VirtualBox.xidl@ 42018

Last change on this file since 42018 was 42018, checked in by vboxsync, 13 years ago
Main/idl: missing piece from r78900, plus adding a bit more explanation to the error codes.
Property svn:eol-style set to `native`
File size: 666.8 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490	<const name="v1_13" value="15">
491	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
492	<!--
493	Machine changes: tracing config;
494	-->
495	</const>
496
497	<const name="Future" value="99999">
498	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
499	</const>
500	</enum>
501
502	<enum
503	name="AccessMode"
504	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
505	>
506	<desc>
507	Access mode for opening files.
508	</desc>
509
510	<const name="ReadOnly" value="1"/>
511	<const name="ReadWrite" value="2"/>
512	</enum>
513
514	<enum
515	name="MachineState"
516	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
517	>
518	<desc>
519	Virtual machine execution state.
520
521	This enumeration represents possible values of the <link
522	to="IMachine::state"/> attribute.
523
524	Below is the basic virtual machine state diagram. It shows how the state
525	changes during virtual machine execution. The text in square braces shows
526	a method of the IConsole interface that performs the given state
527	transition.
528
529	<pre>
530	+---------[powerDown()] <- Stuck <--[failure]-+
531	V \|
532	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
533	\| \| \| \| V \|
534	\| Aborted -----+ +--> Running --[pause()]--> Paused
535	\| \| ^ \| ^ \|
536	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
537	\| ^ \| \| \| \|
538	\| \| +-----------------------------------------+-\|-------------------+ +
539	\| \| \| \| \|
540	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
541	\| \| \| \|
542	\| +-------- Saving <--------[saveState()]<----------+---------------------+
543	\| \| \|
544	+-------------- Stopping -------[powerDown()]<----------+---------------------+
545	</pre>
546
547	Note that states to the right from PoweredOff, Aborted and Saved in the
548	above diagram are called <i>online VM states</i>. These states
549	represent the virtual machine which is being executed in a dedicated
550	process (usually with a GUI window attached to it where you can see the
551	activity of the virtual machine and interact with it). There are two
552	special pseudo-states, FirstOnline and LastOnline, that can be used in
553	relational expressions to detect if the given machine state is online or
554	not:
555
556	<pre>
557	if (machine.GetState() >= MachineState_FirstOnline &&
558	machine.GetState() <= MachineState_LastOnline)
559	{
560	...the machine is being executed...
561	}
562	</pre>
563
564	When the virtual machine is in one of the online VM states (that is, being
565	executed), only a few machine settings can be modified. Methods working
566	with such settings contain an explicit note about that. An attempt to
567	change any other setting or perform a modifying operation during this time
568	will result in the @c VBOX_E_INVALID_VM_STATE error.
569
570	All online states except Running, Paused and Stuck are transitional: they
571	represent temporary conditions of the virtual machine that will last as
572	long as the operation that initiated such a condition.
573
574	The Stuck state is a special case. It means that execution of the machine
575	has reached the "Guru Meditation" condition. This condition indicates an
576	internal VMM (virtual machine manager) failure which may happen as a
577	result of either an unhandled low-level virtual hardware exception or one
578	of the recompiler exceptions (such as the <i>too-many-traps</i>
579	condition).
580
581	Note also that any online VM state may transit to the Aborted state. This
582	happens if the process that is executing the virtual machine terminates
583	unexpectedly (for example, crashes). Other than that, the Aborted state is
584	equivalent to PoweredOff.
585
586	There are also a few additional state diagrams that do not deal with
587	virtual machine execution and therefore are shown separately. The states
588	shown on these diagrams are called <i>offline VM states</i> (this includes
589	PoweredOff, Aborted and Saved too).
590
591	The first diagram shows what happens when a lengthy setup operation is
592	being executed (such as <link to="IMachine::attachDevice"/>).
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| \| \|
599	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
600	\| \|
601	+-> Saved -------+
602	</pre>
603
604	The next two diagrams demonstrate the process of taking a snapshot of a
605	powered off virtual machine, restoring the state to that as of a snapshot
606	or deleting a snapshot, respectively.
607
608	<pre>
609	+----------------------------------(same state as before the call)------+
610	\| \|
611	+-> PoweredOff --+ \|
612	\| +-->[takeSnapshot()] -------------------> Saving ------+
613	+-> Aborted -----+
614
615	+-> PoweredOff --+
616	\| \|
617	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
618	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
619	+-> Saved -------+ \|
620	\| \|
621	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
622	</pre>
623
624	Note that the Saving state is present in both the offline state group and
625	online state group. Currently, the only way to determine what group is
626	assumed in a particular case is to remember the previous machine state: if
627	it was Running or Paused, then Saving is an online state, otherwise it is
628	an offline state. This inconsistency may be removed in one of the future
629	versions of VirtualBox by adding a new state.
630
631	<note internal="yes">
632	For whoever decides to touch this enum: In order to keep the
633	comparisons involving FirstOnline and LastOnline pseudo-states valid,
634	the numeric values of these states must be correspondingly updated if
635	needed: for any online VM state, the condition
636	<tt>FirstOnline <= state <= LastOnline</tt> must be
637	@c true. The same relates to transient states for which
638	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
639	@c true.
640	</note>
641	</desc>
642
643	<const name="Null" value="0">
644	<desc>Null value (never used by the API).</desc>
645	</const>
646	<const name="PoweredOff" value="1">
647	<desc>
648	The machine is not running and has no saved execution state; it has
649	either never been started or been shut down successfully.
650	</desc>
651	</const>
652	<const name="Saved" value="2">
653	<desc>
654	The machine is not currently running, but the execution state of the machine
655	has been saved to an external file when it was running, from where
656	it can be resumed.
657	</desc>
658	</const>
659	<const name="Teleported" value="3">
660	<desc>
661	The machine was teleported to a different host (or process) and then
662	powered off. Take care when powering it on again may corrupt resources
663	it shares with the teleportation target (e.g. disk and network).
664	</desc>
665	</const>
666	<const name="Aborted" value="4">
667	<desc>
668	The process running the machine has terminated abnormally. This may
669	indicate a crash of the VM process in host execution context, or
670	the VM process has been terminated externally.
671	</desc>
672	</const>
673	<const name="Running" value="5">
674	<desc>
675	The machine is currently being executed.
676	<note internal="yes">
677	For whoever decides to touch this enum: In order to keep the
678	comparisons in the old source code valid, this state must immediately
679	precede the Paused state.
680	TODO: Lift this spectacularly wonderful restriction.
681	</note>
682	</desc>
683	</const>
684	<const name="Paused" value="6">
685	<desc>
686	Execution of the machine has been paused.
687	<note internal="yes">
688	For whoever decides to touch this enum: In order to keep the
689	comparisons in the old source code valid, this state must immediately
690	follow the Running state.
691	TODO: Lift this spectacularly wonderful restriction.
692	</note>
693	</desc>
694	</const>
695	<const name="Stuck" value="7">
696	<desc>
697	Execution of the machine has reached the "Guru Meditation"
698	condition. This indicates a severe error in the hypervisor itself.
699	<note internal="yes">
700	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
701	"Guru", perhaps? Or are there some other VMM states that are
702	intended to be lumped in here as well?
703	</note>
704	</desc>
705	</const>
706	<const name="Teleporting" value="8">
707	<desc>
708	The machine is about to be teleported to a different host or process.
709	It is possible to pause a machine in this state, but it will go to the
710	@c TeleportingPausedVM state and it will not be
711	possible to resume it again unless the teleportation fails.
712	</desc>
713	</const>
714	<const name="LiveSnapshotting" value="9">
715	<desc>
716	A live snapshot is being taken. The machine is running normally, but
717	some of the runtime configuration options are inaccessible. Also, if
718	paused while in this state it will transition to
719	@c Saving and it will not be resume the
720	execution until the snapshot operation has completed.
721	</desc>
722	</const>
723	<const name="Starting" value="10">
724	<desc>
725	Machine is being started after powering it on from a
726	zero execution state.
727	</desc>
728	</const>
729	<const name="Stopping" value="11">
730	<desc>
731	Machine is being normally stopped powering it off, or after the guest OS
732	has initiated a shutdown sequence.
733	</desc>
734	</const>
735	<const name="Saving" value="12">
736	<desc>
737	Machine is saving its execution state to a file, or an online
738	snapshot of the machine is being taken.
739	</desc>
740	</const>
741	<const name="Restoring" value="13">
742	<desc>
743	Execution state of the machine is being restored from a file
744	after powering it on from the saved execution state.
745	</desc>
746	</const>
747	<const name="TeleportingPausedVM" value="14">
748	<desc>
749	The machine is being teleported to another host or process, but it is
750	not running. This is the paused variant of the
751	@c state.
752	</desc>
753	</const>
754	<const name="TeleportingIn" value="15">
755	<desc>
756	Teleporting the machine state in from another host or process.
757	</desc>
758	</const>
759	<const name="FaultTolerantSyncing" value="16">
760	<desc>
761	The machine is being synced with a fault tolerant VM running elsewhere.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotOnline" value="17">
765	<desc>
766	Like @c DeletingSnapshot, but the merging of media is ongoing in
767	the background while the machine is running.
768	</desc>
769	</const>
770	<const name="DeletingSnapshotPaused" value="18">
771	<desc>
772	Like @c DeletingSnapshotOnline, but the machine was paused when the
773	merging of differencing media was started.
774	</desc>
775	</const>
776	<const name="RestoringSnapshot" value="19">
777	<desc>
778	A machine snapshot is being restored; this typically does not take long.
779	</desc>
780	</const>
781	<const name="DeletingSnapshot" value="20">
782	<desc>
783	A machine snapshot is being deleted; this can take a long time since this
784	may require merging differencing media. This value indicates that the
785	machine is not running while the snapshot is being deleted.
786	</desc>
787	</const>
788	<const name="SettingUp" value="21">
789	<desc>
790	Lengthy setup operation is in progress.
791	</desc>
792	</const>
793
794	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
795	<desc>
796	Pseudo-state: first online state (for use in relational expressions).
797	</desc>
798	</const>
799	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
800	<desc>
801	Pseudo-state: last online state (for use in relational expressions).
802	</desc>
803	</const>
804
805	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
806	<desc>
807	Pseudo-state: first transient state (for use in relational expressions).
808	</desc>
809	</const>
810	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
811	<desc>
812	Pseudo-state: last transient state (for use in relational expressions).
813	</desc>
814	</const>
815
816	</enum>
817
818	<enum
819	name="SessionState"
820	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
821	>
822	<desc>
823	Session state. This enumeration represents possible values of
824	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
825	attributes.
826	</desc>
827
828	<const name="Null" value="0">
829	<desc>Null value (never used by the API).</desc>
830	</const>
831	<const name="Unlocked" value="1">
832	<desc>
833	In <link to="IMachine::sessionState"/>, this means that the machine
834	is not locked for any sessions.
835
836	In <link to="ISession::state"/>, this means that no machine is
837	currently locked for this session.
838	</desc>
839	</const>
840	<const name="Locked" value="2">
841	<desc>
842	In <link to="IMachine::sessionState"/>, this means that the machine
843	is currently locked for a session, whose process identifier can
844	then be found in the <link to="IMachine::sessionPid" /> attribute.
845
846	In <link to="ISession::state"/>, this means that a machine is
847	currently locked for this session, and the mutable machine object
848	can be found in the <link to="ISession::machine"/> attribute
849	(see <link to="IMachine::lockMachine" /> for details).
850	</desc>
851	</const>
852	<const name="Spawning" value="3">
853	<desc>
854	A new process is being spawned for the machine as a result of
855	<link to="IMachine::launchVMProcess"/> call. This state also occurs
856	as a short transient state during an <link to="IMachine::lockMachine"/>
857	call.
858	</desc>
859	</const>
860	<const name="Unlocking" value="4">
861	<desc>
862	The session is being unlocked.
863	</desc>
864	</const>
865	</enum>
866
867	<enum
868	name="CPUPropertyType"
869	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
870	>
871	<desc>
872	Virtual CPU property type. This enumeration represents possible values of the
873	IMachine get- and setCPUProperty methods.
874	</desc>
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="PAE" value="1">
879	<desc>
880	This setting determines whether VirtualBox will expose the Physical Address
881	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
882	is not available, it will not be reported.
883	</desc>
884	</const>
885	<const name="Synthetic" value="2">
886	<desc>
887	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
888	teleporting between host systems that differ significantly.
889	</desc>
890	</const>
891	</enum>
892
893
894	<enum
895	name="HWVirtExPropertyType"
896	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
897	>
898	<desc>
899	Hardware virtualization property type. This enumeration represents possible values
900	for the <link to="IMachine::getHWVirtExProperty"/> and
901	<link to="IMachine::setHWVirtExProperty"/> methods.
902	</desc>
903	<const name="Null" value="0">
904	<desc>Null value (never used by the API).</desc>
905	</const>
906	<const name="Enabled" value="1">
907	<desc>
908	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
909	such extensions are not available, they will not be used.
910	</desc>
911	</const>
912	<const name="Exclusive" value="2">
913	<desc>
914	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
915	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
916	feature of the host. To share these with other hypervisors, you must disable this property.
917	</desc>
918	</const>
919	<const name="VPID" value="3">
920	<desc>
921	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
922	</desc>
923	</const>
924	<const name="NestedPaging" value="4">
925	<desc>
926	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
927	</desc>
928	</const>
929	<const name="LargePages" value="5">
930	<desc>
931	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
932	</desc>
933	</const>
934	<const name="Force" value="6">
935	<desc>
936	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
937	not set, there will be an automatic fallback to software virtualization.
938	</desc>
939	</const>
940	</enum>
941
942	<enum
943	name="FaultToleranceState"
944	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
945	>
946	<desc>
947	Used with <link to="IMachine::faultToleranceState" />.
948	</desc>
949	<const name="Inactive" value="1">
950	<desc>No fault tolerance enabled.</desc>
951	</const>
952	<const name="Master" value="2">
953	<desc>Fault tolerant master VM.</desc>
954	</const>
955	<const name="Standby" value="3">
956	<desc>Fault tolerant standby VM.</desc>
957	</const>
958	</enum>
959
960	<enum
961	name="LockType"
962	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
963	>
964	<desc>
965	Used with <link to="IMachine::lockMachine" />.
966	</desc>
967	<const name="Write" value="2">
968	<desc>Lock the machine for writing.</desc>
969	</const>
970	<const name="Shared" value="1">
971	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
972	</const>
973	</enum>
974
975	<enum
976	name="SessionType"
977	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
978	>
979	<desc>
980	Session type. This enumeration represents possible values of the
981	<link to="ISession::type"/> attribute.
982	</desc>
983
984	<const name="Null" value="0">
985	<desc>Null value (never used by the API).</desc>
986	</const>
987	<const name="WriteLock" value="1">
988	<desc>
989	Session has acquired an exclusive write lock on a machine
990	using <link to="IMachine::lockMachine"/>.
991	</desc>
992	</const>
993	<const name="Remote" value="2">
994	<desc>
995	Session has launched a VM process using
996	<link to="IMachine::launchVMProcess"/>
997	</desc>
998	</const>
999	<const name="Shared" value="3">
1000	<desc>
1001	Session has obtained a link to another session using
1002	<link to="IMachine::lockMachine"/>
1003	</desc>
1004	</const>
1005	</enum>
1006
1007	<enum
1008	name="DeviceType"
1009	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1010	>
1011	<desc>
1012	Device type.
1013	</desc>
1014	<const name="Null" value="0">
1015	<desc>
1016	Null value, may also mean "no device" (not allowed for
1017	<link to="IConsole::getDeviceActivity"/>).
1018	</desc>
1019	</const>
1020	<const name="Floppy" value="1">
1021	<desc>Floppy device.</desc>
1022	</const>
1023	<const name="DVD" value="2">
1024	<desc>CD/DVD-ROM device.</desc>
1025	</const>
1026	<const name="HardDisk" value="3">
1027	<desc>Hard disk device.</desc>
1028	</const>
1029	<const name="Network" value="4">
1030	<desc>Network device.</desc>
1031	</const>
1032	<const name="USB" value="5">
1033	<desc>USB device.</desc>
1034	</const>
1035	<const name="SharedFolder" value="6">
1036	<desc>Shared folder device.</desc>
1037	</const>
1038	</enum>
1039
1040	<enum
1041	name="DeviceActivity"
1042	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1043	>
1044	<desc>
1045	Device activity for <link to="IConsole::getDeviceActivity"/>.
1046	</desc>
1047
1048	<const name="Null" value="0"/>
1049	<const name="Idle" value="1"/>
1050	<const name="Reading" value="2"/>
1051	<const name="Writing" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="ClipboardMode"
1056	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1057	>
1058	<desc>
1059	Host-Guest clipboard interchange mode.
1060	</desc>
1061
1062	<const name="Disabled" value="0"/>
1063	<const name="HostToGuest" value="1"/>
1064	<const name="GuestToHost" value="2"/>
1065	<const name="Bidirectional" value="3"/>
1066	</enum>
1067
1068	<enum
1069	name="Scope"
1070	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1071	>
1072	<desc>
1073	Scope of the operation.
1074
1075	A generic enumeration used in various methods to define the action or
1076	argument scope.
1077	</desc>
1078
1079	<const name="Global" value="0"/>
1080	<const name="Machine" value="1"/>
1081	<const name="Session" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="BIOSBootMenuMode"
1086	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1087	>
1088	<desc>
1089	BIOS boot menu mode.
1090	</desc>
1091
1092	<const name="Disabled" value="0"/>
1093	<const name="MenuOnly" value="1"/>
1094	<const name="MessageAndMenu" value="2"/>
1095	</enum>
1096
1097	<enum
1098	name="ProcessorFeature"
1099	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1100	>
1101	<desc>
1102	CPU features.
1103	</desc>
1104
1105	<const name="HWVirtEx" value="0"/>
1106	<const name="PAE" value="1"/>
1107	<const name="LongMode" value="2"/>
1108	<const name="NestedPaging" value="3"/>
1109	</enum>
1110
1111	<enum
1112	name="FirmwareType"
1113	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1114	>
1115	<desc>
1116	Firmware type.
1117	</desc>
1118	<const name="BIOS" value="1">
1119	<desc>BIOS Firmware.</desc>
1120	</const>
1121	<const name="EFI" value="2">
1122	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1123	</const>
1124	<const name="EFI32" value="3">
1125	<desc>Efi firmware, 32-bit.</desc>
1126	</const>
1127	<const name="EFI64" value="4">
1128	<desc>Efi firmware, 64-bit.</desc>
1129	</const>
1130	<const name="EFIDUAL" value="5">
1131	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1132	</const>
1133	</enum>
1134
1135	<enum
1136	name="PointingHidType"
1137	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1138	>
1139	<desc>
1140	Type of pointing device used in a virtual machine.
1141	</desc>
1142	<const name="None" value="1">
1143	<desc>No mouse.</desc>
1144	</const>
1145	<const name="PS2Mouse" value="2">
1146	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1147	</const>
1148	<const name="USBMouse" value="3">
1149	<desc>USB mouse (relative pointer).</desc>
1150	</const>
1151	<const name="USBTablet" value="4">
1152	<desc>USB tablet (absolute pointer).</desc>
1153	</const>
1154	<const name="ComboMouse" value="5">
1155	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1156	Using of such device can have negative performance implications. </desc>
1157	</const>
1158	</enum>
1159
1160	<enum
1161	name="KeyboardHidType"
1162	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1163	>
1164	<desc>
1165	Type of keyboard device used in a virtual machine.
1166	</desc>
1167	<const name="None" value="1">
1168	<desc>No keyboard.</desc>
1169	</const>
1170	<const name="PS2Keyboard" value="2">
1171	<desc>PS/2 keyboard.</desc>
1172	</const>
1173	<const name="USBKeyboard" value="3">
1174	<desc>USB keyboard.</desc>
1175	</const>
1176	<const name="ComboKeyboard" value="4">
1177	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1178	Using of such device can have negative performance implications. </desc>
1179	</const>
1180	</enum>
1181
1182	<!--
1183	// IVirtualBoxErrorInfo
1184	/////////////////////////////////////////////////////////////////////////
1185	-->
1186
1187	<interface
1188	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1189	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1190	supportsErrorInfo="no"
1191	wsmap="managed"
1192	>
1193	<desc>
1194	The IVirtualBoxErrorInfo interface represents extended error information.
1195
1196	Extended error information can be set by VirtualBox components after
1197	unsuccessful or partially successful method invocation. This information
1198	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1199	and then shown to the client in addition to the plain 32-bit result code.
1200
1201	In MS COM, this interface extends the IErrorInfo interface,
1202	in XPCOM, it extends the nsIException interface. In both cases,
1203	it provides a set of common attributes to retrieve error
1204	information.
1205
1206	Sometimes invocation of some component's method may involve methods of
1207	other components that may also fail (independently of this method's
1208	failure), or a series of non-fatal errors may precede a fatal error that
1209	causes method failure. In cases like that, it may be desirable to preserve
1210	information about all errors happened during method invocation and deliver
1211	it to the caller. The <link to="#next"/> attribute is intended
1212	specifically for this purpose and allows to represent a chain of errors
1213	through a single IVirtualBoxErrorInfo object set after method invocation.
1214
1215	<note>errors are stored to a chain in the reverse order, i.e. the
1216	initial error object you query right after method invocation is the last
1217	error set by the callee, the object it points to in the @a next attribute
1218	is the previous error and so on, up to the first error (which is the last
1219	in the chain).</note>
1220	</desc>
1221
1222	<attribute name="resultCode" type="long" readonly="yes">
1223	<desc>
1224	Result code of the error.
1225	Usually, it will be the same as the result code returned
1226	by the method that provided this error information, but not
1227	always. For example, on Win32, CoCreateInstance() will most
1228	likely return E_NOINTERFACE upon unsuccessful component
1229	instantiation attempt, but not the value the component factory
1230	returned. Value is typed 'long', not 'result',
1231	to make interface usable from scripting languages.
1232	<note>
1233	In MS COM, there is no equivalent.
1234	In XPCOM, it is the same as nsIException::result.
1235	</note>
1236	</desc>
1237	</attribute>
1238
1239	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1240	<desc>
1241	UUID of the interface that defined the error.
1242	<note>
1243	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1244	data type.
1245	In XPCOM, there is no equivalent.
1246	</note>
1247	</desc>
1248	</attribute>
1249
1250	<attribute name="component" type="wstring" readonly="yes">
1251	<desc>
1252	Name of the component that generated the error.
1253	<note>
1254	In MS COM, it is the same as IErrorInfo::GetSource.
1255	In XPCOM, there is no equivalent.
1256	</note>
1257	</desc>
1258	</attribute>
1259
1260	<attribute name="text" type="wstring" readonly="yes">
1261	<desc>
1262	Text description of the error.
1263	<note>
1264	In MS COM, it is the same as IErrorInfo::GetDescription.
1265	In XPCOM, it is the same as nsIException::message.
1266	</note>
1267	</desc>
1268	</attribute>
1269
1270	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1271	<desc>
1272	Next error object if there is any, or @c null otherwise.
1273	<note>
1274	In MS COM, there is no equivalent.
1275	In XPCOM, it is the same as nsIException::inner.
1276	</note>
1277	</desc>
1278	</attribute>
1279
1280	</interface>
1281
1282	<!--
1283	// IVirtualBox
1284	/////////////////////////////////////////////////////////////////////////
1285	-->
1286
1287	<interface
1288	name="IDHCPServer" extends="$unknown"
1289	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1290	wsmap="managed"
1291	>
1292	<desc>
1293	The IDHCPServer interface represents the vbox dhcp server configuration.
1294
1295	To enumerate all the dhcp servers on the host, use the
1296	<link to="IVirtualBox::DHCPServers"/> attribute.
1297	</desc>
1298
1299	<attribute name="enabled" type="boolean">
1300	<desc>
1301	specifies if the dhcp server is enabled
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="IPAddress" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server IP
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkMask" type="wstring" readonly="yes">
1312	<desc>
1313	specifies server network mask
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="networkName" type="wstring" readonly="yes">
1318	<desc>
1319	specifies internal network name the server is used for
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="lowerIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies from IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<attribute name="upperIP" type="wstring" readonly="yes">
1330	<desc>
1331	specifies to IP address in server address range
1332	</desc>
1333	</attribute>
1334
1335	<method name="setConfiguration">
1336	<desc>
1337	configures the server
1338	<result name="E_INVALIDARG">
1339	invalid configuration supplied
1340	</result>
1341	</desc>
1342	<param name="IPAddress" type="wstring" dir="in">
1343	<desc>
1344	server IP address
1345	</desc>
1346	</param>
1347	<param name="networkMask" type="wstring" dir="in">
1348	<desc>
1349	server network mask
1350	</desc>
1351	</param>
1352	<param name="FromIPAddress" type="wstring" dir="in">
1353	<desc>
1354	server From IP address for address range
1355	</desc>
1356	</param>
1357	<param name="ToIPAddress" type="wstring" dir="in">
1358	<desc>
1359	server To IP address for address range
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="start">
1365	<desc>
1366	Starts DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to start the process.
1369	</result>
1370	</desc>
1371	<param name="networkName" type="wstring" dir="in">
1372	<desc>
1373	Name of internal network DHCP server should attach to.
1374	</desc>
1375	</param>
1376	<param name="trunkName" type="wstring" dir="in">
1377	<desc>
1378	Name of internal network trunk.
1379	</desc>
1380	</param>
1381	<param name="trunkType" type="wstring" dir="in">
1382	<desc>
1383	Type of internal network trunk.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="stop">
1389	<desc>
1390	Stops DHCP server process.
1391	<result name="E_FAIL">
1392	Failed to stop the process.
1393	</result>
1394	</desc>
1395	</method>
1396	</interface>
1397
1398	<interface
1399	name="IVirtualBox" extends="$unknown"
1400	uuid="867664ba-41ce-4099-a10d-b7a8e34057c7"
1401	wsmap="managed"
1402	>
1403	<desc>
1404	The IVirtualBox interface represents the main interface exposed by the
1405	product that provides virtual machine management.
1406
1407	An instance of IVirtualBox is required for the product to do anything
1408	useful. Even though the interface does not expose this, internally,
1409	IVirtualBox is implemented as a singleton and actually lives in the
1410	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1411	IVirtualBox can track the state of all virtual machines on a particular
1412	host, regardless of which frontend started them.
1413
1414	To enumerate all the virtual machines on the host, use the
1415	<link to="IVirtualBox::machines"/> attribute.
1416	</desc>
1417
1418	<attribute name="version" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the version number of the product. The
1421	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1422	last number represents the build number and will frequently change.
1423
1424	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1425	in prerelease builds. Non-Oracle builds may (/shall) also have a
1426	publisher tag, at the end. The publisher tag starts with an underscore
1427	just like the prerelease build type tag.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="revision" type="unsigned long" readonly="yes">
1432	<desc>
1433	The internal build revision number of the product.
1434	</desc>
1435	</attribute>
1436
1437	<attribute name="packageType" type="wstring" readonly="yes">
1438	<desc>
1439	A string representing the package type of this product. The
1440	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1441	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1442	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1443	this.
1444	</desc>
1445	</attribute>
1446
1447	<attribute name="APIVersion" type="wstring" readonly="yes">
1448	<desc>
1449	A string representing the VirtualBox API version number. The format is
1450	2 integer numbers divided by an underscore (e.g. 1_0). After the
1451	first public release of packages with a particular API version the
1452	API will not be changed in an incompatible way. Note that this
1453	guarantee does not apply to development builds, and also there is no
1454	guarantee that this version is identical to the first two integer
1455	numbers of the package version.
1456	</desc>
1457	</attribute>
1458
1459	<attribute name="homeFolder" type="wstring" readonly="yes">
1460	<desc>
1461	Full path to the directory where the global settings file,
1462	<tt>VirtualBox.xml</tt>, is stored.
1463
1464	In this version of VirtualBox, the value of this property is
1465	always <tt><user_dir>/.VirtualBox</tt> (where
1466	<tt><user_dir></tt> is the path to the user directory,
1467	as determined by the host OS), and cannot be changed.
1468
1469	This path is also used as the base to resolve relative paths in
1470	places where relative paths are allowed (unless otherwise
1471	expressly indicated).
1472	</desc>
1473	</attribute>
1474
1475	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1476	<desc>
1477	Full name of the global settings file.
1478	The value of this property corresponds to the value of
1479	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1480	</desc>
1481	</attribute>
1482
1483	<attribute name="host" type="IHost" readonly="yes">
1484	<desc>Associated host object.</desc>
1485	</attribute>
1486
1487	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1488	<desc>Associated system information object.</desc>
1489	</attribute>
1490
1491	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of machine objects registered within this VirtualBox instance.
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1498	<desc>
1499	Array of medium objects known to this VirtualBox installation.
1500
1501	This array contains only base media. All differencing
1502	media of the given base medium can be enumerated using
1503	<link to="IMedium::children"/>.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1514	<desc>
1515	Array of floppy image objects currently in use by this VirtualBox instance.
1516	</desc>
1517	</attribute>
1518
1519	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1520
1521	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1522
1523	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1524	<desc>
1525	Collection of global shared folders. Global shared folders are
1526	available to all virtual machines.
1527
1528	New shared folders are added to the collection using
1529	<link to="#createSharedFolder"/>. Existing shared folders can be
1530	removed using <link to="#removeSharedFolder"/>.
1531
1532	<note>
1533	In the current version of the product, global shared folders are not
1534	implemented and therefore this collection is always empty.
1535	</note>
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1540	<desc>
1541	Associated performance collector object.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1546	<desc>
1547	DHCP servers.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="eventSource" type="IEventSource" readonly="yes">
1552	<desc>
1553	Event source for VirtualBox events.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1558	<desc>
1559	The extension pack manager.
1560	</desc>
1561	</attribute>
1562
1563
1564	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all internal networks.
1567	</desc>
1568	</attribute>
1569
1570	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1571	<desc>
1572	Names of all generic network drivers.
1573	</desc>
1574	</attribute>
1575
1576	<method name="composeMachineFilename">
1577	<desc>
1578	Returns a recommended full path of the settings file name for a new virtual
1579	machine.
1580
1581	This API serves two purposes:
1582
1583	<ul>
1584	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1585	for the @a settingsFile argument there, which means that API should use
1586	a recommended default file name.</li>
1587
1588	<li>It can be called manually by a client software before creating a machine,
1589	e.g. if that client wants to pre-create the machine directory to create
1590	virtual hard disks in that directory together with the new machine
1591	settings file. In that case, the file name should be stripped from the
1592	full settings file path returned by this function to obtain the
1593	machine directory.</li>
1594	</ul>
1595
1596	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1597	details about the machine name.
1598
1599	If @a baseFolder is a @c null or empty string (which is recommended), the
1600	default machine settings folder
1601	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1602	a base folder for the created machine, resulting in a file name like
1603	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1604	will be used.
1605
1606	This method does not access the host disks. In particular, it does not check
1607	for whether a machine of this name already exists.
1608	</desc>
1609	<param name="name" type="wstring" dir="in">
1610	<desc>Suggested machine name.</desc>
1611	</param>
1612	<param name="baseFolder" type="wstring" dir="in">
1613	<desc>Base machine folder (optional).</desc>
1614	</param>
1615	<param name="file" type="wstring" dir="return">
1616	<desc>Fully qualified path where the machine would be created.</desc>
1617	</param>
1618	</method>
1619
1620	<method name="createMachine">
1621	<desc>
1622	Creates a new virtual machine by creating a machine settings file at
1623	the given location.
1624
1625	VirtualBox machine settings files use a custom XML dialect. Starting
1626	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1627	and machine files can be created at arbitrary locations.
1628
1629	However, it is is recommended that machines be created in the default
1630	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1631	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1632	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1633	is called automatically to have such a recommended name composed based
1634	on the machine name given in the @a name argument.
1635
1636	If the resulting settings file already exists, this method will fail,
1637	unless @a forceOverwrite is set.
1638
1639	The new machine is created unregistered, with the initial configuration
1640	set according to the specified guest OS type. A typical sequence of
1641	actions to create a new virtual machine is as follows:
1642
1643	<ol>
1644	<li>
1645	Call this method to have a new machine created. The returned machine
1646	object will be "mutable" allowing to change any machine property.
1647	</li>
1648
1649	<li>
1650	Configure the machine using the appropriate attributes and methods.
1651	</li>
1652
1653	<li>
1654	Call <link to="IMachine::saveSettings" /> to write the settings
1655	to the machine's XML settings file. The configuration of the newly
1656	created machine will not be saved to disk until this method is
1657	called.
1658	</li>
1659
1660	<li>
1661	Call <link to="#registerMachine" /> to add the machine to the list
1662	of machines known to VirtualBox.
1663	</li>
1664	</ol>
1665
1666	The specified guest OS type identifier must match an ID of one of known
1667	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1668	array.
1669
1670	Optionally, you may specify an UUID of to assign to the created machine.
1671	However, this is not recommended and you should normally pass an empty
1672	(@c null) UUID to this method so that a new UUID will be automatically
1673	generated for every created machine. You can use UUID
1674	00000000-0000-0000-0000-000000000000 as @c null value.
1675
1676	<note>
1677	There is no way to change the name of the settings file or
1678	subfolder of the created machine directly.
1679	</note>
1680
1681	<result name="VBOX_E_OBJECT_NOT_FOUND">
1682	@a osTypeId is invalid.
1683	</result>
1684	<result name="VBOX_E_FILE_ERROR">
1685	Resulting settings file name is invalid or the settings file already
1686	exists or could not be created due to an I/O error.
1687	</result>
1688	<result name="E_INVALIDARG">
1689	@a name is empty or @c null.
1690	</result>
1691	</desc>
1692
1693	<param name="settingsFile" type="wstring" dir="in">
1694	<desc>Fully qualified path where the settings file should be created,
1695	or NULL for a default folder and file based on the @a name argument
1696	(see <link to="#composeMachineFilename" />).</desc>
1697	</param>
1698	<param name="name" type="wstring" dir="in">
1699	<desc>Machine name.</desc>
1700	</param>
1701	<param name="osTypeId" type="wstring" dir="in">
1702	<desc>Guest OS Type ID.</desc>
1703	</param>
1704	<param name="id" type="uuid" mod="string" dir="in">
1705	<desc>Machine UUID (optional).</desc>
1706	</param>
1707	<param name="forceOverwrite" type="boolean" dir="in">
1708	<desc>If true, an existing machine settings file will be overwritten.</desc>
1709	</param>
1710	<param name="machine" type="IMachine" dir="return">
1711	<desc>Created machine object.</desc>
1712	</param>
1713	</method>
1714
1715	<method name="openMachine">
1716	<desc>
1717	Opens a virtual machine from the existing settings file.
1718	The opened machine remains unregistered until you call
1719	<link to="#registerMachine"/>.
1720
1721	The specified settings file name must be fully qualified.
1722	The file must exist and be a valid machine XML settings file
1723	whose contents will be used to construct the machine object.
1724
1725	<result name="VBOX_E_FILE_ERROR">
1726	Settings file name invalid, not found or sharing violation.
1727	</result>
1728	</desc>
1729	<param name="settingsFile" type="wstring" dir="in">
1730	<desc>
1731	Name of the machine settings file.
1732	</desc>
1733	</param>
1734	<param name="machine" type="IMachine" dir="return">
1735	<desc>Opened machine object.</desc>
1736	</param>
1737	<note>
1738	<link to="IMachine::settingsModified"/> will return
1739	@c false for the created machine, until any of machine settings
1740	are changed.
1741	</note>
1742	</method>
1743
1744	<method name="registerMachine">
1745	<desc>
1746
1747	Registers the machine previously created using
1748	<link to="#createMachine"/> or opened using
1749	<link to="#openMachine"/> within this VirtualBox installation. After
1750	successful method invocation, the
1751	<link to="IMachineRegisteredEvent"/> event is fired.
1752
1753	<note>
1754	This method implicitly calls <link to="IMachine::saveSettings"/>
1755	to save all current machine settings before registering it.
1756	</note>
1757
1758	<result name="VBOX_E_OBJECT_NOT_FOUND">
1759	No matching virtual machine found.
1760	</result>
1761	<result name="VBOX_E_INVALID_OBJECT_STATE">
1762	Virtual machine was not created within this VirtualBox instance.
1763	</result>
1764
1765	</desc>
1766	<param name="machine" type="IMachine" dir="in"/>
1767	</method>
1768
1769	<method name="findMachine">
1770	<desc>
1771	Attempts to find a virtual machine given its name or UUID.
1772
1773	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1774	cannot safely be determined.</note>
1775
1776	<result name="VBOX_E_OBJECT_NOT_FOUND">
1777	Could not find registered machine matching @a nameOrId.
1778	</result>
1779
1780	</desc>
1781	<param name="nameOrId" type="wstring" dir="in">
1782	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1783	</param>
1784	<param name="machine" type="IMachine" dir="return">
1785	<desc>Machine object, if found.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="getMachineStates">
1790	<desc>
1791	Gets the state of several machines in a single operation.
1792	</desc>
1793	<param name="machines" type="IMachine" dir="in" safearray="yes">
1794	<desc>Array with the machine references.</desc>
1795	</param>
1796	<param name="states" type="MachineState" dir="return" safearray="yes">
1797	<desc>Machine states, corresponding to the machines.</desc>
1798	</param>
1799	</method>
1800
1801	<method name="createAppliance">
1802	<desc>
1803	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1804	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1805	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1806	</desc>
1807	<param name="appliance" type="IAppliance" dir="return">
1808	<desc>New appliance.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="createHardDisk">
1813	<desc>
1814	Creates a new base medium object that will use the given storage
1815	format and location for medium data.
1816
1817	The actual storage unit is not created by this method. In order to
1818	do it, and before you are able to attach the created medium to
1819	virtual machines, you must call one of the following methods to
1820	allocate a format-specific storage unit at the specified location:
1821	<ul>
1822	<li><link to="IMedium::createBaseStorage"/></li>
1823	<li><link to="IMedium::createDiffStorage"/></li>
1824	</ul>
1825
1826	Some medium attributes, such as <link to="IMedium::id"/>, may
1827	remain uninitialized until the medium storage unit is successfully
1828	created by one of the above methods.
1829
1830	After the storage unit is successfully created, it will be
1831	accessible through the <link to="#openMedium"/> method and can
1832	be found in the <link to="#hardDisks"/> array.
1833
1834	The list of all storage formats supported by this VirtualBox
1835	installation can be obtained using
1836	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1837	attribute is empty or @c null then the default storage format
1838	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1839	be used for creating a storage unit of the medium.
1840
1841	Note that the format of the location string is storage format specific.
1842	See <link to="IMedium::location"/> and IMedium for more details.
1843
1844	<result name="VBOX_E_OBJECT_NOT_FOUND">
1845	@a format identifier is invalid. See
1846	<link to="ISystemProperties::mediumFormats"/>.
1847	</result>
1848	<result name="VBOX_E_FILE_ERROR">
1849	@a location is a not valid file name (for file-based formats only).
1850	</result>
1851	</desc>
1852	<param name="format" type="wstring" dir="in">
1853	<desc>
1854	Identifier of the storage format to use for the new medium.
1855	</desc>
1856	</param>
1857	<param name="location" type="wstring" dir="in">
1858	<desc>
1859	Location of the storage unit for the new medium.
1860	</desc>
1861	</param>
1862	<param name="medium" type="IMedium" dir="return">
1863	<desc>Created medium object.</desc>
1864	</param>
1865	</method>
1866
1867	<method name="openMedium">
1868	<desc>
1869	Finds existing media or opens a medium from an existing storage location.
1870
1871	Once a medium has been opened, it can be passed to other VirtualBox
1872	methods, in particular to <link to="IMachine::attachDevice" />.
1873
1874	Depending on the given device type, the file at the storage location
1875	must be in one of the media formats understood by VirtualBox:
1876
1877	<ul>
1878	<li>With a "HardDisk" device type, the file must be a hard disk image
1879	in one of the formats supported by VirtualBox (see
1880	<link to="ISystemProperties::mediumFormats" />).
1881	After this method succeeds, if the medium is a base medium, it
1882	will be added to the <link to="#hardDisks"/> array attribute. </li>
1883	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1884	After this method succeeds, the medium will be added to the
1885	<link to="#DVDImages"/> array attribute.</li>
1886	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1887	After this method succeeds, the medium will be added to the
1888	<link to="#floppyImages"/> array attribute.</li>
1889	</ul>
1890
1891	After having been opened, the medium can be re-found by this method
1892	and can be attached to virtual machines. See <link to="IMedium" /> for
1893	more details.
1894
1895	The UUID of the newly opened medium will either be retrieved from the
1896	storage location, if the format supports it (e.g. for hard disk images),
1897	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1898	If for some reason you need to change the medium's UUID, use
1899	<link to="IMedium::setIDs" />.
1900
1901	If a differencing hard disk medium is to be opened by this method, the
1902	operation will succeed only if its parent medium and all ancestors,
1903	if any, are already known to this VirtualBox installation (for example,
1904	were opened by this method before).
1905
1906	This method attempts to guess the storage format of the specified medium
1907	by reading medium data at the specified location.
1908
1909	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1910	the image is opened for read/write access and must have according permissions,
1911	as VirtualBox may actually write status information into the disk's metadata
1912	sections.
1913
1914	Note that write access is required for all typical hard disk usage in VirtualBox,
1915	since VirtualBox may need to write metadata such as a UUID into the image.
1916	The only exception is opening a source image temporarily for copying and
1917	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1918	again soon.
1919
1920	The format of the location string is storage format specific. See
1921	<link to="IMedium::location"/> and IMedium for more details.
1922
1923	<result name="VBOX_E_FILE_ERROR">
1924	Invalid medium storage file location or could not find the medium
1925	at the specified location.
1926	</result>
1927	<result name="VBOX_E_IPRT_ERROR">
1928	Could not get medium storage format.
1929	</result>
1930	<result name="E_INVALIDARG">
1931	Invalid medium storage format.
1932	</result>
1933	<result name="VBOX_E_INVALID_OBJECT_STATE">
1934	Medium has already been added to a media registry.
1935	</result>
1936	</desc>
1937	<param name="location" type="wstring" dir="in">
1938	<desc>
1939	Location of the storage unit that contains medium data in one of
1940	the supported storage formats.
1941	</desc>
1942	</param>
1943	<param name="deviceType" type="DeviceType" dir="in">
1944	<desc>
1945	Must be one of "HardDisk", "DVD" or "Floppy".
1946	</desc>
1947	</param>
1948	<param name="accessMode" type="AccessMode" dir="in">
1949	<desc>Whether to open the image in read/write or read-only mode. For
1950	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1951	</param>
1952	<param name="forceNewUuid" type="boolean" dir="in">
1953	<desc>Allows the caller to request a completely new medium UUID for
1954	the image which is to be opened. Useful if one intends to open an exact
1955	copy of a previously opened image, as this would normally fail due to
1956	the duplicate UUID.</desc>
1957	</param>
1958	<param name="medium" type="IMedium" dir="return">
1959	<desc>Opened medium object.</desc>
1960	</param>
1961	</method>
1962
1963	<method name="getGuestOSType">
1964	<desc>
1965	Returns an object describing the specified guest OS type.
1966
1967	The requested guest OS type is specified using a string which is a
1968	mnemonic identifier of the guest operating system, such as
1969	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1970	particular virtual machine can be read or set using the
1971	<link to="IMachine::OSTypeId"/> attribute.
1972
1973	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1974	available guest OS type objects. Each object has an
1975	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1976	the guest OS this object describes.
1977
1978	<result name="E_INVALIDARG">
1979	@a id is not a valid Guest OS type.
1980	</result>
1981
1982	</desc>
1983	<param name="id" type="uuid" mod="string" dir="in">
1984	<desc>Guest OS type ID string.</desc>
1985	</param>
1986	<param name="type" type="IGuestOSType" dir="return">
1987	<desc>Guest OS type object.</desc>
1988	</param>
1989	</method>
1990
1991	<method name="createSharedFolder">
1992	<desc>
1993	Creates a new global shared folder by associating the given logical
1994	name with the given host path, adds it to the collection of shared
1995	folders and starts sharing it. Refer to the description of
1996	<link to="ISharedFolder"/> to read more about logical names.
1997	<note>
1998	In the current implementation, this operation is not
1999	implemented.
2000	</note>
2001	</desc>
2002	<param name="name" type="wstring" dir="in">
2003	<desc>Unique logical name of the shared folder.</desc>
2004	</param>
2005	<param name="hostPath" type="wstring" dir="in">
2006	<desc>Full path to the shared folder in the host file system.</desc>
2007	</param>
2008	<param name="writable" type="boolean" dir="in">
2009	<desc>Whether the share is writable or readonly</desc>
2010	</param>
2011	<param name="automount" type="boolean" dir="in">
2012	<desc>Whether the share gets automatically mounted by the guest
2013	or not.</desc>
2014	</param>
2015	</method>
2016
2017	<method name="removeSharedFolder">
2018	<desc>
2019	Removes the global shared folder with the given name previously
2020	created by <link to="#createSharedFolder"/> from the collection of
2021	shared folders and stops sharing it.
2022	<note>
2023	In the current implementation, this operation is not
2024	implemented.
2025	</note>
2026	</desc>
2027	<param name="name" type="wstring" dir="in">
2028	<desc>Logical name of the shared folder to remove.</desc>
2029	</param>
2030	</method>
2031
2032	<method name="getExtraDataKeys">
2033	<desc>
2034	Returns an array representing the global extra data keys which currently
2035	have values defined.
2036	</desc>
2037	<param name="value" type="wstring" dir="return" safearray="yes">
2038	<desc>Array of extra data keys.</desc>
2039	</param>
2040	</method>
2041
2042	<method name="getExtraData">
2043	<desc>
2044	Returns associated global extra data.
2045
2046	If the requested data @a key does not exist, this function will
2047	succeed and return an empty string in the @a value argument.
2048
2049	<result name="VBOX_E_FILE_ERROR">
2050	Settings file not accessible.
2051	</result>
2052	<result name="VBOX_E_XML_ERROR">
2053	Could not parse the settings file.
2054	</result>
2055
2056	</desc>
2057	<param name="key" type="wstring" dir="in">
2058	<desc>Name of the data key to get.</desc>
2059	</param>
2060	<param name="value" type="wstring" dir="return">
2061	<desc>Value of the requested data key.</desc>
2062	</param>
2063	</method>
2064
2065	<method name="setExtraData">
2066	<desc>
2067	Sets associated global extra data.
2068
2069	If you pass @c null or empty string as a key @a value, the given @a key
2070	will be deleted.
2071
2072	<note>
2073	Before performing the actual data change, this method will ask all
2074	registered event listener using the
2075	<link to="IExtraDataCanChangeEvent"/>
2076	notification for a permission. If one of the listeners refuses the
2077	new value, the change will not be performed.
2078	</note>
2079	<note>
2080	On success, the
2081	<link to="IExtraDataChangedEvent"/> notification
2082	is called to inform all registered listeners about a successful data
2083	change.
2084	</note>
2085
2086	<result name="VBOX_E_FILE_ERROR">
2087	Settings file not accessible.
2088	</result>
2089	<result name="VBOX_E_XML_ERROR">
2090	Could not parse the settings file.
2091	</result>
2092	<result name="E_ACCESSDENIED">
2093	Modification request refused.
2094	</result>
2095
2096	</desc>
2097	<param name="key" type="wstring" dir="in">
2098	<desc>Name of the data key to set.</desc>
2099	</param>
2100	<param name="value" type="wstring" dir="in">
2101	<desc>Value to assign to the key.</desc>
2102	</param>
2103	</method>
2104
2105	<!--method name="createDHCPServerForInterface">
2106	<desc>
2107	Creates a dhcp server settings to be used for the given interface
2108	<result name="E_INVALIDARG">
2109	Host network interface @a name already exists.
2110	</result>
2111	</desc>
2112	<param name="interface" type="IHostNetworkInterface" dir="in">
2113	<desc>Network Interface</desc>
2114	</param>
2115	<param name="server" type="IDHCPServer" dir="out">
2116	<desc>Dhcp server settings</desc>
2117	</param>
2118	</method-->
2119
2120	<method name="createDHCPServer">
2121	<desc>
2122	Creates a dhcp server settings to be used for the given internal network name
2123	<result name="E_INVALIDARG">
2124	Host network interface @a name already exists.
2125	</result>
2126	</desc>
2127	<param name="name" type="wstring" dir="in">
2128	<desc>server name</desc>
2129	</param>
2130	<param name="server" type="IDHCPServer" dir="return">
2131	<desc>Dhcp server settings</desc>
2132	</param>
2133	</method>
2134
2135	<method name="findDHCPServerByNetworkName">
2136	<desc>
2137	Searches a dhcp server settings to be used for the given internal network name
2138	<result name="E_INVALIDARG">
2139	Host network interface @a name already exists.
2140	</result>
2141
2142	</desc>
2143	<param name="name" type="wstring" dir="in">
2144	<desc>server name</desc>
2145	</param>
2146	<param name="server" type="IDHCPServer" dir="return">
2147	<desc>Dhcp server settings</desc>
2148	</param>
2149	</method>
2150
2151	<!--method name="findDHCPServerForInterface">
2152	<desc>
2153	Searches a dhcp server settings to be used for the given interface
2154	<result name="E_INVALIDARG">
2155	Host network interface @a name already exists.
2156	</result>
2157	</desc>
2158	<param name="interface" type="IHostNetworkInterface" dir="in">
2159	<desc>Network Interface</desc>
2160	</param>
2161	<param name="server" type="IDHCPServer" dir="out">
2162	<desc>Dhcp server settings</desc>
2163	</param>
2164	</method-->
2165
2166	<method name="removeDHCPServer">
2167	<desc>
2168	Removes the dhcp server settings
2169	<result name="E_INVALIDARG">
2170	Host network interface @a name already exists.
2171	</result>
2172	</desc>
2173	<param name="server" type="IDHCPServer" dir="in">
2174	<desc>Dhcp server settings to be removed</desc>
2175	</param>
2176	</method>
2177
2178
2179	<method name="checkFirmwarePresent">
2180	<desc>
2181	Check if this VirtualBox installation has a firmware
2182	of the given type available, either system-wide or per-user.
2183	Optionally, this may return a hint where this firmware can be
2184	downloaded from.
2185	</desc>
2186	<param name="firmwareType" type="FirmwareType" dir="in">
2187	<desc>
2188	Type of firmware to check.
2189	</desc>
2190	</param>
2191	<param name="version" type="wstring" dir="in">
2192	<desc>Expected version number, usually empty string (presently ignored).</desc>
2193	</param>
2194
2195	<param name="url" type="wstring" dir="out">
2196	<desc>
2197	Suggested URL to download this firmware from.
2198	</desc>
2199	</param>
2200
2201	<param name="file" type="wstring" dir="out">
2202	<desc>
2203	Filename of firmware, only valid if result == TRUE.
2204	</desc>
2205	</param>
2206
2207	<param name="result" type="boolean" dir="return">
2208	<desc>If firmware of this type and version is available.</desc>
2209	</param>
2210	</method>
2211
2212	</interface>
2213
2214	<!--
2215	// IVFSExplorer
2216	/////////////////////////////////////////////////////////////////////////
2217	-->
2218
2219	<enum
2220	name="VFSType"
2221	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2222	>
2223	<desc>
2224	Virtual file systems supported by VFSExplorer.
2225	</desc>
2226
2227	<const name="File" value="1" />
2228	<const name="Cloud" value="2" />
2229	<const name="S3" value="3" />
2230	<const name="WebDav" value="4" />
2231	</enum>
2232
2233	<enum
2234	name="VFSFileType"
2235	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2236	>
2237	<desc>
2238	File types known by VFSExplorer.
2239	</desc>
2240
2241	<const name="Unknown" value="1" />
2242	<const name="Fifo" value="2" />
2243	<const name="DevChar" value="3" />
2244	<const name="Directory" value="4" />
2245	<const name="DevBlock" value="5" />
2246	<const name="File" value="6" />
2247	<const name="SymLink" value="7" />
2248	<const name="Socket" value="8" />
2249	<const name="WhiteOut" value="9" />
2250	</enum>
2251
2252	<interface
2253	name="IVFSExplorer" extends="$unknown"
2254	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2255	wsmap="managed"
2256	>
2257	<desc>
2258	The VFSExplorer interface unifies access to different file system
2259	types. This includes local file systems as well remote file systems like
2260	S3. For a list of supported types see <link to="VFSType" />.
2261	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2262	</desc>
2263
2264	<attribute name="path" type="wstring" readonly="yes">
2265	<desc>Returns the current path in the virtual file system.</desc>
2266	</attribute>
2267
2268	<attribute name="type" type="VFSType" readonly="yes">
2269	<desc>Returns the file system type which is currently in use.</desc>
2270	</attribute>
2271
2272	<method name="update">
2273	<desc>Updates the internal list of files/directories from the
2274	current directory level. Use <link to="#entryList" /> to get the full list
2275	after a call to this method.</desc>
2276
2277	<param name="aProgress" type="IProgress" dir="return">
2278	<desc>Progress object to track the operation completion.</desc>
2279	</param>
2280	</method>
2281
2282	<method name="cd">
2283	<desc>Change the current directory level.</desc>
2284
2285	<param name="aDir" type="wstring" dir="in">
2286	<desc>The name of the directory to go in.</desc>
2287	</param>
2288
2289	<param name="aProgress" type="IProgress" dir="return">
2290	<desc>Progress object to track the operation completion.</desc>
2291	</param>
2292	</method>
2293
2294	<method name="cdUp">
2295	<desc>Go one directory upwards from the current directory level.</desc>
2296
2297	<param name="aProgress" type="IProgress" dir="return">
2298	<desc>Progress object to track the operation completion.</desc>
2299	</param>
2300	</method>
2301
2302	<method name="entryList">
2303	<desc>Returns a list of files/directories after a call to <link
2304	to="#update" />. The user is responsible for keeping this internal
2305	list up do date.</desc>
2306
2307	<param name="aNames" type="wstring" safearray="yes" dir="out">
2308	<desc>The list of names for the entries.</desc>
2309	</param>
2310
2311	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2312	<desc>The list of types for the entries.</desc>
2313	</param>
2314
2315	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2316	<desc>The list of sizes (in bytes) for the entries.</desc>
2317	</param>
2318
2319	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2320	<desc>The list of file modes (in octal form) for the entries.</desc>
2321	</param>
2322	</method>
2323
2324	<method name="exists">
2325	<desc>Checks if the given file list exists in the current directory
2326	level.</desc>
2327
2328	<param name="aNames" type="wstring" safearray="yes" dir="in">
2329	<desc>The names to check.</desc>
2330	</param>
2331
2332	<param name="aExists" type="wstring" safearray="yes" dir="return">
2333	<desc>The names which exist.</desc>
2334	</param>
2335	</method>
2336
2337	<method name="remove">
2338	<desc>Deletes the given files in the current directory level.</desc>
2339
2340	<param name="aNames" type="wstring" safearray="yes" dir="in">
2341	<desc>The names to remove.</desc>
2342	</param>
2343
2344	<param name="aProgress" type="IProgress" dir="return">
2345	<desc>Progress object to track the operation completion.</desc>
2346	</param>
2347	</method>
2348
2349	</interface>
2350
2351	<enum
2352	name="ImportOptions" extends="$unknown"
2353	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2354	>
2355
2356	<desc>
2357	Import options, used with <link to="IAppliance::importMachines" />.
2358	</desc>
2359
2360	<const name="KeepAllMACs" value="1">
2361	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2362	</const>
2363	<const name="KeepNATMACs" value="2">
2364	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2365	</const>
2366
2367	</enum>
2368
2369
2370	<!--
2371	// IAppliance
2372	/////////////////////////////////////////////////////////////////////////
2373	-->
2374
2375	<interface
2376	name="IAppliance" extends="$unknown"
2377	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2378	wsmap="managed"
2379	>
2380	<desc>
2381	Represents a platform-independent appliance in OVF format. An instance of this is returned
2382	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2383	virtual machines within an appliance with VirtualBox.
2384
2385	The OVF standard suggests two different physical file formats:
2386
2387	<ol>
2388	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2389	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2390	this descriptor file references other files such as disk images, as OVF appliances typically
2391	do, those additional files must be in the same directory as the descriptor file.</li>
2392
2393	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2394	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2395	files and optionally other files.
2396
2397	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2398	be added with a later version.</li>
2399	</ol>
2400
2401	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2402	<link to="IMachine" /> involves the following sequence of API calls:
2403
2404	<ol>
2405	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2406	</li>
2407
2408	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2409	would like to import. So long as this file is syntactically valid, this will succeed
2410	and fill the appliance object with the parsed data from the OVF file.
2411	</li>
2412
2413	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2414	contents of the IAppliance attributes accordingly. These can be inspected by a
2415	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2416	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2417	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2418	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2419	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2420	The GUI can then give the user the option to confirm and/or change these suggestions.
2421	</li>
2422
2423	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2424	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2425	</li>
2426
2427	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2428	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2429	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2430	can be found in the <link to="#machines" /> array attribute.
2431	</li>
2432	</ol>
2433
2434	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2435
2436	<ol>
2437	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2438	an empty IAppliance object.
2439	</li>
2440
2441	<li>For each machine you would like to export, call <link to="IMachine::export" />
2442	with the IAppliance object you just created. Each such call creates one instance of
2443	<link to="IVirtualSystemDescription" /> inside the appliance.
2444	</li>
2445
2446	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2447	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2448	</li>
2449
2450	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2451	file written.</li>
2452	</ol>
2453
2454	</desc>
2455
2456	<attribute name="path" type="wstring" readonly="yes">
2457	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2458	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2459	<link to="#write" /> (for export).
2460	This attribute is empty until one of these methods has been called.
2461	</desc>
2462	</attribute>
2463
2464	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2465	<desc>
2466	Array of virtual disk definitions. One such description exists for each
2467	disk definition in the OVF; each string array item represents one such piece of
2468	disk information, with the information fields separated by tab (\\t) characters.
2469
2470	The caller should be prepared for additional fields being appended to
2471	this string in future versions of VirtualBox and therefore check for
2472	the number of tabs in the strings returned.
2473
2474	In the current version, the following eight fields are returned per string
2475	in the array:
2476
2477	<ol>
2478	<li>Disk ID (unique string identifier given to disk)</li>
2479
2480	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2481
2482	<li>Populated size (optional unsigned integer indicating the current size of the
2483	disk; can be approximate; -1 if unspecified)</li>
2484
2485	<li>Format (string identifying the disk format, typically
2486	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2487
2488	<li>Reference (where to find the disk image, typically a file name; if empty,
2489	then the disk should be created on import)</li>
2490
2491	<li>Image size (optional unsigned integer indicating the size of the image,
2492	which need not necessarily be the same as the values specified above, since
2493	the image may be compressed or sparse; -1 if not specified)</li>
2494
2495	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2496	presently unsupported and always -1)</li>
2497
2498	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2499	</ol>
2500	</desc>
2501	</attribute>
2502
2503	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2504	<desc> Array of virtual system descriptions. One such description is created
2505	for each virtual system (machine) found in the OVF.
2506	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2507	(for export) has been called.
2508	</desc>
2509	</attribute>
2510
2511	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2512	<desc>
2513	Contains the UUIDs of the machines created from the information in this appliances. This is only
2514	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2515	succeeded.
2516	</desc>
2517	</attribute>
2518
2519	<method name="read">
2520	<desc>
2521	Reads an OVF file into the appliance object.
2522
2523	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2524	mere fact that this method returns successfully does not mean that VirtualBox supports all
2525	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2526	</desc>
2527	<param name="file" type="wstring" dir="in">
2528	<desc>
2529	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2530	on whether the appliance is distributed as a set of files or as a single file, respectively).
2531	</desc>
2532	</param>
2533	<param name="aProgress" type="IProgress" dir="return">
2534	<desc>Progress object to track the operation completion.</desc>
2535	</param>
2536	</method>
2537
2538	<method name="interpret">
2539	<desc>
2540	Interprets the OVF data that was read when the appliance was constructed. After
2541	calling this method, one can inspect the
2542	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2543	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2544	the appliance.
2545
2546	Calling this method is the second step of importing an appliance into VirtualBox;
2547	see <link to="IAppliance" /> for an overview.
2548
2549	After calling this method, one should call <link to="#getWarnings" /> to find out
2550	if problems were encountered during the processing which might later lead to
2551	errors.
2552	</desc>
2553	</method>
2554
2555	<method name="importMachines">
2556	<desc>
2557	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2558	and other interfaces that match the information contained in the appliance as
2559	closely as possible, as represented by the import instructions in the
2560	<link to="#virtualSystemDescriptions" /> array.
2561
2562	Calling this method is the final step of importing an appliance into VirtualBox;
2563	see <link to="IAppliance" /> for an overview.
2564
2565	Since importing the appliance will most probably involve copying and converting
2566	disk images, which can take a long time, this method operates asynchronously and
2567	returns an IProgress object to allow the caller to monitor the progress.
2568
2569	After the import succeeded, the UUIDs of the IMachine instances created can be
2570	retrieved from the <link to="#machines" /> array attribute.
2571	</desc>
2572
2573	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2574	<desc>Options for the importing operation.</desc>
2575	</param>
2576
2577	<param name="aProgress" type="IProgress" dir="return">
2578	<desc>Progress object to track the operation completion.</desc>
2579	</param>
2580	</method>
2581
2582	<method name="createVFSExplorer">
2583	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2584
2585	<param name="aUri" type="wstring" dir="in">
2586	<desc>The URI describing the file system to use.</desc>
2587	</param>
2588
2589	<param name="aExplorer" type="IVFSExplorer" dir="return">
2590	<desc></desc>
2591	</param>
2592	</method>
2593
2594	<method name="write">
2595	<desc>
2596	Writes the contents of the appliance exports into a new OVF file.
2597
2598	Calling this method is the final step of exporting an appliance from VirtualBox;
2599	see <link to="IAppliance" /> for an overview.
2600
2601	Since exporting the appliance will most probably involve copying and converting
2602	disk images, which can take a long time, this method operates asynchronously and
2603	returns an IProgress object to allow the caller to monitor the progress.
2604	</desc>
2605	<param name="format" type="wstring" dir="in">
2606	<desc>
2607	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2608	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2609	</desc>
2610	</param>
2611	<param name="manifest" type="boolean" dir="in">
2612	<desc>
2613	Indicate if the optional manifest file (.mf) should be written. The manifest file
2614	is used for integrity checks prior import.
2615	</desc>
2616	</param>
2617	<param name="path" type="wstring" dir="in">
2618	<desc>
2619	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2620	on whether the appliance is distributed as a set of files or as a single file, respectively).
2621	</desc>
2622	</param>
2623	<param name="progress" type="IProgress" dir="return">
2624	<desc>Progress object to track the operation completion.</desc>
2625	</param>
2626	</method>
2627
2628	<method name="getWarnings">
2629	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2630
2631	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2632	<desc></desc>
2633	</param>
2634	</method>
2635
2636	</interface>
2637
2638	<enum
2639	name="VirtualSystemDescriptionType"
2640	uuid="303c0900-a746-4612-8c67-79003e91f459"
2641	>
2642	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2643	a configuration value.</desc>
2644
2645	<const name="Ignore" value="1" />
2646	<const name="OS" value="2" />
2647	<const name="Name" value="3" />
2648	<const name="Product" value="4" />
2649	<const name="Vendor" value="5" />
2650	<const name="Version" value="6" />
2651	<const name="ProductUrl" value="7" />
2652	<const name="VendorUrl" value="8" />
2653	<const name="Description" value="9" />
2654	<const name="License" value="10" />
2655	<const name="Miscellaneous" value="11" />
2656	<const name="CPU" value="12" />
2657	<const name="Memory" value="13" />
2658	<const name="HardDiskControllerIDE" value="14" />
2659	<const name="HardDiskControllerSATA" value="15" />
2660	<const name="HardDiskControllerSCSI" value="16" />
2661	<const name="HardDiskControllerSAS" value="17" />
2662	<const name="HardDiskImage" value="18" />
2663	<const name="Floppy" value="19" />
2664	<const name="CDROM" value="20" />
2665	<const name="NetworkAdapter" value="21" />
2666	<const name="USBController" value="22" />
2667	<const name="SoundCard" value="23" />
2668	<const name="SettingsFile" value="24">
2669	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2670	</const>
2671	</enum>
2672
2673	<enum
2674	name="VirtualSystemDescriptionValueType"
2675	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2676	>
2677	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2678	type to fetch.</desc>
2679
2680	<const name="Reference" value="1" />
2681	<const name="Original" value="2" />
2682	<const name="Auto" value="3" />
2683	<const name="ExtraConfig" value="4" />
2684
2685	</enum>
2686
2687	<interface
2688	name="IVirtualSystemDescription" extends="$unknown"
2689	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2690	wsmap="managed"
2691	>
2692
2693	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2694	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2695	<link to="IAppliance::interpret" /> has been called, that array contains information
2696	about how the virtual systems described in the OVF should best be imported into
2697	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2698	import an OVF into VirtualBox.
2699	</desc>
2700
2701	<attribute name="count" type="unsigned long" readonly="yes">
2702	<desc>Return the number of virtual system description entries.</desc>
2703	</attribute>
2704
2705	<method name="getDescription">
2706	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2707	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2708
2709	The list below identifies the value sets that are possible depending on the
2710	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2711	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2712	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2713	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2714	the @a aExtraConfigValues[] array item may also be used.
2715
2716	<ul>
2717	<li>
2718	"OS": the guest operating system type. There must be exactly one such array item on import. The
2719	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2720	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2721	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2722	</li>
2723	<li>
2724	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2725	if none is present on import, then an automatic name will be created from the operating system
2726	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2727	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2728	<link to="IMachine" /> name that does not exist yet.
2729	</li>
2730	<li>
2731	"Description": an arbitrary description.
2732	</li>
2733	<li>
2734	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2735	code to display such a license for agreement; the Main API does not enforce any such policy.
2736	</li>
2737	<li>
2738	Miscellaneous: reserved for future use.
2739	</li>
2740	<li>
2741	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2742	</li>
2743	<li>
2744	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2745	is present on import, then VirtualBox will set a meaningful default based on the operating system
2746	type.
2747	</li>
2748	<li>
2749	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2750	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2751	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2752	writes into the OVF.
2753	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2754	type can use to specify which hard disk controller a virtual disk should be connected to.
2755	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2756	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2757	its virtual machines supports four channels (primary master, primary slave, secondary master,
2758	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2759	</li>
2760	<li>
2761	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2762	has no value in @a aOvfValues[] or @a aVBoxValues[].
2763	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2764	</li>
2765	<li>
2766	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2767	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2768	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2769	whereas VirtualBox considers it a class of storage controllers of its own; see
2770	<link to="StorageControllerType" />).
2771	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2772	</li>
2773	<li>
2774	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2775	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2776
2777	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2778	a path since the image file should be in the same location as the OVF file itself), whereas the
2779	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2780	hard disk image. This means that on import the image will be copied and converted from the
2781	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2782
2783	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2784	format: "controller=<index>;channel=<c>"
2785	In this string, <index> must be an integer specifying the hard disk controller to connect
2786	the image to. That number must be the index of an array item with one of the hard disk controller
2787	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2788	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2789	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2790	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2791	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2792	</li>
2793	<li>
2794	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2795	attachment information as with "HardDiskImage" items.
2796	</li>
2797	<li>
2798	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2799	attachment information as with "HardDiskImage" items.
2800	</li>
2801	<li>
2802	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2803	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2804	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2805	</li>
2806	<li>
2807	"USBController": a USB controller. There can be at most one such item. If and only if such an
2808	item ispresent, USB support will be enabled for the new virtual machine.
2809	</li>
2810	<li>
2811	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2812	present, sound support will be enabled for the new virtual machine. Note that the virtual
2813	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2814	may be different from the virtual soundcard expected by the appliance.
2815	</li>
2816	</ul>
2817
2818	</desc>
2819
2820	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2821	<desc></desc>
2822	</param>
2823
2824	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2825	<desc></desc>
2826	</param>
2827
2828	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2829	<desc></desc>
2830	</param>
2831
2832	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	</method>
2841
2842	<method name="getDescriptionByType">
2843	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2844	should be returned.</desc>
2845
2846	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	</method>
2871
2872	<method name="getValuesByType">
2873	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2874	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2875	values.</desc>
2876
2877	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2878	<desc></desc>
2879	</param>
2880
2881	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2882	<desc></desc>
2883	</param>
2884
2885	<param name="aValues" type="wstring" dir="return" safearray="yes">
2886	<desc></desc>
2887	</param>
2888
2889	</method>
2890
2891	<method name="setFinalValues">
2892	<desc>
2893	This method allows the appliance's user to change the configuration for the virtual
2894	system descriptions. For each array item returned from <link to="#getDescription" />,
2895	you must pass in one boolean value and one configuration value.
2896
2897	Each item in the boolean array determines whether the particular configuration item
2898	should be enabled.
2899	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2900	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2901	and SoundCard.
2902
2903	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2904	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2905	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2906	for valid configuration values for the individual array item types. If the
2907	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2908	</desc>
2909
2910	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2911	<desc></desc>
2912	</param>
2913
2914	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2915	<desc></desc>
2916	</param>
2917
2918	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2919	<desc></desc>
2920	</param>
2921	</method>
2922
2923	<method name="addDescription">
2924	<desc>
2925	This method adds an additional description entry to the stack of already
2926	available descriptions for this virtual system. This is handy for writing
2927	values which aren't directly supported by VirtualBox. One example would
2928	be the License type of <link to="VirtualSystemDescriptionType" />.
2929	</desc>
2930
2931	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2932	<desc></desc>
2933	</param>
2934
2935	<param name="aVBoxValue" type="wstring" dir="in">
2936	<desc></desc>
2937	</param>
2938
2939	<param name="aExtraConfigValue" type="wstring" dir="in">
2940	<desc></desc>
2941	</param>
2942	</method>
2943	</interface>
2944
2945
2946	<!--
2947	// IMachine
2948	/////////////////////////////////////////////////////////////////////////
2949	-->
2950
2951	<interface
2952	name="IInternalMachineControl" extends="$unknown"
2953	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
2954	internal="yes"
2955	wsmap="suppress"
2956	>
2957	<method name="setRemoveSavedStateFile">
2958	<desc>
2959	Updates the flag whether the saved state file is removed on a
2960	machine state change from Saved to PoweredOff.
2961	</desc>
2962	<param name="aRemove" type="boolean" dir="in"/>
2963	</method>
2964
2965	<method name="updateState">
2966	<desc>
2967	Updates the VM state.
2968	<note>
2969	This operation will also update the settings file with the correct
2970	information about the saved state file and delete this file from disk
2971	when appropriate.
2972	</note>
2973	</desc>
2974	<param name="state" type="MachineState" dir="in"/>
2975	</method>
2976
2977	<method name="getIPCId">
2978	<param name="id" type="wstring" dir="return"/>
2979	</method>
2980
2981	<method name="beginPowerUp">
2982	<desc>
2983	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2984	gives it the progress object that should be part of any pending
2985	<link to="IMachine::launchVMProcess"/> operations. The progress
2986	object may be called back to reflect an early cancelation, so some care
2987	have to be taken with respect to any cancelation callbacks. The console
2988	object will call <link to="IInternalMachineControl::endPowerUp"/>
2989	to signal the completion of the progress object.
2990	</desc>
2991	<param name="aProgress" type="IProgress" dir="in" />
2992	</method>
2993
2994	<method name="endPowerUp">
2995	<desc>
2996	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2997	This method may query status information from the progress object it
2998	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2999	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3000	call in order to complete that progress object.
3001	</desc>
3002	<param name="result" type="long" dir="in"/>
3003	</method>
3004
3005	<method name="beginPoweringDown">
3006	<desc>
3007	Called by the VM process to inform the server it wants to
3008	stop the VM execution and power down.
3009	</desc>
3010	<param name="progress" type="IProgress" dir="out">
3011	<desc>
3012	Progress object created by VBoxSVC to wait until
3013	the VM is powered down.
3014	</desc>
3015	</param>
3016	</method>
3017
3018	<method name="endPoweringDown">
3019	<desc>
3020	Called by the VM process to inform the server that powering
3021	down previously requested by #beginPoweringDown is either
3022	successfully finished or there was a failure.
3023
3024	<result name="VBOX_E_FILE_ERROR">
3025	Settings file not accessible.
3026	</result>
3027	<result name="VBOX_E_XML_ERROR">
3028	Could not parse the settings file.
3029	</result>
3030
3031	</desc>
3032
3033	<param name="result" type="long" dir="in">
3034	<desc>@c S_OK to indicate success.
3035	</desc>
3036	</param>
3037	<param name="errMsg" type="wstring" dir="in">
3038	<desc>@c human readable error message in case of failure.
3039	</desc>
3040	</param>
3041	</method>
3042
3043	<method name="runUSBDeviceFilters">
3044	<desc>
3045	Asks the server to run USB devices filters of the associated
3046	machine against the given USB device and tell if there is
3047	a match.
3048	<note>
3049	Intended to be used only for remote USB devices. Local
3050	ones don't require to call this method (this is done
3051	implicitly by the Host and USBProxyService).
3052	</note>
3053	</desc>
3054	<param name="device" type="IUSBDevice" dir="in"/>
3055	<param name="matched" type="boolean" dir="out"/>
3056	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3057	</method>
3058
3059	<method name="captureUSBDevice">
3060	<desc>
3061	Requests a capture of the given host USB device.
3062	When the request is completed, the VM process will
3063	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3064	notification.
3065	</desc>
3066	<param name="id" type="uuid" mod="string" dir="in"/>
3067	</method>
3068
3069	<method name="detachUSBDevice">
3070	<desc>
3071	Notification that a VM is going to detach (@a done = @c false) or has
3072	already detached (@a done = @c true) the given USB device.
3073	When the @a done = @c true request is completed, the VM process will
3074	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3075	notification.
3076	<note>
3077	In the @a done = @c true case, the server must run its own filters
3078	and filters of all VMs but this one on the detached device
3079	as if it were just attached to the host computer.
3080	</note>
3081	</desc>
3082	<param name="id" type="uuid" mod="string" dir="in"/>
3083	<param name="done" type="boolean" dir="in"/>
3084	</method>
3085
3086	<method name="autoCaptureUSBDevices">
3087	<desc>
3088	Requests a capture all matching USB devices attached to the host.
3089	When the request is completed, the VM process will
3090	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3091	notification per every captured device.
3092	</desc>
3093	</method>
3094
3095	<method name="detachAllUSBDevices">
3096	<desc>
3097	Notification that a VM that is being powered down. The done
3098	parameter indicates whether which stage of the power down
3099	we're at. When @a done = @c false the VM is announcing its
3100	intentions, while when @a done = @c true the VM is reporting
3101	what it has done.
3102	<note>
3103	In the @a done = @c true case, the server must run its own filters
3104	and filters of all VMs but this one on all detach devices as
3105	if they were just attached to the host computer.
3106	</note>
3107	</desc>
3108	<param name="done" type="boolean" dir="in"/>
3109	</method>
3110
3111	<method name="onSessionEnd">
3112	<desc>
3113	Triggered by the given session object when the session is about
3114	to close normally.
3115	</desc>
3116	<param name="session" type="ISession" dir="in">
3117	<desc>Session that is being closed</desc>
3118	</param>
3119	<param name="progress" type="IProgress" dir="return">
3120	<desc>
3121	Used to wait until the corresponding machine is actually
3122	dissociated from the given session on the server.
3123	Returned only when this session is a direct one.
3124	</desc>
3125	</param>
3126	</method>
3127
3128	<method name="beginSavingState">
3129	<desc>
3130	Called by the VM process to inform the server it wants to
3131	save the current state and stop the VM execution.
3132	</desc>
3133	<param name="progress" type="IProgress" dir="out">
3134	<desc>
3135	Progress object created by VBoxSVC to wait until
3136	the state is saved.
3137	</desc>
3138	</param>
3139	<param name="stateFilePath" type="wstring" dir="out">
3140	<desc>
3141	File path the VM process must save the execution state to.
3142	</desc>
3143	</param>
3144	</method>
3145
3146	<method name="endSavingState">
3147	<desc>
3148	Called by the VM process to inform the server that saving
3149	the state previously requested by #beginSavingState is either
3150	successfully finished or there was a failure.
3151
3152	<result name="VBOX_E_FILE_ERROR">
3153	Settings file not accessible.
3154	</result>
3155	<result name="VBOX_E_XML_ERROR">
3156	Could not parse the settings file.
3157	</result>
3158
3159	</desc>
3160
3161	<param name="result" type="long" dir="in">
3162	<desc>@c S_OK to indicate success.
3163	</desc>
3164	</param>
3165	<param name="errMsg" type="wstring" dir="in">
3166	<desc>@c human readable error message in case of failure.
3167	</desc>
3168	</param>
3169	</method>
3170
3171	<method name="adoptSavedState">
3172	<desc>
3173	Gets called by <link to="IConsole::adoptSavedState"/>.
3174	<result name="VBOX_E_FILE_ERROR">
3175	Invalid saved state file path.
3176	</result>
3177	</desc>
3178	<param name="savedStateFile" type="wstring" dir="in">
3179	<desc>Path to the saved state file to adopt.</desc>
3180	</param>
3181	</method>
3182
3183	<method name="beginTakingSnapshot">
3184	<desc>
3185	Called from the VM process to request from the server to perform the
3186	server-side actions of creating a snapshot (creating differencing images
3187	and the snapshot object).
3188
3189	<result name="VBOX_E_FILE_ERROR">
3190	Settings file not accessible.
3191	</result>
3192	<result name="VBOX_E_XML_ERROR">
3193	Could not parse the settings file.
3194	</result>
3195	</desc>
3196	<param name="initiator" type="IConsole" dir="in">
3197	<desc>The console object that initiated this call.</desc>
3198	</param>
3199	<param name="name" type="wstring" dir="in">
3200	<desc>Snapshot name.</desc>
3201	</param>
3202	<param name="description" type="wstring" dir="in">
3203	<desc>Snapshot description.</desc>
3204	</param>
3205	<param name="consoleProgress" type="IProgress" dir="in">
3206	<desc>
3207	Progress object created by the VM process tracking the
3208	snapshot's progress. This has the following sub-operations:
3209	<ul>
3210	<li>setting up (weight 1);</li>
3211	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3212	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3213	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3214	<li>finishing up (weight 1)</li>
3215	</ul>
3216	</desc>
3217	</param>
3218	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3219	<desc>
3220	Whether this is an online snapshot (i.e. the machine is running).
3221	</desc>
3222	</param>
3223	<param name="stateFilePath" type="wstring" dir="out">
3224	<desc>
3225	File path the VM process must save the execution state to.
3226	</desc>
3227	</param>
3228	</method>
3229
3230	<method name="endTakingSnapshot">
3231	<desc>
3232	Called by the VM process to inform the server that the snapshot
3233	previously requested by #beginTakingSnapshot is either
3234	successfully taken or there was a failure.
3235	</desc>
3236
3237	<param name="success" type="boolean" dir="in">
3238	<desc>@c true to indicate success and @c false otherwise</desc>
3239	</param>
3240	</method>
3241
3242	<method name="deleteSnapshot">
3243	<desc>
3244	Gets called by <link to="IConsole::deleteSnapshot"/>,
3245	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3246	<link to="IConsole::deleteSnapshotRange"/>.
3247	<result name="VBOX_E_INVALID_OBJECT_STATE">
3248	Snapshot has more than one child snapshot. Only possible if the
3249	delete operation does not delete all children or the range does
3250	not meet the linearity condition.
3251	</result>
3252	</desc>
3253	<param name="initiator" type="IConsole" dir="in">
3254	<desc>The console object that initiated this call.</desc>
3255	</param>
3256	<param name="startId" type="uuid" mod="string" dir="in">
3257	<desc>UUID of the first snapshot to delete.</desc>
3258	</param>
3259	<param name="endId" type="uuid" mod="string" dir="in">
3260	<desc>UUID of the last snapshot to delete.</desc>
3261	</param>
3262	<param name="deleteAllChildren" type="boolean" dir="in">
3263	<desc>Whether all children should be deleted.</desc>
3264	</param>
3265	<param name="machineState" type="MachineState" dir="out">
3266	<desc>New machine state after this operation is started.</desc>
3267	</param>
3268	<param name="progress" type="IProgress" dir="return">
3269	<desc>Progress object to track the operation completion.</desc>
3270	</param>
3271	</method>
3272
3273	<method name="finishOnlineMergeMedium">
3274	<desc>
3275	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3276	</desc>
3277	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3278	<desc>The medium attachment which needs to be cleaned up.</desc>
3279	</param>
3280	<param name="source" type="IMedium" dir="in">
3281	<desc>Merge source medium.</desc>
3282	</param>
3283	<param name="target" type="IMedium" dir="in">
3284	<desc>Merge target medium.</desc>
3285	</param>
3286	<param name="mergeForward" type="boolean" dir="in">
3287	<desc>Merge direction.</desc>
3288	</param>
3289	<param name="parentForTarget" type="IMedium" dir="in">
3290	<desc>For forward merges: new parent for target medium.</desc>
3291	</param>
3292	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3293	<desc>For backward merges: list of media which need their parent UUID
3294	updated.</desc>
3295	</param>
3296	</method>
3297
3298	<method name="restoreSnapshot">
3299	<desc>
3300	Gets called by <link to="IConsole::restoreSnapshot"/>.
3301	</desc>
3302	<param name="initiator" type="IConsole" dir="in">
3303	<desc>The console object that initiated this call.</desc>
3304	</param>
3305	<param name="snapshot" type="ISnapshot" dir="in">
3306	<desc>The snapshot to restore the VM state from.</desc>
3307	</param>
3308	<param name="machineState" type="MachineState" dir="out">
3309	<desc>New machine state after this operation is started.</desc>
3310	</param>
3311	<param name="progress" type="IProgress" dir="return">
3312	<desc>Progress object to track the operation completion.</desc>
3313	</param>
3314	</method>
3315
3316	<method name="pullGuestProperties">
3317	<desc>
3318	Get the list of the guest properties matching a set of patterns along
3319	with their values, time stamps and flags and give responsibility for
3320	managing properties to the console.
3321	</desc>
3322	<param name="name" type="wstring" dir="out" safearray="yes">
3323	<desc>
3324	The names of the properties returned.
3325	</desc>
3326	</param>
3327	<param name="value" type="wstring" dir="out" safearray="yes">
3328	<desc>
3329	The values of the properties returned. The array entries match the
3330	corresponding entries in the @a name array.
3331	</desc>
3332	</param>
3333	<param name="timestamp" type="long long" dir="out" safearray="yes">
3334	<desc>
3335	The time stamps of the properties returned. The array entries match
3336	the corresponding entries in the @a name array.
3337	</desc>
3338	</param>
3339	<param name="flags" type="wstring" dir="out" safearray="yes">
3340	<desc>
3341	The flags of the properties returned. The array entries match the
3342	corresponding entries in the @a name array.
3343	</desc>
3344	</param>
3345	</method>
3346
3347	<method name="pushGuestProperty">
3348	<desc>
3349	Update a single guest property in IMachine.
3350	</desc>
3351	<param name="name" type="wstring" dir="in">
3352	<desc>
3353	The name of the property to be updated.
3354	</desc>
3355	</param>
3356	<param name="value" type="wstring" dir="in">
3357	<desc>
3358	The value of the property.
3359	</desc>
3360	</param>
3361	<param name="timestamp" type="long long" dir="in">
3362	<desc>
3363	The timestamp of the property.
3364	</desc>
3365	</param>
3366	<param name="flags" type="wstring" dir="in">
3367	<desc>
3368	The flags of the property.
3369	</desc>
3370	</param>
3371	</method>
3372
3373	<method name="lockMedia">
3374	<desc>
3375	Locks all media attached to the machine for writing and parents of
3376	attached differencing media (if any) for reading. This operation is
3377	atomic so that if it fails no media is actually locked.
3378
3379	This method is intended to be called when the machine is in Starting or
3380	Restoring state. The locked media will be automatically unlocked when
3381	the machine is powered off or crashed.
3382	</desc>
3383	</method>
3384	<method name="unlockMedia">
3385	<desc>
3386	Unlocks all media previously locked using
3387	<link to="IInternalMachineControl::lockMedia"/>.
3388
3389	This method is intended to be used with teleportation so that it is
3390	possible to teleport between processes on the same machine.
3391	</desc>
3392	</method>
3393
3394	<method name="ejectMedium">
3395	<desc>
3396	Tells VBoxSVC that the guest has ejected the medium associated with
3397	the medium attachment.
3398	</desc>
3399	<param name="attachment" type="IMediumAttachment" dir="in">
3400	<desc>
3401	The medium attachment where the eject happened.
3402	</desc>
3403	</param>
3404	<param name="newAttachment" type="IMediumAttachment" dir="return">
3405	<desc>
3406	A new reference to the medium attachment, as the config change can
3407	result in the creation of a new instance.
3408	</desc>
3409	</param>
3410	</method>
3411
3412	<method name="reportGuestStatistics">
3413	<desc>
3414	Passes collected guest statistics to VBoxSVC.
3415	</desc>
3416	<param name="validStats" type="unsigned long" dir="in">
3417	<desc>
3418	Mask defining which parameters are valid. For example: 0x11 means
3419	that cpuIdle and XXX are valid. Other parameters should be ignored.
3420	</desc>
3421	</param>
3422	<param name="cpuUser" type="unsigned long" dir="in">
3423	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3424	</param>
3425	<param name="cpuKernel" type="unsigned long" dir="in">
3426	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3427	</param>
3428	<param name="cpuIdle" type="unsigned long" dir="in">
3429	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3430	</param>
3431	<param name="memTotal" type="unsigned long" dir="in">
3432	<desc>Total amount of physical guest RAM.</desc>
3433	</param>
3434	<param name="memFree" type="unsigned long" dir="in">
3435	<desc>Free amount of physical guest RAM.</desc>
3436	</param>
3437	<param name="memBalloon" type="unsigned long" dir="in">
3438	<desc>Amount of ballooned physical guest RAM.</desc>
3439	</param>
3440	<param name="memShared" type="unsigned long" dir="in">
3441	<desc>Amount of shared physical guest RAM.</desc>
3442	</param>
3443	<param name="memCache" type="unsigned long" dir="in">
3444	<desc>Total amount of guest (disk) cache memory.</desc>
3445	</param>
3446	<param name="pagedTotal" type="unsigned long" dir="in">
3447	<desc>Total amount of space in the page file.</desc>
3448	</param>
3449	<param name="memAllocTotal" type="unsigned long" dir="in">
3450	<desc>Total amount of memory allocated by the hypervisor.</desc>
3451	</param>
3452	<param name="memFreeTotal" type="unsigned long" dir="in">
3453	<desc>Total amount of free memory available in the hypervisor.</desc>
3454	</param>
3455	<param name="memBalloonTotal" type="unsigned long" dir="in">
3456	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3457	</param>
3458	<param name="memSharedTotal" type="unsigned long" dir="in">
3459	<desc>Total amount of shared memory in the hypervisor.</desc>
3460	</param>
3461	</method>
3462	</interface>
3463
3464	<interface
3465	name="IBIOSSettings" extends="$unknown"
3466	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3467	wsmap="managed"
3468	>
3469	<desc>
3470	The IBIOSSettings interface represents BIOS settings of the virtual
3471	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3472	</desc>
3473	<attribute name="logoFadeIn" type="boolean">
3474	<desc>Fade in flag for BIOS logo animation.</desc>
3475	</attribute>
3476
3477	<attribute name="logoFadeOut" type="boolean">
3478	<desc>Fade out flag for BIOS logo animation.</desc>
3479	</attribute>
3480
3481	<attribute name="logoDisplayTime" type="unsigned long">
3482	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3483	</attribute>
3484
3485	<attribute name="logoImagePath" type="wstring">
3486	<desc>
3487	Local file system path for external BIOS splash image. Empty string
3488	means the default image is shown on boot.
3489	</desc>
3490	</attribute>
3491
3492	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3493	<desc>Mode of the BIOS boot device menu.</desc>
3494	</attribute>
3495
3496	<attribute name="ACPIEnabled" type="boolean">
3497	<desc>ACPI support flag.</desc>
3498	</attribute>
3499
3500	<attribute name="IOAPICEnabled" type="boolean">
3501	<desc>
3502	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3503	and support IRQs above 15.
3504	</desc>
3505	</attribute>
3506
3507	<attribute name="timeOffset" type="long long">
3508	<desc>
3509	Offset in milliseconds from the host system time. This allows for
3510	guests running with a different system date/time than the host.
3511	It is equivalent to setting the system date/time in the BIOS except
3512	it is not an absolute value but a relative one. Guest Additions
3513	time synchronization honors this offset.
3514	</desc>
3515	</attribute>
3516
3517	<attribute name="PXEDebugEnabled" type="boolean">
3518	<desc>
3519	PXE debug logging flag. If set, VirtualBox will write extensive
3520	PXE trace information to the release log.
3521	</desc>
3522	</attribute>
3523	</interface>
3524
3525	<enum
3526	name="CleanupMode"
3527	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3528	>
3529	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3530	</desc>
3531	<const name="UnregisterOnly" value="1">
3532	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3533	</const>
3534	<const name="DetachAllReturnNone" value="2">
3535	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3536	</const>
3537	<const name="DetachAllReturnHardDisksOnly" value="3">
3538	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3539	</const>
3540	<const name="Full" value="4">
3541	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3542	</const>
3543	</enum>
3544
3545	<interface
3546	name="IPciAddress" extends="$unknown"
3547	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3548	wsmap="struct"
3549	>
3550
3551	<desc>
3552	Address on the PCI bus.
3553	</desc>
3554
3555	<attribute name="bus" type="short">
3556	<desc>
3557	Bus number.
3558	</desc>
3559	</attribute>
3560
3561	<attribute name="device" type="short">
3562	<desc>
3563	Device number.
3564	</desc>
3565	</attribute>
3566
3567	<attribute name="devFunction" type="short">
3568	<desc>
3569	Device function number.
3570	</desc>
3571	</attribute>
3572
3573	<method name="asLong">
3574	<desc>
3575	Convert PCI address into long.
3576	</desc>
3577	<param name="result" type="long" dir="return" />
3578	</method>
3579
3580	<method name="fromLong">
3581	<desc>
3582	Make PCI address from long.
3583	</desc>
3584	<param name="number" type="long" dir="in" />
3585	</method>
3586	</interface>
3587
3588	<interface
3589	name="IPciDeviceAttachment" extends="$unknown"
3590	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3591	wsmap="struct"
3592	>
3593
3594	<desc>
3595	Information about PCI attachments.
3596	</desc>
3597
3598	<attribute name="name" type="wstring" readonly="yes">
3599	<desc>
3600	Device name.
3601	</desc>
3602	</attribute>
3603
3604	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3605	<desc>
3606	If this is physical or virtual device.
3607	</desc>
3608	</attribute>
3609
3610	<attribute name="hostAddress" type="long" readonly="yes">
3611	<desc>
3612	Address of device on the host, applicable only to host devices.
3613	</desc>
3614	</attribute>
3615
3616	<attribute name="guestAddress" type="long" readonly="yes">
3617	<desc>
3618	Address of device on the guest.
3619	</desc>
3620	</attribute>
3621
3622	</interface>
3623
3624	<enum
3625	name="CloneMode" extends="$unknown"
3626	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3627	>
3628
3629	<desc>
3630	Clone mode, used with <link to="IMachine::cloneTo" />.
3631	</desc>
3632
3633	<const name="MachineState" value="1">
3634	<desc>Clone the state of the selected machine.</desc>
3635	</const>
3636	<const name="MachineAndChildStates" value="2">
3637	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3638	</const>
3639	<const name="AllStates" value="3">
3640	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3641	</const>
3642
3643	</enum>
3644
3645	<enum
3646	name="CloneOptions" extends="$unknown"
3647	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3648	>
3649
3650	<desc>
3651	Clone options, used with <link to="IMachine::cloneTo" />.
3652	</desc>
3653
3654	<const name="Link" value="1">
3655	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3656	</const>
3657	<const name="KeepAllMACs" value="2">
3658	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3659	</const>
3660	<const name="KeepNATMACs" value="3">
3661	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3662	</const>
3663	<const name="KeepDiskNames" value="4">
3664	<desc>Don't change the disk names.</desc>
3665	</const>
3666
3667	</enum>
3668
3669	<enum
3670	name="AutostopType" extends="$unknown"
3671	uuid="6bb96740-cf34-470d-aab2-2cd48ea2e10e"
3672	>
3673
3674	<desc>
3675	Autostop types, used with <link to="IMachine::autostopType" />.
3676	</desc>
3677
3678	<const name="Disabled" value="1">
3679	<desc>Stopping the VM during system shutdown is disabled.</desc>
3680	</const>
3681	<const name="SaveState" value="2">
3682	<desc>The state of the VM will be saved when the system shuts down.</desc>
3683	</const>
3684	<const name="PowerOff" value="3">
3685	<desc>The VM is powered off when the system shuts down.</desc>
3686	</const>
3687	<const name="AcpiShutdown" value="4">
3688	<desc>An ACPI shutdown event is generated.</desc>
3689	</const>
3690
3691	</enum>
3692
3693
3694	<interface
3695	name="IMachine" extends="$unknown"
3696	uuid="019d7a7b-1e2d-4008-b954-4b5d72d103b8"
3697	wsmap="managed"
3698	>
3699	<desc>
3700	The IMachine interface represents a virtual machine, or guest, created
3701	in VirtualBox.
3702
3703	This interface is used in two contexts. First of all, a collection of
3704	objects implementing this interface is stored in the
3705	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3706	machines that are currently registered with this VirtualBox
3707	installation. Also, once a session has been opened for the given virtual
3708	machine (e.g. the virtual machine is running), the machine object
3709	associated with the open session can be queried from the session object;
3710	see <link to="ISession"/> for details.
3711
3712	The main role of this interface is to expose the settings of the virtual
3713	machine and provide methods to change various aspects of the virtual
3714	machine's configuration. For machine objects stored in the
3715	<link to="IVirtualBox::machines"/> collection, all attributes are
3716	read-only unless explicitly stated otherwise in individual attribute
3717	and method descriptions.
3718
3719	In order to change a machine setting, a session for this machine must be
3720	opened using one of the <link to="IMachine::lockMachine" /> or
3721	<link to="IMachine::launchVMProcess"/> methods. After the
3722	machine has been successfully locked for a session, a mutable machine object
3723	needs to be queried from the session object and then the desired settings
3724	changes can be applied to the returned object using IMachine attributes and
3725	methods. See the <link to="ISession"/> interface description for more
3726	information about sessions.
3727
3728	Note that IMachine does not provide methods to control virtual machine
3729	execution (such as start the machine, or power it down) -- these methods
3730	are grouped in a separate interface called <link to="IConsole" />.
3731
3732	<see><link to="ISession"/>, <link to="IConsole"/></see>
3733	</desc>
3734
3735	<attribute name="parent" type="IVirtualBox" readonly="yes">
3736	<desc>Associated parent object.</desc>
3737	</attribute>
3738
3739	<attribute name="accessible" type="boolean" readonly="yes">
3740	<desc>
3741	Whether this virtual machine is currently accessible or not.
3742
3743	A machine is always deemed accessible unless it is registered <i>and</i>
3744	its settings file cannot be read or parsed (either because the file itself
3745	is unavailable or has invalid XML contents).
3746
3747	Every time this property is read, the accessibility state of
3748	this machine is re-evaluated. If the returned value is @c false,
3749	the <link to="#accessError"/> property may be used to get the
3750	detailed error information describing the reason of
3751	inaccessibility, including XML error messages.
3752
3753	When the machine is inaccessible, only the following properties
3754	can be used on it:
3755	<ul>
3756	<li><link to="#parent"/></li>
3757	<li><link to="#id"/></li>
3758	<li><link to="#settingsFilePath"/></li>
3759	<li><link to="#accessible"/></li>
3760	<li><link to="#accessError"/></li>
3761	</ul>
3762
3763	An attempt to access any other property or method will return
3764	an error.
3765
3766	The only possible action you can perform on an inaccessible
3767	machine is to unregister it using the
3768	<link to="IMachine::unregister"/> call (or, to check
3769	for the accessibility state once more by querying this
3770	property).
3771
3772	<note>
3773	In the current implementation, once this property returns
3774	@c true, the machine will never become inaccessible
3775	later, even if its settings file cannot be successfully
3776	read/written any more (at least, until the VirtualBox
3777	server is restarted). This limitation may be removed in
3778	future releases.
3779	</note>
3780	</desc>
3781	</attribute>
3782
3783	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3784	<desc>
3785	Error information describing the reason of machine
3786	inaccessibility.
3787
3788	Reading this property is only valid after the last call to
3789	<link to="#accessible"/> returned @c false (i.e. the
3790	machine is currently inaccessible). Otherwise, a @c null
3791	IVirtualBoxErrorInfo object will be returned.
3792	</desc>
3793	</attribute>
3794
3795	<attribute name="name" type="wstring">
3796	<desc>
3797	Name of the virtual machine.
3798
3799	Besides being used for human-readable identification purposes
3800	everywhere in VirtualBox, the virtual machine name is also used
3801	as a name of the machine's settings file and as a name of the
3802	subdirectory this settings file resides in. Thus, every time you
3803	change the value of this property, the settings file will be
3804	renamed once you call <link to="#saveSettings"/> to confirm the
3805	change. The containing subdirectory will be also renamed, but
3806	only if it has exactly the same name as the settings file
3807	itself prior to changing this property (for backward compatibility
3808	with previous API releases). The above implies the following
3809	limitations:
3810	<ul>
3811	<li>The machine name cannot be empty.</li>
3812	<li>The machine name can contain only characters that are valid
3813	file name characters according to the rules of the file
3814	system used to store VirtualBox configuration.</li>
3815	<li>You cannot have two or more machines with the same name
3816	if they use the same subdirectory for storing the machine
3817	settings files.</li>
3818	<li>You cannot change the name of the machine if it is running,
3819	or if any file in the directory containing the settings file
3820	is being used by another running machine or by any other
3821	process in the host operating system at a time when
3822	<link to="#saveSettings"/> is called.
3823	</li>
3824	</ul>
3825	If any of the above limitations are hit, <link to="#saveSettings"/>
3826	will return an appropriate error message explaining the exact
3827	reason and the changes you made to this machine will not be saved.
3828
3829	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3830	file is recommended, but not enforced. (Previous versions always
3831	used a generic ".xml" extension.)
3832	</desc>
3833	</attribute>
3834
3835	<attribute name="description" type="wstring">
3836	<desc>
3837	Description of the virtual machine.
3838
3839	The description attribute can contain any text and is
3840	typically used to describe the hardware and software
3841	configuration of the virtual machine in detail (i.e. network
3842	settings, versions of the installed software and so on).
3843	</desc>
3844	</attribute>
3845
3846	<attribute name="id" type="uuid" mod="string" readonly="yes">
3847	<desc>UUID of the virtual machine.</desc>
3848	</attribute>
3849
3850	<attribute name="OSTypeId" type="wstring">
3851	<desc>
3852	User-defined identifier of the Guest OS type.
3853	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3854	an IGuestOSType object representing details about the given
3855	Guest OS type.
3856	<note>
3857	This value may differ from the value returned by
3858	<link to="IGuest::OSTypeId"/> if Guest Additions are
3859	installed to the guest OS.
3860	</note>
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="hardwareVersion" type="wstring">
3865	<desc>Hardware version identifier. Internal use only for now.</desc>
3866	</attribute>
3867
3868	<attribute name="hardwareUUID" type="uuid" mod="string">
3869	<desc>
3870	The UUID presented to the guest via memory tables, hardware and guest
3871	properties. For most VMs this is the same as the @a id, but for VMs
3872	which have been cloned or teleported it may be the same as the source
3873	VM. This latter is because the guest shouldn't notice that it was
3874	cloned or teleported.
3875	</desc>
3876	</attribute>
3877
3878	<attribute name="CPUCount" type="unsigned long">
3879	<desc>Number of virtual CPUs in the VM.</desc>
3880	</attribute>
3881
3882	<attribute name="CPUHotPlugEnabled" type="boolean">
3883	<desc>
3884	This setting determines whether VirtualBox allows CPU
3885	hotplugging for this machine.</desc>
3886	</attribute>
3887
3888	<attribute name="CPUExecutionCap" type="unsigned long">
3889	<desc>
3890	Means to limit the number of CPU cycles a guest can use. The unit
3891	is percentage of host CPU cycles per second. The valid range
3892	is 1 - 100. 100 (the default) implies no limit.
3893	</desc>
3894	</attribute>
3895
3896	<attribute name="memorySize" type="unsigned long">
3897	<desc>System memory size in megabytes.</desc>
3898	</attribute>
3899
3900	<attribute name="memoryBalloonSize" type="unsigned long">
3901	<desc>Memory balloon size in megabytes.</desc>
3902	</attribute>
3903
3904	<attribute name="pageFusionEnabled" type="boolean">
3905	<desc>
3906	This setting determines whether VirtualBox allows page
3907	fusion for this machine (64 bits host only).
3908	</desc>
3909	</attribute>
3910
3911	<attribute name="VRAMSize" type="unsigned long">
3912	<desc>Video memory size in megabytes.</desc>
3913	</attribute>
3914
3915	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3916	<desc>
3917	This setting determines whether VirtualBox allows this machine to make
3918	use of the 3D graphics support available on the host.</desc>
3919	</attribute>
3920
3921	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3922	<desc>
3923	This setting determines whether VirtualBox allows this machine to make
3924	use of the 2D video acceleration support available on the host.</desc>
3925	</attribute>
3926
3927	<attribute name="monitorCount" type="unsigned long">
3928	<desc>
3929	Number of virtual monitors.
3930	<note>
3931	Only effective on Windows XP and later guests with
3932	Guest Additions installed.
3933	</note>
3934	</desc>
3935	</attribute>
3936
3937	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3938	<desc>Object containing all BIOS settings.</desc>
3939	</attribute>
3940
3941	<attribute name="firmwareType" type="FirmwareType">
3942	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3943	bootstrap in this VM.</desc>
3944	</attribute>
3945
3946	<attribute name="pointingHidType" type="PointingHidType">
3947	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3948	The default is typically "PS2Mouse" but can vary depending on the
3949	requirements of the guest operating system.</desc>
3950	</attribute>
3951
3952	<attribute name="keyboardHidType" type="KeyboardHidType">
3953	<desc>Type of keyboard HID used in this VM.
3954	The default is typically "PS2Keyboard" but can vary depending on the
3955	requirements of the guest operating system.</desc>
3956	</attribute>
3957
3958	<attribute name="hpetEnabled" type="boolean">
3959	<desc>This attribute controls if High Precision Event Timer (HPET) is
3960	enabled in this VM. Use this property if you want to provide guests
3961	with additional time source, or if guest requires HPET to function correctly.
3962	Default is false.</desc>
3963	</attribute>
3964
3965	<attribute name="chipsetType" type="ChipsetType">
3966	<desc>Chipset type used in this VM.</desc>
3967	</attribute>
3968
3969	<attribute name="snapshotFolder" type="wstring">
3970	<desc>
3971	Full path to the directory used to store snapshot data
3972	(differencing media and saved state files) of this machine.
3973
3974	The initial value of this property is
3975	<tt><</tt><link to="#settingsFilePath">
3976	path_to_settings_file</link><tt>>/<</tt>
3977	<link to="#id">machine_uuid</link>
3978	<tt>></tt>.
3979
3980	Currently, it is an error to try to change this property on
3981	a machine that has snapshots (because this would require to
3982	move possibly large files to a different location).
3983	A separate method will be available for this purpose later.
3984
3985	<note>
3986	Setting this property to @c null or to an empty string will restore
3987	the initial value.
3988	</note>
3989	<note>
3990	When setting this property, the specified path can be
3991	absolute (full path) or relative to the directory where the
3992	<link to="#settingsFilePath">machine settings file</link>
3993	is located. When reading this property, a full path is
3994	always returned.
3995	</note>
3996	<note>
3997	The specified path may not exist, it will be created
3998	when necessary.
3999	</note>
4000	</desc>
4001	</attribute>
4002
4003	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4004	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4005	</attribute>
4006
4007	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4008	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4009
4010	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4011	<desc>Array of media attached to this machine.</desc>
4012	</attribute>
4013
4014	<attribute name="USBController" type="IUSBController" readonly="yes">
4015	<desc>
4016	Associated USB controller object.
4017
4018	<note>
4019	If USB functionality is not available in the given edition of
4020	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4021	</note>
4022	</desc>
4023	</attribute>
4024
4025	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4026	<desc>Associated audio adapter, always present.</desc>
4027	</attribute>
4028
4029	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4030	<desc>Array of storage controllers attached to this machine.</desc>
4031	</attribute>
4032
4033	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4034	<desc>
4035	Full name of the file containing machine settings data.
4036	</desc>
4037	</attribute>
4038
4039	<attribute name="settingsModified" type="boolean" readonly="yes">
4040	<desc>
4041	Whether the settings of this machine have been modified
4042	(but neither yet saved nor discarded).
4043	<note>
4044	Reading this property is only valid on instances returned
4045	by <link to="ISession::machine"/> and on new machines
4046	created by <link to="IVirtualBox::createMachine"/> or opened
4047	by <link to="IVirtualBox::openMachine"/> but not
4048	yet registered, or on unregistered machines after calling
4049	<link to="IMachine::unregister"/>. For all other
4050	cases, the settings can never be modified.
4051	</note>
4052	<note>
4053	For newly created unregistered machines, the value of this
4054	property is always @c true until <link to="#saveSettings"/>
4055	is called (no matter if any machine settings have been
4056	changed after the creation or not). For opened machines
4057	the value is set to @c false (and then follows to normal rules).
4058	</note>
4059	</desc>
4060	</attribute>
4061
4062	<attribute name="sessionState" type="SessionState" readonly="yes">
4063	<desc>Current session state for this machine.</desc>
4064	</attribute>
4065
4066	<attribute name="sessionType" type="wstring" readonly="yes">
4067	<desc>
4068	Type of the session. If <link to="#sessionState"/> is
4069	Spawning or Locked, this attribute contains the
4070	same value as passed to the
4071	<link to="IMachine::launchVMProcess"/> method in the
4072	@a type parameter. If the session was used with
4073	<link to="IMachine::lockMachine" />, or if
4074	<link to="#sessionState"/> is SessionClosed, the value of this
4075	attribute is an empty string.
4076	</desc>
4077	</attribute>
4078
4079	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4080	<desc>
4081	Identifier of the session process. This attribute contains the
4082	platform-dependent identifier of the process whose session was
4083	used with <link to="IMachine::lockMachine" /> call. The returned
4084	value is only valid if <link to="#sessionState"/> is Locked or
4085	Unlocking by the time this property is read.
4086	</desc>
4087	</attribute>
4088
4089	<attribute name="state" type="MachineState" readonly="yes">
4090	<desc>Current execution state of this machine.</desc>
4091	</attribute>
4092
4093	<attribute name="lastStateChange" type="long long" readonly="yes">
4094	<desc>
4095	Time stamp of the last execution state change,
4096	in milliseconds since 1970-01-01 UTC.
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="stateFilePath" type="wstring" readonly="yes">
4101	<desc>
4102	Full path to the file that stores the execution state of
4103	the machine when it is in the <link to="MachineState_Saved"/> state.
4104	<note>
4105	When the machine is not in the Saved state, this attribute is
4106	an empty string.
4107	</note>
4108	</desc>
4109	</attribute>
4110
4111	<attribute name="logFolder" type="wstring" readonly="yes">
4112	<desc>
4113	Full path to the folder that stores a set of rotated log files
4114	recorded during machine execution. The most recent log file is
4115	named <tt>VBox.log</tt>, the previous log file is
4116	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4117	in the current version).
4118	</desc>
4119	</attribute>
4120
4121	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4122	<desc>
4123	Current snapshot of this machine. This is @c null if the machine
4124	currently has no snapshots. If it is not @c null, then it was
4125	set by one of <link to="IConsole::takeSnapshot" />,
4126	<link to="IConsole::deleteSnapshot" />
4127	or <link to="IConsole::restoreSnapshot" />, depending on which
4128	was called last. See <link to="ISnapshot"/> for details.
4129	</desc>
4130	</attribute>
4131
4132	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4133	<desc>
4134	Number of snapshots taken on this machine. Zero means the
4135	machine doesn't have any snapshots.
4136	</desc>
4137	</attribute>
4138
4139	<attribute name="currentStateModified" type="boolean" readonly="yes">
4140	<desc>
4141	Returns @c true if the current state of the machine is not
4142	identical to the state stored in the current snapshot.
4143
4144	The current state is identical to the current snapshot only
4145	directly after one of the following calls are made:
4146
4147	<ul>
4148	<li><link to="IConsole::restoreSnapshot"/>
4149	</li>
4150	<li><link to="IConsole::takeSnapshot"/> (issued on a
4151	"powered off" or "saved" machine, for which
4152	<link to="#settingsModified"/> returns @c false)
4153	</li>
4154	</ul>
4155
4156	The current state remains identical until one of the following
4157	happens:
4158	<ul>
4159	<li>settings of the machine are changed</li>
4160	<li>the saved state is deleted</li>
4161	<li>the current snapshot is deleted</li>
4162	<li>an attempt to execute the machine is made</li>
4163	</ul>
4164
4165	<note>
4166	For machines that don't have snapshots, this property is
4167	always @c false.
4168	</note>
4169	</desc>
4170	</attribute>
4171
4172	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4173	<desc>
4174	Collection of shared folders for this machine (permanent shared
4175	folders). These folders are shared automatically at machine startup
4176	and available only to the guest OS installed within this machine.
4177
4178	New shared folders are added to the collection using
4179	<link to="#createSharedFolder"/>. Existing shared folders can be
4180	removed using <link to="#removeSharedFolder"/>.
4181	</desc>
4182	</attribute>
4183
4184	<attribute name="clipboardMode" type="ClipboardMode">
4185	<desc>
4186	Synchronization mode between the host OS clipboard
4187	and the guest OS clipboard.
4188	</desc>
4189	</attribute>
4190
4191	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4192	<desc>
4193	A comma-separated list of simple glob patterns. Changes to guest
4194	properties whose name matches one of the patterns will generate an
4195	<link to="IGuestPropertyChangedEvent"/> signal.
4196	</desc>
4197	</attribute>
4198
4199	<attribute name="teleporterEnabled" type="boolean">
4200	<desc>
4201	When set to @a true, the virtual machine becomes a target teleporter
4202	the next time it is powered on. This can only set to @a true when the
4203	VM is in the @a PoweredOff or @a Aborted state.
4204
4205	<!-- This property is automatically set to @a false when the VM is powered
4206	on. (bird: This doesn't work yet ) -->
4207	</desc>
4208	</attribute>
4209
4210	<attribute name="teleporterPort" type="unsigned long">
4211	<desc>
4212	The TCP port the target teleporter will listen for incoming
4213	teleportations on.
4214
4215	0 means the port is automatically selected upon power on. The actual
4216	value can be read from this property while the machine is waiting for
4217	incoming teleportations.
4218	</desc>
4219	</attribute>
4220
4221	<attribute name="teleporterAddress" type="wstring">
4222	<desc>
4223	The address the target teleporter will listen on. If set to an empty
4224	string, it will listen on all addresses.
4225	</desc>
4226	</attribute>
4227
4228	<attribute name="teleporterPassword" type="wstring">
4229	<desc>
4230	The password to check for on the target teleporter. This is just a
4231	very basic measure to prevent simple hacks and operators accidentally
4232	beaming a virtual machine to the wrong place.
4233
4234	Note that you SET a plain text password while reading back a HASHED
4235	password. Setting a hashed password is currently not supported.
4236	</desc>
4237	</attribute>
4238
4239	<attribute name="faultToleranceState" type="FaultToleranceState">
4240	<desc>
4241	Fault tolerance state; disabled, source or target.
4242	This property can be changed at any time. If you change it for a running
4243	VM, then the fault tolerance address and port must be set beforehand.
4244	</desc>
4245	</attribute>
4246
4247	<attribute name="faultTolerancePort" type="unsigned long">
4248	<desc>
4249	The TCP port the fault tolerance source or target will use for
4250	communication.
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="faultToleranceAddress" type="wstring">
4255	<desc>
4256	The address the fault tolerance source or target.
4257	</desc>
4258	</attribute>
4259
4260	<attribute name="faultTolerancePassword" type="wstring">
4261	<desc>
4262	The password to check for on the standby VM. This is just a
4263	very basic measure to prevent simple hacks and operators accidentally
4264	choosing the wrong standby VM.
4265	</desc>
4266	</attribute>
4267
4268	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4269	<desc>
4270	The interval in ms used for syncing the state between source and target.
4271	</desc>
4272	</attribute>
4273
4274	<attribute name="RTCUseUTC" type="boolean">
4275	<desc>
4276	When set to @a true, the RTC device of the virtual machine will run
4277	in UTC time, otherwise in local time. Especially Unix guests prefer
4278	the time in UTC.
4279	</desc>
4280	</attribute>
4281
4282	<attribute name="ioCacheEnabled" type="boolean">
4283	<desc>
4284	When set to @a true, the builtin I/O cache of the virtual machine
4285	will be enabled.
4286	</desc>
4287	</attribute>
4288
4289	<attribute name="ioCacheSize" type="unsigned long">
4290	<desc>
4291	Maximum size of the I/O cache in MB.
4292	</desc>
4293	</attribute>
4294
4295	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4296	<desc>Array of PCI devices assigned to this machine, to get list of all
4297	PCI devices attached to the machine use
4298	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4299	is intended to list only devices additional to what described in
4300	virtual hardware config. Usually, this list keeps host's physical
4301	devices assigned to the particular machine.
4302	</desc>
4303	</attribute>
4304
4305	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4306	<desc>
4307	Bandwidth control manager.
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="tracingEnabled" type="boolean">
4312	<desc>
4313	Enables the tracing facility in the VMM (including PDM devices +
4314	drivers). The VMM will consume about 0.5MB of more memory when
4315	enabled and there may be some extra overhead from tracepoints that are
4316	always enabled.
4317	</desc>
4318	</attribute>
4319
4320	<attribute name="tracingConfig" type="wstring">
4321	<desc>
4322	Tracepoint configuration to apply at startup when
4323	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4324	a space separated of tracepoint group names to enable. The special
4325	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4326	more details on available tracepoint groups and such.
4327
4328	Note that on hosts supporting DTrace (or similar), a lot of the
4329	tracepoints may be implemented exclusivly as DTrace probes. So, the
4330	effect of the same config may differ between Solaris and Windows for
4331	example.
4332	</desc>
4333	</attribute>
4334
4335	<attribute name="allowTracingToAccessVM" type="boolean">
4336	<desc>
4337	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4338	structures when firing off trace points. This is especially useful
4339	with DTrace tracepoints, as it allow you to use the VMCPU or VM pointer
4340	to obtail useful information such as guest register state.
4341
4342	This is disabled by default because devices and drivers normally has no
4343	business accessing the VMCPU or VM structures, and are therefore unable
4344	to get any pointers to these.
4345	</desc>
4346	</attribute>
4347
4348	<attribute name="autostartEnabled" type="boolean">
4349	<desc>
4350	Enables autostart of the VM during system boot.
4351	</desc>
4352	</attribute>
4353
4354	<attribute name="autostartDelay" type="unsigned long">
4355	<desc>
4356	Number of seconds to wait until the VM should be started during system boot.
4357	</desc>
4358	</attribute>
4359
4360	<attribute name="autostopType" type="AutostopType">
4361	<desc>
4362	Action type to do when the system is shutting down.
4363	</desc>
4364	</attribute>
4365
4366	<method name="lockMachine">
4367	<desc>
4368	Locks the machine for the given session to enable the caller
4369	to make changes to the machine or start the VM or control
4370	VM execution.
4371
4372	There are two ways to lock a machine for such uses:
4373
4374	<ul>
4375	<li>If you want to make changes to the machine settings,
4376	you must obtain an exclusive write lock on the machine
4377	by setting @a lockType to @c Write.
4378
4379	This will only succeed if no other process has locked
4380	the machine to prevent conflicting changes. Only after
4381	an exclusive write lock has been obtained using this method, one
4382	can change all VM settings or execute the VM in the process
4383	space of the session object. (Note that the latter is only of
4384	interest if you actually want to write a new front-end for
4385	virtual machines; but this API gets called internally by
4386	the existing front-ends such as VBoxHeadless and the VirtualBox
4387	GUI to acquire a write lock on the machine that they are running.)
4388
4389	On success, write-locking the machine for a session creates
4390	a second copy of the IMachine object. It is this second object
4391	upon which changes can be made; in VirtualBox terminology, the
4392	second copy is "mutable". It is only this second, mutable machine
4393	object upon which you can call methods that change the
4394	machine state. After having called this method, you can
4395	obtain this second, mutable machine object using the
4396	<link to="ISession::machine" /> attribute.
4397	</li>
4398	<li>If you only want to check the machine state or control
4399	machine execution without actually changing machine
4400	settings (e.g. to get access to VM statistics or take
4401	a snapshot or save the machine state), then set the
4402	@a lockType argument to @c Shared.
4403
4404	If no other session has obtained a lock, you will obtain an
4405	exclusive write lock as described above. However, if another
4406	session has already obtained such a lock, then a link to that
4407	existing session will be established which allows you
4408	to control that existing session.
4409
4410	To find out which type of lock was obtained, you can
4411	inspect <link to="ISession::type" />, which will have been
4412	set to either @c WriteLock or @c Shared.
4413	</li>
4414	</ul>
4415
4416	In either case, you can get access to the <link to="IConsole" />
4417	object which controls VM execution.
4418
4419	Also in all of the above cases, one must always call
4420	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4421	the machine's state will eventually be set to "Aborted".
4422
4423	To change settings on a machine, the following sequence is typically
4424	performed:
4425
4426	<ol>
4427	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4428
4429	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4430
4431	<li>Change the settings of the machine by invoking IMachine methods.</li>
4432
4433	<li>Call <link to="IMachine::saveSettings" />.</li>
4434
4435	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4436	</ol>
4437
4438	<result name="E_UNEXPECTED">
4439	Virtual machine not registered.
4440	</result>
4441	<result name="E_ACCESSDENIED">
4442	Process not started by OpenRemoteSession.
4443	</result>
4444	<result name="VBOX_E_INVALID_OBJECT_STATE">
4445	Session already open or being opened.
4446	</result>
4447	<result name="VBOX_E_VM_ERROR">
4448	Failed to assign machine to session.
4449	</result>
4450	</desc>
4451	<param name="session" type="ISession" dir="in">
4452	<desc>
4453	Session object for which the machine will be locked.
4454	</desc>
4455	</param>
4456	<param name="lockType" type="LockType" dir="in">
4457	<desc>
4458	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4459	If set to @c Shared, then either acquire an exclusive write lock or establish
4460	a link to an existing session.
4461	</desc>
4462	</param>
4463	</method>
4464
4465	<method name="launchVMProcess">
4466	<desc>
4467	Spawns a new process that will execute the virtual machine and obtains a shared
4468	lock on the machine for the calling session.
4469
4470	If launching the VM succeeds, the new VM process will create its own session
4471	and write-lock the machine for it, preventing conflicting changes from other
4472	processes. If the machine is already locked (because it is already running or
4473	because another session has a write lock), launching the VM process will therefore
4474	fail. Reversely, future attempts to obtain a write lock will also fail while the
4475	machine is running.
4476
4477	The caller's session object remains separate from the session opened by the new
4478	VM process. It receives its own <link to="IConsole" /> object which can be used
4479	to control machine execution, but it cannot be used to change all VM settings
4480	which would be available after a <link to="#lockMachine" /> call.
4481
4482	The caller must eventually release the session's shared lock by calling
4483	<link to="ISession::unlockMachine" /> on the local session object once this call
4484	has returned. However, the session's state (see <link to="ISession::state" />)
4485	will not return to "Unlocked" until the remote session has also unlocked
4486	the machine (i.e. the machine has stopped running).
4487
4488	Launching a VM process can take some time (a new VM is started in a new process,
4489	for which memory and other resources need to be set up). Because of this,
4490	an <link to="IProgress" /> object is returned to allow the caller to wait
4491	for this asynchronous operation to be completed. Until then, the caller's
4492	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4493	and <link to="ISession::console" /> attributes cannot be accessed.
4494	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4495	similar calls to wait for completion. Completion is signalled when the VM
4496	is powered on. If launching the VM fails, error messages can be queried
4497	via the progress object, if available.
4498
4499	The progress object will have at least 2 sub-operations. The first
4500	operation covers the period up to the new VM process calls powerUp.
4501	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4502	progress object. Because <link to="IConsole::powerUp"/> may require
4503	some extra sub-operations, the <link to="IProgress::operationCount"/>
4504	may change at the completion of operation.
4505
4506	For details on the teleportation progress operation, see
4507	<link to="IConsole::powerUp"/>.
4508
4509	The @a environment argument is a string containing definitions of
4510	environment variables in the following format:
4511	<pre>
4512	NAME[=VALUE]\n
4513	NAME[=VALUE]\n
4514	...
4515	</pre>
4516	where <tt>\\n</tt> is the new line character. These environment
4517	variables will be appended to the environment of the VirtualBox server
4518	process. If an environment variable exists both in the server process
4519	and in this list, the value from this list takes precedence over the
4520	server's variable. If the value of the environment variable is
4521	omitted, this variable will be removed from the resulting environment.
4522	If the environment string is @c null or empty, the server environment
4523	is inherited by the started process as is.
4524
4525	<result name="E_UNEXPECTED">
4526	Virtual machine not registered.
4527	</result>
4528	<result name="E_INVALIDARG">
4529	Invalid session type @a type.
4530	</result>
4531	<result name="VBOX_E_OBJECT_NOT_FOUND">
4532	No machine matching @a machineId found.
4533	</result>
4534	<result name="VBOX_E_INVALID_OBJECT_STATE">
4535	Session already open or being opened.
4536	</result>
4537	<result name="VBOX_E_IPRT_ERROR">
4538	Launching process for machine failed.
4539	</result>
4540	<result name="VBOX_E_VM_ERROR">
4541	Failed to assign machine to session.
4542	</result>
4543	</desc>
4544	<param name="session" type="ISession" dir="in">
4545	<desc>
4546	Client session object to which the VM process will be connected (this
4547	must be in "Unlocked" state).
4548	</desc>
4549	</param>
4550	<param name="type" type="wstring" dir="in">
4551	<desc>
4552	Front-end to use for the new VM process. The following are currently supported:
4553	<ul>
4554	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4555	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4556	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4557	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4558	the currently running VM or session owner. In this case the
4559	@a session parameter may be @c NULL (if it is non-null it isn't
4560	used in any way), and the @a progress return value will be always
4561	NULL. The operation completes immediately.</li>
4562	</ul>
4563	</desc>
4564	</param>
4565	<param name="environment" type="wstring" dir="in">
4566	<desc>
4567	Environment to pass to the VM process.
4568	</desc>
4569	</param>
4570	<param name="progress" type="IProgress" dir="return">
4571	<desc>Progress object to track the operation completion.</desc>
4572	</param>
4573	</method>
4574
4575	<method name="setBootOrder">
4576	<desc>
4577	Puts the given device to the specified position in
4578	the boot order.
4579
4580	To indicate that no device is associated with the given position,
4581	<link to="DeviceType_Null"/> should be used.
4582
4583	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4584
4585	<result name="E_INVALIDARG">
4586	Boot @a position out of range.
4587	</result>
4588	<result name="E_NOTIMPL">
4589	Booting from USB @a device currently not supported.
4590	</result>
4591
4592	</desc>
4593	<param name="position" type="unsigned long" dir="in">
4594	<desc>
4595	Position in the boot order (@c 1 to the total number of
4596	devices the machine can boot from, as returned by
4597	<link to="ISystemProperties::maxBootPosition"/>).
4598	</desc>
4599	</param>
4600	<param name="device" type="DeviceType" dir="in">
4601	<desc>
4602	The type of the device used to boot at the given position.
4603	</desc>
4604	</param>
4605	</method>
4606
4607	<method name="getBootOrder" const="yes">
4608	<desc>
4609	Returns the device type that occupies the specified
4610	position in the boot order.
4611
4612	@todo [remove?]
4613	If the machine can have more than one device of the returned type
4614	(such as hard disks), then a separate method should be used to
4615	retrieve the individual device that occupies the given position.
4616
4617	If here are no devices at the given position, then
4618	<link to="DeviceType_Null"/> is returned.
4619
4620	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4621
4622	<result name="E_INVALIDARG">
4623	Boot @a position out of range.
4624	</result>
4625
4626	</desc>
4627	<param name="position" type="unsigned long" dir="in">
4628	<desc>
4629	Position in the boot order (@c 1 to the total number of
4630	devices the machine can boot from, as returned by
4631	<link to="ISystemProperties::maxBootPosition"/>).
4632	</desc>
4633	</param>
4634	<param name="device" type="DeviceType" dir="return">
4635	<desc>
4636	Device at the given position.
4637	</desc>
4638	</param>
4639	</method>
4640
4641	<method name="attachDevice">
4642	<desc>
4643	Attaches a device and optionally mounts a medium to the given storage
4644	controller (<link to="IStorageController" />, identified by @a name),
4645	at the indicated port and device.
4646
4647	This method is intended for managing storage devices in general while a
4648	machine is powered off. It can be used to attach and detach fixed
4649	and removable media. The following kind of media can be attached
4650	to a machine:
4651
4652	<ul>
4653	<li>For fixed and removable media, you can pass in a medium that was
4654	previously opened using <link to="IVirtualBox::openMedium" />.
4655	</li>
4656
4657	<li>Only for storage devices supporting removable media (such as
4658	DVDs and floppies), you can also specify a null pointer to
4659	indicate an empty drive or one of the medium objects listed
4660	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4661	arrays to indicate a host drive.
4662	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4663	to change the media while the machine is running.
4664	</li>
4665	</ul>
4666
4667	In a VM's default configuration of virtual machines, the secondary
4668	master of the IDE controller is used for a CD/DVD drive.
4669
4670	After calling this returns successfully, a new instance of
4671	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4672	attachments (see <link to="IMachine::mediumAttachments"/>).
4673
4674	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4675	information about attaching media.
4676
4677	The specified device slot must not have a device attached to it,
4678	or this method will fail.
4679
4680	<note>
4681	You cannot attach a device to a newly created machine until
4682	this machine's settings are saved to disk using
4683	<link to="#saveSettings"/>.
4684	</note>
4685	<note>
4686	If the medium is being attached indirectly, a new differencing medium
4687	will implicitly be created for it and attached instead. If the
4688	changes made to the machine settings (including this indirect
4689	attachment) are later cancelled using <link to="#discardSettings"/>,
4690	this implicitly created differencing medium will implicitly
4691	be deleted.
4692	</note>
4693
4694	<result name="E_INVALIDARG">
4695	SATA device, SATA port, IDE port or IDE slot out of range, or
4696	file or UUID not found.
4697	</result>
4698	<result name="VBOX_E_INVALID_OBJECT_STATE">
4699	Machine must be registered before media can be attached.
4700	</result>
4701	<result name="VBOX_E_INVALID_VM_STATE">
4702	Invalid machine state.
4703	</result>
4704	<result name="VBOX_E_OBJECT_IN_USE">
4705	A medium is already attached to this or another virtual machine.
4706	</result>
4707
4708	</desc>
4709	<param name="name" type="wstring" dir="in">
4710	<desc>Name of the storage controller to attach the device to.</desc>
4711	</param>
4712	<param name="controllerPort" type="long" dir="in">
4713	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4714	the primary controller and 1 specifies the secondary controller.
4715	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4716	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4717	</param>
4718	<param name="device" type="long" dir="in">
4719	<desc>Device slot in the given port to attach the device to. This is only
4720	relevant for IDE controllers, for which 0 specifies the master device and
4721	1 specifies the slave device. For all other controller types, this must
4722	be 0.</desc>
4723	</param>
4724	<param name="type" type="DeviceType" dir="in">
4725	<desc>Device type of the attached device. For media opened by
4726	<link to="IVirtualBox::openMedium" />, this must match the device type
4727	specified there.</desc>
4728	</param>
4729	<param name="medium" type="IMedium" dir="in">
4730	<desc>Medium to mount or NULL for an empty drive.</desc>
4731	</param>
4732	</method>
4733
4734	<method name="detachDevice">
4735	<desc>
4736	Detaches the device attached to a device slot of the specified bus.
4737
4738	Detaching the device from the virtual machine is deferred. This means
4739	that the medium remains associated with the machine when this method
4740	returns and gets actually de-associated only after a successful
4741	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4742	for more detailed information about attaching media.
4743
4744	<note>
4745	You cannot detach a device from a running machine.
4746	</note>
4747	<note>
4748	Detaching differencing media implicitly created by <link
4749	to="#attachDevice"/> for the indirect attachment using this
4750	method will <b>not</b> implicitly delete them. The
4751	<link to="IMedium::deleteStorage"/> operation should be
4752	explicitly performed by the caller after the medium is successfully
4753	detached and the settings are saved with
4754	<link to="#saveSettings"/>, if it is the desired action.
4755	</note>
4756
4757	<result name="VBOX_E_INVALID_VM_STATE">
4758	Attempt to detach medium from a running virtual machine.
4759	</result>
4760	<result name="VBOX_E_OBJECT_NOT_FOUND">
4761	No medium attached to given slot/bus.
4762	</result>
4763	<result name="VBOX_E_NOT_SUPPORTED">
4764	Medium format does not support storage deletion (only for implicitly
4765	created differencing media, should not happen).
4766	</result>
4767
4768	</desc>
4769	<param name="name" type="wstring" dir="in">
4770	<desc>Name of the storage controller to detach the medium from.</desc>
4771	</param>
4772	<param name="controllerPort" type="long" dir="in">
4773	<desc>Port number to detach the medium from.</desc>
4774	</param>
4775	<param name="device" type="long" dir="in">
4776	<desc>Device slot number to detach the medium from.</desc>
4777	</param>
4778	</method>
4779
4780	<method name="passthroughDevice">
4781	<desc>
4782	Sets the passthrough mode of an existing DVD device. Changing the
4783	setting while the VM is running is forbidden. The setting is only used
4784	if at VM start the device is configured as a host DVD drive, in all
4785	other cases it is ignored. The device must already exist; see
4786	<link to="IMachine::attachDevice"/> for how to attach a new device.
4787
4788	The @a controllerPort and @a device parameters specify the device slot and
4789	have have the same meaning as with <link to="IMachine::attachDevice" />.
4790
4791	<result name="E_INVALIDARG">
4792	SATA device, SATA port, IDE port or IDE slot out of range.
4793	</result>
4794	<result name="VBOX_E_INVALID_OBJECT_STATE">
4795	Attempt to modify an unregistered virtual machine.
4796	</result>
4797	<result name="VBOX_E_INVALID_VM_STATE">
4798	Invalid machine state.
4799	</result>
4800
4801	</desc>
4802	<param name="name" type="wstring" dir="in">
4803	<desc>Name of the storage controller.</desc>
4804	</param>
4805	<param name="controllerPort" type="long" dir="in">
4806	<desc>Storage controller port.</desc>
4807	</param>
4808	<param name="device" type="long" dir="in">
4809	<desc>Device slot in the given port.</desc>
4810	</param>
4811	<param name="passthrough" type="boolean" dir="in">
4812	<desc>New value for the passthrough setting.</desc>
4813	</param>
4814	</method>
4815
4816	<method name="temporaryEjectDevice">
4817	<desc>
4818	Sets the behavior for guest-triggered medium eject. In some situations
4819	it is desirable that such ejects update the VM configuration, and in
4820	others the eject should keep the VM configuration. The device must
4821	already exist; see <link to="IMachine::attachDevice"/> for how to
4822	attach a new device.
4823
4824	The @a controllerPort and @a device parameters specify the device slot and
4825	have have the same meaning as with <link to="IMachine::attachDevice" />.
4826
4827	<result name="E_INVALIDARG">
4828	SATA device, SATA port, IDE port or IDE slot out of range.
4829	</result>
4830	<result name="VBOX_E_INVALID_OBJECT_STATE">
4831	Attempt to modify an unregistered virtual machine.
4832	</result>
4833	<result name="VBOX_E_INVALID_VM_STATE">
4834	Invalid machine state.
4835	</result>
4836
4837	</desc>
4838	<param name="name" type="wstring" dir="in">
4839	<desc>Name of the storage controller.</desc>
4840	</param>
4841	<param name="controllerPort" type="long" dir="in">
4842	<desc>Storage controller port.</desc>
4843	</param>
4844	<param name="device" type="long" dir="in">
4845	<desc>Device slot in the given port.</desc>
4846	</param>
4847	<param name="temporaryEject" type="boolean" dir="in">
4848	<desc>New value for the eject behavior.</desc>
4849	</param>
4850	</method>
4851
4852	<method name="nonRotationalDevice">
4853	<desc>
4854	Sets a flag in the device information which indicates that the medium
4855	is not based on rotational technology, i.e. that the access times are
4856	more or less independent of the position on the medium. This may or may
4857	not be supported by a particular drive, and is silently ignored in the
4858	latter case. At the moment only hard disks (which is a misnomer in this
4859	context) accept this setting. Changing the setting while the VM is
4860	running is forbidden. The device must already exist; see
4861	<link to="IMachine::attachDevice"/> for how to attach a new device.
4862
4863	The @a controllerPort and @a device parameters specify the device slot and
4864	have have the same meaning as with <link to="IMachine::attachDevice" />.
4865
4866	<result name="E_INVALIDARG">
4867	SATA device, SATA port, IDE port or IDE slot out of range.
4868	</result>
4869	<result name="VBOX_E_INVALID_OBJECT_STATE">
4870	Attempt to modify an unregistered virtual machine.
4871	</result>
4872	<result name="VBOX_E_INVALID_VM_STATE">
4873	Invalid machine state.
4874	</result>
4875
4876	</desc>
4877	<param name="name" type="wstring" dir="in">
4878	<desc>Name of the storage controller.</desc>
4879	</param>
4880	<param name="controllerPort" type="long" dir="in">
4881	<desc>Storage controller port.</desc>
4882	</param>
4883	<param name="device" type="long" dir="in">
4884	<desc>Device slot in the given port.</desc>
4885	</param>
4886	<param name="nonRotational" type="boolean" dir="in">
4887	<desc>New value for the non-rotational device flag.</desc>
4888	</param>
4889	</method>
4890
4891	<method name="setAutoDiscardForDevice">
4892	<desc>
4893	Sets a flag in the device information which indicates that the medium
4894	supports discarding unsused blocks (called trimming for SATA or unmap
4895	for SCSI devices) .This may or may not be supported by a particular drive,
4896	and is silently ignored in the latter case. At the moment only hard disks
4897	(which is a misnomer in this context) accept this setting. Changing the
4898	setting while the VM is running is forbidden. The device must already
4899	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4900	device.
4901
4902	The @a controllerPort and @a device parameters specify the device slot and
4903	have have the same meaning as with <link to="IMachine::attachDevice" />.
4904
4905	<result name="E_INVALIDARG">
4906	SATA device, SATA port, SCSI port out of range.
4907	</result>
4908	<result name="VBOX_E_INVALID_OBJECT_STATE">
4909	Attempt to modify an unregistered virtual machine.
4910	</result>
4911	<result name="VBOX_E_INVALID_VM_STATE">
4912	Invalid machine state.
4913	</result>
4914
4915	</desc>
4916	<param name="name" type="wstring" dir="in">
4917	<desc>Name of the storage controller.</desc>
4918	</param>
4919	<param name="controllerPort" type="long" dir="in">
4920	<desc>Storage controller port.</desc>
4921	</param>
4922	<param name="device" type="long" dir="in">
4923	<desc>Device slot in the given port.</desc>
4924	</param>
4925	<param name="discard" type="boolean" dir="in">
4926	<desc>New value for the discard device flag.</desc>
4927	</param>
4928	</method>
4929
4930	<method name="setBandwidthGroupForDevice">
4931	<desc>
4932	Sets the bandwidth group of an existing storage device.
4933	The device must already exist; see <link to="IMachine::attachDevice"/>
4934	for how to attach a new device.
4935
4936	The @a controllerPort and @a device parameters specify the device slot and
4937	have have the same meaning as with <link to="IMachine::attachDevice" />.
4938
4939	<result name="E_INVALIDARG">
4940	SATA device, SATA port, IDE port or IDE slot out of range.
4941	</result>
4942	<result name="VBOX_E_INVALID_OBJECT_STATE">
4943	Attempt to modify an unregistered virtual machine.
4944	</result>
4945	<result name="VBOX_E_INVALID_VM_STATE">
4946	Invalid machine state.
4947	</result>
4948
4949	</desc>
4950	<param name="name" type="wstring" dir="in">
4951	<desc>Name of the storage controller.</desc>
4952	</param>
4953	<param name="controllerPort" type="long" dir="in">
4954	<desc>Storage controller port.</desc>
4955	</param>
4956	<param name="device" type="long" dir="in">
4957	<desc>Device slot in the given port.</desc>
4958	</param>
4959	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4960	<desc>New value for the bandwidth group or NULL for no group.</desc>
4961	</param>
4962	</method>
4963
4964	<method name="mountMedium">
4965	<desc>
4966	Mounts a medium (<link to="IMedium" />, identified
4967	by the given UUID @a id) to the given storage controller
4968	(<link to="IStorageController" />, identified by @a name),
4969	at the indicated port and device. The device must already exist;
4970	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4971
4972	This method is intended only for managing removable media, where the
4973	device is fixed but media is changeable at runtime (such as DVDs
4974	and floppies). It cannot be used for fixed media such as hard disks.
4975
4976	The @a controllerPort and @a device parameters specify the device slot and
4977	have have the same meaning as with <link to="IMachine::attachDevice" />.
4978
4979	The specified device slot can have a medium mounted, which will be
4980	unmounted first. Specifying a zero UUID (or an empty string) for
4981	@a medium does just an unmount.
4982
4983	See <link to="IMedium"/> for more detailed information about
4984	attaching media.
4985
4986	<result name="E_INVALIDARG">
4987	SATA device, SATA port, IDE port or IDE slot out of range.
4988	</result>
4989	<result name="VBOX_E_INVALID_OBJECT_STATE">
4990	Attempt to attach medium to an unregistered virtual machine.
4991	</result>
4992	<result name="VBOX_E_INVALID_VM_STATE">
4993	Invalid machine state.
4994	</result>
4995	<result name="VBOX_E_OBJECT_IN_USE">
4996	Medium already attached to this or another virtual machine.
4997	</result>
4998
4999	</desc>
5000	<param name="name" type="wstring" dir="in">
5001	<desc>Name of the storage controller to attach the medium to.</desc>
5002	</param>
5003	<param name="controllerPort" type="long" dir="in">
5004	<desc>Port to attach the medium to.</desc>
5005	</param>
5006	<param name="device" type="long" dir="in">
5007	<desc>Device slot in the given port to attach the medium to.</desc>
5008	</param>
5009	<param name="medium" type="IMedium" dir="in">
5010	<desc>Medium to mount or NULL for an empty drive.</desc>
5011	</param>
5012	<param name="force" type="boolean" dir="in">
5013	<desc>Allows to force unmount/mount of a medium which is locked by
5014	the device slot in the given port to attach the medium to.</desc>
5015	</param>
5016	</method>
5017
5018	<method name="getMedium" const="yes">
5019	<desc>
5020	Returns the virtual medium attached to a device slot of the specified
5021	bus.
5022
5023	Note that if the medium was indirectly attached by
5024	<link to="#mountMedium"/> to the given device slot then this
5025	method will return not the same object as passed to the
5026	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5027	more detailed information about mounting a medium.
5028
5029	<result name="VBOX_E_OBJECT_NOT_FOUND">
5030	No medium attached to given slot/bus.
5031	</result>
5032
5033	</desc>
5034	<param name="name" type="wstring" dir="in">
5035	<desc>Name of the storage controller the medium is attached to.</desc>
5036	</param>
5037	<param name="controllerPort" type="long" dir="in">
5038	<desc>Port to query.</desc>
5039	</param>
5040	<param name="device" type="long" dir="in">
5041	<desc>Device slot in the given port to query.</desc>
5042	</param>
5043	<param name="medium" type="IMedium" dir="return">
5044	<desc>Attached medium object.</desc>
5045	</param>
5046	</method>
5047
5048	<method name="getMediumAttachmentsOfController" const="yes">
5049	<desc>
5050	Returns an array of medium attachments which are attached to the
5051	the controller with the given name.
5052
5053	<result name="VBOX_E_OBJECT_NOT_FOUND">
5054	A storage controller with given name doesn't exist.
5055	</result>
5056	</desc>
5057	<param name="name" type="wstring" dir="in"/>
5058	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5059	</method>
5060
5061	<method name="getMediumAttachment" const="yes">
5062	<desc>
5063	Returns a medium attachment which corresponds to the controller with
5064	the given name, on the given port and device slot.
5065
5066	<result name="VBOX_E_OBJECT_NOT_FOUND">
5067	No attachment exists for the given controller/port/device combination.
5068	</result>
5069	</desc>
5070	<param name="name" type="wstring" dir="in"/>
5071	<param name="controllerPort" type="long" dir="in"/>
5072	<param name="device" type="long" dir="in"/>
5073	<param name="attachment" type="IMediumAttachment" dir="return"/>
5074	</method>
5075
5076	<method name="attachHostPciDevice">
5077	<desc>
5078	Attaches host PCI device with the given (host) PCI address to the
5079	PCI bus of the virtual machine. Please note, that this operation
5080	is two phase, as real attachment will happen when VM will start,
5081	and most information will be delivered as IHostPciDevicePlugEvent
5082	on IVirtualBox event source.
5083
5084	<see><link to="IHostPciDevicePlugEvent"/></see>
5085
5086	<result name="VBOX_E_INVALID_VM_STATE">
5087	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5088	</result>
5089	<result name="VBOX_E_PDM_ERROR">
5090	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5091	</result>
5092	<result name="VBOX_E_NOT_SUPPORTED">
5093	Hardware or host OS doesn't allow PCI device passthrought.
5094	</result>
5095	</desc>
5096	<param name="hostAddress" type="long" dir="in">
5097	<desc>Address of the host PCI device.</desc>
5098	</param>
5099	<param name="desiredGuestAddress" type="long" dir="in">
5100	<desc>Desired position of this device on guest PCI bus.</desc>
5101	</param>
5102	<param name="tryToUnbind" type="boolean" dir="in">
5103	<desc>If VMM shall try to unbind existing drivers from the
5104	device before attaching it to the guest.</desc>
5105	</param>
5106	</method>
5107
5108	<method name="detachHostPciDevice">
5109	<desc>
5110	Detach host PCI device from the virtual machine.
5111	Also HostPciDevicePlugEvent on IVirtualBox event source
5112	will be delivered. As currently we don't support hot device
5113	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5114
5115	<see><link to="IHostPciDevicePlugEvent"/></see>
5116
5117	<result name="VBOX_E_INVALID_VM_STATE">
5118	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5119	</result>
5120	<result name="VBOX_E_OBJECT_NOT_FOUND">
5121	This host device is not attached to this machine.
5122	</result>
5123	<result name="VBOX_E_PDM_ERROR">
5124	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5125	</result>
5126	<result name="VBOX_E_NOT_SUPPORTED">
5127	Hardware or host OS doesn't allow PCI device passthrought.
5128	</result>
5129	</desc>
5130	<param name="hostAddress" type="long" dir="in">
5131	<desc>Address of the host PCI device.</desc>
5132	</param>
5133	</method>
5134
5135	<method name="getNetworkAdapter" const="yes">
5136	<desc>
5137	Returns the network adapter associated with the given slot.
5138	Slots are numbered sequentially, starting with zero. The total
5139	number of adapters per machine is defined by the
5140	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5141	so the maximum slot number is one less than that property's value.
5142
5143	<result name="E_INVALIDARG">
5144	Invalid @a slot number.
5145	</result>
5146
5147	</desc>
5148	<param name="slot" type="unsigned long" dir="in"/>
5149	<param name="adapter" type="INetworkAdapter" dir="return"/>
5150	</method>
5151
5152	<method name="addStorageController">
5153	<desc>
5154	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5155	machine and returns it as an instance of
5156	<link to="IStorageController" />.
5157
5158	@a name identifies the controller for subsequent calls such as
5159	<link to="#getStorageControllerByName" />,
5160	<link to="#getStorageControllerByInstance" />,
5161	<link to="#removeStorageController" />,
5162	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5163
5164	After the controller has been added, you can set its exact
5165	type by setting the <link to="IStorageController::controllerType" />.
5166
5167	<result name="VBOX_E_OBJECT_IN_USE">
5168	A storage controller with given name exists already.
5169	</result>
5170	<result name="E_INVALIDARG">
5171	Invalid @a controllerType.
5172	</result>
5173	</desc>
5174	<param name="name" type="wstring" dir="in"/>
5175	<param name="connectionType" type="StorageBus" dir="in"/>
5176	<param name="controller" type="IStorageController" dir="return"/>
5177	</method>
5178
5179	<method name="getStorageControllerByName" const="yes">
5180	<desc>
5181	Returns a storage controller with the given name.
5182
5183	<result name="VBOX_E_OBJECT_NOT_FOUND">
5184	A storage controller with given name doesn't exist.
5185	</result>
5186	</desc>
5187	<param name="name" type="wstring" dir="in"/>
5188	<param name="storageController" type="IStorageController" dir="return"/>
5189	</method>
5190
5191	<method name="getStorageControllerByInstance" const="yes">
5192	<desc>
5193	Returns a storage controller with the given instance number.
5194
5195	<result name="VBOX_E_OBJECT_NOT_FOUND">
5196	A storage controller with given instance number doesn't exist.
5197	</result>
5198	</desc>
5199	<param name="instance" type="unsigned long" dir="in"/>
5200	<param name="storageController" type="IStorageController" dir="return"/>
5201	</method>
5202
5203	<method name="removeStorageController">
5204	<desc>
5205	Removes a storage controller from the machine with all devices attached to it.
5206
5207	<result name="VBOX_E_OBJECT_NOT_FOUND">
5208	A storage controller with given name doesn't exist.
5209	</result>
5210	<result name="VBOX_E_NOT_SUPPORTED">
5211	Medium format does not support storage deletion (only for implicitly
5212	created differencing media, should not happen).
5213	</result>
5214	</desc>
5215	<param name="name" type="wstring" dir="in"/>
5216	</method>
5217
5218	<method name="setStorageControllerBootable">
5219	<desc>
5220	Sets the bootable flag of the storage controller with the given name.
5221
5222	<result name="VBOX_E_OBJECT_NOT_FOUND">
5223	A storage controller with given name doesn't exist.
5224	</result>
5225	<result name="VBOX_E_OBJECT_IN_USE">
5226	Another storage controller is marked as bootable already.
5227	</result>
5228	</desc>
5229	<param name="name" type="wstring" dir="in"/>
5230	<param name="bootable" type="boolean" dir="in"/>
5231	</method>
5232
5233	<method name="getSerialPort" const="yes">
5234	<desc>
5235	Returns the serial port associated with the given slot.
5236	Slots are numbered sequentially, starting with zero. The total
5237	number of serial ports per machine is defined by the
5238	<link to="ISystemProperties::serialPortCount"/> property,
5239	so the maximum slot number is one less than that property's value.
5240
5241	<result name="E_INVALIDARG">
5242	Invalid @a slot number.
5243	</result>
5244
5245	</desc>
5246	<param name="slot" type="unsigned long" dir="in"/>
5247	<param name="port" type="ISerialPort" dir="return"/>
5248	</method>
5249
5250	<method name="getParallelPort" const="yes">
5251	<desc>
5252	Returns the parallel port associated with the given slot.
5253	Slots are numbered sequentially, starting with zero. The total
5254	number of parallel ports per machine is defined by the
5255	<link to="ISystemProperties::parallelPortCount"/> property,
5256	so the maximum slot number is one less than that property's value.
5257
5258	<result name="E_INVALIDARG">
5259	Invalid @a slot number.
5260	</result>
5261
5262	</desc>
5263	<param name="slot" type="unsigned long" dir="in"/>
5264	<param name="port" type="IParallelPort" dir="return"/>
5265	</method>
5266
5267	<method name="getExtraDataKeys">
5268	<desc>
5269	Returns an array representing the machine-specific extra data keys
5270	which currently have values defined.
5271	</desc>
5272	<param name="value" type="wstring" dir="return" safearray="yes">
5273	<desc>Array of extra data keys.</desc>
5274	</param>
5275	</method>
5276
5277	<method name="getExtraData">
5278	<desc>
5279	Returns associated machine-specific extra data.
5280
5281	If the requested data @a key does not exist, this function will
5282	succeed and return an empty string in the @a value argument.
5283
5284	<result name="VBOX_E_FILE_ERROR">
5285	Settings file not accessible.
5286	</result>
5287	<result name="VBOX_E_XML_ERROR">
5288	Could not parse the settings file.
5289	</result>
5290
5291	</desc>
5292	<param name="key" type="wstring" dir="in">
5293	<desc>Name of the data key to get.</desc>
5294	</param>
5295	<param name="value" type="wstring" dir="return">
5296	<desc>Value of the requested data key.</desc>
5297	</param>
5298	</method>
5299
5300	<method name="setExtraData">
5301	<desc>
5302	Sets associated machine-specific extra data.
5303
5304	If you pass @c null or an empty string as a key @a value, the given
5305	@a key will be deleted.
5306
5307	<note>
5308	Before performing the actual data change, this method will ask all
5309	registered listeners using the
5310	<link to="IExtraDataCanChangeEvent"/>
5311	notification for a permission. If one of the listeners refuses the
5312	new value, the change will not be performed.
5313	</note>
5314	<note>
5315	On success, the
5316	<link to="IExtraDataChangedEvent"/> notification
5317	is called to inform all registered listeners about a successful data
5318	change.
5319	</note>
5320	<note>
5321	This method can be called outside the machine session and therefore
5322	it's a caller's responsibility to handle possible race conditions
5323	when several clients change the same key at the same time.
5324	</note>
5325
5326	<result name="VBOX_E_FILE_ERROR">
5327	Settings file not accessible.
5328	</result>
5329	<result name="VBOX_E_XML_ERROR">
5330	Could not parse the settings file.
5331	</result>
5332
5333	</desc>
5334	<param name="key" type="wstring" dir="in">
5335	<desc>Name of the data key to set.</desc>
5336	</param>
5337	<param name="value" type="wstring" dir="in">
5338	<desc>Value to assign to the key.</desc>
5339	</param>
5340	</method>
5341
5342	<method name="getCPUProperty" const="yes">
5343	<desc>
5344	Returns the virtual CPU boolean value of the specified property.
5345
5346	<result name="E_INVALIDARG">
5347	Invalid property.
5348	</result>
5349
5350	</desc>
5351	<param name="property" type="CPUPropertyType" dir="in">
5352	<desc>
5353	Property type to query.
5354	</desc>
5355	</param>
5356	<param name="value" type="boolean" dir="return">
5357	<desc>
5358	Property value.
5359	</desc>
5360	</param>
5361	</method>
5362
5363	<method name="setCPUProperty">
5364	<desc>
5365	Sets the virtual CPU boolean value of the specified property.
5366
5367	<result name="E_INVALIDARG">
5368	Invalid property.
5369	</result>
5370
5371	</desc>
5372	<param name="property" type="CPUPropertyType" dir="in">
5373	<desc>
5374	Property type to query.
5375	</desc>
5376	</param>
5377	<param name="value" type="boolean" dir="in">
5378	<desc>
5379	Property value.
5380	</desc>
5381	</param>
5382	</method>
5383
5384	<method name="getCPUIDLeaf" const="yes">
5385	<desc>
5386	Returns the virtual CPU cpuid information for the specified leaf.
5387
5388	Currently supported index values for cpuid:
5389	Standard CPUID leafs: 0 - 0xA
5390	Extended CPUID leafs: 0x80000000 - 0x8000000A
5391
5392	See the Intel and AMD programmer's manuals for detailed information
5393	about the cpuid instruction and its leafs.
5394	<result name="E_INVALIDARG">
5395	Invalid id.
5396	</result>
5397
5398	</desc>
5399	<param name="id" type="unsigned long" dir="in">
5400	<desc>
5401	CPUID leaf index.
5402	</desc>
5403	</param>
5404	<param name="valEax" type="unsigned long" dir="out">
5405	<desc>
5406	CPUID leaf value for register eax.
5407	</desc>
5408	</param>
5409	<param name="valEbx" type="unsigned long" dir="out">
5410	<desc>
5411	CPUID leaf value for register ebx.
5412	</desc>
5413	</param>
5414	<param name="valEcx" type="unsigned long" dir="out">
5415	<desc>
5416	CPUID leaf value for register ecx.
5417	</desc>
5418	</param>
5419	<param name="valEdx" type="unsigned long" dir="out">
5420	<desc>
5421	CPUID leaf value for register edx.
5422	</desc>
5423	</param>
5424	</method>
5425
5426	<method name="setCPUIDLeaf">
5427	<desc>
5428	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5429	are not passed unmodified. VirtualBox clears features that it doesn't support.
5430
5431	Currently supported index values for cpuid:
5432	Standard CPUID leafs: 0 - 0xA
5433	Extended CPUID leafs: 0x80000000 - 0x8000000A
5434
5435	See the Intel and AMD programmer's manuals for detailed information
5436	about the cpuid instruction and its leafs.
5437
5438	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5439	random crashes inside VMs.
5440	<result name="E_INVALIDARG">
5441	Invalid id.
5442	</result>
5443
5444	</desc>
5445	<param name="id" type="unsigned long" dir="in">
5446	<desc>
5447	CPUID leaf index.
5448	</desc>
5449	</param>
5450	<param name="valEax" type="unsigned long" dir="in">
5451	<desc>
5452	CPUID leaf value for register eax.
5453	</desc>
5454	</param>
5455	<param name="valEbx" type="unsigned long" dir="in">
5456	<desc>
5457	CPUID leaf value for register ebx.
5458	</desc>
5459	</param>
5460	<param name="valEcx" type="unsigned long" dir="in">
5461	<desc>
5462	CPUID leaf value for register ecx.
5463	</desc>
5464	</param>
5465	<param name="valEdx" type="unsigned long" dir="in">
5466	<desc>
5467	CPUID leaf value for register edx.
5468	</desc>
5469	</param>
5470	</method>
5471
5472	<method name="removeCPUIDLeaf">
5473	<desc>
5474	Removes the virtual CPU cpuid leaf for the specified index
5475
5476	<result name="E_INVALIDARG">
5477	Invalid id.
5478	</result>
5479
5480	</desc>
5481	<param name="id" type="unsigned long" dir="in">
5482	<desc>
5483	CPUID leaf index.
5484	</desc>
5485	</param>
5486	</method>
5487
5488	<method name="removeAllCPUIDLeaves">
5489	<desc>
5490	Removes all the virtual CPU cpuid leaves
5491	</desc>
5492	</method>
5493
5494	<method name="getHWVirtExProperty" const="yes">
5495	<desc>
5496	Returns the value of the specified hardware virtualization boolean property.
5497
5498	<result name="E_INVALIDARG">
5499	Invalid property.
5500	</result>
5501
5502	</desc>
5503	<param name="property" type="HWVirtExPropertyType" dir="in">
5504	<desc>
5505	Property type to query.
5506	</desc>
5507	</param>
5508	<param name="value" type="boolean" dir="return">
5509	<desc>
5510	Property value.
5511	</desc>
5512	</param>
5513	</method>
5514
5515	<method name="setHWVirtExProperty">
5516	<desc>
5517	Sets a new value for the specified hardware virtualization boolean property.
5518
5519	<result name="E_INVALIDARG">
5520	Invalid property.
5521	</result>
5522
5523	</desc>
5524	<param name="property" type="HWVirtExPropertyType" dir="in">
5525	<desc>
5526	Property type to set.
5527	</desc>
5528	</param>
5529	<param name="value" type="boolean" dir="in">
5530	<desc>
5531	New property value.
5532	</desc>
5533	</param>
5534	</method>
5535
5536	<method name="saveSettings">
5537	<desc>
5538	Saves any changes to machine settings made since the session
5539	has been opened or a new machine has been created, or since the
5540	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5541	For registered machines, new settings become visible to all
5542	other VirtualBox clients after successful invocation of this
5543	method.
5544	<note>
5545	The method sends <link to="IMachineDataChangedEvent"/>
5546	notification event after the configuration has been successfully
5547	saved (only for registered machines).
5548	</note>
5549	<note>
5550	Calling this method is only valid on instances returned
5551	by <link to="ISession::machine"/> and on new machines
5552	created by <link to="IVirtualBox::createMachine"/> but not
5553	yet registered, or on unregistered machines after calling
5554	<link to="IMachine::unregister"/>.
5555	</note>
5556
5557	<result name="VBOX_E_FILE_ERROR">
5558	Settings file not accessible.
5559	</result>
5560	<result name="VBOX_E_XML_ERROR">
5561	Could not parse the settings file.
5562	</result>
5563	<result name="E_ACCESSDENIED">
5564	Modification request refused.
5565	</result>
5566
5567	</desc>
5568	</method>
5569
5570	<method name="discardSettings">
5571	<desc>
5572	Discards any changes to the machine settings made since the session
5573	has been opened or since the last call to <link to="#saveSettings"/>
5574	or <link to="#discardSettings"/>.
5575	<note>
5576	Calling this method is only valid on instances returned
5577	by <link to="ISession::machine"/> and on new machines
5578	created by <link to="IVirtualBox::createMachine"/> or
5579	opened by <link to="IVirtualBox::openMachine"/> but not
5580	yet registered, or on unregistered machines after calling
5581	<link to="IMachine::unregister"/>.
5582	</note>
5583
5584	<result name="VBOX_E_INVALID_VM_STATE">
5585	Virtual machine is not mutable.
5586	</result>
5587
5588	</desc>
5589	</method>
5590
5591	<method name="unregister">
5592	<desc>
5593	Unregisters a machine previously registered with
5594	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5595	cleanup before the machine is unregistered.
5596
5597	This method does not delete any files. It only changes the machine configuration and
5598	the list of registered machines in the VirtualBox object. To delete the files which
5599	belonged to the machine, including the XML file of the machine itself, call
5600	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5601	from this method.
5602
5603	How thoroughly this method cleans up the machine configuration before unregistering
5604	the machine depends on the @a cleanupMode argument.
5605
5606	<ul>
5607	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5608	cleanup will be performed. The call will fail if the machine is in "Saved" state
5609	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5610	It is the responsibility of the caller to delete all such configuration in this mode.
5611	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5612	which it replaces.</li>
5613	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5614	state or if it has snapshots or media attached. All media attached to the current machine
5615	state or in snapshots will be detached. No medium objects will be returned;
5616	all of the machine's media will remain open.</li>
5617	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5618	except that all the hard disk medium objects which were detached from the machine will
5619	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5620	API for closing and deletion.</li>
5621	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5622	that all media will be returned in the array, including removable media like DVDs and
5623	floppies. This might be useful if the user wants to inspect in detail which media were
5624	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5625	in that case because users will typically want to preserve ISO and RAW image files.</li>
5626	</ul>
5627
5628	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5629	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5630	deleted with all its saved states and hard disk images, but images for removable
5631	drives (such as ISO and RAW files) will remain on disk.
5632
5633	This API does not verify whether the media files returned in the array are still
5634	attached to other machines (i.e. shared between several machines). If such a shared
5635	image is passed to <link to="#delete" /> however, closing the image will fail there
5636	and the image will be silently skipped.
5637
5638	This API may, however, move media from this machine's media registry to other media
5639	registries (see <link to="IMedium" /> for details on media registries). For machines
5640	created with VirtualBox 4.0 or later, if media from this machine's media registry
5641	are also attached to another machine (shared attachments), each such medium will be
5642	moved to another machine's registry. This is because without this machine's media
5643	registry, the other machine cannot find its media any more and would become inaccessible.
5644
5645	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5646	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5647	if media are moved to other machines' media registries.
5648
5649	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5650	is fired.
5651
5652	The call will fail if the machine is currently locked (see <link to="ISession" />).
5653
5654	<note>
5655	If the given machine is inaccessible (see <link to="#accessible"/>), it
5656	will be unregistered and fully uninitialized right afterwards. As a result,
5657	the returned machine object will be unusable and an attempt to call
5658	<b>any</b> method will return the "Object not ready" error.
5659	</note>
5660
5661	<result name="VBOX_E_INVALID_OBJECT_STATE">
5662	Machine is currently locked for a session.
5663	</result>
5664	</desc>
5665
5666	<param name="cleanupMode" type="CleanupMode" dir="in">
5667	<desc>How to clean up after the machine has been unregistered.</desc>
5668	</param>
5669	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5670	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5671	</param>
5672	</method>
5673
5674	<method name="delete">
5675	<desc>
5676	Deletes the files associated with this machine from disk. If medium objects are passed
5677	in with the @a aMedia argument, they are closed and, if closing was successful, their
5678	storage files are deleted as well. For convenience, this array of media files can be
5679	the same as the one returned from a previous <link to="#unregister" /> call.
5680
5681	This method must only be called on machines which are either write-locked (i.e. on instances
5682	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5683	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5684	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5685
5686	The following files will be deleted by this method:
5687	<ul>
5688	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5689	argument other than "UnregisterOnly", this will delete all saved state files that
5690	the machine had in use; possibly one if the machine was in "Saved" state and one
5691	for each online snapshot that the machine had.</li>
5692	<li>On each medium object passed in the @a aMedia array, this will call
5693	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5694	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5695	in use, e.g. because it is still attached to a second machine; in that case the
5696	storage will not be deleted.</li>
5697	<li>Finally, the machine's own XML file will be deleted.</li>
5698	</ul>
5699
5700	Since deleting large disk image files can be a time-consuming I/O operation, this
5701	method operates asynchronously and returns an IProgress object to allow the caller
5702	to monitor the progress. There will be one sub-operation for each file that is
5703	being deleted (saved state or medium storage file).
5704
5705	<note>
5706	<link to="#settingsModified"/> will return @c true after this
5707	method successfully returns.
5708	</note>
5709
5710	<result name="VBOX_E_INVALID_VM_STATE">
5711	Machine is registered but not write-locked.
5712	</result>
5713	<result name="VBOX_E_IPRT_ERROR">
5714	Could not delete the settings file.
5715	</result>
5716	</desc>
5717	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5718	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5719	</param>
5720	<param name="aProgress" type="IProgress" dir="return">
5721	<desc>Progress object to track the operation completion.</desc>
5722	</param>
5723	</method>
5724
5725	<method name="export">
5726	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5727	steps required to export VirtualBox machines to OVF.
5728	</desc>
5729
5730	<param name="aAppliance" type="IAppliance" dir="in">
5731	<desc>Appliance to export this machine to.</desc>
5732	</param>
5733	<param name="location" type="wstring" dir="in">
5734	<desc>The target location.</desc>
5735	</param>
5736	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5737	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5738	</param>
5739	</method >
5740
5741	<method name="findSnapshot">
5742	<desc>
5743	Returns a snapshot of this machine with the given name or UUID.
5744
5745	Returns a snapshot of this machine with the given UUID.
5746	A @c null argument can be used to obtain the first snapshot
5747	taken on this machine. To traverse the whole tree of snapshots
5748	starting from the root, inspect the root snapshot's
5749	<link to="ISnapshot::children" /> attribute and recurse over those children.
5750
5751	<result name="VBOX_E_OBJECT_NOT_FOUND">
5752	Virtual machine has no snapshots or snapshot not found.
5753	</result>
5754
5755	</desc>
5756	<param name="nameOrId" type="wstring" dir="in">
5757	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5758	</param>
5759	<param name="snapshot" type="ISnapshot" dir="return">
5760	<desc>Snapshot object with the given name.</desc>
5761	</param>
5762	</method>
5763
5764	<method name="createSharedFolder">
5765	<desc>
5766	Creates a new permanent shared folder by associating the given logical
5767	name with the given host path, adds it to the collection of shared
5768	folders and starts sharing it. Refer to the description of
5769	<link to="ISharedFolder"/> to read more about logical names.
5770
5771	<result name="VBOX_E_OBJECT_IN_USE">
5772	Shared folder already exists.
5773	</result>
5774	<result name="VBOX_E_FILE_ERROR">
5775	Shared folder @a hostPath not accessible.
5776	</result>
5777
5778	</desc>
5779	<param name="name" type="wstring" dir="in">
5780	<desc>Unique logical name of the shared folder.</desc>
5781	</param>
5782	<param name="hostPath" type="wstring" dir="in">
5783	<desc>Full path to the shared folder in the host file system.</desc>
5784	</param>
5785	<param name="writable" type="boolean" dir="in">
5786	<desc>Whether the share is writable or readonly.</desc>
5787	</param>
5788	<param name="automount" type="boolean" dir="in">
5789	<desc>Whether the share gets automatically mounted by the guest
5790	or not.</desc>
5791	</param>
5792	</method>
5793
5794	<method name="removeSharedFolder">
5795	<desc>
5796	Removes the permanent shared folder with the given name previously
5797	created by <link to="#createSharedFolder"/> from the collection of
5798	shared folders and stops sharing it.
5799
5800	<result name="VBOX_E_INVALID_VM_STATE">
5801	Virtual machine is not mutable.
5802	</result>
5803	<result name="VBOX_E_OBJECT_NOT_FOUND">
5804	Shared folder @a name does not exist.
5805	</result>
5806
5807	</desc>
5808	<param name="name" type="wstring" dir="in">
5809	<desc>Logical name of the shared folder to remove.</desc>
5810	</param>
5811	</method>
5812
5813	<method name="canShowConsoleWindow">
5814	<desc>
5815	Returns @c true if the VM console process can activate the
5816	console window and bring it to foreground on the desktop of
5817	the host PC.
5818	<note>
5819	This method will fail if a session for this machine is not
5820	currently open.
5821	</note>
5822
5823	<result name="VBOX_E_INVALID_VM_STATE">
5824	Machine session is not open.
5825	</result>
5826
5827	</desc>
5828	<param name="canShow" type="boolean" dir="return">
5829	<desc>
5830	@c true if the console window can be shown and @c false otherwise.
5831	</desc>
5832	</param>
5833	</method>
5834
5835	<method name="showConsoleWindow">
5836	<desc>
5837	Activates the console window and brings it to foreground on
5838	the desktop of the host PC. Many modern window managers on
5839	many platforms implement some sort of focus stealing
5840	prevention logic, so that it may be impossible to activate
5841	a window without the help of the currently active
5842	application. In this case, this method will return a non-zero
5843	identifier that represents the top-level window of the VM
5844	console process. The caller, if it represents a currently
5845	active process, is responsible to use this identifier (in a
5846	platform-dependent manner) to perform actual window
5847	activation.
5848	<note>
5849	This method will fail if a session for this machine is not
5850	currently open.
5851	</note>
5852
5853	<result name="VBOX_E_INVALID_VM_STATE">
5854	Machine session is not open.
5855	</result>
5856
5857	</desc>
5858	<param name="winId" type="long long" dir="return">
5859	<desc>
5860	Platform-dependent identifier of the top-level VM console
5861	window, or zero if this method has performed all actions
5862	necessary to implement the <i>show window</i> semantics for
5863	the given platform and/or VirtualBox front-end.
5864	</desc>
5865	</param>
5866	</method>
5867
5868	<method name="getGuestProperty" const="yes">
5869	<desc>
5870	Reads an entry from the machine's guest property store.
5871
5872	<result name="VBOX_E_INVALID_VM_STATE">
5873	Machine session is not open.
5874	</result>
5875
5876	</desc>
5877	<param name="name" type="wstring" dir="in">
5878	<desc>
5879	The name of the property to read.
5880	</desc>
5881	</param>
5882	<param name="value" type="wstring" dir="out">
5883	<desc>
5884	The value of the property. If the property does not exist then this
5885	will be empty.
5886	</desc>
5887	</param>
5888	<param name="timestamp" type="long long" dir="out">
5889	<desc>
5890	The time at which the property was last modified, as seen by the
5891	server process.
5892	</desc>
5893	</param>
5894	<param name="flags" type="wstring" dir="out">
5895	<desc>
5896	Additional property parameters, passed as a comma-separated list of
5897	"name=value" type entries.
5898	</desc>
5899	</param>
5900	</method>
5901
5902	<method name="getGuestPropertyValue" const="yes">
5903	<desc>
5904	Reads a value from the machine's guest property store.
5905
5906	<result name="VBOX_E_INVALID_VM_STATE">
5907	Machine session is not open.
5908	</result>
5909
5910	</desc>
5911	<param name="property" type="wstring" dir="in">
5912	<desc>
5913	The name of the property to read.
5914	</desc>
5915	</param>
5916	<param name="value" type="wstring" dir="return">
5917	<desc>
5918	The value of the property. If the property does not exist then this
5919	will be empty.
5920	</desc>
5921	</param>
5922	</method>
5923
5924	<method name="getGuestPropertyTimestamp" const="yes">
5925	<desc>
5926	Reads a property timestamp from the machine's guest property store.
5927
5928	<result name="VBOX_E_INVALID_VM_STATE">
5929	Machine session is not open.
5930	</result>
5931
5932	</desc>
5933	<param name="property" type="wstring" dir="in">
5934	<desc>
5935	The name of the property to read.
5936	</desc>
5937	</param>
5938	<param name="value" type="long long" dir="return">
5939	<desc>
5940	The timestamp. If the property does not exist then this will be
5941	empty.
5942	</desc>
5943	</param>
5944	</method>
5945
5946	<method name="setGuestProperty">
5947	<desc>
5948	Sets, changes or deletes an entry in the machine's guest property
5949	store.
5950
5951	<result name="E_ACCESSDENIED">
5952	Property cannot be changed.
5953	</result>
5954	<result name="E_INVALIDARG">
5955	Invalid @a flags.
5956	</result>
5957	<result name="VBOX_E_INVALID_VM_STATE">
5958	Virtual machine is not mutable or session not open.
5959	</result>
5960	<result name="VBOX_E_INVALID_OBJECT_STATE">
5961	Cannot set transient property when machine not running.
5962	</result>
5963
5964	</desc>
5965	<param name="property" type="wstring" dir="in">
5966	<desc>
5967	The name of the property to set, change or delete.
5968	</desc>
5969	</param>
5970	<param name="value" type="wstring" dir="in">
5971	<desc>
5972	The new value of the property to set, change or delete. If the
5973	property does not yet exist and value is non-empty, it will be
5974	created. If the value is @c null or empty, the property will be
5975	deleted if it exists.
5976	</desc>
5977	</param>
5978	<param name="flags" type="wstring" dir="in">
5979	<desc>
5980	Additional property parameters, passed as a comma-separated list of
5981	"name=value" type entries.
5982	</desc>
5983	</param>
5984	</method>
5985
5986	<method name="setGuestPropertyValue">
5987	<desc>
5988	Sets, changes or deletes a value in the machine's guest property
5989	store. The flags field will be left unchanged or created empty for a
5990	new property.
5991
5992	<result name="E_ACCESSDENIED">
5993	Property cannot be changed.
5994	</result>
5995	<result name="VBOX_E_INVALID_VM_STATE">
5996	Virtual machine is not mutable or session not open.
5997	</result>
5998	<result name="VBOX_E_INVALID_OBJECT_STATE">
5999	Cannot set transient property when machine not running.
6000	</result>
6001	</desc>
6002
6003	<param name="property" type="wstring" dir="in">
6004	<desc>
6005	The name of the property to set, change or delete.
6006	</desc>
6007	</param>
6008	<param name="value" type="wstring" dir="in">
6009	<desc>
6010	The new value of the property to set, change or delete. If the
6011	property does not yet exist and value is non-empty, it will be
6012	created. If the value is @c null or empty, the property will be
6013	deleted if it exists.
6014	</desc>
6015	</param>
6016	</method>
6017
6018	<method name="deleteGuestProperty" const="yes">
6019	<desc>
6020	Deletes an entry from the machine's guest property store.
6021
6022	<result name="VBOX_E_INVALID_VM_STATE">
6023	Machine session is not open.
6024	</result>
6025
6026	</desc>
6027	<param name="name" type="wstring" dir="in">
6028	<desc>
6029	The name of the property to delete.
6030	</desc>
6031	</param>
6032	</method>
6033
6034	<method name="enumerateGuestProperties" const="yes">
6035	<desc>
6036	Return a list of the guest properties matching a set of patterns along
6037	with their values, time stamps and flags.
6038	</desc>
6039	<param name="patterns" type="wstring" dir="in">
6040	<desc>
6041	The patterns to match the properties against, separated by '\|'
6042	characters. If this is empty or @c null, all properties will match.
6043	</desc>
6044	</param>
6045	<param name="name" type="wstring" dir="out" safearray="yes">
6046	<desc>
6047	The names of the properties returned.
6048	</desc>
6049	</param>
6050	<param name="value" type="wstring" dir="out" safearray="yes">
6051	<desc>
6052	The values of the properties returned. The array entries match the
6053	corresponding entries in the @a name array.
6054	</desc>
6055	</param>
6056	<param name="timestamp" type="long long" dir="out" safearray="yes">
6057	<desc>
6058	The time stamps of the properties returned. The array entries match
6059	the corresponding entries in the @a name array.
6060	</desc>
6061	</param>
6062	<param name="flags" type="wstring" dir="out" safearray="yes">
6063	<desc>
6064	The flags of the properties returned. The array entries match the
6065	corresponding entries in the @a name array.
6066	</desc>
6067	</param>
6068	</method>
6069
6070	<method name="querySavedGuestScreenInfo" const="yes">
6071	<desc>
6072	Returns the guest dimensions from the saved state.
6073	</desc>
6074	<param name="screenId" type="unsigned long" dir="in">
6075	<desc>
6076	Saved guest screen to query info from.
6077	</desc>
6078	</param>
6079	<param name="originX" type="unsigned long" dir="out">
6080	<desc>
6081	The X position of the guest monitor top left corner.
6082	</desc>
6083	</param>
6084	<param name="originY" type="unsigned long" dir="out">
6085	<desc>
6086	The Y position of the guest monitor top left corner.
6087	</desc>
6088	</param>
6089	<param name="width" type="unsigned long" dir="out">
6090	<desc>
6091	Guest width at the time of the saved state was taken.
6092	</desc>
6093	</param>
6094	<param name="height" type="unsigned long" dir="out">
6095	<desc>
6096	Guest height at the time of the saved state was taken.
6097	</desc>
6098	</param>
6099	<param name="enabled" type="boolean" dir="out">
6100	<desc>
6101	Whether the monitor is enabled in the guest.
6102	</desc>
6103	</param>
6104	</method>
6105
6106	<method name="querySavedThumbnailSize">
6107	<desc>
6108	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6109	</desc>
6110	<param name="screenId" type="unsigned long" dir="in">
6111	<desc>
6112	Saved guest screen to query info from.
6113	</desc>
6114	</param>
6115	<param name="size" type="unsigned long" dir="out">
6116	<desc>
6117	Size of buffer required to store the bitmap.
6118	</desc>
6119	</param>
6120	<param name="width" type="unsigned long" dir="out">
6121	<desc>
6122	Bitmap width.
6123	</desc>
6124	</param>
6125	<param name="height" type="unsigned long" dir="out">
6126	<desc>
6127	Bitmap height.
6128	</desc>
6129	</param>
6130	</method>
6131
6132	<method name="readSavedThumbnailToArray">
6133	<desc>
6134	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6135	</desc>
6136	<param name="screenId" type="unsigned long" dir="in">
6137	<desc>
6138	Saved guest screen to read from.
6139	</desc>
6140	</param>
6141	<param name="BGR" type="boolean" dir="in">
6142	<desc>
6143	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6144	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6145	</desc>
6146	</param>
6147	<param name="width" type="unsigned long" dir="out">
6148	<desc>
6149	Bitmap width.
6150	</desc>
6151	</param>
6152	<param name="height" type="unsigned long" dir="out">
6153	<desc>
6154	Bitmap height.
6155	</desc>
6156	</param>
6157	<param name="data" type="octet" safearray="yes" dir="return">
6158	<desc>
6159	Array with resulting bitmap data.
6160	</desc>
6161	</param>
6162	</method>
6163
6164	<method name="readSavedThumbnailPNGToArray">
6165	<desc>
6166	Thumbnail in PNG format is retrieved to an array of bytes.
6167	</desc>
6168	<param name="screenId" type="unsigned long" dir="in">
6169	<desc>
6170	Saved guest screen to read from.
6171	</desc>
6172	</param>
6173	<param name="width" type="unsigned long" dir="out">
6174	<desc>
6175	Image width.
6176	</desc>
6177	</param>
6178	<param name="height" type="unsigned long" dir="out">
6179	<desc>
6180	Image height.
6181	</desc>
6182	</param>
6183	<param name="data" type="octet" dir="return" safearray="yes">
6184	<desc>
6185	Array with resulting PNG data.
6186	</desc>
6187	</param>
6188	</method>
6189
6190	<method name="querySavedScreenshotPNGSize">
6191	<desc>
6192	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6193	</desc>
6194	<param name="screenId" type="unsigned long" dir="in">
6195	<desc>
6196	Saved guest screen to query info from.
6197	</desc>
6198	</param>
6199	<param name="size" type="unsigned long" dir="out">
6200	<desc>
6201	Size of buffer required to store the PNG binary data.
6202	</desc>
6203	</param>
6204	<param name="width" type="unsigned long" dir="out">
6205	<desc>
6206	Image width.
6207	</desc>
6208	</param>
6209	<param name="height" type="unsigned long" dir="out">
6210	<desc>
6211	Image height.
6212	</desc>
6213	</param>
6214	</method>
6215
6216	<method name="readSavedScreenshotPNGToArray">
6217	<desc>
6218	Screenshot in PNG format is retrieved to an array of bytes.
6219	</desc>
6220	<param name="screenId" type="unsigned long" dir="in">
6221	<desc>
6222	Saved guest screen to read from.
6223	</desc>
6224	</param>
6225	<param name="width" type="unsigned long" dir="out">
6226	<desc>
6227	Image width.
6228	</desc>
6229	</param>
6230	<param name="height" type="unsigned long" dir="out">
6231	<desc>
6232	Image height.
6233	</desc>
6234	</param>
6235	<param name="data" type="octet" dir="return" safearray="yes">
6236	<desc>
6237	Array with resulting PNG data.
6238	</desc>
6239	</param>
6240	</method>
6241
6242	<method name="hotPlugCPU">
6243	<desc>
6244	Plugs a CPU into the machine.
6245	</desc>
6246	<param name="cpu" type="unsigned long" dir="in">
6247	<desc>
6248	The CPU id to insert.
6249	</desc>
6250	</param>
6251	</method>
6252
6253	<method name="hotUnplugCPU">
6254	<desc>
6255	Removes a CPU from the machine.
6256	</desc>
6257	<param name="cpu" type="unsigned long" dir="in">
6258	<desc>
6259	The CPU id to remove.
6260	</desc>
6261	</param>
6262	</method>
6263
6264	<method name="getCPUStatus">
6265	<desc>
6266	Returns the current status of the given CPU.
6267	</desc>
6268	<param name="cpu" type="unsigned long" dir="in">
6269	<desc>
6270	The CPU id to check for.
6271	</desc>
6272	</param>
6273	<param name="attached" type="boolean" dir="return">
6274	<desc>
6275	Status of the CPU.
6276	</desc>
6277	</param>
6278	</method>
6279
6280	<method name="queryLogFilename">
6281	<desc>
6282	Queries for the VM log file name of an given index. Returns an empty
6283	string if a log file with that index doesn't exists.
6284	</desc>
6285	<param name="idx" type="unsigned long" dir="in">
6286	<desc>
6287	Which log file name to query. 0=current log file.
6288	</desc>
6289	</param>
6290	<param name="filename" type="wstring" dir="return">
6291	<desc>
6292	On return the full path to the log file or an empty string on error.
6293	</desc>
6294	</param>
6295	</method>
6296
6297	<method name="readLog">
6298	<desc>
6299	Reads the VM log file. The chunk size is limited, so even if you
6300	ask for a big piece there might be less data returned.
6301	</desc>
6302	<param name="idx" type="unsigned long" dir="in">
6303	<desc>
6304	Which log file to read. 0=current log file.
6305	</desc>
6306	</param>
6307	<param name="offset" type="long long" dir="in">
6308	<desc>
6309	Offset in the log file.
6310	</desc>
6311	</param>
6312	<param name="size" type="long long" dir="in">
6313	<desc>
6314	Chunk size to read in the log file.
6315	</desc>
6316	</param>
6317	<param name="data" type="octet" dir="return" safearray="yes">
6318	<desc>
6319	Data read from the log file. A data size of 0 means end of file
6320	if the requested chunk size was not 0. This is the unprocessed
6321	file data, i.e. the line ending style depends on the platform of
6322	the system the server is running on.
6323	</desc>
6324	</param>
6325	</method>
6326
6327	<method name="cloneTo">
6328	<desc>
6329	Creates a clone of this machine, either as a full clone (which means
6330	creating independent copies of the hard disk media, save states and so
6331	on), or as a linked clone (which uses its own differencing media,
6332	sharing the parent media with the source machine).
6333
6334	The target machine object must have been created previously with <link
6335	to="IVirtualBox::createMachine"/>, and all the settings will be
6336	transferred except the VM name and the hardware UUID. You can set the
6337	VM name and the new hardware UUID when creating the target machine. The
6338	network MAC addresses are newly created for all newtwork adapters. You
6339	can change that behaviour with the options parameter. The operation is
6340	performed asynchronously, so the machine object will be not be usable
6341	until the @a progress object signals completion.
6342
6343	<result name="E_INVALIDARG">
6344	@a target is @c null.
6345	</result>
6346	</desc>
6347
6348	<param name="target" type="IMachine" dir="in">
6349	<desc>Target machine object.</desc>
6350	</param>
6351	<param name="mode" type="CloneMode" dir="in">
6352	<desc>Which states should be cloned.</desc>
6353	</param>
6354	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6355	<desc>Options for the cloning operation.</desc>
6356	</param>
6357	<param name="progress" type="IProgress" dir="return">
6358	<desc>Progress object to track the operation completion.</desc>
6359	</param>
6360	</method>
6361
6362	</interface>
6363
6364	<!--
6365	// IConsole
6366	/////////////////////////////////////////////////////////////////////////
6367	-->
6368
6369	<interface
6370	name="IVRDEServerInfo" extends="$unknown"
6371	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6372	wsmap="struct"
6373	>
6374	<desc>
6375	Contains information about the remote desktop (VRDE) server capabilities and status.
6376	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6377	</desc>
6378
6379	<attribute name="active" type="boolean" readonly="yes">
6380	<desc>
6381	Whether the remote desktop connection is active.
6382	</desc>
6383	</attribute>
6384
6385	<attribute name="port" type="long" readonly="yes">
6386	<desc>
6387	VRDE server port number. If this property is equal to <tt>0</tt>, then
6388	the VRDE server failed to start, usually because there are no free IP
6389	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6390	server has not yet been started.
6391	</desc>
6392	</attribute>
6393
6394	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6395	<desc>
6396	How many times a client connected.
6397	</desc>
6398	</attribute>
6399
6400	<attribute name="beginTime" type="long long" readonly="yes">
6401	<desc>
6402	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6403	</desc>
6404	</attribute>
6405
6406	<attribute name="endTime" type="long long" readonly="yes">
6407	<desc>
6408	When the last connection was terminated or the current time, if
6409	connection is still active, in milliseconds since 1970-01-01 UTC.
6410	</desc>
6411	</attribute>
6412
6413	<attribute name="bytesSent" type="long long" readonly="yes">
6414	<desc>
6415	How many bytes were sent in last or current, if still active, connection.
6416	</desc>
6417	</attribute>
6418
6419	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6420	<desc>
6421	How many bytes were sent in all connections.
6422	</desc>
6423	</attribute>
6424
6425	<attribute name="bytesReceived" type="long long" readonly="yes">
6426	<desc>
6427	How many bytes were received in last or current, if still active, connection.
6428	</desc>
6429	</attribute>
6430
6431	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6432	<desc>
6433	How many bytes were received in all connections.
6434	</desc>
6435	</attribute>
6436
6437	<attribute name="user" type="wstring" readonly="yes">
6438	<desc>
6439	Login user name supplied by the client.
6440	</desc>
6441	</attribute>
6442
6443	<attribute name="domain" type="wstring" readonly="yes">
6444	<desc>
6445	Login domain name supplied by the client.
6446	</desc>
6447	</attribute>
6448
6449	<attribute name="clientName" type="wstring" readonly="yes">
6450	<desc>
6451	The client name supplied by the client.
6452	</desc>
6453	</attribute>
6454
6455	<attribute name="clientIP" type="wstring" readonly="yes">
6456	<desc>
6457	The IP address of the client.
6458	</desc>
6459	</attribute>
6460
6461	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6462	<desc>
6463	The client software version number.
6464	</desc>
6465	</attribute>
6466
6467	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6468	<desc>
6469	Public key exchange method used when connection was established.
6470	Values: 0 - RDP4 public key exchange scheme.
6471	1 - X509 certificates were sent to client.
6472	</desc>
6473	</attribute>
6474
6475	</interface>
6476
6477	<interface
6478	name="IConsole" extends="$unknown"
6479	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6480	wsmap="managed"
6481	>
6482	<desc>
6483	The IConsole interface represents an interface to control virtual
6484	machine execution.
6485
6486	A console object gets created when a machine has been locked for a
6487	particular session (client process) using <link to="IMachine::lockMachine" />
6488	or <link to="IMachine::launchVMProcess"/>. The console object can
6489	then be found in the session's <link to="ISession::console" /> attribute.
6490
6491	Methods of the IConsole interface allow the caller to query the current
6492	virtual machine execution state, pause the machine or power it down, save
6493	the machine state or take a snapshot, attach and detach removable media
6494	and so on.
6495
6496	<see><link to="ISession"/></see>
6497	</desc>
6498
6499	<attribute name="machine" type="IMachine" readonly="yes">
6500	<desc>
6501	Machine object for this console session.
6502	<note>
6503	This is a convenience property, it has the same value as
6504	<link to="ISession::machine"/> of the corresponding session
6505	object.
6506	</note>
6507	</desc>
6508	</attribute>
6509
6510	<attribute name="state" type="MachineState" readonly="yes">
6511	<desc>
6512	Current execution state of the machine.
6513	<note>
6514	This property always returns the same value as the corresponding
6515	property of the IMachine object for this console session.
6516	For the process that owns (executes) the VM, this is the
6517	preferable way of querying the VM state, because no IPC
6518	calls are made.
6519	</note>
6520	</desc>
6521	</attribute>
6522
6523	<attribute name="guest" type="IGuest" readonly="yes">
6524	<desc>Guest object.</desc>
6525	</attribute>
6526
6527	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6528	<desc>
6529	Virtual keyboard object.
6530	<note>
6531	If the machine is not running, any attempt to use
6532	the returned object will result in an error.
6533	</note>
6534	</desc>
6535	</attribute>
6536
6537	<attribute name="mouse" type="IMouse" readonly="yes">
6538	<desc>
6539	Virtual mouse object.
6540	<note>
6541	If the machine is not running, any attempt to use
6542	the returned object will result in an error.
6543	</note>
6544	</desc>
6545	</attribute>
6546
6547	<attribute name="display" type="IDisplay" readonly="yes">
6548	<desc>Virtual display object.
6549	<note>
6550	If the machine is not running, any attempt to use
6551	the returned object will result in an error.
6552	</note>
6553	</desc>
6554	</attribute>
6555
6556	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6557	<desc>Debugging interface.</desc>
6558	</attribute>
6559
6560	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6561	<desc>
6562	Collection of USB devices currently attached to the virtual
6563	USB controller.
6564	<note>
6565	The collection is empty if the machine is not running.
6566	</note>
6567	</desc>
6568	</attribute>
6569
6570	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6571	<desc>
6572	List of USB devices currently attached to the remote VRDE client.
6573	Once a new device is physically attached to the remote host computer,
6574	it appears in this list and remains there until detached.
6575	</desc>
6576	</attribute>
6577
6578	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6579	<desc>
6580	Collection of shared folders for the current session. These folders
6581	are called transient shared folders because they are available to the
6582	guest OS running inside the associated virtual machine only for the
6583	duration of the session (as opposed to
6584	<link to="IMachine::sharedFolders"/> which represent permanent shared
6585	folders). When the session is closed (e.g. the machine is powered down),
6586	these folders are automatically discarded.
6587
6588	New shared folders are added to the collection using
6589	<link to="#createSharedFolder"/>. Existing shared folders can be
6590	removed using <link to="#removeSharedFolder"/>.
6591	</desc>
6592	</attribute>
6593
6594	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6595	<desc>
6596	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6597	</desc>
6598	</attribute>
6599
6600	<attribute name="eventSource" type="IEventSource" readonly="yes">
6601	<desc>
6602	Event source for console events.
6603	</desc>
6604	</attribute>
6605
6606	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6607	<desc>Array of PCI devices attached to this machine.</desc>
6608	</attribute>
6609
6610	<attribute name="useHostClipboard" type="boolean">
6611	<desc>
6612	Whether the guest clipboard should be connected to the host one or
6613	whether it should only be allowed access to the VRDE clipboard. This
6614	setting may not affect existing guest clipboard connections which
6615	are already connected to the host clipboard.
6616	</desc>
6617	</attribute>
6618
6619	<method name="powerUp">
6620	<desc>
6621	Starts the virtual machine execution using the current machine
6622	state (that is, its current execution state, current settings and
6623	current storage devices).
6624
6625	<note>
6626	This method is only useful for front-ends that want to actually
6627	execute virtual machines in their own process (like the VirtualBox
6628	or VBoxSDL front-ends). Unless you are intending to write such a
6629	front-end, do not call this method. If you simply want to
6630	start virtual machine execution using one of the existing front-ends
6631	(for example the VirtualBox GUI or headless server), use
6632	<link to="IMachine::launchVMProcess"/> instead; these
6633	front-ends will power up the machine automatically for you.
6634	</note>
6635
6636	If the machine is powered off or aborted, the execution will
6637	start from the beginning (as if the real hardware were just
6638	powered on).
6639
6640	If the machine is in the <link to="MachineState_Saved"/> state,
6641	it will continue its execution the point where the state has
6642	been saved.
6643
6644	If the machine <link to="IMachine::teleporterEnabled"/> property is
6645	enabled on the machine being powered up, the machine will wait for an
6646	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6647	state. The returned progress object will have at least three
6648	operations where the last three are defined as: (1) powering up and
6649	starting TCP server, (2) waiting for incoming teleportations, and
6650	(3) perform teleportation. These operations will be reflected as the
6651	last three operations of the progress objected returned by
6652	<link to="IMachine::launchVMProcess"/> as well.
6653
6654	<see><link to="#saveState"/></see>
6655
6656	<result name="VBOX_E_INVALID_VM_STATE">
6657	Virtual machine already running.
6658	</result>
6659	<result name="VBOX_E_HOST_ERROR">
6660	Host interface does not exist or name not set.
6661	</result>
6662	<result name="VBOX_E_FILE_ERROR">
6663	Invalid saved state file.
6664	</result>
6665	</desc>
6666	<param name="progress" type="IProgress" dir="return">
6667	<desc>Progress object to track the operation completion.</desc>
6668	</param>
6669	</method>
6670
6671	<method name="powerUpPaused">
6672	<desc>
6673	Identical to powerUp except that the VM will enter the
6674	<link to="MachineState_Paused"/> state, instead of
6675	<link to="MachineState_Running"/>.
6676
6677	<see><link to="#powerUp"/></see>
6678	<result name="VBOX_E_INVALID_VM_STATE">
6679	Virtual machine already running.
6680	</result>
6681	<result name="VBOX_E_HOST_ERROR">
6682	Host interface does not exist or name not set.
6683	</result>
6684	<result name="VBOX_E_FILE_ERROR">
6685	Invalid saved state file.
6686	</result>
6687	</desc>
6688	<param name="progress" type="IProgress" dir="return">
6689	<desc>Progress object to track the operation completion.</desc>
6690	</param>
6691	</method>
6692
6693	<method name="powerDown">
6694	<desc>
6695	Initiates the power down procedure to stop the virtual machine
6696	execution.
6697
6698	The completion of the power down procedure is tracked using the returned
6699	IProgress object. After the operation is complete, the machine will go
6700	to the PoweredOff state.
6701	<result name="VBOX_E_INVALID_VM_STATE">
6702	Virtual machine must be Running, Paused or Stuck to be powered down.
6703	</result>
6704	</desc>
6705	<param name="progress" type="IProgress" dir="return">
6706	<desc>Progress object to track the operation completion.</desc>
6707	</param>
6708	</method>
6709
6710	<method name="reset">
6711	<desc>Resets the virtual machine.
6712	<result name="VBOX_E_INVALID_VM_STATE">
6713	Virtual machine not in Running state.
6714	</result>
6715	<result name="VBOX_E_VM_ERROR">
6716	Virtual machine error in reset operation.
6717	</result>
6718	</desc>
6719	</method>
6720
6721	<method name="pause">
6722	<desc>Pauses the virtual machine execution.
6723	<result name="VBOX_E_INVALID_VM_STATE">
6724	Virtual machine not in Running state.
6725	</result>
6726	<result name="VBOX_E_VM_ERROR">
6727	Virtual machine error in suspend operation.
6728	</result>
6729	</desc>
6730	</method>
6731
6732	<method name="resume">
6733	<desc>Resumes the virtual machine execution.
6734	<result name="VBOX_E_INVALID_VM_STATE">
6735	Virtual machine not in Paused state.
6736	</result>
6737	<result name="VBOX_E_VM_ERROR">
6738	Virtual machine error in resume operation.
6739	</result>
6740	</desc>
6741	</method>
6742
6743	<method name="powerButton">
6744	<desc>Sends the ACPI power button event to the guest.
6745	<result name="VBOX_E_INVALID_VM_STATE">
6746	Virtual machine not in Running state.
6747	</result>
6748	<result name="VBOX_E_PDM_ERROR">
6749	Controlled power off failed.
6750	</result>
6751	</desc>
6752	</method>
6753
6754	<method name="sleepButton">
6755	<desc>Sends the ACPI sleep button event to the guest.
6756	<result name="VBOX_E_INVALID_VM_STATE">
6757	Virtual machine not in Running state.
6758	</result>
6759	<result name="VBOX_E_PDM_ERROR">
6760	Sending sleep button event failed.
6761	</result>
6762	</desc>
6763	</method>
6764
6765	<method name="getPowerButtonHandled">
6766	<desc>Checks if the last power button event was handled by guest.
6767	<result name="VBOX_E_PDM_ERROR">
6768	Checking if the event was handled by the guest OS failed.
6769	</result>
6770	</desc>
6771	<param name="handled" type="boolean" dir="return"/>
6772	</method>
6773
6774	<method name="getGuestEnteredACPIMode">
6775	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6776	G1 (sleeping). If this method returns @c false, the guest will
6777	most likely not respond to external ACPI events.
6778	<result name="VBOX_E_INVALID_VM_STATE">
6779	Virtual machine not in Running state.
6780	</result>
6781	</desc>
6782	<param name="entered" type="boolean" dir="return"/>
6783	</method>
6784
6785	<method name="saveState">
6786	<desc>
6787	Saves the current execution state of a running virtual machine
6788	and stops its execution.
6789
6790	After this operation completes, the machine will go to the
6791	Saved state. Next time it is powered up, this state will
6792	be restored and the machine will continue its execution from
6793	the place where it was saved.
6794
6795	This operation differs from taking a snapshot to the effect
6796	that it doesn't create new differencing media. Also, once
6797	the machine is powered up from the state saved using this method,
6798	the saved state is deleted, so it will be impossible to return
6799	to this state later.
6800
6801	<note>
6802	On success, this method implicitly calls
6803	<link to="IMachine::saveSettings"/> to save all current machine
6804	settings (including runtime changes to the DVD medium, etc.).
6805	Together with the impossibility to change any VM settings when it is
6806	in the Saved state, this guarantees adequate hardware
6807	configuration of the machine when it is restored from the saved
6808	state file.
6809	</note>
6810
6811	<note>
6812	The machine must be in the Running or Paused state, otherwise
6813	the operation will fail.
6814	</note>
6815	<result name="VBOX_E_INVALID_VM_STATE">
6816	Virtual machine state neither Running nor Paused.
6817	</result>
6818	<result name="VBOX_E_FILE_ERROR">
6819	Failed to create directory for saved state file.
6820	</result>
6821
6822	<see><link to="#takeSnapshot"/></see>
6823	</desc>
6824	<param name="progress" type="IProgress" dir="return">
6825	<desc>Progress object to track the operation completion.</desc>
6826	</param>
6827	</method>
6828
6829	<method name="adoptSavedState">
6830	<desc>
6831	Associates the given saved state file to the virtual machine.
6832
6833	On success, the machine will go to the Saved state. Next time it is
6834	powered up, it will be restored from the adopted saved state and
6835	continue execution from the place where the saved state file was
6836	created.
6837
6838	The specified saved state file path may be absolute or relative to the
6839	folder the VM normally saves the state to (usually,
6840	<link to="IMachine::snapshotFolder"/>).
6841
6842	<note>
6843	It's a caller's responsibility to make sure the given saved state
6844	file is compatible with the settings of this virtual machine that
6845	represent its virtual hardware (memory size, storage disk configuration
6846	etc.). If there is a mismatch, the behavior of the virtual machine
6847	is undefined.
6848	</note>
6849	<result name="VBOX_E_INVALID_VM_STATE">
6850	Virtual machine state neither PoweredOff nor Aborted.
6851	</result>
6852	</desc>
6853	<param name="savedStateFile" type="wstring" dir="in">
6854	<desc>Path to the saved state file to adopt.</desc>
6855	</param>
6856	</method>
6857
6858	<method name="discardSavedState">
6859	<desc>
6860	Forcibly resets the machine to "Powered Off" state if it is
6861	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6862	Next time the machine is powered up, a clean boot will occur.
6863	<note>
6864	This operation is equivalent to resetting or powering off
6865	the machine without doing a proper shutdown of the guest
6866	operating system; as with resetting a running phyiscal
6867	computer, it can can lead to data loss.
6868	</note>
6869	If @a fRemoveFile is @c true, the file in the machine directory
6870	into which the machine state was saved is also deleted. If
6871	this is @c false, then the state can be recovered and later
6872	re-inserted into a machine using <link to="#adoptSavedState" />.
6873	The location of the file can be found in the
6874	<link to="IMachine::stateFilePath" /> attribute.
6875	<result name="VBOX_E_INVALID_VM_STATE">
6876	Virtual machine not in state Saved.
6877	</result>
6878	</desc>
6879	<param name="fRemoveFile" type="boolean" dir="in" >
6880	<desc>Whether to also remove the saved state file.</desc>
6881	</param>
6882	</method>
6883
6884	<method name="getDeviceActivity">
6885	<desc>
6886	Gets the current activity type of a given device or device group.
6887	<result name="E_INVALIDARG">
6888	Invalid device type.
6889	</result>
6890	</desc>
6891	<param name="type" type="DeviceType" dir="in"/>
6892	<param name="activity" type="DeviceActivity" dir="return"/>
6893	</method>
6894
6895	<method name="attachUSBDevice">
6896	<desc>
6897	Attaches a host USB device with the given UUID to the
6898	USB controller of the virtual machine.
6899
6900	The device needs to be in one of the following states:
6901	<link to="USBDeviceState_Busy"/>,
6902	<link to="USBDeviceState_Available"/> or
6903	<link to="USBDeviceState_Held"/>,
6904	otherwise an error is immediately returned.
6905
6906	When the device state is
6907	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6908	be returned if the host computer refuses to release it for some reason.
6909
6910	<see><link to="IUSBController::deviceFilters"/>,
6911	<link to="USBDeviceState"/></see>
6912	<result name="VBOX_E_INVALID_VM_STATE">
6913	Virtual machine state neither Running nor Paused.
6914	</result>
6915	<result name="VBOX_E_PDM_ERROR">
6916	Virtual machine does not have a USB controller.
6917	</result>
6918	</desc>
6919	<param name="id" type="uuid" mod="string" dir="in">
6920	<desc>UUID of the host USB device to attach.</desc>
6921	</param>
6922	</method>
6923
6924	<method name="detachUSBDevice">
6925	<desc>
6926	Detaches an USB device with the given UUID from the USB controller
6927	of the virtual machine.
6928
6929	After this method succeeds, the VirtualBox server re-initiates
6930	all USB filters as if the device were just physically attached
6931	to the host, but filters of this machine are ignored to avoid
6932	a possible automatic re-attachment.
6933
6934	<see><link to="IUSBController::deviceFilters"/>,
6935	<link to="USBDeviceState"/></see>
6936
6937	<result name="VBOX_E_PDM_ERROR">
6938	Virtual machine does not have a USB controller.
6939	</result>
6940	<result name="E_INVALIDARG">
6941	USB device not attached to this virtual machine.
6942	</result>
6943	</desc>
6944	<param name="id" type="uuid" mod="string" dir="in">
6945	<desc>UUID of the USB device to detach.</desc>
6946	</param>
6947	<param name="device" type="IUSBDevice" dir="return">
6948	<desc>Detached USB device.</desc>
6949	</param>
6950	</method>
6951
6952	<method name="findUSBDeviceByAddress">
6953	<desc>
6954	Searches for a USB device with the given host address.
6955
6956	<result name="VBOX_E_OBJECT_NOT_FOUND">
6957	Given @c name does not correspond to any USB device.
6958	</result>
6959
6960	<see><link to="IUSBDevice::address"/></see>
6961	</desc>
6962	<param name="name" type="wstring" dir="in">
6963	<desc>
6964	Address of the USB device (as assigned by the host) to
6965	search for.
6966	</desc>
6967	</param>
6968	<param name="device" type="IUSBDevice" dir="return">
6969	<desc>Found USB device object.</desc>
6970	</param>
6971	</method>
6972
6973	<method name="findUSBDeviceById">
6974	<desc>
6975	Searches for a USB device with the given UUID.
6976
6977	<result name="VBOX_E_OBJECT_NOT_FOUND">
6978	Given @c id does not correspond to any USB device.
6979	</result>
6980
6981	<see><link to="IUSBDevice::id"/></see>
6982	</desc>
6983	<param name="id" type="uuid" mod="string" dir="in">
6984	<desc>UUID of the USB device to search for.</desc>
6985	</param>
6986	<param name="device" type="IUSBDevice" dir="return">
6987	<desc>Found USB device object.</desc>
6988	</param>
6989	</method>
6990
6991	<method name="createSharedFolder">
6992	<desc>
6993	Creates a transient new shared folder by associating the given logical
6994	name with the given host path, adds it to the collection of shared
6995	folders and starts sharing it. Refer to the description of
6996	<link to="ISharedFolder"/> to read more about logical names.
6997
6998	<result name="VBOX_E_INVALID_VM_STATE">
6999	Virtual machine in Saved state or currently changing state.
7000	</result>
7001	<result name="VBOX_E_FILE_ERROR">
7002	Shared folder already exists or not accessible.
7003	</result>
7004	</desc>
7005	<param name="name" type="wstring" dir="in">
7006	<desc>Unique logical name of the shared folder.</desc>
7007	</param>
7008	<param name="hostPath" type="wstring" dir="in">
7009	<desc>Full path to the shared folder in the host file system.</desc>
7010	</param>
7011	<param name="writable" type="boolean" dir="in">
7012	<desc>Whether the share is writable or readonly</desc>
7013	</param>
7014	<param name="automount" type="boolean" dir="in">
7015	<desc>Whether the share gets automatically mounted by the guest
7016	or not.</desc>
7017	</param>
7018	</method>
7019
7020	<method name="removeSharedFolder">
7021	<desc>
7022	Removes a transient shared folder with the given name previously
7023	created by <link to="#createSharedFolder"/> from the collection of
7024	shared folders and stops sharing it.
7025	<result name="VBOX_E_INVALID_VM_STATE">
7026	Virtual machine in Saved state or currently changing state.
7027	</result>
7028	<result name="VBOX_E_FILE_ERROR">
7029	Shared folder does not exists.
7030	</result>
7031	</desc>
7032	<param name="name" type="wstring" dir="in">
7033	<desc>Logical name of the shared folder to remove.</desc>
7034	</param>
7035	</method>
7036
7037	<method name="takeSnapshot">
7038	<desc>
7039	Saves the current execution state
7040	and all settings of the machine and creates differencing images
7041	for all normal (non-independent) media.
7042	See <link to="ISnapshot" /> for an introduction to snapshots.
7043
7044	This method can be called for a PoweredOff, Saved (see
7045	<link to="#saveState"/>), Running or
7046	Paused virtual machine. When the machine is PoweredOff, an
7047	offline snapshot is created. When the machine is Running a live
7048	snapshot is created, and an online snapshot is is created when Paused.
7049
7050	The taken snapshot is always based on the
7051	<link to="IMachine::currentSnapshot">current snapshot</link>
7052	of the associated virtual machine and becomes a new current snapshot.
7053
7054	<note>
7055	This method implicitly calls <link to="IMachine::saveSettings"/> to
7056	save all current machine settings before taking an offline snapshot.
7057	</note>
7058
7059	<result name="VBOX_E_INVALID_VM_STATE">
7060	Virtual machine currently changing state.
7061	</result>
7062	</desc>
7063	<param name="name" type="wstring" dir="in">
7064	<desc>Short name for the snapshot.</desc>
7065	</param>
7066	<param name="description" type="wstring" dir="in">
7067	<desc>Optional description of the snapshot.</desc>
7068	</param>
7069	<param name="progress" type="IProgress" dir="return">
7070	<desc>Progress object to track the operation completion.</desc>
7071	</param>
7072	</method>
7073
7074	<method name="deleteSnapshot">
7075	<desc>
7076	Starts deleting the specified snapshot asynchronously.
7077	See <link to="ISnapshot" /> for an introduction to snapshots.
7078
7079	The execution state and settings of the associated machine stored in
7080	the snapshot will be deleted. The contents of all differencing media of
7081	this snapshot will be merged with the contents of their dependent child
7082	media to keep the medium chain valid (in other words, all changes
7083	represented by media being deleted will be propagated to their child
7084	medium). After that, this snapshot's differencing medium will be
7085	deleted. The parent of this snapshot will become a new parent for all
7086	its child snapshots.
7087
7088	If the deleted snapshot is the current one, its parent snapshot will
7089	become a new current snapshot. The current machine state is not directly
7090	affected in this case, except that currently attached differencing
7091	media based on media of the deleted snapshot will be also merged as
7092	described above.
7093
7094	If the deleted snapshot is the first or current snapshot, then the
7095	respective IMachine attributes will be adjusted. Deleting the current
7096	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7097	to make all current machine settings permanent.
7098
7099	Deleting a snapshot has the following preconditions:
7100
7101	<ul>
7102	<li>Child media of all normal media of the deleted snapshot
7103	must be accessible (see <link to="IMedium::state"/>) for this
7104	operation to succeed. If only one running VM refers to all images
7105	which participates in merging the operation can be performed while
7106	the VM is running. Otherwise all virtual machines whose media are
7107	directly or indirectly based on the media of deleted snapshot must
7108	be powered off. In any case, online snapshot deleting usually is
7109	slower than the same operation without any running VM.</li>
7110
7111	<li>You cannot delete the snapshot if a medium attached to it has
7112	more than one child medium (differencing images) because otherwise
7113	merging would be impossible. This might be the case if there is
7114	more than one child snapshot or differencing images were created
7115	for other reason (e.g. implicitly because of multiple machine
7116	attachments).</li>
7117	</ul>
7118
7119	The virtual machine's <link to="IMachine::state">state</link> is
7120	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7121	"DeletingSnapshotPaused" while this operation is in progress.
7122
7123	<note>
7124	Merging medium contents can be very time and disk space
7125	consuming, if these media are big in size and have many
7126	children. However, if the snapshot being deleted is the last
7127	(head) snapshot on the branch, the operation will be rather
7128	quick.
7129	</note>
7130	<result name="VBOX_E_INVALID_VM_STATE">
7131	The running virtual machine prevents deleting this snapshot. This
7132	happens only in very specific situations, usually snapshots can be
7133	deleted without trouble while a VM is running. The error message
7134	text explains the reason for the failure.
7135	</result>
7136	</desc>
7137	<param name="id" type="uuid" mod="string" dir="in">
7138	<desc>UUID of the snapshot to delete.</desc>
7139	</param>
7140	<param name="progress" type="IProgress" dir="return">
7141	<desc>Progress object to track the operation completion.</desc>
7142	</param>
7143	</method>
7144
7145	<method name="deleteSnapshotAndAllChildren">
7146	<desc>
7147	Starts deleting the specified snapshot and all its children
7148	asynchronously. See <link to="ISnapshot" /> for an introduction to
7149	snapshots. The conditions and many details are the same as with
7150	<link to="#deleteSnapshot"/>.
7151
7152	This operation is very fast if the snapshot subtree does not include
7153	the current state. It is still significantly faster than deleting the
7154	snapshots one by one if the current state is in the subtree and there
7155	are more than one snapshots from current state to the snapshot which
7156	marks the subtree, since it eliminates the incremental image merging.
7157
7158	<note>This API method is right now not implemented!</note>
7159
7160	<result name="VBOX_E_INVALID_VM_STATE">
7161	The running virtual machine prevents deleting this snapshot. This
7162	happens only in very specific situations, usually snapshots can be
7163	deleted without trouble while a VM is running. The error message
7164	text explains the reason for the failure.
7165	</result>
7166	<result name="E_NOTIMPL">
7167	The method is not implemented yet.
7168	</result>
7169	</desc>
7170	<param name="id" type="uuid" mod="string" dir="in">
7171	<desc>UUID of the snapshot to delete, including all its children.</desc>
7172	</param>
7173	<param name="progress" type="IProgress" dir="return">
7174	<desc>Progress object to track the operation completion.</desc>
7175	</param>
7176	</method>
7177
7178	<method name="deleteSnapshotRange">
7179	<desc>
7180	Starts deleting the specified snapshot range. This is limited to
7181	linear snapshot lists, which means there may not be any other child
7182	snapshots other than the direct sequence between the start and end
7183	snapshot. If the start and end snapshot point to the same snapshot this
7184	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7185	<link to="ISnapshot" /> for an introduction to snapshots. The
7186	conditions and many details are the same as with
7187	<link to="#deleteSnapshot"/>.
7188
7189	This operation is generally faster than deleting snapshots one by one
7190	and often also needs less extra disk space before freeing up disk space
7191	by deleting the removed disk images corresponding to the snapshot.
7192
7193	<note>This API method is right now not implemented!</note>
7194
7195	<result name="VBOX_E_INVALID_VM_STATE">
7196	The running virtual machine prevents deleting this snapshot. This
7197	happens only in very specific situations, usually snapshots can be
7198	deleted without trouble while a VM is running. The error message
7199	text explains the reason for the failure.
7200	</result>
7201	<result name="E_NOTIMPL">
7202	The method is not implemented yet.
7203	</result>
7204	</desc>
7205	<param name="startId" type="uuid" mod="string" dir="in">
7206	<desc>UUID of the first snapshot to delete.</desc>
7207	</param>
7208	<param name="endId" type="uuid" mod="string" dir="in">
7209	<desc>UUID of the last snapshot to delete.</desc>
7210	</param>
7211	<param name="progress" type="IProgress" dir="return">
7212	<desc>Progress object to track the operation completion.</desc>
7213	</param>
7214	</method>
7215
7216	<method name="restoreSnapshot">
7217	<desc>
7218	Starts resetting the machine's current state to the state contained
7219	in the given snapshot, asynchronously. All current settings of the
7220	machine will be reset and changes stored in differencing media
7221	will be lost.
7222	See <link to="ISnapshot" /> for an introduction to snapshots.
7223
7224	After this operation is successfully completed, new empty differencing
7225	media are created for all normal media of the machine.
7226
7227	If the given snapshot is an online snapshot, the machine will go to
7228	the <link to="MachineState_Saved"> saved state</link>, so that the
7229	next time it is powered on, the execution state will be restored
7230	from the state of the snapshot.
7231
7232	<note>
7233	The machine must not be running, otherwise the operation will fail.
7234	</note>
7235
7236	<note>
7237	If the machine state is <link to="MachineState_Saved">Saved</link>
7238	prior to this operation, the saved state file will be implicitly
7239	deleted (as if <link to="IConsole::discardSavedState"/> were
7240	called).
7241	</note>
7242
7243	<result name="VBOX_E_INVALID_VM_STATE">
7244	Virtual machine is running.
7245	</result>
7246	</desc>
7247	<param name="snapshot" type="ISnapshot" dir="in">
7248	<desc>The snapshot to restore the VM state from.</desc>
7249	</param>
7250	<param name="progress" type="IProgress" dir="return">
7251	<desc>Progress object to track the operation completion.</desc>
7252	</param>
7253	</method>
7254
7255	<method name="teleport">
7256	<desc>
7257	Teleport the VM to a different host machine or process.
7258
7259	TODO explain the details.
7260
7261	<result name="VBOX_E_INVALID_VM_STATE">
7262	Virtual machine not running or paused.
7263	</result>
7264	</desc>
7265	<param name="hostname" type="wstring" dir="in">
7266	<desc>The name or IP of the host to teleport to.</desc>
7267	</param>
7268	<param name="tcpport" type="unsigned long" dir="in">
7269	<desc>The TCP port to connect to (1..65535).</desc>
7270	</param>
7271	<param name="password" type="wstring" dir="in">
7272	<desc>The password.</desc>
7273	</param>
7274	<param name="maxDowntime" type="unsigned long" dir="in">
7275	<desc>
7276	The maximum allowed downtime given as milliseconds. 0 is not a valid
7277	value. Recommended value: 250 ms.
7278
7279	The higher the value is, the greater the chance for a successful
7280	teleportation. A small value may easily result in the teleportation
7281	process taking hours and eventually fail.
7282
7283	<note>
7284	The current implementation treats this a guideline, not as an
7285	absolute rule.
7286	</note>
7287	</desc>
7288	</param>
7289	<param name="progress" type="IProgress" dir="return">
7290	<desc>Progress object to track the operation completion.</desc>
7291	</param>
7292	</method>
7293
7294	</interface>
7295
7296	<!--
7297	// IHost
7298	/////////////////////////////////////////////////////////////////////////
7299	-->
7300
7301	<enum
7302	name="HostNetworkInterfaceMediumType"
7303	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7304	>
7305	<desc>
7306	Type of encapsulation. Ethernet encapsulation includes both wired and
7307	wireless Ethernet connections.
7308	<see><link to="IHostNetworkInterface"/></see>
7309	</desc>
7310
7311	<const name="Unknown" value="0">
7312	<desc>
7313	The type of interface cannot be determined.
7314	</desc>
7315	</const>
7316	<const name="Ethernet" value="1">
7317	<desc>
7318	Ethernet frame encapsulation.
7319	</desc>
7320	</const>
7321	<const name="PPP" value="2">
7322	<desc>
7323	Point-to-point protocol encapsulation.
7324	</desc>
7325	</const>
7326	<const name="SLIP" value="3">
7327	<desc>
7328	Serial line IP encapsulation.
7329	</desc>
7330	</const>
7331	</enum>
7332
7333	<enum
7334	name="HostNetworkInterfaceStatus"
7335	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7336	>
7337	<desc>
7338	Current status of the interface.
7339	<see><link to="IHostNetworkInterface"/></see>
7340	</desc>
7341
7342	<const name="Unknown" value="0">
7343	<desc>
7344	The state of interface cannot be determined.
7345	</desc>
7346	</const>
7347	<const name="Up" value="1">
7348	<desc>
7349	The interface is fully operational.
7350	</desc>
7351	</const>
7352	<const name="Down" value="2">
7353	<desc>
7354	The interface is not functioning.
7355	</desc>
7356	</const>
7357	</enum>
7358
7359	<enum
7360	name="HostNetworkInterfaceType"
7361	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7362	>
7363	<desc>
7364	Network interface type.
7365	</desc>
7366	<const name="Bridged" value="1"/>
7367	<const name="HostOnly" value="2"/>
7368	</enum>
7369
7370	<interface
7371	name="IHostNetworkInterface" extends="$unknown"
7372	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7373	wsmap="managed"
7374	>
7375	<desc>
7376	Represents one of host's network interfaces. IP V6 address and network
7377	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7378	separated by colons.
7379	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7380	</desc>
7381	<attribute name="name" type="wstring" readonly="yes">
7382	<desc>Returns the host network interface name.</desc>
7383	</attribute>
7384
7385	<attribute name="id" type="uuid" mod="string" readonly="yes">
7386	<desc>Returns the interface UUID.</desc>
7387	</attribute>
7388
7389	<attribute name="networkName" type="wstring" readonly="yes">
7390	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7391	</attribute>
7392
7393	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7394	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7395	</attribute>
7396
7397	<attribute name="IPAddress" type="wstring" readonly="yes">
7398	<desc>Returns the IP V4 address of the interface.</desc>
7399	</attribute>
7400
7401	<attribute name="networkMask" type="wstring" readonly="yes">
7402	<desc>Returns the network mask of the interface.</desc>
7403	</attribute>
7404
7405	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7406	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7407	</attribute>
7408
7409	<attribute name="IPV6Address" type="wstring" readonly="yes">
7410	<desc>Returns the IP V6 address of the interface.</desc>
7411	</attribute>
7412
7413	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7414	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7415	</attribute>
7416
7417	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7418	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7419	</attribute>
7420
7421	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7422	<desc>Type of protocol encapsulation used.</desc>
7423	</attribute>
7424
7425	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7426	<desc>Status of the interface.</desc>
7427	</attribute>
7428
7429	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7430	<desc>specifies the host interface type.</desc>
7431	</attribute>
7432
7433	<method name="enableStaticIpConfig">
7434	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7435	<param name="IPAddress" type="wstring" dir="in">
7436	<desc>
7437	IP address.
7438	</desc>
7439	</param>
7440	<param name="networkMask" type="wstring" dir="in">
7441	<desc>
7442	network mask.
7443	</desc>
7444	</param>
7445	</method>
7446
7447	<method name="enableStaticIpConfigV6">
7448	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7449	<param name="IPV6Address" type="wstring" dir="in">
7450	<desc>
7451	IP address.
7452	</desc>
7453	</param>
7454	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7455	<desc>
7456	network mask.
7457	</desc>
7458	</param>
7459	</method>
7460
7461	<method name="enableDynamicIpConfig">
7462	<desc>enables the dynamic IP configuration.</desc>
7463	</method>
7464
7465	<method name="dhcpRediscover">
7466	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7467	</method>
7468
7469	</interface>
7470
7471	<interface
7472	name="IHost" extends="$unknown"
7473	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7474	wsmap="managed"
7475	>
7476	<desc>
7477	The IHost interface represents the physical machine that this VirtualBox
7478	installation runs on.
7479
7480	An object implementing this interface is returned by the
7481	<link to="IVirtualBox::host" /> attribute. This interface contains
7482	read-only information about the host's physical hardware (such as what
7483	processors and disks are available, what the host operating system is,
7484	and so on) and also allows for manipulating some of the host's hardware,
7485	such as global USB device filters and host interface networking.
7486
7487	</desc>
7488	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7489	<desc>List of DVD drives available on the host.</desc>
7490	</attribute>
7491
7492	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7493	<desc>List of floppy drives available on the host.</desc>
7494	</attribute>
7495
7496	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7497	<desc>
7498	List of USB devices currently attached to the host.
7499	Once a new device is physically attached to the host computer,
7500	it appears in this list and remains there until detached.
7501
7502	<note>
7503	If USB functionality is not available in the given edition of
7504	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7505	</note>
7506	</desc>
7507	</attribute>
7508
7509	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7510	<desc>
7511	List of USB device filters in action.
7512	When a new device is physically attached to the host computer,
7513	filters from this list are applied to it (in order they are stored
7514	in the list). The first matched filter will determine the
7515	<link to="IHostUSBDeviceFilter::action">action</link>
7516	performed on the device.
7517
7518	Unless the device is ignored by these filters, filters of all
7519	currently running virtual machines
7520	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7521
7522	<note>
7523	If USB functionality is not available in the given edition of
7524	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7525	</note>
7526
7527	<see><link to="IHostUSBDeviceFilter"/>,
7528	<link to="USBDeviceState"/></see>
7529	</desc>
7530	</attribute>
7531
7532	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7533	<desc>List of host network interfaces currently defined on the host.</desc>
7534	</attribute>
7535
7536	<attribute name="processorCount" type="unsigned long" readonly="yes">
7537	<desc>Number of (logical) CPUs installed in the host system.</desc>
7538	</attribute>
7539
7540	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7541	<desc>Number of (logical) CPUs online in the host system.</desc>
7542	</attribute>
7543
7544	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7545	<desc>Number of physical processor cores installed in the host system.</desc>
7546	</attribute>
7547
7548	<method name="getProcessorSpeed">
7549	<desc>Query the (approximate) maximum speed of a specified host CPU in
7550	Megahertz.
7551	</desc>
7552	<param name="cpuId" type="unsigned long" dir="in">
7553	<desc>
7554	Identifier of the CPU.
7555	</desc>
7556	</param>
7557	<param name="speed" type="unsigned long" dir="return">
7558	<desc>
7559	Speed value. 0 is returned if value is not known or @a cpuId is
7560	invalid.
7561	</desc>
7562	</param>
7563	</method>
7564
7565	<method name="getProcessorFeature">
7566	<desc>Query whether a CPU feature is supported or not.</desc>
7567	<param name="feature" type="ProcessorFeature" dir="in">
7568	<desc>
7569	CPU Feature identifier.
7570	</desc>
7571	</param>
7572	<param name="supported" type="boolean" dir="return">
7573	<desc>
7574	Feature is supported or not.
7575	</desc>
7576	</param>
7577	</method>
7578
7579	<method name="getProcessorDescription">
7580	<desc>Query the model string of a specified host CPU.
7581	</desc>
7582	<param name="cpuId" type="unsigned long" dir="in">
7583	<desc>
7584	Identifier of the CPU.
7585	<note>
7586	The current implementation might not necessarily return the
7587	description for this exact CPU.
7588	</note>
7589	</desc>
7590	</param>
7591	<param name="description" type="wstring" dir="return">
7592	<desc>
7593	Model string. An empty string is returned if value is not known or
7594	@a cpuId is invalid.
7595	</desc>
7596	</param>
7597	</method>
7598
7599	<method name="getProcessorCPUIDLeaf">
7600	<desc>
7601	Returns the CPU cpuid information for the specified leaf.
7602	</desc>
7603	<param name="cpuId" type="unsigned long" dir="in">
7604	<desc>
7605	Identifier of the CPU. The CPU most be online.
7606	<note>
7607	The current implementation might not necessarily return the
7608	description for this exact CPU.
7609	</note>
7610	</desc>
7611	</param>
7612	<param name="leaf" type="unsigned long" dir="in">
7613	<desc>
7614	CPUID leaf index (eax).
7615	</desc>
7616	</param>
7617	<param name="subLeaf" type="unsigned long" dir="in">
7618	<desc>
7619	CPUID leaf sub index (ecx). This currently only applies to cache
7620	information on Intel CPUs. Use 0 if retrieving values for
7621	<link to="IMachine::setCPUIDLeaf"/>.
7622	</desc>
7623	</param>
7624	<param name="valEax" type="unsigned long" dir="out">
7625	<desc>
7626	CPUID leaf value for register eax.
7627	</desc>
7628	</param>
7629	<param name="valEbx" type="unsigned long" dir="out">
7630	<desc>
7631	CPUID leaf value for register ebx.
7632	</desc>
7633	</param>
7634	<param name="valEcx" type="unsigned long" dir="out">
7635	<desc>
7636	CPUID leaf value for register ecx.
7637	</desc>
7638	</param>
7639	<param name="valEdx" type="unsigned long" dir="out">
7640	<desc>
7641	CPUID leaf value for register edx.
7642	</desc>
7643	</param>
7644	</method>
7645
7646	<attribute name="memorySize" type="unsigned long" readonly="yes">
7647	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7648	</attribute>
7649
7650	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7651	<desc>Available system memory in the host system.</desc>
7652	</attribute>
7653
7654	<attribute name="operatingSystem" type="wstring" readonly="yes">
7655	<desc>Name of the host system's operating system.</desc>
7656	</attribute>
7657
7658	<attribute name="OSVersion" type="wstring" readonly="yes">
7659	<desc>Host operating system's version string.</desc>
7660	</attribute>
7661
7662	<attribute name="UTCTime" type="long long" readonly="yes">
7663	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7664	</attribute>
7665
7666	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7667	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7668	</attribute>
7669
7670	<method name="createHostOnlyNetworkInterface">
7671	<desc>
7672	Creates a new adapter for Host Only Networking.
7673	<result name="E_INVALIDARG">
7674	Host network interface @a name already exists.
7675	</result>
7676	</desc>
7677	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7678	<desc>
7679	Created host interface object.
7680	</desc>
7681	</param>
7682	<param name="progress" type="IProgress" dir="return">
7683	<desc>
7684	Progress object to track the operation completion.
7685	</desc>
7686	</param>
7687	</method>
7688
7689	<method name="removeHostOnlyNetworkInterface">
7690	<desc>
7691	Removes the given Host Only Networking interface.
7692	<result name="VBOX_E_OBJECT_NOT_FOUND">
7693	No host network interface matching @a id found.
7694	</result>
7695	</desc>
7696	<param name="id" type="uuid" mod="string" dir="in">
7697	<desc>
7698	Adapter GUID.
7699	</desc>
7700	</param>
7701	<param name="progress" type="IProgress" dir="return">
7702	<desc>
7703	Progress object to track the operation completion.
7704	</desc>
7705	</param>
7706	</method>
7707
7708	<method name="createUSBDeviceFilter">
7709	<desc>
7710	Creates a new USB device filter. All attributes except
7711	the filter name are set to empty (any match),
7712	<i>active</i> is @c false (the filter is not active).
7713
7714	The created filter can be added to the list of filters using
7715	<link to="#insertUSBDeviceFilter"/>.
7716
7717	<see><link to="#USBDeviceFilters"/></see>
7718	</desc>
7719	<param name="name" type="wstring" dir="in">
7720	<desc>
7721	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7722	</desc>
7723	</param>
7724	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7725	<desc>Created filter object.</desc>
7726	</param>
7727	</method>
7728
7729	<method name="insertUSBDeviceFilter">
7730	<desc>
7731	Inserts the given USB device to the specified position
7732	in the list of filters.
7733
7734	Positions are numbered starting from @c 0. If the specified
7735	position is equal to or greater than the number of elements in
7736	the list, the filter is added at the end of the collection.
7737
7738	<note>
7739	Duplicates are not allowed, so an attempt to insert a
7740	filter already in the list is an error.
7741	</note>
7742	<note>
7743	If USB functionality is not available in the given edition of
7744	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7745	</note>
7746
7747	<see><link to="#USBDeviceFilters"/></see>
7748
7749	<result name="VBOX_E_INVALID_OBJECT_STATE">
7750	USB device filter is not created within this VirtualBox instance.
7751	</result>
7752	<result name="E_INVALIDARG">
7753	USB device filter already in list.
7754	</result>
7755
7756	</desc>
7757	<param name="position" type="unsigned long" dir="in">
7758	<desc>Position to insert the filter to.</desc>
7759	</param>
7760	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7761	<desc>USB device filter to insert.</desc>
7762	</param>
7763	</method>
7764
7765	<method name="removeUSBDeviceFilter">
7766	<desc>
7767	Removes a USB device filter from the specified position in the
7768	list of filters.
7769
7770	Positions are numbered starting from @c 0. Specifying a
7771	position equal to or greater than the number of elements in
7772	the list will produce an error.
7773
7774	<note>
7775	If USB functionality is not available in the given edition of
7776	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7777	</note>
7778
7779	<see><link to="#USBDeviceFilters"/></see>
7780
7781	<result name="E_INVALIDARG">
7782	USB device filter list empty or invalid @a position.
7783	</result>
7784
7785	</desc>
7786	<param name="position" type="unsigned long" dir="in">
7787	<desc>Position to remove the filter from.</desc>
7788	</param>
7789	</method>
7790
7791	<method name="findHostDVDDrive">
7792	<desc>
7793	Searches for a host DVD drive with the given @c name.
7794
7795	<result name="VBOX_E_OBJECT_NOT_FOUND">
7796	Given @c name does not correspond to any host drive.
7797	</result>
7798
7799	</desc>
7800	<param name="name" type="wstring" dir="in">
7801	<desc>Name of the host drive to search for</desc>
7802	</param>
7803	<param name="drive" type="IMedium" dir="return">
7804	<desc>Found host drive object</desc>
7805	</param>
7806	</method>
7807
7808	<method name="findHostFloppyDrive">
7809	<desc>
7810	Searches for a host floppy drive with the given @c name.
7811
7812	<result name="VBOX_E_OBJECT_NOT_FOUND">
7813	Given @c name does not correspond to any host floppy drive.
7814	</result>
7815
7816	</desc>
7817	<param name="name" type="wstring" dir="in">
7818	<desc>Name of the host floppy drive to search for</desc>
7819	</param>
7820	<param name="drive" type="IMedium" dir="return">
7821	<desc>Found host floppy drive object</desc>
7822	</param>
7823	</method>
7824
7825	<method name="findHostNetworkInterfaceByName">
7826	<desc>
7827	Searches through all host network interfaces for an interface with
7828	the given @c name.
7829	<note>
7830	The method returns an error if the given @c name does not
7831	correspond to any host network interface.
7832	</note>
7833	</desc>
7834	<param name="name" type="wstring" dir="in">
7835	<desc>Name of the host network interface to search for.</desc>
7836	</param>
7837	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7838	<desc>Found host network interface object.</desc>
7839	</param>
7840	</method>
7841	<method name="findHostNetworkInterfaceById">
7842	<desc>
7843	Searches through all host network interfaces for an interface with
7844	the given GUID.
7845	<note>
7846	The method returns an error if the given GUID does not
7847	correspond to any host network interface.
7848	</note>
7849	</desc>
7850	<param name="id" type="uuid" mod="string" dir="in">
7851	<desc>GUID of the host network interface to search for.</desc>
7852	</param>
7853	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7854	<desc>Found host network interface object.</desc>
7855	</param>
7856	</method>
7857	<method name="findHostNetworkInterfacesOfType">
7858	<desc>
7859	Searches through all host network interfaces and returns a list of interfaces of the specified type
7860	</desc>
7861	<param name="type" type="HostNetworkInterfaceType" dir="in">
7862	<desc>type of the host network interfaces to search for.</desc>
7863	</param>
7864	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7865	<desc>Found host network interface objects.</desc>
7866	</param>
7867	</method>
7868
7869	<method name="findUSBDeviceById">
7870	<desc>
7871	Searches for a USB device with the given UUID.
7872
7873	<result name="VBOX_E_OBJECT_NOT_FOUND">
7874	Given @c id does not correspond to any USB device.
7875	</result>
7876
7877	<see><link to="IUSBDevice::id"/></see>
7878	</desc>
7879	<param name="id" type="uuid" mod="string" dir="in">
7880	<desc>UUID of the USB device to search for.</desc>
7881	</param>
7882	<param name="device" type="IHostUSBDevice" dir="return">
7883	<desc>Found USB device object.</desc>
7884	</param>
7885	</method>
7886
7887	<method name="findUSBDeviceByAddress">
7888	<desc>
7889	Searches for a USB device with the given host address.
7890
7891	<result name="VBOX_E_OBJECT_NOT_FOUND">
7892	Given @c name does not correspond to any USB device.
7893	</result>
7894
7895	<see><link to="IUSBDevice::address"/></see>
7896	</desc>
7897	<param name="name" type="wstring" dir="in">
7898	<desc>
7899	Address of the USB device (as assigned by the host) to
7900	search for.
7901	</desc>
7902	</param>
7903	<param name="device" type="IHostUSBDevice" dir="return">
7904	<desc>Found USB device object.</desc>
7905	</param>
7906	</method>
7907
7908	<method name="generateMACAddress">
7909	<desc>
7910	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7911	</desc>
7912	<param name="address" type="wstring" dir="return">
7913	<desc>New Ethernet MAC address.</desc>
7914	</param>
7915	</method>
7916
7917	</interface>
7918
7919	<!--
7920	// ISystemProperties
7921	/////////////////////////////////////////////////////////////////////////
7922	-->
7923
7924	<interface
7925	name="ISystemProperties"
7926	extends="$unknown"
7927	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7928	wsmap="managed"
7929	>
7930	<desc>
7931	The ISystemProperties interface represents global properties of the given
7932	VirtualBox installation.
7933
7934	These properties define limits and default values for various attributes
7935	and parameters. Most of the properties are read-only, but some can be
7936	changed by a user.
7937	</desc>
7938
7939	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7940	<desc>Minimum guest system memory in Megabytes.</desc>
7941	</attribute>
7942
7943	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7944	<desc>Maximum guest system memory in Megabytes.</desc>
7945	</attribute>
7946
7947	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7948	<desc>Minimum guest video memory in Megabytes.</desc>
7949	</attribute>
7950
7951	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7952	<desc>Maximum guest video memory in Megabytes.</desc>
7953	</attribute>
7954
7955	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7956	<desc>Minimum CPU count.</desc>
7957	</attribute>
7958
7959	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7960	<desc>Maximum CPU count.</desc>
7961	</attribute>
7962
7963	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7964	<desc>Maximum of monitors which could be connected.</desc>
7965	</attribute>
7966
7967	<attribute name="infoVDSize" type="long long" readonly="yes">
7968	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7969	does not reflect the limits of any virtual disk image format.</desc>
7970	</attribute>
7971
7972	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7973	<desc>
7974	Maximum number of serial ports associated with every
7975	<link to="IMachine"/> instance.
7976	</desc>
7977	</attribute>
7978
7979	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7980	<desc>
7981	Maximum number of parallel ports associated with every
7982	<link to="IMachine"/> instance.
7983	</desc>
7984	</attribute>
7985
7986	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7987	<desc>
7988	Maximum device position in the boot order. This value corresponds
7989	to the total number of devices a machine can boot from, to make it
7990	possible to include all possible devices to the boot list.
7991	<see><link to="IMachine::setBootOrder"/></see>
7992	</desc>
7993	</attribute>
7994
7995	<attribute name="defaultMachineFolder" type="wstring">
7996	<desc>
7997	Full path to the default directory used to create new or open
7998	existing machines when a machine settings file name contains no
7999	path.
8000
8001	Starting with VirtualBox 4.0, by default, this attribute contains
8002	the full path of folder named "VirtualBox VMs" in the user's
8003	home directory, which depends on the host platform.
8004
8005	When setting this attribute, a full path must be specified.
8006	Setting this property to @c null or an empty string or the
8007	special value "Machines" (for compatibility reasons) will restore
8008	that default value.
8009
8010	If the folder specified herein does not exist, it will be created
8011	automatically as needed.
8012
8013	<see>
8014	<link to="IVirtualBox::createMachine"/>,
8015	<link to="IVirtualBox::openMachine"/>
8016	</see>
8017	</desc>
8018	</attribute>
8019
8020	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8021	<desc>
8022	List of all medium storage formats supported by this VirtualBox
8023	installation.
8024
8025	Keep in mind that the medium format identifier
8026	(<link to="IMediumFormat::id"/>) used in other API calls like
8027	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8028	medium format is a case-insensitive string. This means that, for
8029	example, all of the following strings:
8030	<pre>
8031	"VDI"
8032	"vdi"
8033	"VdI"</pre>
8034	refer to the same medium format.
8035
8036	Note that the virtual medium framework is backend-based, therefore
8037	the list of supported formats depends on what backends are currently
8038	installed.
8039
8040	<see><link to="IMediumFormat"/></see>
8041	</desc>
8042	</attribute>
8043
8044	<attribute name="defaultHardDiskFormat" type="wstring">
8045	<desc>
8046	Identifier of the default medium format used by VirtualBox.
8047
8048	The medium format set by this attribute is used by VirtualBox
8049	when the medium format was not specified explicitly. One example is
8050	<link to="IVirtualBox::createHardDisk"/> with the empty
8051	format argument. A more complex example is implicit creation of
8052	differencing media when taking a snapshot of a virtual machine:
8053	this operation will try to use a format of the parent medium first
8054	and if this format does not support differencing media the default
8055	format specified by this argument will be used.
8056
8057	The list of supported medium formats may be obtained by the
8058	<link to="#mediumFormats"/> call. Note that the default medium
8059	format must have a capability to create differencing media;
8060	otherwise operations that create media implicitly may fail
8061	unexpectedly.
8062
8063	The initial value of this property is <tt>"VDI"</tt> in the current
8064	version of the VirtualBox product, but may change in the future.
8065
8066	<note>
8067	Setting this property to @c null or empty string will restore the
8068	initial value.
8069	</note>
8070
8071	<see>
8072	<link to="#mediumFormats"/>,
8073	<link to="IMediumFormat::id"/>,
8074	<link to="IVirtualBox::createHardDisk"/>
8075	</see>
8076	</desc>
8077	</attribute>
8078
8079	<attribute name="freeDiskSpaceWarning" type="long long">
8080	<desc>Issue a warning if the free disk space is below (or in some disk
8081	intensive operation is expected to go below) the given size in
8082	bytes.</desc>
8083	</attribute>
8084
8085	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8086	<desc>Issue a warning if the free disk space is below (or in some disk
8087	intensive operation is expected to go below) the given percentage.</desc>
8088	</attribute>
8089
8090	<attribute name="freeDiskSpaceError" type="long long">
8091	<desc>Issue an error if the free disk space is below (or in some disk
8092	intensive operation is expected to go below) the given size in
8093	bytes.</desc>
8094	</attribute>
8095
8096	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8097	<desc>Issue an error if the free disk space is below (or in some disk
8098	intensive operation is expected to go below) the given percentage.</desc>
8099	</attribute>
8100
8101	<attribute name="VRDEAuthLibrary" type="wstring">
8102	<desc>
8103	Library that provides authentication for Remote Desktop clients. The library
8104	is used if a virtual machine's authentication type is set to "external"
8105	in the VM RemoteDisplay configuration.
8106
8107	The system library extension (".DLL" or ".so") must be omitted.
8108	A full path can be specified; if not, then the library must reside on the
8109	system's default library path.
8110
8111	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8112	of that name in one of the default VirtualBox library directories.
8113
8114	For details about VirtualBox authentication libraries and how to implement
8115	them, please refer to the VirtualBox manual.
8116
8117	<note>
8118	Setting this property to @c null or empty string will restore the
8119	initial value.
8120	</note>
8121	</desc>
8122	</attribute>
8123
8124	<attribute name="webServiceAuthLibrary" type="wstring">
8125	<desc>
8126	Library that provides authentication for webservice clients. The library
8127	is used if a virtual machine's authentication type is set to "external"
8128	in the VM RemoteDisplay configuration and will be called from
8129	within the <link to="IWebsessionManager::logon" /> implementation.
8130
8131	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8132	there is no per-VM setting for this, as the webservice is a global
8133	resource (if it is running). Only for this setting (for the webservice),
8134	setting this value to a literal <tt>"null"</tt> string disables authentication,
8135	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8136	no matter what user name and password are supplied.
8137
8138	The initial value of this property is <tt>"VBoxAuth"</tt>,
8139	meaning that the webservice will use the same authentication
8140	library that is used by default for VRDE (again, see
8141	<link to="ISystemProperties::VRDEAuthLibrary" />).
8142	The format and calling convention of authentication libraries
8143	is the same for the webservice as it is for VRDE.
8144
8145	<note>
8146	Setting this property to @c null or empty string will restore the
8147	initial value.
8148	</note>
8149	</desc>
8150	</attribute>
8151
8152	<attribute name="defaultVRDEExtPack" type="wstring">
8153	<desc>
8154	The name of the extension pack providing the default VRDE.
8155
8156	This attribute is for choosing between multiple extension packs
8157	providing VRDE. If only one is installed, it will automatically be the
8158	default one. The attribute value can be empty if no VRDE extension
8159	pack is installed.
8160
8161	For details about VirtualBox Remote Desktop Extension and how to
8162	implement one, please refer to the VirtualBox SDK.
8163	</desc>
8164	</attribute>
8165
8166	<attribute name="logHistoryCount" type="unsigned long">
8167	<desc>
8168	This value specifies how many old release log files are kept.
8169	</desc>
8170	</attribute>
8171
8172	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8173	<desc>This value hold the default audio driver for the current
8174	system.</desc>
8175	</attribute>
8176
8177
8178	<method name="getMaxNetworkAdapters">
8179	<desc>
8180	Maximum total number of network adapters associated with every
8181	<link to="IMachine"/> instance.
8182	</desc>
8183
8184	<param name="chipset" type="ChipsetType" dir="in">
8185	<desc>The chipset type to get the value for.</desc>
8186	</param>
8187
8188
8189	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8190	<desc>The maximum total number of network adapters allowed.</desc>
8191	</param>
8192
8193	</method>
8194
8195	<method name="getMaxNetworkAdaptersOfType">
8196	<desc>
8197	Maximum number of network adapters of a given attachment type,
8198	associated with every <link to="IMachine"/> instance.
8199	</desc>
8200
8201	<param name="chipset" type="ChipsetType" dir="in">
8202	<desc>The chipset type to get the value for.</desc>
8203	</param>
8204
8205	<param name="type" type="NetworkAttachmentType" dir="in">
8206	<desc>Type of attachment.</desc>
8207	</param>
8208
8209	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8210	<desc>The maximum number of network adapters allowed for
8211	particular chipset and attachment type.</desc>
8212	</param>
8213
8214	</method>
8215
8216
8217	<method name="getMaxDevicesPerPortForStorageBus">
8218	<desc>Returns the maximum number of devices which can be attached to a port
8219	for the given storage bus.</desc>
8220
8221	<param name="bus" type="StorageBus" dir="in">
8222	<desc>The storage bus type to get the value for.</desc>
8223	</param>
8224
8225	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8226	<desc>The maximum number of devices which can be attached to the port for the given
8227	storage bus.</desc>
8228	</param>
8229	</method>
8230
8231	<method name="getMinPortCountForStorageBus">
8232	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8233
8234	<param name="bus" type="StorageBus" dir="in">
8235	<desc>The storage bus type to get the value for.</desc>
8236	</param>
8237
8238	<param name="minPortCount" type="unsigned long" dir="return">
8239	<desc>The minimum number of ports for the given storage bus.</desc>
8240	</param>
8241	</method>
8242
8243	<method name="getMaxPortCountForStorageBus">
8244	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8245
8246	<param name="bus" type="StorageBus" dir="in">
8247	<desc>The storage bus type to get the value for.</desc>
8248	</param>
8249
8250	<param name="maxPortCount" type="unsigned long" dir="return">
8251	<desc>The maximum number of ports for the given storage bus.</desc>
8252	</param>
8253	</method>
8254
8255	<method name="getMaxInstancesOfStorageBus">
8256	<desc>Returns the maximum number of storage bus instances which
8257	can be configured for each VM. This corresponds to the number of
8258	storage controllers one can have. Value may depend on chipset type
8259	used.</desc>
8260
8261	<param name="chipset" type="ChipsetType" dir="in">
8262	<desc>The chipset type to get the value for.</desc>
8263	</param>
8264
8265	<param name="bus" type="StorageBus" dir="in">
8266	<desc>The storage bus type to get the value for.</desc>
8267	</param>
8268
8269	<param name="maxInstances" type="unsigned long" dir="return">
8270	<desc>The maximum number of instances for the given storage bus.</desc>
8271	</param>
8272	</method>
8273
8274	<method name="getDeviceTypesForStorageBus">
8275	<desc>Returns list of all the supported device types
8276	(<link to="DeviceType"/>) for the given type of storage
8277	bus.</desc>
8278
8279	<param name="bus" type="StorageBus" dir="in">
8280	<desc>The storage bus type to get the value for.</desc>
8281	</param>
8282
8283	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8284	<desc>The list of all supported device types for the given storage bus.</desc>
8285	</param>
8286	</method>
8287
8288	<method name="getDefaultIoCacheSettingForStorageController">
8289	<desc>Returns the default I/O cache setting for the
8290	given storage controller</desc>
8291
8292	<param name="controllerType" type="StorageControllerType" dir="in">
8293	<desc>The storage controller to the setting for.</desc>
8294	</param>
8295
8296	<param name="enabled" type="boolean" dir="return">
8297	<desc>Returned flag indicating the default value</desc>
8298	</param>
8299	</method>
8300	</interface>
8301
8302	<!--
8303	// IGuest
8304	/////////////////////////////////////////////////////////////////////////
8305	-->
8306
8307	<interface
8308	name="IGuestOSType" extends="$unknown"
8309	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8310	wsmap="struct"
8311	>
8312	<desc>
8313	</desc>
8314
8315	<attribute name="familyId" type="wstring" readonly="yes">
8316	<desc>Guest OS family identifier string.</desc>
8317	</attribute>
8318
8319	<attribute name="familyDescription" type="wstring" readonly="yes">
8320	<desc>Human readable description of the guest OS family.</desc>
8321	</attribute>
8322
8323	<attribute name="id" type="wstring" readonly="yes">
8324	<desc>Guest OS identifier string.</desc>
8325	</attribute>
8326
8327	<attribute name="description" type="wstring" readonly="yes">
8328	<desc>Human readable description of the guest OS.</desc>
8329	</attribute>
8330
8331	<attribute name="is64Bit" type="boolean" readonly="yes">
8332	<desc>Returns @c true if the given OS is 64-bit</desc>
8333	</attribute>
8334
8335	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8336	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8337	</attribute>
8338
8339	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8340	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8341	</attribute>
8342
8343	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8344	<desc>Recommended RAM size in Megabytes.</desc>
8345	</attribute>
8346
8347	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8348	<desc>Recommended video RAM size in Megabytes.</desc>
8349	</attribute>
8350
8351	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8352	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8353	</attribute>
8354
8355	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8356	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8357	</attribute>
8358
8359	<attribute name="recommendedHDD" type="long long" readonly="yes">
8360	<desc>Recommended hard disk size in bytes.</desc>
8361	</attribute>
8362
8363	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8364	<desc>Returns recommended network adapter for this OS type.</desc>
8365	</attribute>
8366
8367	<attribute name="recommendedPae" type="boolean" readonly="yes">
8368	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8369	</attribute>
8370
8371	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8372	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8373	</attribute>
8374
8375	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8376	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8377	</attribute>
8378
8379	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8380	<desc>Recommended storage controller type for HD drives.</desc>
8381	</attribute>
8382
8383	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8384	<desc>Recommended storage bus type for HD drives.</desc>
8385	</attribute>
8386
8387	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8388	<desc>Recommended firmware type.</desc>
8389	</attribute>
8390
8391	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8392	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8393	</attribute>
8394
8395	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8396	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8397	</attribute>
8398
8399	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8400	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8401	</attribute>
8402
8403	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8404	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8405	</attribute>
8406
8407	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8408	<desc>Recommended chipset type.</desc>
8409	</attribute>
8410
8411	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8412	<desc>Recommended audio type.</desc>
8413	</attribute>
8414
8415	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8416	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8417	</attribute>
8418
8419	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8420	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8421	</attribute>
8422
8423	</interface>
8424
8425	<enum
8426	name="AdditionsFacilityType"
8427	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8428	>
8429	<desc>
8430	Guest Additions facility IDs.
8431	</desc>
8432
8433	<const name="None" value="0">
8434	<desc>No/invalid facility.</desc>
8435	</const>
8436	<const name="VBoxGuestDriver" value="20">
8437	<desc>VirtualBox base driver (VBoxGuest).</desc>
8438	</const>
8439	<const name="AutoLogon" value="90">
8440	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8441	</const>
8442	<const name="VBoxService" value="100">
8443	<desc>VirtualBox system service (VBoxService).</desc>
8444	</const>
8445	<const name="VBoxTrayClient" value="101">
8446	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8447	</const>
8448	<const name="Seamless" value="1000">
8449	<desc>Seamless guest desktop integration.</desc>
8450	</const>
8451	<const name="Graphics" value="1100">
8452	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8453	are not immediately acted on and guest display resizes are probably not initiated by
8454	the guest additions.
8455	</desc>
8456	</const>
8457	<const name="All" value="2147483646">
8458	<desc>All facilities selected.</desc>
8459	</const>
8460	</enum>
8461
8462	<enum
8463	name="AdditionsFacilityClass"
8464	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8465	>
8466	<desc>
8467	Guest Additions facility classes.
8468	</desc>
8469
8470	<const name="None" value="0">
8471	<desc>No/invalid class.</desc>
8472	</const>
8473	<const name="Driver" value="10">
8474	<desc>Driver.</desc>
8475	</const>
8476	<const name="Service" value="30">
8477	<desc>System service.</desc>
8478	</const>
8479	<const name="Program" value="50">
8480	<desc>Program.</desc>
8481	</const>
8482	<const name="Feature" value="100">
8483	<desc>Feature.</desc>
8484	</const>
8485	<const name="ThirdParty" value="999">
8486	<desc>Third party.</desc>
8487	</const>
8488	<const name="All" value="2147483646">
8489	<desc>All facility classes selected.</desc>
8490	</const>
8491	</enum>
8492
8493	<enum
8494	name="AdditionsFacilityStatus"
8495	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8496	>
8497	<desc>
8498	Guest Additions facility states.
8499	</desc>
8500
8501	<const name="Inactive" value="0">
8502	<desc>Facility is not active.</desc>
8503	</const>
8504	<const name="Paused" value="1">
8505	<desc>Facility has been paused.</desc>
8506	</const>
8507	<const name="PreInit" value="20">
8508	<desc>Facility is preparing to initialize.</desc>
8509	</const>
8510	<const name="Init" value="30">
8511	<desc>Facility is initializing.</desc>
8512	</const>
8513	<const name="Active" value="50">
8514	<desc>Facility is up and running.</desc>
8515	</const>
8516	<const name="Terminating" value="100">
8517	<desc>Facility is shutting down.</desc>
8518	</const>
8519	<const name="Terminated" value="101">
8520	<desc>Facility successfully shut down.</desc>
8521	</const>
8522	<const name="Failed" value="800">
8523	<desc>Facility failed to start.</desc>
8524	</const>
8525	<const name="Unknown" value="999">
8526	<desc>Facility status is unknown.</desc>
8527	</const>
8528	</enum>
8529
8530	<interface
8531	name="IAdditionsFacility" extends="$unknown"
8532	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8533	wsmap="struct"
8534	>
8535	<desc>
8536	Structure representing a Guest Additions facility.
8537	</desc>
8538
8539	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8540	<desc>The class this facility is part of.</desc>
8541	</attribute>
8542
8543	<attribute name="lastUpdated" type="long long" readonly="yes">
8544	<desc>
8545	Time stamp of the last status update,
8546	in milliseconds since 1970-01-01 UTC.
8547	</desc>
8548	</attribute>
8549
8550	<attribute name="name" type="wstring" readonly="yes">
8551	<desc>The facility's friendly name.</desc>
8552	</attribute>
8553
8554	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8555	<desc>The current status.</desc>
8556	</attribute>
8557
8558	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8559	<desc>The facility's type ID.</desc>
8560	</attribute>
8561	</interface>
8562
8563	<enum
8564	name="AdditionsRunLevelType"
8565	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8566	>
8567	<desc>
8568	Guest Additions run level type.
8569	</desc>
8570
8571	<const name="None" value="0">
8572	<desc>Guest Additions are not loaded.</desc>
8573	</const>
8574	<const name="System" value="1">
8575	<desc>Guest drivers are loaded.</desc>
8576	</const>
8577	<const name="Userland" value="2">
8578	<desc>Common components (such as application services) are loaded.</desc>
8579	</const>
8580	<const name="Desktop" value="3">
8581	<desc>Per-user desktop components are loaded.</desc>
8582	</const>
8583	</enum>
8584
8585	<enum
8586	name="AdditionsUpdateFlag"
8587	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8588	>
8589	<desc>
8590	Guest Additions update flags.
8591	</desc>
8592
8593	<const name="None" value="0">
8594	<desc>No flag set.</desc>
8595	</const>
8596	<const name="WaitForUpdateStartOnly" value="1">
8597	<desc>Only wait for the update process being started and do not
8598	wait while peforming the actual update.</desc>
8599	</const>
8600	</enum>
8601
8602	<enum
8603	name="ExecuteProcessFlag"
8604	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8605	>
8606	<desc>
8607	Guest process execution flags.
8608	</desc>
8609
8610	<const name="None" value="0">
8611	<desc>No flag set.</desc>
8612	</const>
8613	<const name="WaitForProcessStartOnly" value="1">
8614	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8615	process itself then uses an infinite timeout.</desc>
8616	</const>
8617	<const name="IgnoreOrphanedProcesses" value="2">
8618	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8619	</const>
8620	<const name="Hidden" value="4">
8621	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8622	</const>
8623	<const name="NoProfile" value="8">
8624	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8625	</const>
8626	<const name="WaitForStdOut" value="16">
8627	<desc>The guest process waits until all data from stdout is read out.</desc>
8628	</const>
8629	<const name="WaitForStdErr" value="32">
8630	<desc>The guest process waits until all data from stderr is read out.</desc>
8631	</const>
8632	</enum>
8633
8634	<enum
8635	name="ExecuteProcessStatus"
8636	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8637	>
8638	<desc>
8639	Guest process execution status.
8640	</desc>
8641	<const name="Undefined" value="0">
8642	<desc>Process is in an undefined state.</desc>
8643	</const>
8644
8645	<const name="Started" value="1">
8646	<desc>Process has been started.</desc>
8647	</const>
8648	<const name="TerminatedNormally" value="2">
8649	<desc>Process terminated normally.</desc>
8650	</const>
8651	<const name="TerminatedSignal" value="3">
8652	<desc>Process terminated via signal.</desc>
8653	</const>
8654	<const name="TerminatedAbnormally" value="4">
8655	<desc>Process terminated abnormally.</desc>
8656	</const>
8657	<const name="TimedOutKilled" value="5">
8658	<desc>Process timed out and was killed.</desc>
8659	</const>
8660	<const name="TimedOutAbnormally" value="6">
8661	<desc>Process timed out and was not killed successfully.</desc>
8662	</const>
8663	<const name="Down" value="7">
8664	<desc>Service/OS is stopping, process was killed.</desc>
8665	</const>
8666	<const name="Error" value="8">
8667	<desc>Something went wrong (error code in flags).</desc>
8668	</const>
8669	</enum>
8670
8671	<enum
8672	name="ProcessInputFlag"
8673	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8674	>
8675	<desc>
8676	Guest process input flags.
8677	</desc>
8678	<const name="None" value="0">
8679	<desc>No flag set.</desc>
8680	</const>
8681	<const name="EndOfFile" value="1">
8682	<desc>End of file (input) reached.</desc>
8683	</const>
8684	</enum>
8685
8686	<enum
8687	name="ProcessOutputFlag"
8688	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8689	>
8690	<desc>
8691	Guest process output flags for specifying which
8692	type of output to retrieve.
8693	</desc>
8694	<const name="None" value="0">
8695	<desc>No flags set. Get output from stdout.</desc>
8696	</const>
8697	<const name="StdErr" value="1">
8698	<desc>Get output from stderr.</desc>
8699	</const>
8700	</enum>
8701
8702	<enum
8703	name="CopyFileFlag"
8704	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8705	>
8706	<desc>
8707	Host/Guest copy flags. At the moment none of these flags
8708	are implemented.
8709	</desc>
8710	<const name="None" value="0">
8711	<desc>No flag set.</desc>
8712	</const>
8713	<const name="Recursive" value="1">
8714	<desc>Copy directories recursively.</desc>
8715	</const>
8716	<const name="Update" value="2">
8717	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8718	</const>
8719	<const name="FollowLinks" value="4">
8720	<desc>Follow symbolic links.</desc>
8721	</const>
8722	</enum>
8723
8724	<enum
8725	name="DirectoryCreateFlag"
8726	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8727	>
8728	<desc>
8729	Directory creation flags.
8730	</desc>
8731	<const name="None" value="0">
8732	<desc>No flag set.</desc>
8733	</const>
8734	<const name="Parents" value="1">
8735	<desc>No error if existing, make parent directories as needed.</desc>
8736	</const>
8737	</enum>
8738
8739	<enum
8740	name="DragAndDropAction"
8741	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8742	>
8743	<desc>
8744	Possible actions within an Drag and Drop operation.
8745	</desc>
8746
8747	<const name="Ignore" value="0">
8748	<desc>Do nothing.</desc>
8749	</const>
8750
8751	<const name="Copy" value="1">
8752	<desc>Copy the item to the target.</desc>
8753	</const>
8754
8755	<const name="Move" value="2">
8756	<desc>Move the item to the target.</desc>
8757	</const>
8758
8759	<const name="Link" value="3">
8760	<desc>Link the item from within the target.</desc>
8761	</const>
8762	</enum>
8763
8764	<enum
8765	name="DirectoryOpenFlag"
8766	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8767	>
8768	<desc>
8769	Directory open flags.
8770	</desc>
8771	<const name="None" value="0">
8772	<desc>No flag set.</desc>
8773	</const>
8774	</enum>
8775
8776	<enum
8777	name="GuestDirEntryType"
8778	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8779	>
8780	<desc>
8781	Guest directory entry type.
8782	</desc>
8783	<const name="Unknown" value="0">
8784	<desc>Unknown.</desc>
8785	</const>
8786	<const name="Directory" value="4">
8787	<desc>Regular file.</desc>
8788	</const>
8789	<const name="File" value="10">
8790	<desc>Regular file.</desc>
8791	</const>
8792	<const name="Symlink" value="12">
8793	<desc>Symbolic link.</desc>
8794	</const>
8795	</enum>
8796
8797	<interface
8798	name="IGuestDirEntry" extends="$unknown"
8799	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8800	wsmap="struct"
8801	>
8802	<desc>
8803	Structure representing a directory entry on the guest OS.
8804	</desc>
8805	<attribute name="nodeId" type="long long" readonly="yes">
8806	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8807	</attribute>
8808	<attribute name="name" type="wstring" readonly="yes">
8809	<desc>The filename.</desc>
8810	</attribute>
8811	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8812	<desc>The entry type.</desc>
8813	</attribute>
8814	</interface>
8815
8816	<interface
8817	name="IGuest" extends="$unknown"
8818	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8819	wsmap="managed"
8820	>
8821	<desc>
8822	The IGuest interface represents information about the operating system
8823	running inside the virtual machine. Used in
8824	<link to="IConsole::guest"/>.
8825
8826	IGuest provides information about the guest operating system, whether
8827	Guest Additions are installed and other OS-specific virtual machine
8828	properties.
8829	</desc>
8830
8831	<attribute name="OSTypeId" type="wstring" readonly="yes">
8832	<desc>
8833	Identifier of the Guest OS type as reported by the Guest
8834	Additions.
8835	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8836	an IGuestOSType object representing details about the given
8837	Guest OS type.
8838	<note>
8839	If Guest Additions are not installed, this value will be
8840	the same as <link to="IMachine::OSTypeId"/>.
8841	</note>
8842	</desc>
8843	</attribute>
8844
8845	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8846	<desc>
8847	Current run level of the Guest Additions.
8848	</desc>
8849	</attribute>
8850
8851	<attribute name="additionsVersion" type="wstring" readonly="yes">
8852	<desc>
8853	Version of the Guest Additions in the same format as
8854	<link to="IVirtualBox::version"/>.
8855	</desc>
8856	</attribute>
8857
8858	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8859	<desc>
8860	The internal build revision number of the additions.
8861
8862	See also <link to="IVirtualBox::revision"/>.
8863	</desc>
8864	</attribute>
8865
8866	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8867	<desc>
8868	Array of current known facilities. Only returns facilities where a status is known,
8869	e.g. facilities with an unknown status will not be returned.
8870	</desc>
8871	</attribute>
8872
8873	<attribute name="memoryBalloonSize" type="unsigned long">
8874	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8875	</attribute>
8876
8877	<attribute name="statisticsUpdateInterval" type="unsigned long">
8878	<desc>Interval to update guest statistics in seconds.</desc>
8879	</attribute>
8880
8881	<method name="internalGetStatistics">
8882	<desc>
8883	Internal method; do not use as it might change at any time.
8884	</desc>
8885	<param name="cpuUser" type="unsigned long" dir="out">
8886	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8887	</param>
8888	<param name="cpuKernel" type="unsigned long" dir="out">
8889	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8890	</param>
8891	<param name="cpuIdle" type="unsigned long" dir="out">
8892	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8893	</param>
8894	<param name="memTotal" type="unsigned long" dir="out">
8895	<desc>Total amount of physical guest RAM.</desc>
8896	</param>
8897	<param name="memFree" type="unsigned long" dir="out">
8898	<desc>Free amount of physical guest RAM.</desc>
8899	</param>
8900	<param name="memBalloon" type="unsigned long" dir="out">
8901	<desc>Amount of ballooned physical guest RAM.</desc>
8902	</param>
8903	<param name="memShared" type="unsigned long" dir="out">
8904	<desc>Amount of shared physical guest RAM.</desc>
8905	</param>
8906	<param name="memCache" type="unsigned long" dir="out">
8907	<desc>Total amount of guest (disk) cache memory.</desc>
8908	</param>
8909	<param name="pagedTotal" type="unsigned long" dir="out">
8910	<desc>Total amount of space in the page file.</desc>
8911	</param>
8912	<param name="memAllocTotal" type="unsigned long" dir="out">
8913	<desc>Total amount of memory allocated by the hypervisor.</desc>
8914	</param>
8915	<param name="memFreeTotal" type="unsigned long" dir="out">
8916	<desc>Total amount of free memory available in the hypervisor.</desc>
8917	</param>
8918	<param name="memBalloonTotal" type="unsigned long" dir="out">
8919	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8920	</param>
8921	<param name="memSharedTotal" type="unsigned long" dir="out">
8922	<desc>Total amount of shared memory in the hypervisor.</desc>
8923	</param>
8924	</method>
8925
8926	<method name="getFacilityStatus">
8927	<desc>
8928	Get the current status of a Guest Additions facility.
8929	</desc>
8930	<param name="facility" type="AdditionsFacilityType" dir="in">
8931	<desc>Facility to check status for.</desc>
8932	</param>
8933	<param name="timestamp" type="long long" dir="out">
8934	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8935	</param>
8936	<param name="status" type="AdditionsFacilityStatus" dir="return">
8937	<desc>The current (latest) facility status.</desc>
8938	</param>
8939	</method>
8940
8941	<method name="getAdditionsStatus">
8942	<desc>
8943	Retrieve the current status of a certain Guest Additions run level.
8944
8945	<result name="VBOX_E_NOT_SUPPORTED">
8946	Wrong status level specified.
8947	</result>
8948
8949	</desc>
8950	<param name="level" type="AdditionsRunLevelType" dir="in">
8951	<desc>Status level to check</desc>
8952	</param>
8953	<param name="active" type="boolean" dir="return">
8954	<desc>Flag whether the status level has been reached or not</desc>
8955	</param>
8956	</method>
8957
8958	<method name="setCredentials">
8959	<desc>
8960	Store login credentials that can be queried by guest operating
8961	systems with Additions installed. The credentials are transient
8962	to the session and the guest may also choose to erase them. Note
8963	that the caller cannot determine whether the guest operating system
8964	has queried or made use of the credentials.
8965
8966	<result name="VBOX_E_VM_ERROR">
8967	VMM device is not available.
8968	</result>
8969
8970	</desc>
8971	<param name="userName" type="wstring" dir="in">
8972	<desc>User name string, can be empty</desc>
8973	</param>
8974	<param name="password" type="wstring" dir="in">
8975	<desc>Password string, can be empty</desc>
8976	</param>
8977	<param name="domain" type="wstring" dir="in">
8978	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8979	</param>
8980	<param name="allowInteractiveLogon" type="boolean" dir="in">
8981	<desc>
8982	Flag whether the guest should alternatively allow the user to
8983	interactively specify different credentials. This flag might
8984	not be supported by all versions of the Additions.
8985	</desc>
8986	</param>
8987	</method>
8988
8989	<method name="dragHGEnter">
8990	<desc>
8991	Informs the guest about a Drag and Drop enter event.
8992
8993	This is used in Host - Guest direction.
8994
8995	<result name="VBOX_E_VM_ERROR">
8996	VMM device is not available.
8997	</result>
8998
8999	</desc>
9000	<param name="screenId" type="unsigned long" dir="in">
9001	<desc>The screen id where the Drag and Drop event occured.</desc>
9002	</param>
9003	<param name="y" type="unsigned long" dir="in">
9004	<desc>y-position of the event.</desc>
9005	</param>
9006	<param name="x" type="unsigned long" dir="in">
9007	<desc>x-position of the event.</desc>
9008	</param>
9009	<param name="defaultAction" type="DragAndDropAction" dir="in">
9010	<desc>The default action to use.</desc>
9011	</param>
9012	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9013	<desc>The actions which are allowed.</desc>
9014	</param>
9015	<param name="formats" type="wstring" dir="in" safearray="yes">
9016	<desc>The supported mime types.</desc>
9017	</param>
9018	<param name="resultAction" type="DragAndDropAction" dir="return">
9019	<desc>The resulting action of this event.</desc>
9020	</param>
9021	</method>
9022
9023	<method name="dragHGMove">
9024	<desc>
9025	Informs the guest about a Drag and Drop move event.
9026
9027	This is used in Host - Guest direction.
9028
9029	<result name="VBOX_E_VM_ERROR">
9030	VMM device is not available.
9031	</result>
9032
9033	</desc>
9034	<param name="screenId" type="unsigned long" dir="in">
9035	<desc>The screen id where the Drag and Drop event occured.</desc>
9036	</param>
9037	<param name="x" type="unsigned long" dir="in">
9038	<desc>x-position of the event.</desc>
9039	</param>
9040	<param name="y" type="unsigned long" dir="in">
9041	<desc>y-position of the event.</desc>
9042	</param>
9043	<param name="defaultAction" type="DragAndDropAction" dir="in">
9044	<desc>The default action to use.</desc>
9045	</param>
9046	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9047	<desc>The actions which are allowed.</desc>
9048	</param>
9049	<param name="formats" type="wstring" dir="in" safearray="yes">
9050	<desc>The supported mime types.</desc>
9051	</param>
9052	<param name="resultAction" type="DragAndDropAction" dir="return">
9053	<desc>The resulting action of this event.</desc>
9054	</param>
9055	</method>
9056
9057	<method name="dragHGLeave">
9058	<desc>
9059	Informs the guest about a Drag and Drop leave event.
9060
9061	This is used in Host - Guest direction.
9062
9063	<result name="VBOX_E_VM_ERROR">
9064	VMM device is not available.
9065	</result>
9066
9067	</desc>
9068	<param name="screenId" type="unsigned long" dir="in">
9069	<desc>The screen id where the Drag and Drop event occured.</desc>
9070	</param>
9071	</method>
9072
9073	<method name="dragHGDrop">
9074	<desc>
9075	Informs the guest about a drop event.
9076
9077	This is used in Host - Guest direction.
9078
9079	<result name="VBOX_E_VM_ERROR">
9080	VMM device is not available.
9081	</result>
9082
9083	</desc>
9084	<param name="screenId" type="unsigned long" dir="in">
9085	<desc>The screen id where the Drag and Drop event occured.</desc>
9086	</param>
9087	<param name="x" type="unsigned long" dir="in">
9088	<desc>x-position of the event.</desc>
9089	</param>
9090	<param name="y" type="unsigned long" dir="in">
9091	<desc>y-position of the event.</desc>
9092	</param>
9093	<param name="defaultAction" type="DragAndDropAction" dir="in">
9094	<desc>The default action to use.</desc>
9095	</param>
9096	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9097	<desc>The actions which are allowed.</desc>
9098	</param>
9099	<param name="formats" type="wstring" dir="in" safearray="yes">
9100	<desc>The supported mime types.</desc>
9101	</param>
9102	<param name="format" type="wstring" dir="out">
9103	<desc>The resulting format of this event.</desc>
9104	</param>
9105	<param name="resultAction" type="DragAndDropAction" dir="return">
9106	<desc>The resulting action of this event.</desc>
9107	</param>
9108	</method>
9109
9110	<method name="dragHGPutData">
9111	<desc>
9112	Informs the guest about a drop data event.
9113
9114	This is used in Host - Guest direction.
9115
9116	<result name="VBOX_E_VM_ERROR">
9117	VMM device is not available.
9118	</result>
9119
9120	</desc>
9121	<param name="screenId" type="unsigned long" dir="in">
9122	<desc>The screen id where the Drag and Drop event occured.</desc>
9123	</param>
9124	<param name="format" type="wstring" dir="in">
9125	<desc>The mime type the data is in.</desc>
9126	</param>
9127	<param name="data" type="octet" dir="in" safearray="yes">
9128	<desc>The actual data.</desc>
9129	</param>
9130	<param name="progress" type="IProgress" dir="return">
9131	<desc>Progress object to track the operation completion.</desc>
9132	</param>
9133	</method>
9134
9135	<method name="dragGHPending">
9136	<desc>
9137	Ask the guest if there is any Drag and Drop operation pending in the guest.
9138
9139	If no Drag and Drop operation is pending currently, Ignore is returned.
9140
9141	This is used in Guest - Host direction.
9142
9143	<result name="VBOX_E_VM_ERROR">
9144	VMM device is not available.
9145	</result>
9146
9147	</desc>
9148	<param name="screenId" type="unsigned long" dir="in">
9149	<desc>The screen id where the Drag and Drop event occured.</desc>
9150	</param>
9151	<param name="format" type="wstring" dir="out" safearray="yes">
9152	<desc>On return the supported mime types.</desc>
9153	</param>
9154	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9155	<desc>On return the actions which are allowed.</desc>
9156	</param>
9157	<param name="defaultAction" type="DragAndDropAction" dir="return">
9158	<desc>On return the default action to use.</desc>
9159	</param>
9160	</method>
9161
9162	<method name="dragGHDropped">
9163	<desc>
9164	Informs the guest that a drop event occured for a pending Drag and Drop event.
9165
9166	This is used in Guest - Host direction.
9167
9168	<result name="VBOX_E_VM_ERROR">
9169	VMM device is not available.
9170	</result>
9171
9172	</desc>
9173
9174	<param name="format" type="wstring" dir="in">
9175	<desc>The mime type the data must be in.</desc>
9176	</param>
9177	<param name="action" type="DragAndDropAction" dir="in">
9178	<desc>The action to use.</desc>
9179	</param>
9180	<param name="progress" type="IProgress" dir="return">
9181	<desc>Progress object to track the operation completion.</desc>
9182	</param>
9183	</method>
9184
9185	<method name="dragGHGetData">
9186	<desc>
9187	Fetch the data of a previously Drag and Drop event from the guest.
9188
9189	This is used in Guest - Host direction.
9190
9191	<result name="VBOX_E_VM_ERROR">
9192	VMM device is not available.
9193	</result>
9194
9195	</desc>
9196
9197	<param name="data" type="octet" safearray="yes" dir="return">
9198	<desc>The actual data.</desc>
9199	</param>
9200	</method>
9201
9202	<method name="executeProcess">
9203	<desc>
9204	Executes an existing program inside the guest VM.
9205
9206	<note>
9207	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9208	to serve up to 25 guest processes at a time. If all 25 guest processes
9209	are still active and running, starting a new guest process will result in an
9210	appropriate error message.
9211
9212	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9213	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9214	set, the guest process will not exit until all data from the specified
9215	stream(s) is/are read out.
9216
9217	To raise or lower the guest process execution limit, either the guest property
9218	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9219	command line by specifying "--control-procs-max-kept" needs to be modified.
9220	A restart of the guest OS is required afterwards. To serve unlimited guest
9221	processes, a value of "0" needs to be set (not recommended).
9222	</note>
9223
9224	<result name="VBOX_E_IPRT_ERROR">
9225	Could not execute process.
9226	</result>
9227
9228	</desc>
9229	<param name="execName" type="wstring" dir="in">
9230	<desc>
9231	Full path name of the command to execute on the guest; the
9232	commands has to exists in the guest VM in order to be executed.
9233	</desc>
9234	</param>
9235	<param name="flags" type="unsigned long" dir="in">
9236	<desc>
9237	<link to="ExecuteProcessFlag"/> flags.
9238	</desc>
9239	</param>
9240	<param name="arguments" type="wstring" safearray="yes" dir="in">
9241	<desc>
9242	Array of arguments passed to the execution command.
9243	</desc>
9244	</param>
9245	<param name="environment" type="wstring" safearray="yes" dir="in">
9246	<desc>
9247	Environment variables that can be set while the command is being
9248	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9249	variable just set its name ("NAME") without a value.
9250	</desc>
9251	</param>
9252	<param name="userName" type="wstring" dir="in">
9253	<desc>
9254	User name under which the command will be executed; has to exist
9255	and have the appropriate rights to execute programs in the VM.
9256	</desc>
9257	</param>
9258	<param name="password" type="wstring" dir="in">
9259	<desc>
9260	Password of the user account specified.
9261	</desc>
9262	</param>
9263	<param name="timeoutMS" type="unsigned long" dir="in">
9264	<desc>
9265	The maximum timeout value (in msec) to wait for finished program
9266	execution. Pass 0 for an infinite timeout.
9267	</desc>
9268	</param>
9269	<param name="pid" type="unsigned long" dir="out">
9270	<desc>
9271	The PID (process ID) of the started command for later reference.
9272	</desc>
9273	</param>
9274	<param name="progress" type="IProgress" dir="return">
9275	<desc>Progress object to track the operation completion.</desc>
9276	</param>
9277	</method>
9278
9279	<method name="getProcessOutput">
9280	<desc>
9281	Retrieves output of a formerly started and running guest process.
9282
9283	<note>
9284	Starting with VirtualBox 4.1.8 this only will return output data
9285	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9286	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9287	<link to="ExecuteProcessFlag"/> is set in the
9288	former <link to="#executeProcess"/> call for this guest process.
9289	</note>
9290
9291	<result name="VBOX_E_IPRT_ERROR">
9292	Could not retrieve output.
9293	</result>
9294
9295	</desc>
9296	<param name="pid" type="unsigned long" dir="in">
9297	<desc>
9298	Process id returned by earlier <link to="#executeProcess"/> call.
9299	</desc>
9300	</param>
9301	<param name="flags" type="unsigned long" dir="in">
9302	<desc>
9303	<link to="ProcessOutputFlag"/> flags.
9304	</desc>
9305	</param>
9306	<param name="timeoutMS" type="unsigned long" dir="in">
9307	<desc>
9308	The maximum timeout value (in msec) to wait for output
9309	data. Pass 0 for an infinite timeout.
9310	</desc>
9311	</param>
9312	<param name="size" type="long long" dir="in">
9313	<desc>
9314	Size in bytes to read in the buffer.
9315	</desc>
9316	</param>
9317	<param name="data" type="octet" safearray="yes" dir="return">
9318	<desc>
9319	Buffer for retrieving the actual output. A data size of 0 means end of file
9320	if the requested size was not 0. This is the unprocessed
9321	output data, i.e. the line ending style depends on the platform of
9322	the system the server is running on.
9323	</desc>
9324	</param>
9325	</method>
9326
9327	<method name="getProcessStatus">
9328	<desc>
9329	Retrieves status, exit code and the exit reason of a formerly started
9330	guest process. If a guest process exited or got terminated this function
9331	returns its final status and removes this process from the list of
9332	known guest processes for further retrieval.
9333
9334	<result name="VBOX_E_IPRT_ERROR">
9335	Process with specified PID was not found.
9336	</result>
9337
9338	</desc>
9339	<param name="pid" type="unsigned long" dir="in">
9340	<desc>
9341	Process id returned by earlier <link to="#executeProcess"/> call.
9342	</desc>
9343	</param>
9344	<param name="exitcode" type="unsigned long" dir="out">
9345	<desc>
9346	The exit code (if available).
9347	</desc>
9348	</param>
9349	<param name="flags" type="unsigned long" dir="out">
9350	<desc>
9351	Additional flags of process status. Not used at the moment and
9352	must be set to 0.
9353	</desc>
9354	</param>
9355	<param name="reason" type="ExecuteProcessStatus" dir="return">
9356	<desc>
9357	The current process status.
9358	</desc>
9359	</param>
9360	</method>
9361
9362	<method name="copyFromGuest">
9363	<desc>
9364	Copies files/directories from guest to the host.
9365
9366	<result name="VBOX_E_IPRT_ERROR">
9367	Error while copying.
9368	</result>
9369
9370	</desc>
9371	<param name="source" type="wstring" dir="in">
9372	<desc>
9373	Source file on the guest to copy.
9374	</desc>
9375	</param>
9376	<param name="dest" type="wstring" dir="in">
9377	<desc>
9378	Destination path on the host.
9379	</desc>
9380	</param>
9381	<param name="userName" type="wstring" dir="in">
9382	<desc>
9383	User name under which the copy command will be executed; the
9384	user has to exist and have the appropriate rights to read from
9385	the source path.
9386	</desc>
9387	</param>
9388	<param name="password" type="wstring" dir="in">
9389	<desc>
9390	Password of the user account specified.
9391	</desc>
9392	</param>
9393	<param name="flags" type="unsigned long" dir="in">
9394	<desc>
9395	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9396	</desc>
9397	</param>
9398	<param name="progress" type="IProgress" dir="return">
9399	<desc>Progress object to track the operation completion.</desc>
9400	</param>
9401	</method>
9402
9403	<method name="copyToGuest">
9404	<desc>
9405	Copies files/directories from host to the guest.
9406
9407	<result name="VBOX_E_IPRT_ERROR">
9408	Error while copying.
9409	</result>
9410
9411	</desc>
9412	<param name="source" type="wstring" dir="in">
9413	<desc>
9414	Source file on the host to copy.
9415	</desc>
9416	</param>
9417	<param name="dest" type="wstring" dir="in">
9418	<desc>
9419	Destination path on the guest.
9420	</desc>
9421	</param>
9422	<param name="userName" type="wstring" dir="in">
9423	<desc>
9424	User name under which the copy command will be executed; the
9425	user has to exist and have the appropriate rights to write to
9426	the destination path.
9427	</desc>
9428	</param>
9429	<param name="password" type="wstring" dir="in">
9430	<desc>
9431	Password of the user account specified.
9432	</desc>
9433	</param>
9434	<param name="flags" type="unsigned long" dir="in">
9435	<desc>
9436	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9437	</desc>
9438	</param>
9439	<param name="progress" type="IProgress" dir="return">
9440	<desc>Progress object to track the operation completion.</desc>
9441	</param>
9442	</method>
9443
9444	<method name="directoryClose">
9445	<desc>
9446	Closes a formerly opened guest directory.
9447
9448	<result name="VBOX_E_IPRT_ERROR">
9449	Error while closing directory.
9450	</result>
9451
9452	</desc>
9453	<param name="handle" type="unsigned long" dir="in">
9454	<desc>
9455	Handle of opened directory to close.
9456	</desc>
9457	</param>
9458	</method>
9459
9460	<method name="directoryCreate">
9461	<desc>
9462	Creates a directory on the guest.
9463
9464	<result name="VBOX_E_IPRT_ERROR">
9465	Error while creating directory.
9466	</result>
9467
9468	</desc>
9469	<param name="directory" type="wstring" dir="in">
9470	<desc>
9471	Directory to create.
9472	</desc>
9473	</param>
9474	<param name="userName" type="wstring" dir="in">
9475	<desc>
9476	User name under which the directory creation will be executed; the
9477	user has to exist and have the appropriate rights to create the
9478	desired directory.
9479	</desc>
9480	</param>
9481	<param name="password" type="wstring" dir="in">
9482	<desc>
9483	Password of the user account specified.
9484	</desc>
9485	</param>
9486	<param name="mode" type="unsigned long" dir="in">
9487	<desc>
9488	File mode.
9489	</desc>
9490	</param>
9491	<param name="flags" type="unsigned long" dir="in">
9492	<desc>
9493	<link to="DirectoryCreateFlag"/> flags.
9494	</desc>
9495	</param>
9496	</method>
9497
9498	<method name="directoryOpen">
9499	<desc>
9500	Opens a directory on the guest.
9501
9502	<result name="VBOX_E_IPRT_ERROR">
9503	Error while opening / reading directory.
9504	</result>
9505
9506	</desc>
9507	<param name="directory" type="wstring" dir="in">
9508	<desc>
9509	Directory to read.
9510	</desc>
9511	</param>
9512	<param name="filter" type="wstring" dir="in">
9513	<desc>
9514	Directory filter (DOS style wildcards). Set to empty
9515	string if no filter required.
9516	</desc>
9517	</param>
9518	<param name="flags" type="unsigned long" dir="in">
9519	<desc>
9520	<link to="DirectoryOpenFlag"/> flags.
9521	</desc>
9522	</param>
9523	<param name="userName" type="wstring" dir="in">
9524	<desc>
9525	User name under which the directory reading will be performed; the
9526	user has to exist and have the appropriate rights to access / read the
9527	desired directory.
9528	</desc>
9529	</param>
9530	<param name="password" type="wstring" dir="in">
9531	<desc>
9532	Password of the user account specified.
9533	</desc>
9534	</param>
9535	<param name="handle" type="unsigned long" dir="return">
9536	<desc>
9537	Handle of opened directory returned by openDirectory.
9538	</desc>
9539	</param>
9540	</method>
9541
9542	<method name="directoryRead">
9543	<desc>
9544	Reads the next directory entry of an opened guest directory.
9545
9546	<result name="E_ABORT">
9547	When the end of the directory has been reached.
9548	</result>
9549
9550	<result name="VBOX_E_IPRT_ERROR">
9551	Error while opening / reading directory.
9552	</result>
9553
9554	</desc>
9555	<param name="handle" type="unsigned long" dir="in">
9556	<desc>
9557	Handle of opened directory returned by openDirectory.
9558	</desc>
9559	</param>
9560	<param name="entry" type="IGuestDirEntry" dir="return">
9561	<desc>
9562	Information about next directory entry on success.
9563	</desc>
9564	</param>
9565	</method>
9566
9567	<method name="fileExists">
9568	<desc>
9569	Checks if the specified file name exists and is a regular file.
9570
9571	If the file name ends with a slash or backslash, the function assumes
9572	it's a directory and will check if the specified directory exists and
9573	is a regular directory.
9574
9575	<result name="VBOX_E_IPRT_ERROR">
9576	Error while looking up information.
9577	</result>
9578
9579	</desc>
9580	<param name="file" type="wstring" dir="in">
9581	<desc>
9582	Full path of file to check.
9583	</desc>
9584	</param>
9585	<param name="userName" type="wstring" dir="in">
9586	<desc>
9587	User name under which the lookup will be performed; the
9588	user has to exist and have the appropriate rights to access / read the
9589	desired directory.
9590	</desc>
9591	</param>
9592	<param name="password" type="wstring" dir="in">
9593	<desc>
9594	Password of the user account specified.
9595	</desc>
9596	</param>
9597	<param name="exists" type="boolean" dir="return">
9598	<desc>
9599	True if it's a regular file, false if it isn't (or doesn't exist).
9600	</desc>
9601	</param>
9602	</method>
9603
9604	<method name="fileQuerySize">
9605	<desc>
9606	Queries the size of a file, given the path to it.
9607
9608	<result name="VBOX_E_IPRT_ERROR">
9609	Error while looking up information.
9610	</result>
9611
9612	</desc>
9613	<param name="file" type="wstring" dir="in">
9614	<desc>
9615	Full path of file to query file size for.
9616	</desc>
9617	</param>
9618	<param name="userName" type="wstring" dir="in">
9619	<desc>
9620	User name under which the lookup will be performed; the
9621	user has to exist and have the appropriate rights to access / read the
9622	desired directory.
9623	</desc>
9624	</param>
9625	<param name="password" type="wstring" dir="in">
9626	<desc>
9627	Password of the user account specified.
9628	</desc>
9629	</param>
9630	<param name="size" type="long long" dir="return">
9631	<desc>
9632	Size (in bytes) of file specified.
9633	</desc>
9634	</param>
9635	</method>
9636
9637	<method name="setProcessInput">
9638	<desc>
9639	Sends input into a formerly started process.
9640
9641	<result name="VBOX_E_IPRT_ERROR">
9642	Could not send input.
9643	</result>
9644
9645	</desc>
9646	<param name="pid" type="unsigned long" dir="in">
9647	<desc>
9648	Process id returned by earlier <link to="#executeProcess"/> call.
9649	</desc>
9650	</param>
9651	<param name="flags" type="unsigned long" dir="in">
9652	<desc>
9653	<link to="ProcessInputFlag"/> flags.
9654	</desc>
9655	</param>
9656	<param name="timeoutMS" type="unsigned long" dir="in">
9657	<desc>
9658	The maximum timeout value (in msec) to wait for getting the
9659	data transfered to the guest. Pass 0 for an infinite timeout.
9660	</desc>
9661	</param>
9662	<param name="data" type="octet" dir="in" safearray="yes">
9663	<desc>
9664	Buffer of input data to send to the started process to.
9665	</desc>
9666	</param>
9667	<param name="written" type="unsigned long" dir="return">
9668	<desc>
9669	Number of bytes written.
9670	</desc>
9671	</param>
9672	</method>
9673
9674	<method name="updateGuestAdditions">
9675	<desc>
9676	Updates already installed Guest Additions in a VM
9677	(Windows guests only).
9678
9679	<result name="VBOX_E_IPRT_ERROR">
9680	Error while updating.
9681	</result>
9682
9683	</desc>
9684	<param name="source" type="wstring" dir="in">
9685	<desc>
9686	Path to the Guest Additions .ISO file to use for the upate.
9687	</desc>
9688	</param>
9689	<param name="flags" type="unsigned long" dir="in">
9690	<desc>
9691	<link to="AdditionsUpdateFlag"/> flags.
9692	</desc>
9693	</param>
9694	<param name="progress" type="IProgress" dir="return">
9695	<desc>Progress object to track the operation completion.</desc>
9696	</param>
9697	</method>
9698
9699	</interface>
9700
9701
9702	<!--
9703	// IProgress
9704	/////////////////////////////////////////////////////////////////////////
9705	-->
9706
9707	<interface
9708	name="IProgress" extends="$unknown"
9709	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9710	wsmap="managed"
9711	>
9712	<desc>
9713	The IProgress interface is used to track and control
9714	asynchronous tasks within VirtualBox.
9715
9716	An instance of this is returned every time VirtualBox starts
9717	an asynchronous task (in other words, a separate thread) which
9718	continues to run after a method call returns. For example,
9719	<link to="IConsole::saveState" />, which saves the state of
9720	a running virtual machine, can take a long time to complete.
9721	To be able to display a progress bar, a user interface such as
9722	the VirtualBox graphical user interface can use the IProgress
9723	object returned by that method.
9724
9725	Note that IProgress is a "read-only" interface in the sense
9726	that only the VirtualBox internals behind the Main API can
9727	create and manipulate progress objects, whereas client code
9728	can only use the IProgress object to monitor a task's
9729	progress and, if <link to="#cancelable" /> is @c true,
9730	cancel the task by calling <link to="#cancel" />.
9731
9732	A task represented by IProgress consists of either one or
9733	several sub-operations that run sequentially, one by one (see
9734	<link to="#operation" /> and <link to="#operationCount" />).
9735	Every operation is identified by a number (starting from 0)
9736	and has a separate description.
9737
9738	You can find the individual percentage of completion of the current
9739	operation in <link to="#operationPercent" /> and the
9740	percentage of completion of the task as a whole
9741	in <link to="#percent" />.
9742
9743	Similarly, you can wait for the completion of a particular
9744	operation via <link to="#waitForOperationCompletion" /> or
9745	for the completion of the whole task via
9746	<link to="#waitForCompletion" />.
9747	</desc>
9748
9749	<attribute name="id" type="uuid" mod="string" readonly="yes">
9750	<desc>ID of the task.</desc>
9751	</attribute>
9752
9753	<attribute name="description" type="wstring" readonly="yes">
9754	<desc>Description of the task.</desc>
9755	</attribute>
9756
9757	<attribute name="initiator" type="$unknown" readonly="yes">
9758	<desc>Initiator of the task.</desc>
9759	</attribute>
9760
9761	<attribute name="cancelable" type="boolean" readonly="yes">
9762	<desc>Whether the task can be interrupted.</desc>
9763	</attribute>
9764
9765	<attribute name="percent" type="unsigned long" readonly="yes">
9766	<desc>
9767	Current progress value of the task as a whole, in percent.
9768	This value depends on how many operations are already complete.
9769	Returns 100 if <link to="#completed" /> is @c true.
9770	</desc>
9771	</attribute>
9772
9773	<attribute name="timeRemaining" type="long" readonly="yes">
9774	<desc>
9775	Estimated remaining time until the task completes, in
9776	seconds. Returns 0 once the task has completed; returns -1
9777	if the remaining time cannot be computed, in particular if
9778	the current progress is 0.
9779
9780	Even if a value is returned, the estimate will be unreliable
9781	for low progress values. It will become more reliable as the
9782	task progresses; it is not recommended to display an ETA
9783	before at least 20% of a task have completed.
9784	</desc>
9785	</attribute>
9786
9787	<attribute name="completed" type="boolean" readonly="yes">
9788	<desc>Whether the task has been completed.</desc>
9789	</attribute>
9790
9791	<attribute name="canceled" type="boolean" readonly="yes">
9792	<desc>Whether the task has been canceled.</desc>
9793	</attribute>
9794
9795	<attribute name="resultCode" type="long" readonly="yes">
9796	<desc>
9797	Result code of the progress task.
9798	Valid only if <link to="#completed"/> is @c true.
9799	</desc>
9800	</attribute>
9801
9802	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9803	<desc>
9804	Extended information about the unsuccessful result of the
9805	progress operation. May be @c null if no extended information
9806	is available.
9807	Valid only if <link to="#completed"/> is @c true and
9808	<link to="#resultCode"/> indicates a failure.
9809	</desc>
9810	</attribute>
9811
9812	<attribute name="operationCount" type="unsigned long" readonly="yes">
9813	<desc>
9814	Number of sub-operations this task is divided into.
9815	Every task consists of at least one suboperation.
9816	</desc>
9817	</attribute>
9818
9819	<attribute name="operation" type="unsigned long" readonly="yes">
9820	<desc>Number of the sub-operation being currently executed.</desc>
9821	</attribute>
9822
9823	<attribute name="operationDescription" type="wstring" readonly="yes">
9824	<desc>
9825	Description of the sub-operation being currently executed.
9826	</desc>
9827	</attribute>
9828
9829	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9830	<desc>Progress value of the current sub-operation only, in percent.</desc>
9831	</attribute>
9832
9833	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9834	<desc>Weight value of the current sub-operation only.</desc>
9835	</attribute>
9836
9837	<attribute name="timeout" type="unsigned long">
9838	<desc>
9839	When non-zero, this specifies the number of milliseconds after which
9840	the operation will automatically be canceled. This can only be set on
9841	cancelable objects.
9842	</desc>
9843	</attribute>
9844
9845	<method name="setCurrentOperationProgress">
9846	<desc>Internal method, not to be called externally.</desc>
9847	<param name="percent" type="unsigned long" dir="in" />
9848	</method>
9849	<method name="setNextOperation">
9850	<desc>Internal method, not to be called externally.</desc>
9851	<param name="nextOperationDescription" type="wstring" dir="in" />
9852	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9853	</method>
9854
9855	<method name="waitForCompletion">
9856	<desc>
9857	Waits until the task is done (including all sub-operations)
9858	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9859
9860	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9861	thread are not processed while waiting. Neglecting event queues may
9862	have dire consequences (degrade performance, resource hogs,
9863	deadlocks, etc.), this is specially so for the main thread on
9864	platforms using XPCOM. Callers are adviced wait for short periods
9865	and service their event queues between calls, or to create a worker
9866	thread to do the waiting.
9867
9868	<result name="VBOX_E_IPRT_ERROR">
9869	Failed to wait for task completion.
9870	</result>
9871	</desc>
9872
9873	<param name="timeout" type="long" dir="in">
9874	<desc>
9875	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9876	</desc>
9877	</param>
9878	</method>
9879
9880	<method name="waitForOperationCompletion">
9881	<desc>
9882	Waits until the given operation is done with a given timeout in
9883	milliseconds; specify -1 for an indefinite wait.
9884
9885	See <link to="#waitForCompletion"> for event queue considerations.</link>
9886
9887	<result name="VBOX_E_IPRT_ERROR">
9888	Failed to wait for operation completion.
9889	</result>
9890
9891	</desc>
9892	<param name="operation" type="unsigned long" dir="in">
9893	<desc>
9894	Number of the operation to wait for.
9895	Must be less than <link to="#operationCount"/>.
9896	</desc>
9897	</param>
9898	<param name="timeout" type="long" dir="in">
9899	<desc>
9900	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9901	</desc>
9902	</param>
9903	</method>
9904
9905	<method name="waitForAsyncProgressCompletion">
9906	<desc>
9907	Waits until the other task is completed (including all
9908	sub-operations) and forward all changes from the other progress to
9909	this progress. This means sub-operation number, description, percent
9910	and so on.
9911
9912	You have to take care on setting up at least the same count on
9913	sub-operations in this progress object like there are in the other
9914	progress object.
9915
9916	If the other progress object supports cancel and this object gets any
9917	cancel request (when here enabled as well), it will be forwarded to
9918	the other progress object.
9919
9920	If there is an error in the other progress, this error isn't
9921	automatically transfered to this progress object. So you have to
9922	check any operation error within the other progress object, after
9923	this method returns.
9924	</desc>
9925
9926	<param name="pProgressAsync" type="IProgress" dir="in">
9927	<desc>
9928	The progress object of the asynchrony process.
9929	</desc>
9930	</param>
9931	</method>
9932
9933	<method name="cancel">
9934	<desc>
9935	Cancels the task.
9936	<note>
9937	If <link to="#cancelable"/> is @c false, then this method will fail.
9938	</note>
9939
9940	<result name="VBOX_E_INVALID_OBJECT_STATE">
9941	Operation cannot be canceled.
9942	</result>
9943
9944	</desc>
9945	</method>
9946
9947	</interface>
9948
9949	<!--
9950	// ISnapshot
9951	/////////////////////////////////////////////////////////////////////////
9952	-->
9953
9954	<interface
9955	name="ISnapshot" extends="$unknown"
9956	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9957	wsmap="managed"
9958	>
9959	<desc>
9960	The ISnapshot interface represents a snapshot of the virtual
9961	machine.
9962
9963	Together with the differencing media that are created
9964	when a snapshot is taken, a machine can be brought back to
9965	the exact state it was in when the snapshot was taken.
9966
9967	The ISnapshot interface has no methods, only attributes; snapshots
9968	are controlled through methods of the <link to="IConsole" /> interface
9969	which also manage the media associated with the snapshot.
9970	The following operations exist:
9971
9972	<ul>
9973	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9974	by creating new, empty differencing images for the machine's
9975	media and saving the VM settings and (if the VM is running)
9976	the current VM state in the snapshot.
9977
9978	The differencing images will then receive all data written to
9979	the machine's media, while their parent (base) images
9980	remain unmodified after the snapshot has been taken (see
9981	<link to="IMedium" /> for details about differencing images).
9982	This simplifies restoring a machine to the state of a snapshot:
9983	only the differencing images need to be deleted.
9984
9985	The current machine state is not changed by taking a snapshot
9986	except that <link to="IMachine::currentSnapshot" /> is set to
9987	the newly created snapshot, which is also added to the machine's
9988	snapshots tree.
9989	</li>
9990
9991	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9992	the state of a previous snapshot by deleting the differencing
9993	image of each of the machine's media and setting the machine's
9994	settings and state to the state that was saved in the snapshot (if any).
9995
9996	This destroys the machine's current state. After calling this,
9997	<link to="IMachine::currentSnapshot" /> points to the snapshot
9998	that was restored.
9999	</li>
10000
10001	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
10002	without affecting the current machine state.
10003
10004	This does not change the current machine state, but instead frees the
10005	resources allocated when the snapshot was taken: the settings and machine
10006	state file are deleted (if any), and the snapshot's differencing image for
10007	each of the machine's media gets merged with its parent image.
10008
10009	Neither the current machine state nor other snapshots are affected
10010	by this operation, except that parent media will be modified
10011	to contain the disk data associated with the snapshot being deleted.
10012
10013	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
10014	attribute is set to the current snapshot's parent or NULL if it
10015	has no parent. Otherwise the attribute is unchanged.
10016	</li>
10017	</ul>
10018
10019	Each snapshot contains a copy of virtual machine's settings (hardware
10020	configuration etc.). This copy is contained in an immutable (read-only)
10021	instance of <link to="IMachine" /> which is available from the snapshot's
10022	<link to="#machine" /> attribute. When restoring the snapshot, these
10023	settings are copied back to the original machine.
10024
10025	In addition, if the machine was running when the
10026	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
10027	the current VM state is saved in the snapshot (similarly to what happens
10028	when a VM's state is saved). The snapshot is then said to be <i>online</i>
10029	because when restoring it, the VM will be running.
10030
10031	If the machine was in <link to="MachineState_Saved">saved</link> saved,
10032	the snapshot receives a copy of the execution state file
10033	(<link to="IMachine::stateFilePath"/>).
10034
10035	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
10036	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
10037	it then contains a so-called "zero execution state", representing a
10038	machine that is powered off.
10039	</desc>
10040
10041	<attribute name="id" type="uuid" mod="string" readonly="yes">
10042	<desc>UUID of the snapshot.</desc>
10043	</attribute>
10044
10045	<attribute name="name" type="wstring">
10046	<desc>Short name of the snapshot.
10047	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10048	be called implicitly.</note>
10049	</desc>
10050	</attribute>
10051
10052	<attribute name="description" type="wstring">
10053	<desc>Optional description of the snapshot.
10054	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10055	be called implicitly.</note>
10056	</desc>
10057	</attribute>
10058
10059	<attribute name="timeStamp" type="long long" readonly="yes">
10060	<desc>
10061	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
10062	</desc>
10063	</attribute>
10064
10065	<attribute name="online" type="boolean" readonly="yes">
10066	<desc>
10067	@c true if this snapshot is an online snapshot and @c false otherwise.
10068
10069	When this attribute is @c true, the
10070	<link to="IMachine::stateFilePath"/> attribute of the
10071	<link to="#machine"/> object associated with this snapshot
10072	will point to the saved state file. Otherwise, it will be
10073	an empty string.
10074	</desc>
10075	</attribute>
10076
10077	<attribute name="machine" type="IMachine" readonly="yes">
10078	<desc>
10079	Virtual machine this snapshot is taken on. This object
10080	stores all settings the machine had when taking this snapshot.
10081	<note>
10082	The returned machine object is immutable, i.e. no
10083	any settings can be changed.
10084	</note>
10085	</desc>
10086	</attribute>
10087
10088	<attribute name="parent" type="ISnapshot" readonly="yes">
10089	<desc>
10090	Parent snapshot (a snapshot this one is based on), or
10091	@c null if the snapshot has no parent (i.e. is the first snapshot).
10092	</desc>
10093	</attribute>
10094
10095	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
10096	<desc>
10097	Child snapshots (all snapshots having this one as a parent).
10098	By inspecting this attribute starting with a machine's root snapshot
10099	(which can be obtained by calling <link to="IMachine::findSnapshot" />
10100	with a @c null UUID), a machine's snapshots tree can be iterated over.
10101	</desc>
10102	</attribute>
10103
10104	<method name="getChildrenCount" const="yes">
10105	<desc>
10106	Returns the number of direct childrens of this snapshot.
10107	</desc>
10108	<param name="childrenCount" type="unsigned long" dir="return">
10109	<desc>
10110	</desc>
10111	</param>
10112	</method>
10113
10114	</interface>
10115
10116
10117	<!--
10118	// IMedium
10119	/////////////////////////////////////////////////////////////////////////
10120	-->
10121
10122	<enum
10123	name="MediumState"
10124	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
10125	>
10126	<desc>
10127	Virtual medium state.
10128	<see><link to="IMedium"/></see>
10129	</desc>
10130
10131	<const name="NotCreated" value="0">
10132	<desc>
10133	Associated medium storage does not exist (either was not created yet or
10134	was deleted).
10135	</desc>
10136	</const>
10137	<const name="Created" value="1">
10138	<desc>
10139	Associated storage exists and accessible; this gets set if the
10140	accessibility check performed by <link to="IMedium::refreshState" />
10141	was successful.
10142	</desc>
10143	</const>
10144	<const name="LockedRead" value="2">
10145	<desc>
10146	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10147	no data modification is possible.
10148	</desc>
10149	</const>
10150	<const name="LockedWrite" value="3">
10151	<desc>
10152	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10153	no concurrent data reading or modification is possible.
10154	</desc>
10155	</const>
10156	<const name="Inaccessible" value="4">
10157	<desc>
10158	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10159	not yet been performed, or else, associated medium storage is not
10160	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10161	is empty, in the second case, it describes the error that occurred.
10162	</desc>
10163	</const>
10164	<const name="Creating" value="5">
10165	<desc>
10166	Associated medium storage is being created.
10167	</desc>
10168	</const>
10169	<const name="Deleting" value="6">
10170	<desc>
10171	Associated medium storage is being deleted.
10172	</desc>
10173	</const>
10174	</enum>
10175
10176	<enum
10177	name="MediumType"
10178	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10179	>
10180	<desc>
10181	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10182	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10183	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10184	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10185	</desc>
10186
10187	<const name="Normal" value="0">
10188	<desc>
10189	Normal medium (attached directly or indirectly, preserved
10190	when taking snapshots).
10191	</desc>
10192	</const>
10193	<const name="Immutable" value="1">
10194	<desc>
10195	Immutable medium (attached indirectly, changes are wiped out
10196	the next time the virtual machine is started).
10197	</desc>
10198	</const>
10199	<const name="Writethrough" value="2">
10200	<desc>
10201	Write through medium (attached directly, ignored when
10202	taking snapshots).
10203	</desc>
10204	</const>
10205	<const name="Shareable" value="3">
10206	<desc>
10207	Allow using this medium concurrently by several machines.
10208	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10209	</desc>
10210	</const>
10211	<const name="Readonly" value="4">
10212	<desc>
10213	A readonly medium, which can of course be used by several machines.
10214	<note>Present and accepted since VirtualBox 4.0.</note>
10215	</desc>
10216	</const>
10217	<const name="MultiAttach" value="5">
10218	<desc>
10219	A medium which is is indirectly attached, so that one base medium can
10220	be used for several VMs which have their own differencing medium to
10221	store their modifications. In some sense a variant of Immutable
10222	with unset AutoReset flag in each differencing medium.
10223	<note>Present and accepted since VirtualBox 4.0.</note>
10224	</desc>
10225	</const>
10226	</enum>
10227
10228	<enum
10229	name="MediumVariant"
10230	uuid="80685b6b-e42f-497d-8271-e77bf3c61ada"
10231	>
10232	<desc>
10233	Virtual medium image variant. More than one flag may be set.
10234	<see><link to="IMedium"/></see>
10235	</desc>
10236
10237	<const name="Standard" value="0">
10238	<desc>
10239	No particular variant requested, results in using the backend default.
10240	</desc>
10241	</const>
10242	<const name="VmdkSplit2G" value="0x01">
10243	<desc>
10244	VMDK image split in chunks of less than 2GByte.
10245	</desc>
10246	</const>
10247	<const name="VmdkRawDisk" value="0x02">
10248	<desc>
10249	VMDK image representing a raw disk.
10250	</desc>
10251	</const>
10252	<const name="VmdkStreamOptimized" value="0x04">
10253	<desc>
10254	VMDK streamOptimized image. Special import/export format which is
10255	read-only/append-only.
10256	</desc>
10257	</const>
10258	<const name="VmdkESX" value="0x08">
10259	<desc>
10260	VMDK format variant used on ESX products.
10261	</desc>
10262	</const>
10263	<const name="Fixed" value="0x10000">
10264	<desc>
10265	Fixed image. Only allowed for base images.
10266	</desc>
10267	</const>
10268	<const name="Diff" value="0x20000">
10269	<desc>
10270	Differencing image. Only allowed for child images.
10271	</desc>
10272	</const>
10273	<const name="NoCreateDir" value="0x40000000">
10274	<desc>
10275	Special flag which suppresses automatic creation of the subdirectory.
10276	Only used when passing the medium variant as an input parameter.
10277	</desc>
10278	</const>
10279	</enum>
10280
10281	<interface
10282	name="IMediumAttachment" extends="$unknown"
10283	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10284	wsmap="struct"
10285	>
10286	<desc>
10287	The IMediumAttachment interface links storage media to virtual machines.
10288	For each medium (<link to="IMedium"/>) which has been attached to a
10289	storage controller (<link to="IStorageController"/>) of a machine
10290	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10291	method, one instance of IMediumAttachment is added to the machine's
10292	<link to="IMachine::mediumAttachments"/> array attribute.
10293
10294	Each medium attachment specifies the storage controller as well as a
10295	port and device number and the IMedium instance representing a virtual
10296	hard disk or floppy or DVD image.
10297
10298	For removable media (DVDs or floppies), there are two additional
10299	options. For one, the IMedium instance can be @c null to represent
10300	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10301	secondly, the medium can be one of the pseudo-media for host drives
10302	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10303
10304	<h3>Attaching Hard Disks</h3>
10305
10306	Hard disks are attached to virtual machines using the
10307	<link to="IMachine::attachDevice"/> method and detached using the
10308	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10309	type (see <link to="IMedium::type" />), hard disks are attached either
10310	<i>directly</i> or <i>indirectly</i>.
10311
10312	When a hard disk is being attached directly, it is associated with the
10313	virtual machine and used for hard disk operations when the machine is
10314	running. When a hard disk is being attached indirectly, a new differencing
10315	hard disk linked to it is implicitly created and this differencing hard
10316	disk is associated with the machine and used for hard disk operations.
10317	This also means that if <link to="IMachine::attachDevice"/> performs
10318	a direct attachment then the same hard disk will be returned in response
10319	to the subsequent <link to="IMachine::getMedium"/> call; however if
10320	an indirect attachment is performed then
10321	<link to="IMachine::getMedium"/> will return the implicitly created
10322	differencing hard disk, not the original one passed to <link
10323	to="IMachine::attachDevice"/>. In detail:
10324
10325	<ul>
10326	<li><b>Normal base</b> hard disks that do not have children (i.e.
10327	differencing hard disks linked to them) and that are not already
10328	attached to virtual machines in snapshots are attached <b>directly</b>.
10329	Otherwise, they are attached <b>indirectly</b> because having
10330	dependent children or being part of the snapshot makes it impossible
10331	to modify hard disk contents without breaking the integrity of the
10332	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10333	quickly determine the kind of the attachment for the given hard
10334	disk. Note that if a normal base hard disk is to be indirectly
10335	attached to a virtual machine with snapshots then a special
10336	procedure called <i>smart attachment</i> is performed (see below).</li>
10337	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10338	they are attached <b>directly</b> if they do not have children and are
10339	not attached to virtual machines in snapshots, and <b>indirectly</b>
10340	otherwise. Note that the smart attachment procedure is never performed
10341	for differencing hard disks.</li>
10342	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10343	they are designed to be non-writable. If an immutable hard disk is
10344	attached to a virtual machine with snapshots then a special
10345	procedure called smart attachment is performed (see below).</li>
10346	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10347	also as designed. This also means that writethrough hard disks cannot
10348	have other hard disks linked to them at all.</li>
10349	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10350	also as designed. This also means that shareable hard disks cannot
10351	have other hard disks linked to them at all. They behave almost
10352	like writethrough hard disks, except that shareable hard disks can
10353	be attached to several virtual machines which are running, allowing
10354	concurrent accesses. You need special cluster software running in
10355	the virtual machines to make use of such disks.</li>
10356	</ul>
10357
10358	Note that the same hard disk, regardless of its type, may be attached to
10359	more than one virtual machine at a time. In this case, the machine that is
10360	started first gains exclusive access to the hard disk and attempts to
10361	start other machines having this hard disk attached will fail until the
10362	first machine is powered down.
10363
10364	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10365	that the given hard disk remains associated with the given machine after a
10366	successful <link to="IMachine::detachDevice"/> call until
10367	<link to="IMachine::saveSettings"/> is called to save all changes to
10368	machine settings to disk. This deferring is necessary to guarantee that
10369	the hard disk configuration may be restored at any time by a call to
10370	<link to="IMachine::discardSettings"/> before the settings
10371	are saved (committed).
10372
10373	Note that if <link to="IMachine::discardSettings"/> is called after
10374	indirectly attaching some hard disks to the machine but before a call to
10375	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10376	all differencing hard disks implicitly created by
10377	<link to="IMachine::attachDevice"/> for these indirect attachments.
10378	Such implicitly created hard disks will also be immediately deleted when
10379	detached explicitly using the <link to="IMachine::detachDevice"/>
10380	call if it is made before <link to="IMachine::saveSettings"/>. This
10381	implicit deletion is safe because newly created differencing hard
10382	disks do not contain any user data.
10383
10384	However, keep in mind that detaching differencing hard disks that were
10385	implicitly created by <link to="IMachine::attachDevice"/>
10386	before the last <link to="IMachine::saveSettings"/> call will
10387	<b>not</b> implicitly delete them as they may already contain some data
10388	(for example, as a result of virtual machine execution). If these hard
10389	disks are no more necessary, the caller can always delete them explicitly
10390	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10391	from this machine by the <link to="IMachine::saveSettings"/> call.
10392
10393	<h3>Smart Attachment</h3>
10394
10395	When normal base or immutable hard disks are indirectly attached to a
10396	virtual machine then some additional steps are performed to make sure the
10397	virtual machine will have the most recent "view" of the hard disk being
10398	attached. These steps include walking through the machine's snapshots
10399	starting from the current one and going through ancestors up to the first
10400	snapshot. Hard disks attached to the virtual machine in all
10401	of the encountered snapshots are checked whether they are descendants of
10402	the given normal base or immutable hard disk. The first found child (which
10403	is the differencing hard disk) will be used instead of the normal base or
10404	immutable hard disk as a parent for creating a new differencing hard disk
10405	that will be actually attached to the machine. And only if no descendants
10406	are found or if the virtual machine does not have any snapshots then the
10407	normal base or immutable hard disk will be used itself as a parent for
10408	this differencing hard disk.
10409
10410	It is easier to explain what smart attachment does using the
10411	following example:
10412	<pre>
10413	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10414
10415	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10416	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10417	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10418	Snapshot 4 (none) Snapshot 4 (none)
10419	CurState (none) CurState (D3->D2.vdi)
10420
10421	NOT
10422	...
10423	CurState (D3->B.vdi)
10424	</pre>
10425	The first column is the virtual machine configuration before the base hard
10426	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10427	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10428	mean that the hard disk that is actually attached to the machine is a
10429	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10430	another hard disk, <tt>B.vdi</tt>.
10431
10432	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10433	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10434	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10435	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10436	it cannot be attached directly and needs an indirect attachment (i.e.
10437	implicit creation of a new differencing hard disk). Due to the smart
10438	attachment procedure, the new differencing hard disk
10439	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10440	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10441	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10442	machine.
10443
10444	Note that if there is more than one descendant hard disk of the given base
10445	hard disk found in a snapshot, and there is an exact device, channel and
10446	bus match, then this exact match will be used. Otherwise, the youngest
10447	descendant will be picked up.
10448
10449	There is one more important aspect of the smart attachment procedure which
10450	is not related to snapshots at all. Before walking through the snapshots
10451	as described above, the backup copy of the current list of hard disk
10452	attachment is searched for descendants. This backup copy is created when
10453	the hard disk configuration is changed for the first time after the last
10454	<link to="IMachine::saveSettings"/> call and used by
10455	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10456	changes. When such a descendant is found in this backup copy, it will be
10457	simply re-attached back, without creating a new differencing hard disk for
10458	it. This optimization is necessary to make it possible to re-attach the
10459	base or immutable hard disk to a different bus, channel or device slot
10460	without losing the contents of the differencing hard disk actually
10461	attached to the machine in place of it.
10462
10463	</desc>
10464
10465	<attribute name="medium" type="IMedium" readonly="yes">
10466	<desc>Medium object associated with this attachment; it
10467	can be @c null for removable devices.</desc>
10468	</attribute>
10469
10470	<attribute name="controller" type="wstring" readonly="yes">
10471	<desc>Name of the storage controller of this attachment; this
10472	refers to one of the controllers in <link to="IMachine::storageControllers" />
10473	by name.</desc>
10474	</attribute>
10475
10476	<attribute name="port" type="long" readonly="yes">
10477	<desc>Port number of this attachment.
10478	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10479	</desc>
10480	</attribute>
10481
10482	<attribute name="device" type="long" readonly="yes">
10483	<desc>Device slot number of this attachment.
10484	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10485	</desc>
10486	</attribute>
10487
10488	<attribute name="type" type="DeviceType" readonly="yes">
10489	<desc>Device type of this attachment.</desc>
10490	</attribute>
10491
10492	<attribute name="passthrough" type="boolean" readonly="yes">
10493	<desc>Pass I/O requests through to a device on the host.</desc>
10494	</attribute>
10495
10496	<attribute name="temporaryEject" type="boolean" readonly="yes">
10497	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10498	</attribute>
10499
10500	<attribute name="isEjected" type="boolean" readonly="yes">
10501	<desc>Signals that the removable medium has been ejected. This is not
10502	necessarily equivalent to having a @c null medium association.</desc>
10503	</attribute>
10504
10505	<attribute name="nonRotational" type="boolean" readonly="yes">
10506	<desc>Whether the associated medium is non-rotational.</desc>
10507	</attribute>
10508
10509	<attribute name="discard" type="boolean" readonly="yes">
10510	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10511	</attribute>
10512
10513	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10514	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10515	</attribute>
10516
10517	</interface>
10518
10519	<interface
10520	name="IMedium" extends="$unknown"
10521	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10522	wsmap="managed"
10523	>
10524	<desc>
10525	The IMedium interface represents virtual storage for a machine's
10526	hard disks, CD/DVD or floppy drives. It will typically represent
10527	a disk image on the host, for example a VDI or VMDK file representing
10528	a virtual hard disk, or an ISO or RAW file representing virtual
10529	removable media, but can also point to a network location (e.g.
10530	for iSCSI targets).
10531
10532	Instances of IMedium are connected to virtual machines by way of medium
10533	attachments, which link the storage medium to a particular device slot
10534	of a storage controller of the virtual machine.
10535	In the VirtualBox API, virtual storage is therefore always represented
10536	by the following chain of object links:
10537
10538	<ul>
10539	<li><link to="IMachine::storageControllers"/> contains an array of
10540	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10541	these are instances of <link to="IStorageController"/>).</li>
10542	<li><link to="IMachine::mediumAttachments"/> contains an array of
10543	medium attachments (instances of <link to="IMediumAttachment"/>
10544	created by <link to="IMachine::attachDevice" />),
10545	each containing a storage controller from the above array, a
10546	port/device specification, and an instance of IMedium representing
10547	the medium storage (image file).
10548
10549	For removable media, the storage medium is optional; a medium
10550	attachment with no medium represents a CD/DVD or floppy drive
10551	with no medium inserted. By contrast, hard disk attachments
10552	will always have an IMedium object attached.</li>
10553	<li>Each IMedium in turn points to a storage unit (such as a file
10554	on the host computer or a network resource) that holds actual
10555	data. This location is represented by the <link to="#location"/>
10556	attribute.</li>
10557	</ul>
10558
10559	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10560	new hard disk media can be created with the VirtualBox API using the
10561	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10562	disks (see below) are usually implicitly created by VirtualBox as
10563	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10564	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10565	should be created with external tools and then opened from within VirtualBox.
10566
10567	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10568	drive. In that case the <link to="#id" /> attribute contains the UUID of
10569	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10570
10571	<h3>Media registries</h3>
10572
10573	When a medium has been opened or created using one of the aforementioned
10574	APIs, it becomes "known" to VirtualBox. Known media can be attached
10575	to virtual machines and re-found through <link to="IVirtualBox::openMedium"/>.
10576	They also appear in the global
10577	<link to="IVirtualBox::hardDisks" />,
10578	<link to="IVirtualBox::DVDImages" /> and
10579	<link to="IVirtualBox::floppyImages" /> arrays.
10580
10581	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10582	in the VirtualBox.xml file, which was shared between all machines and made
10583	transporting machines and their media from one host to another difficult.
10584
10585	Starting with VirtualBox 4.0, media are only added to a registry when they are
10586	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10587	backwards compatibility, which registry a medium is added to depends on which
10588	VirtualBox version created a machine:
10589
10590	<ul>
10591	<li>If the medium has first been attached to a machine which was created by
10592	VirtualBox 4.0 or later, it is added to that machine's media registry in
10593	the machine XML settings file. This way all information about a machine's
10594	media attachments is contained in a single file and can be transported
10595	easily.</li>
10596	<li>For older media attachments (i.e. if the medium was first attached to a
10597	machine which was created with a VirtualBox version before 4.0), media
10598	continue to be registered in the global VirtualBox settings file, for
10599	backwards compatibility.</li>
10600	</ul>
10601
10602	See <link to="IVirtualBox::openMedium" /> for more information.
10603
10604	Media are removed from media registries by the <link to="IMedium::close"/>,
10605	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10606
10607	<h3>Accessibility checks</h3>
10608
10609	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10610	method is called explicitly on a medium. This is done to make the VirtualBox object
10611	ready for serving requests as fast as possible and let the end-user
10612	application decide if it needs to check media accessibility right away or not.
10613
10614	As a result, when VirtualBox starts up (e.g. the VirtualBox
10615	object gets created for the first time), all known media are in the
10616	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10617	attribute is an empty string because no actual accessibility check has
10618	been made yet.
10619
10620	After calling <link to="#refreshState" />, a medium is considered
10621	<i>accessible</i> if its storage unit can be read. In that case, the
10622	<link to="#state"/> attribute has a value of "Created". If the storage
10623	unit cannot be read (for example, because it is located on a disconnected
10624	network resource, or was accidentally deleted outside VirtualBox),
10625	the medium is considered <i>inaccessible</i>, which is indicated by the
10626	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10627	obtained by reading the <link to="#lastAccessError"/> attribute.
10628
10629	<h3>Medium types</h3>
10630
10631	There are five types of medium behavior which are stored in the
10632	<link to="#type"/> attribute (see <link to="MediumType" />) and
10633	which define the medium's behavior with attachments and snapshots.
10634
10635	All media can be also divided in two groups: <i>base</i> media and
10636	<i>differencing</i> media. A base medium contains all sectors of the
10637	medium data in its own storage and therefore can be used independently.
10638	In contrast, a differencing medium is a "delta" to some other medium and
10639	contains only those sectors which differ from that other medium, which is
10640	then called a <i>parent</i>. The differencing medium is said to be
10641	<i>linked to</i> that parent. The parent may be itself a differencing
10642	medium, thus forming a chain of linked media. The last element in that
10643	chain must always be a base medium. Note that several differencing
10644	media may be linked to the same parent medium.
10645
10646	Differencing media can be distinguished from base media by querying the
10647	<link to="#parent"/> attribute: base media do not have parents they would
10648	depend on, so the value of this attribute is always @c null for them.
10649	Using this attribute, it is possible to walk up the medium tree (from the
10650	child medium to its parent). It is also possible to walk down the tree
10651	using the <link to="#children"/> attribute.
10652
10653	Note that the type of all differencing media is "normal"; all other
10654	values are meaningless for them. Base media may be of any type.
10655
10656	<h3>Automatic composition of the file name part</h3>
10657
10658	Another extension to the <link to="IMedium::location"/> attribute is that
10659	there is a possibility to cause VirtualBox to compose a unique value for
10660	the file name part of the location using the UUID of the hard disk. This
10661	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10662	e.g. before the storage unit is created, and works as follows. You set the
10663	value of the <link to="IMedium::location"/> attribute to a location
10664	specification which only contains the path specification but not the file
10665	name part and ends with either a forward slash or a backslash character.
10666	In response, VirtualBox will generate a new UUID for the hard disk and
10667	compose the file name using the following pattern:
10668	<pre>
10669	<path>/{<uuid>}.<ext>
10670	</pre>
10671	where <tt><path></tt> is the supplied path specification,
10672	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10673	is the default extension for the storage format of this hard disk. After
10674	that, you may call any of the methods that create a new hard disk storage
10675	unit and they will use the generated UUID and file name.
10676	</desc>
10677
10678	<attribute name="id" type="uuid" mod="string" readonly="yes">
10679	<desc>
10680	UUID of the medium. For a newly created medium, this value is a randomly
10681	generated UUID.
10682
10683	<note>
10684	For media in one of MediumState_NotCreated, MediumState_Creating or
10685	MediumState_Deleting states, the value of this property is undefined
10686	and will most likely be an empty UUID.
10687	</note>
10688	</desc>
10689	</attribute>
10690
10691	<attribute name="description" type="wstring">
10692	<desc>
10693	Optional description of the medium. For a newly created medium the value
10694	of this attribute is an empty string.
10695
10696	Medium types that don't support this attribute will return E_NOTIMPL in
10697	attempt to get or set this attribute's value.
10698
10699	<note>
10700	For some storage types, reading this attribute may return an outdated
10701	(last known) value when <link to="#state"/> is <link
10702	to="MediumState_Inaccessible"/> or <link
10703	to="MediumState_LockedWrite"/> because the value of this attribute is
10704	stored within the storage unit itself. Also note that changing the
10705	attribute value is not possible in such case, as well as when the
10706	medium is the <link to="MediumState_LockedRead"/> state.
10707	</note>
10708	</desc>
10709	</attribute>
10710
10711	<attribute name="state" type="MediumState" readonly="yes">
10712	<desc>
10713	Returns the current medium state, which is the last state set by
10714	the accessibility check performed by <link to="#refreshState"/>.
10715	If that method has not yet been called on the medium, the state
10716	is "Inaccessible"; as opposed to truly inaccessible media, the
10717	value of <link to="#lastAccessError"/> will be an empty string in
10718	that case.
10719
10720	<note>As of version 3.1, this no longer performs an accessibility check
10721	automatically; call <link to="#refreshState"/> for that.
10722	</note>
10723	</desc>
10724	</attribute>
10725
10726	<attribute name="variant" type="unsigned long" readonly="yes">
10727	<desc>
10728	Returns the storage format variant information for this medium
10729	as a combination of the flags described at <link to="MediumVariant" />.
10730	Before <link to="#refreshState"/> is called this method returns
10731	an undefined value.
10732	</desc>
10733	</attribute>
10734
10735	<attribute name="location" type="wstring">
10736	<desc>
10737	Location of the storage unit holding medium data.
10738
10739	The format of the location string is medium type specific. For medium
10740	types using regular files in a host's file system, the location
10741	string is the full file name.
10742
10743	Some medium types may support changing the storage unit location by
10744	simply changing the value of this property. If this operation is not
10745	supported, the implementation will return E_NOTIMPL in attempt to set
10746	this attribute's value.
10747
10748	When setting a value of the location attribute which is a regular file
10749	in the host's file system, the given file name may be either relative to
10750	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10751	absolute. Note that if the given location specification does not contain
10752	the file extension part then a proper default extension will be
10753	automatically appended by the implementation depending on the medium type.
10754	</desc>
10755	</attribute>
10756
10757	<attribute name="name" type="wstring" readonly="yes">
10758	<desc>
10759	Name of the storage unit holding medium data.
10760
10761	The returned string is a short version of the <link to="#location"/>
10762	attribute that is suitable for representing the medium in situations
10763	where the full location specification is too long (such as lists
10764	and comboboxes in GUI frontends). This string is also used by frontends
10765	to sort the media list alphabetically when needed.
10766
10767	For example, for locations that are regular files in the host's file
10768	system, the value of this attribute is just the file name (+ extension),
10769	without the path specification.
10770
10771	Note that as opposed to the <link to="#location"/> attribute, the name
10772	attribute will not necessary be unique for a list of media of the
10773	given type and format.
10774	</desc>
10775	</attribute>
10776
10777	<attribute name="deviceType" type="DeviceType" readonly="yes">
10778	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10779	medium.</desc>
10780	</attribute>
10781
10782	<attribute name="hostDrive" type="boolean" readonly="yes">
10783	<desc>True if this corresponds to a drive on the host.</desc>
10784	</attribute>
10785
10786	<attribute name="size" type="long long" readonly="yes">
10787	<desc>
10788	Physical size of the storage unit used to hold medium data (in bytes).
10789
10790	<note>
10791	For media whose <link to="#state"/> is <link
10792	to="MediumState_Inaccessible"/>, the value of this property is the
10793	last known size. For <link to="MediumState_NotCreated"/> media,
10794	the returned value is zero.
10795	</note>
10796	</desc>
10797	</attribute>
10798
10799	<attribute name="format" type="wstring" readonly="yes">
10800	<desc>
10801	Storage format of this medium.
10802
10803	The value of this attribute is a string that specifies a backend used
10804	to store medium data. The storage format is defined when you create a
10805	new medium or automatically detected when you open an existing medium,
10806	and cannot be changed later.
10807
10808	The list of all storage formats supported by this VirtualBox
10809	installation can be obtained using
10810	<link to="ISystemProperties::mediumFormats"/>.
10811	</desc>
10812	</attribute>
10813
10814	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10815	<desc>
10816	Storage medium format object corresponding to this medium.
10817
10818	The value of this attribute is a reference to the medium format object
10819	that specifies the backend properties used to store medium data. The
10820	storage format is defined when you create a new medium or automatically
10821	detected when you open an existing medium, and cannot be changed later.
10822
10823	<note>@c null is returned if there is no associated medium format
10824	object. This can e.g. happen for medium objects representing host
10825	drives and other special medium objects.</note>
10826	</desc>
10827	</attribute>
10828
10829	<attribute name="type" type="MediumType">
10830	<desc>
10831	Type (role) of this medium.
10832
10833	The following constraints apply when changing the value of this
10834	attribute:
10835	<ul>
10836	<li>If a medium is attached to a virtual machine (either in the
10837	current state or in one of the snapshots), its type cannot be
10838	changed.
10839	</li>
10840	<li>As long as the medium has children, its type cannot be set
10841	to <link to="MediumType_Writethrough"/>.
10842	</li>
10843	<li>The type of all differencing media is
10844	<link to="MediumType_Normal"/> and cannot be changed.
10845	</li>
10846	</ul>
10847
10848	The type of a newly created or opened medium is set to
10849	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10850	which have a type of <link to="MediumType_Writethrough"/>.
10851	</desc>
10852	</attribute>
10853
10854	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10855	<desc>
10856	Returns which medium types can selected for this medium.
10857
10858	<result name="E_NOTIMPL">
10859	This attribute is not implemented at the moment.
10860	</result>
10861	</desc>
10862	</attribute>
10863
10864	<attribute name="parent" type="IMedium" readonly="yes">
10865	<desc>
10866	Parent of this medium (the medium this medium is directly based
10867	on).
10868
10869	Only differencing media have parents. For base (non-differencing)
10870	media, @c null is returned.
10871	</desc>
10872	</attribute>
10873
10874	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10875	<desc>
10876	Children of this medium (all differencing media directly based
10877	on this medium). A @c null array is returned if this medium
10878	does not have any children.
10879	</desc>
10880	</attribute>
10881
10882	<attribute name="base" type="IMedium" readonly="yes">
10883	<desc>
10884	Base medium of this medium.
10885
10886	If this is a differencing medium, its base medium is the medium
10887	the given medium branch starts from. For all other types of media, this
10888	property returns the medium object itself (i.e. the same object this
10889	property is read on).
10890	</desc>
10891	</attribute>
10892
10893	<attribute name="readOnly" type="boolean" readonly="yes">
10894	<desc>
10895	Returns @c true if this medium is read-only and @c false otherwise.
10896
10897	A medium is considered to be read-only when its contents cannot be
10898	modified without breaking the integrity of other parties that depend on
10899	this medium such as its child media or snapshots of virtual machines
10900	where this medium is attached to these machines. If there are no
10901	children and no such snapshots then there is no dependency and the
10902	medium is not read-only.
10903
10904	The value of this attribute can be used to determine the kind of the
10905	attachment that will take place when attaching this medium to a
10906	virtual machine. If the value is @c false then the medium will
10907	be attached directly. If the value is @c true then the medium
10908	will be attached indirectly by creating a new differencing child
10909	medium for that. See the interface description for more information.
10910
10911	Note that all <link to="MediumType_Immutable">Immutable</link> media
10912	are always read-only while all
10913	<link to="MediumType_Writethrough">Writethrough</link> media are
10914	always not.
10915
10916	<note>
10917	The read-only condition represented by this attribute is related to
10918	the medium type and usage, not to the current
10919	<link to="IMedium::state">medium state</link> and not to the read-only
10920	state of the storage unit.
10921	</note>
10922	</desc>
10923	</attribute>
10924
10925	<attribute name="logicalSize" type="long long" readonly="yes">
10926	<desc>
10927	Logical size of this medium (in bytes), as reported to the
10928	guest OS running inside the virtual machine this medium is
10929	attached to. The logical size is defined when the medium is created
10930	and cannot be changed later.
10931
10932	<note>
10933	Reading this property on a differencing medium will return the size
10934	of its <link to="#base"/> medium.
10935	</note>
10936	<note>
10937	For media whose state is <link to="#state"/> is <link
10938	to="MediumState_Inaccessible"/>, the value of this property is the
10939	last known logical size. For <link to="MediumState_NotCreated"/>
10940	media, the returned value is zero.
10941	</note>
10942	</desc>
10943	</attribute>
10944
10945	<attribute name="autoReset" type="boolean">
10946	<desc>
10947	Whether this differencing medium will be automatically reset each
10948	time a virtual machine it is attached to is powered up. This
10949	attribute is automatically set to @c true for the last
10950	differencing image of an "immutable" medium (see
10951	<link to="MediumType" />).
10952
10953	See <link to="#reset"/> for more information about resetting
10954	differencing media.
10955
10956	<note>
10957	Reading this property on a base (non-differencing) medium will
10958	always @c false. Changing the value of this property in this
10959	case is not supported.
10960	</note>
10961
10962	<result name="VBOX_E_NOT_SUPPORTED">
10963	This is not a differencing medium (when changing the attribute
10964	value).
10965	</result>
10966	</desc>
10967	</attribute>
10968
10969	<attribute name="lastAccessError" type="wstring" readonly="yes">
10970	<desc>
10971	Text message that represents the result of the last accessibility
10972	check performed by <link to="#refreshState"/>.
10973
10974	An empty string is returned if the last accessibility check
10975	was successful or has not yet been called. As a result, if
10976	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10977	then <link to="#refreshState"/> has yet to be called; this is the
10978	default value of media after VirtualBox initialization.
10979	A non-empty string indicates a failure and should normally describe
10980	a reason of the failure (for example, a file read error).
10981	</desc>
10982	</attribute>
10983
10984	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10985	<desc>
10986	Array of UUIDs of all machines this medium is attached to.
10987
10988	A @c null array is returned if this medium is not attached to any
10989	machine or to any machine's snapshot.
10990
10991	<note>
10992	The returned array will include a machine even if this medium is not
10993	attached to that machine in the current state but attached to it in
10994	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10995	details.
10996	</note>
10997	</desc>
10998	</attribute>
10999
11000	<method name="setIDs">
11001	<desc>
11002	Changes the UUID and parent UUID for a hard disk medium.
11003	</desc>
11004	<param name="setImageId" type="boolean" dir="in">
11005	<desc>
11006	Select whether a new image UUID is set or not.
11007	</desc>
11008	</param>
11009	<param name="imageId" type="uuid" mod="string" dir="in">
11010	<desc>
11011	New UUID for the image. If an empty string is passed, then a new
11012	UUID is automatically created, provided that @a setImageId is @c true.
11013	Specifying a zero UUID is not allowed.
11014	</desc>
11015	</param>
11016	<param name="setParentId" type="boolean" dir="in">
11017	<desc>
11018	Select whether a new parent UUID is set or not.
11019	</desc>
11020	</param>
11021	<param name="parentId" type="uuid" mod="string" dir="in">
11022	<desc>
11023	New parent UUID for the image. If an empty string is passed, then a
11024	new UUID is automatically created, provided @a setParentId is
11025	@c true. A zero UUID is valid.
11026	</desc>
11027	</param>
11028	<result name="E_INVALIDARG">
11029	Invalid parameter combination.
11030	</result>
11031	<result name="VBOX_E_NOT_SUPPORTED">
11032	Medium is not a hard disk medium.
11033	</result>
11034	</method>
11035
11036	<method name="refreshState">
11037	<desc>
11038	If the current medium state (see <link to="MediumState"/>) is one of
11039	"Created", "Inaccessible" or "LockedRead", then this performs an
11040	accessibility check on the medium and sets the value of the <link to="#state"/>
11041	attribute accordingly; that value is also returned for convenience.
11042
11043	For all other state values, this does not perform a refresh but returns
11044	the state only.
11045
11046	The refresh, if performed, may take a long time (several seconds or even
11047	minutes, depending on the storage unit location and format) because it performs an
11048	accessibility check of the storage unit. This check may cause a significant
11049	delay if the storage unit of the given medium is, for example, a file located
11050	on a network share which is not currently accessible due to connectivity
11051	problems. In that case, the call will not return until a timeout
11052	interval defined by the host OS for this operation expires. For this reason,
11053	it is recommended to never read this attribute on the main UI thread to avoid
11054	making the UI unresponsive.
11055
11056	If the last known state of the medium is "Created" and the accessibility
11057	check fails, then the state would be set to "Inaccessible", and
11058	<link to="#lastAccessError"/> may be used to get more details about the
11059	failure. If the state of the medium is "LockedRead", then it remains the
11060	same, and a non-empty value of <link to="#lastAccessError"/> will
11061	indicate a failed accessibility check in this case.
11062
11063	Note that not all medium states are applicable to all medium types.
11064	</desc>
11065	<param name="state" type="MediumState" dir="return">
11066	<desc>
11067	New medium state.
11068	</desc>
11069	</param>
11070	</method>
11071
11072	<method name="getSnapshotIds">
11073	<desc>
11074	Returns an array of UUIDs of all snapshots of the given machine where
11075	this medium is attached to.
11076
11077	If the medium is attached to the machine in the current state, then the
11078	first element in the array will always be the ID of the queried machine
11079	(i.e. the value equal to the @c machineId argument), followed by
11080	snapshot IDs (if any).
11081
11082	If the medium is not attached to the machine in the current state, then
11083	the array will contain only snapshot IDs.
11084
11085	The returned array may be @c null if this medium is not attached
11086	to the given machine at all, neither in the current state nor in one of
11087	the snapshots.
11088	</desc>
11089	<param name="machineId" type="uuid" mod="string" dir="in">
11090	<desc>
11091	UUID of the machine to query.
11092	</desc>
11093	</param>
11094	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
11095	<desc>
11096	Array of snapshot UUIDs of the given machine using this medium.
11097	</desc>
11098	</param>
11099	</method>
11100
11101	<method name="lockRead">
11102	<desc>
11103	Locks this medium for reading.
11104
11105	A read lock is shared: many clients can simultaneously lock the
11106	same medium for reading unless it is already locked for writing (see
11107	<link to="#lockWrite"/>) in which case an error is returned.
11108
11109	When the medium is locked for reading, it cannot be modified
11110	from within VirtualBox. This means that any method that changes
11111	the properties of this medium or contents of the storage unit
11112	will return an error (unless explicitly stated otherwise). That
11113	includes an attempt to start a virtual machine that wants to
11114	write to the the medium.
11115
11116	When the virtual machine is started up, it locks for reading all
11117	media it uses in read-only mode. If some medium cannot be locked
11118	for reading, the startup procedure will fail.
11119	A medium is typically locked for reading while it is used by a running
11120	virtual machine but has a depending differencing image that receives
11121	the actual write operations. This way one base medium can have
11122	multiple child differencing images which can be written to
11123	simultaneously. Read-only media such as DVD and floppy images are
11124	also locked for reading only (so they can be in use by multiple
11125	machines simultaneously).
11126
11127	A medium is also locked for reading when it is the source of a
11128	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11129
11130	The medium locked for reading must be unlocked using the <link
11131	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
11132	can be nested and must be followed by the same number of paired
11133	<link to="#unlockRead"/> calls.
11134
11135	This method sets the medium state (see <link to="#state"/>) to
11136	"LockedRead" on success. The medium's previous state must be
11137	one of "Created", "Inaccessible" or "LockedRead".
11138
11139	Locking an inaccessible medium is not an error; this method performs
11140	a logical lock that prevents modifications of this medium through
11141	the VirtualBox API, not a physical file-system lock of the underlying
11142	storage unit.
11143
11144	This method returns the current state of the medium
11145	<i>before</i> the operation.
11146
11147	<result name="VBOX_E_INVALID_OBJECT_STATE">
11148	Invalid medium state (e.g. not created, locked, inaccessible,
11149	creating, deleting).
11150	</result>
11151
11152	</desc>
11153	<param name="state" type="MediumState" dir="return">
11154	<desc>
11155	State of the medium after the operation.
11156	</desc>
11157	</param>
11158	</method>
11159
11160	<method name="unlockRead">
11161	<desc>
11162	Cancels the read lock previously set by <link to="#lockRead"/>.
11163
11164	For both success and failure, this method returns the current state
11165	of the medium <i>after</i> the operation.
11166
11167	See <link to="#lockRead"/> for more details.
11168
11169	<result name="VBOX_E_INVALID_OBJECT_STATE">
11170	Medium not locked for reading.
11171	</result>
11172
11173	</desc>
11174	<param name="state" type="MediumState" dir="return">
11175	<desc>
11176	State of the medium after the operation.
11177	</desc>
11178	</param>
11179	</method>
11180
11181	<method name="lockWrite">
11182	<desc>
11183	Locks this medium for writing.
11184
11185	A write lock, as opposed to <link to="#lockRead"/>, is
11186	exclusive: there may be only one client holding a write lock,
11187	and there may be no read locks while the write lock is held.
11188	As a result, read-locking fails if a write lock is held, and
11189	write-locking fails if either a read or another write lock is held.
11190
11191	When a medium is locked for writing, it cannot be modified
11192	from within VirtualBox, and it is not guaranteed that the values
11193	of its properties are up-to-date. Any method that changes the
11194	properties of this medium or contents of the storage unit will
11195	return an error (unless explicitly stated otherwise).
11196
11197	When a virtual machine is started up, it locks for writing all
11198	media it uses to write data to. If any medium could not be locked
11199	for writing, the startup procedure will fail. If a medium has
11200	differencing images, then while the machine is running, only
11201	the last ("leaf") differencing image is locked for writing,
11202	whereas its parents are locked for reading only.
11203
11204	A medium is also locked for writing when it is the target of a
11205	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11206
11207	The medium locked for writing must be unlocked using the <link
11208	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11209
11210	This method sets the medium state (see <link to="#state"/>) to
11211	"LockedWrite" on success. The medium's previous state must be
11212	either "Created" or "Inaccessible".
11213
11214	Locking an inaccessible medium is not an error; this method performs
11215	a logical lock that prevents modifications of this medium through
11216	the VirtualBox API, not a physical file-system lock of the underlying
11217	storage unit.
11218
11219	For both, success and failure, this method returns the current
11220	state of the medium <i>before</i> the operation.
11221
11222	<result name="VBOX_E_INVALID_OBJECT_STATE">
11223	Invalid medium state (e.g. not created, locked, inaccessible,
11224	creating, deleting).
11225	</result>
11226
11227	</desc>
11228	<param name="state" type="MediumState" dir="return">
11229	<desc>
11230	State of the medium after the operation.
11231	</desc>
11232	</param>
11233	</method>
11234
11235	<method name="unlockWrite">
11236	<desc>
11237	Cancels the write lock previously set by <link to="#lockWrite"/>.
11238
11239	For both success and failure, this method returns the current
11240	state of the medium <i>after</i> the operation.
11241
11242	See <link to="#lockWrite"/> for more details.
11243
11244	<result name="VBOX_E_INVALID_OBJECT_STATE">
11245	Medium not locked for writing.
11246	</result>
11247
11248	</desc>
11249	<param name="state" type="MediumState" dir="return">
11250	<desc>
11251	State of the medium after the operation.
11252	</desc>
11253	</param>
11254	</method>
11255
11256	<method name="close">
11257	<desc>
11258	Closes this medium.
11259
11260	The medium must not be attached to any known virtual machine
11261	and must not have any known child media, otherwise the
11262	operation will fail.
11263
11264	When the medium is successfully closed, it is removed from
11265	the list of registered media, but its storage unit is not
11266	deleted. In particular, this means that this medium can
11267	later be opened again using the <link to="IVirtualBox::openMedium"/>
11268	call.
11269
11270	Note that after this method successfully returns, the given medium
11271	object becomes uninitialized. This means that any attempt
11272	to call any of its methods or attributes will fail with the
11273	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11274
11275	<result name="VBOX_E_INVALID_OBJECT_STATE">
11276	Invalid medium state (other than not created, created or
11277	inaccessible).
11278	</result>
11279	<result name="VBOX_E_OBJECT_IN_USE">
11280	Medium attached to virtual machine.
11281	</result>
11282	<result name="VBOX_E_FILE_ERROR">
11283	Settings file not accessible.
11284	</result>
11285	<result name="VBOX_E_XML_ERROR">
11286	Could not parse the settings file.
11287	</result>
11288
11289	</desc>
11290	</method>
11291
11292	<!-- property methods -->
11293
11294	<method name="getProperty" const="yes">
11295	<desc>
11296	Returns the value of the custom medium property with the given name.
11297
11298	The list of all properties supported by the given medium format can
11299	be obtained with <link to="IMediumFormat::describeProperties"/>.
11300
11301	<note>If this method returns an empty string in @a value, the requested
11302	property is supported but currently not assigned any value.</note>
11303
11304	<result name="VBOX_E_OBJECT_NOT_FOUND">
11305	Requested property does not exist (not supported by the format).
11306	</result>
11307	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11308	</desc>
11309	<param name="name" type="wstring" dir="in">
11310	<desc>Name of the property to get.</desc>
11311	</param>
11312	<param name="value" type="wstring" dir="return">
11313	<desc>Current property value.</desc>
11314	</param>
11315	</method>
11316
11317	<method name="setProperty">
11318	<desc>
11319	Sets the value of the custom medium property with the given name.
11320
11321	The list of all properties supported by the given medium format can
11322	be obtained with <link to="IMediumFormat::describeProperties"/>.
11323
11324	<note>Setting the property value to @c null or an empty string is
11325	equivalent to deleting the existing value. A default value (if it is
11326	defined for this property) will be used by the format backend in this
11327	case.</note>
11328
11329	<result name="VBOX_E_OBJECT_NOT_FOUND">
11330	Requested property does not exist (not supported by the format).
11331	</result>
11332	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11333	</desc>
11334	<param name="name" type="wstring" dir="in">
11335	<desc>Name of the property to set.</desc>
11336	</param>
11337	<param name="value" type="wstring" dir="in">
11338	<desc>Property value to set.</desc>
11339	</param>
11340	</method>
11341
11342	<method name="getProperties" const="yes">
11343	<desc>
11344	Returns values for a group of properties in one call.
11345
11346	The names of the properties to get are specified using the @a names
11347	argument which is a list of comma-separated property names or
11348	an empty string if all properties are to be returned.
11349	<note>Currently the value of this argument is ignored and the method
11350	always returns all existing properties.</note>
11351
11352	The list of all properties supported by the given medium format can
11353	be obtained with <link to="IMediumFormat::describeProperties"/>.
11354
11355	The method returns two arrays, the array of property names corresponding
11356	to the @a names argument and the current values of these properties.
11357	Both arrays have the same number of elements with each element at the
11358	given index in the first array corresponds to an element at the same
11359	index in the second array.
11360
11361	For properties that do not have assigned values, an empty string is
11362	returned at the appropriate index in the @a returnValues array.
11363
11364	</desc>
11365	<param name="names" type="wstring" dir="in">
11366	<desc>
11367	Names of properties to get.
11368	</desc>
11369	</param>
11370	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11371	<desc>Names of returned properties.</desc>
11372	</param>
11373	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11374	<desc>Values of returned properties.</desc>
11375	</param>
11376	</method>
11377
11378	<method name="setProperties">
11379	<desc>
11380	Sets values for a group of properties in one call.
11381
11382	The names of the properties to set are passed in the @a names
11383	array along with the new values for them in the @a values array. Both
11384	arrays have the same number of elements with each element at the given
11385	index in the first array corresponding to an element at the same index
11386	in the second array.
11387
11388	If there is at least one property name in @a names that is not valid,
11389	the method will fail before changing the values of any other properties
11390	from the @a names array.
11391
11392	Using this method over <link to="#setProperty"/> is preferred if you
11393	need to set several properties at once since it is more efficient.
11394
11395	The list of all properties supported by the given medium format can
11396	be obtained with <link to="IMediumFormat::describeProperties"/>.
11397
11398	Setting the property value to @c null or an empty string is equivalent
11399	to deleting the existing value. A default value (if it is defined for
11400	this property) will be used by the format backend in this case.
11401	</desc>
11402	<param name="names" type="wstring" safearray="yes" dir="in">
11403	<desc>Names of properties to set.</desc>
11404	</param>
11405	<param name="values" type="wstring" safearray="yes" dir="in">
11406	<desc>Values of properties to set.</desc>
11407	</param>
11408	</method>
11409
11410	<!-- storage methods -->
11411
11412	<method name="createBaseStorage">
11413	<desc>
11414	Starts creating a hard disk storage unit (fixed/dynamic, according
11415	to the variant flags) in in the background. The previous storage unit
11416	created for this object, if any, must first be deleted using
11417	<link to="#deleteStorage"/>, otherwise the operation will fail.
11418
11419	Before the operation starts, the medium is placed in
11420	<link to="MediumState_Creating"/> state. If the create operation
11421	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11422	state.
11423
11424	After the returned progress object reports that the operation has
11425	successfully completed, the medium state will be set to <link
11426	to="MediumState_Created"/>, the medium will be remembered by this
11427	VirtualBox installation and may be attached to virtual machines.
11428
11429	<result name="VBOX_E_NOT_SUPPORTED">
11430	The variant of storage creation operation is not supported. See <link
11431	to="IMediumFormat::capabilities"/>.
11432	</result>
11433	</desc>
11434	<param name="logicalSize" type="long long" dir="in">
11435	<desc>Maximum logical size of the medium in bytes.</desc>
11436	</param>
11437	<param name="variant" type="unsigned long" dir="in">
11438	<desc>Exact image variant which should be created (as a combination of
11439	<link to="MediumVariant" /> flags).</desc>
11440	</param>
11441	<param name="progress" type="IProgress" dir="return">
11442	<desc>Progress object to track the operation completion.</desc>
11443	</param>
11444	</method>
11445
11446	<method name="deleteStorage">
11447	<desc>
11448	Starts deleting the storage unit of this medium.
11449
11450	The medium must not be attached to any known virtual machine and must
11451	not have any known child media, otherwise the operation will fail.
11452	It will also fail if there is no storage unit to delete or if deletion
11453	is already in progress, or if the medium is being in use (locked for
11454	read or for write) or inaccessible. Therefore, the only valid state for
11455	this operation to succeed is <link to="MediumState_Created"/>.
11456
11457	Before the operation starts, the medium is placed in
11458	<link to="MediumState_Deleting"/> state and gets removed from the list
11459	of remembered hard disks (media registry). If the delete operation
11460	fails, the medium will be remembered again and placed back to
11461	<link to="MediumState_Created"/> state.
11462
11463	After the returned progress object reports that the operation is
11464	complete, the medium state will be set to
11465	<link to="MediumState_NotCreated"/> and you will be able to use one of
11466	the storage creation methods to create it again.
11467
11468	<see><link to="#close"/></see>
11469
11470	<result name="VBOX_E_OBJECT_IN_USE">
11471	Medium is attached to a virtual machine.
11472	</result>
11473	<result name="VBOX_E_NOT_SUPPORTED">
11474	Storage deletion is not allowed because neither of storage creation
11475	operations are supported. See
11476	<link to="IMediumFormat::capabilities"/>.
11477	</result>
11478
11479	<note>
11480	If the deletion operation fails, it is not guaranteed that the storage
11481	unit still exists. You may check the <link to="IMedium::state"/> value
11482	to answer this question.
11483	</note>
11484	</desc>
11485	<param name="progress" type="IProgress" dir="return">
11486	<desc>Progress object to track the operation completion.</desc>
11487	</param>
11488	</method>
11489
11490	<!-- diff methods -->
11491
11492	<method name="createDiffStorage">
11493	<desc>
11494	Starts creating an empty differencing storage unit based on this
11495	medium in the format and at the location defined by the @a target
11496	argument.
11497
11498	The target medium must be in <link to="MediumState_NotCreated"/>
11499	state (i.e. must not have an existing storage unit). Upon successful
11500	completion, this operation will set the type of the target medium to
11501	<link to="MediumType_Normal"/> and create a storage unit necessary to
11502	represent the differencing medium data in the given format (according
11503	to the storage format of the target object).
11504
11505	After the returned progress object reports that the operation is
11506	successfully complete, the target medium gets remembered by this
11507	VirtualBox installation and may be attached to virtual machines.
11508
11509	<note>
11510	The medium will be set to <link to="MediumState_LockedRead"/>
11511	state for the duration of this operation.
11512	</note>
11513	<result name="VBOX_E_OBJECT_IN_USE">
11514	Medium not in @c NotCreated state.
11515	</result>
11516	</desc>
11517	<param name="target" type="IMedium" dir="in">
11518	<desc>Target medium.</desc>
11519	</param>
11520	<param name="variant" type="unsigned long" dir="in">
11521	<desc>Exact image variant which should be created (as a combination of
11522	<link to="MediumVariant" /> flags).</desc>
11523	</param>
11524	<param name="progress" type="IProgress" dir="return">
11525	<desc>Progress object to track the operation completion.</desc>
11526	</param>
11527	</method>
11528
11529	<method name="mergeTo">
11530	<desc>
11531	Starts merging the contents of this medium and all intermediate
11532	differencing media in the chain to the given target medium.
11533
11534	The target medium must be either a descendant of this medium or
11535	its ancestor (otherwise this method will immediately return a failure).
11536	It follows that there are two logical directions of the merge operation:
11537	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11538	ancestor (<i>backward merge</i>). Let us consider the following medium
11539	chain:
11540
11541	<pre>Base <- Diff_1 <- Diff_2</pre>
11542
11543	Here, calling this method on the <tt>Base</tt> medium object with
11544	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11545	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11546	merge. Note that in both cases the contents of the resulting medium
11547	will be the same, the only difference is the medium object that takes
11548	the result of the merge operation. In case of the forward merge in the
11549	above example, the result will be written to <tt>Diff_2</tt>; in case of
11550	the backward merge, the result will be written to <tt>Base</tt>. In
11551	other words, the result of the operation is always stored in the target
11552	medium.
11553
11554	Upon successful operation completion, the storage units of all media in
11555	the chain between this (source) medium and the target medium, including
11556	the source medium itself, will be automatically deleted and the
11557	relevant medium objects (including this medium) will become
11558	uninitialized. This means that any attempt to call any of
11559	their methods or attributes will fail with the
11560	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11561	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11562	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11563	Note that <tt>Diff_2</tt> in this case will become a base medium
11564	itself since it will no longer be based on any other medium.
11565
11566	Considering the above, all of the following conditions must be met in
11567	order for the merge operation to succeed:
11568	<ul>
11569	<li>
11570	Neither this (source) medium nor any intermediate
11571	differencing medium in the chain between it and the target
11572	medium is attached to any virtual machine.
11573	</li>
11574	<li>
11575	Neither the source medium nor the target medium is an
11576	<link to="MediumType_Immutable"/> medium.
11577	</li>
11578	<li>
11579	The part of the medium tree from the source medium to the
11580	target medium is a linear chain, i.e. all medium in this
11581	chain have exactly one child which is the next medium in this
11582	chain. The only exception from this rule is the target medium in
11583	the forward merge operation; it is allowed to have any number of
11584	child media because the merge operation will not change its
11585	logical contents (as it is seen by the guest OS or by children).
11586	</li>
11587	<li>
11588	None of the involved media are in
11589	<link to="MediumState_LockedRead"/> or
11590	<link to="MediumState_LockedWrite"/> state.
11591	</li>
11592	</ul>
11593
11594	<note>
11595	This (source) medium and all intermediates will be placed to <link
11596	to="MediumState_Deleting"/> state and the target medium will be
11597	placed to <link to="MediumState_LockedWrite"/> state and for the
11598	duration of this operation.
11599	</note>
11600	</desc>
11601	<param name="target" type="IMedium" dir="in">
11602	<desc>Target medium.</desc>
11603	</param>
11604	<param name="progress" type="IProgress" dir="return">
11605	<desc>Progress object to track the operation completion.</desc>
11606	</param>
11607	</method>
11608
11609	<!-- clone method -->
11610
11611	<method name="cloneTo">
11612	<desc>
11613	Starts creating a clone of this medium in the format and at the
11614	location defined by the @a target argument.
11615
11616	The target medium must be either in <link to="MediumState_NotCreated"/>
11617	state (i.e. must not have an existing storage unit) or in
11618	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11619	big enough to hold the data or else the copy will be partial). Upon
11620	successful completion, the cloned medium will contain exactly the
11621	same sector data as the medium being cloned, except that in the
11622	first case a new UUID for the clone will be randomly generated, and in
11623	the second case the UUID will remain unchanged.
11624
11625	The @a parent argument defines which medium will be the parent
11626	of the clone. Passing a @c null reference indicates that the clone will
11627	be a base image, i.e. completely independent. It is possible to specify
11628	an arbitrary medium for this parameter, including the parent of the
11629	medium which is being cloned. Even cloning to a child of the source
11630	medium is possible. Note that when cloning to an existing image, the
11631	@a parent argument is ignored.
11632
11633	After the returned progress object reports that the operation is
11634	successfully complete, the target medium gets remembered by this
11635	VirtualBox installation and may be attached to virtual machines.
11636
11637	<note>
11638	This medium will be placed to <link to="MediumState_LockedRead"/>
11639	state for the duration of this operation.
11640	</note>
11641	<result name="E_NOTIMPL">
11642	The specified cloning variant is not supported at the moment.
11643	</result>
11644	</desc>
11645	<param name="target" type="IMedium" dir="in">
11646	<desc>Target medium.</desc>
11647	</param>
11648	<param name="variant" type="unsigned long" dir="in">
11649	<desc>Exact image variant which should be created (as a combination of
11650	<link to="MediumVariant" /> flags).</desc>
11651	</param>
11652	<param name="parent" type="IMedium" dir="in">
11653	<desc>Parent of the cloned medium.</desc>
11654	</param>
11655	<param name="progress" type="IProgress" dir="return">
11656	<desc>Progress object to track the operation completion.</desc>
11657	</param>
11658	</method>
11659
11660	<!-- other methods -->
11661
11662	<method name="compact">
11663	<desc>
11664	Starts compacting of this medium. This means that the medium is
11665	transformed into a possibly more compact storage representation.
11666	This potentially creates temporary images, which can require a
11667	substantial amount of additional disk space.
11668
11669	This medium will be placed to <link to="MediumState_LockedWrite"/>
11670	state and all its parent media (if any) will be placed to
11671	<link to="MediumState_LockedRead"/> state for the duration of this
11672	operation.
11673
11674	Please note that the results can be either returned straight away,
11675	or later as the result of the background operation via the object
11676	returned via the @a progress parameter.
11677
11678	<result name="VBOX_E_NOT_SUPPORTED">
11679	Medium format does not support compacting (but potentially
11680	needs it).
11681	</result>
11682	</desc>
11683	<param name="progress" type="IProgress" dir="return">
11684	<desc>Progress object to track the operation completion.</desc>
11685	</param>
11686	</method>
11687
11688	<method name="resize">
11689	<desc>
11690	Starts resizing this medium. This means that the nominal size of the
11691	medium is set to the new value. Both increasing and decreasing the
11692	size is possible, and there are no safety checks, since VirtualBox
11693	does not make any assumptions about the medium contents.
11694
11695	Resizing usually needs additional disk space, and possibly also
11696	some temporary disk space. Note that resize does not create a full
11697	temporary copy of the medium, so the additional disk space requirement
11698	is usually much lower than using the clone operation.
11699
11700	This medium will be placed to <link to="MediumState_LockedWrite"/>
11701	state for the duration of this operation.
11702
11703	Please note that the results can be either returned straight away,
11704	or later as the result of the background operation via the object
11705	returned via the @a progress parameter.
11706
11707	<result name="VBOX_E_NOT_SUPPORTED">
11708	Medium format does not support resizing.
11709	</result>
11710	</desc>
11711	<param name="logicalSize" type="long long" dir="in">
11712	<desc>New nominal capacity of the medium in bytes.</desc>
11713	</param>
11714	<param name="progress" type="IProgress" dir="return">
11715	<desc>Progress object to track the operation completion.</desc>
11716	</param>
11717	</method>
11718
11719	<method name="reset">
11720	<desc>
11721	Starts erasing the contents of this differencing medium.
11722
11723	This operation will reset the differencing medium to its initial
11724	state when it does not contain any sector data and any read operation is
11725	redirected to its parent medium. This automatically gets called
11726	during VM power-up for every medium whose <link to="#autoReset" />
11727	attribute is @c true.
11728
11729	The medium will be write-locked for the duration of this operation (see
11730	<link to="#lockWrite" />).
11731
11732	<result name="VBOX_E_NOT_SUPPORTED">
11733	This is not a differencing medium.
11734	</result>
11735	<result name="VBOX_E_INVALID_OBJECT_STATE">
11736	Medium is not in <link to="MediumState_Created"/> or
11737	<link to="MediumState_Inaccessible"/> state.
11738	</result>
11739	</desc>
11740	<param name="progress" type="IProgress" dir="return">
11741	<desc>Progress object to track the operation completion.</desc>
11742	</param>
11743	</method>
11744
11745	</interface>
11746
11747
11748	<!--
11749	// IMediumFormat
11750	/////////////////////////////////////////////////////////////////////////
11751	-->
11752
11753	<enum
11754	name="DataType"
11755	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11756	>
11757	<const name="Int32" value="0"/>
11758	<const name="Int8" value="1"/>
11759	<const name="String" value="2"/>
11760	</enum>
11761
11762	<enum
11763	name="DataFlags"
11764	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11765	>
11766	<const name="None" value="0x00"/>
11767	<const name="Mandatory" value="0x01"/>
11768	<const name="Expert" value="0x02"/>
11769	<const name="Array" value="0x04"/>
11770	<const name="FlagMask" value="0x07"/>
11771	</enum>
11772
11773	<enum
11774	name="MediumFormatCapabilities"
11775	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11776	>
11777	<desc>
11778	Medium format capability flags.
11779	</desc>
11780
11781	<const name="Uuid" value="0x01">
11782	<desc>
11783	Supports UUIDs as expected by VirtualBox code.
11784	</desc>
11785	</const>
11786
11787	<const name="CreateFixed" value="0x02">
11788	<desc>
11789	Supports creating fixed size images, allocating all space instantly.
11790	</desc>
11791	</const>
11792
11793	<const name="CreateDynamic" value="0x04">
11794	<desc>
11795	Supports creating dynamically growing images, allocating space on
11796	demand.
11797	</desc>
11798	</const>
11799
11800	<const name="CreateSplit2G" value="0x08">
11801	<desc>
11802	Supports creating images split in chunks of a bit less than 2 GBytes.
11803	</desc>
11804	</const>
11805
11806	<const name="Differencing" value="0x10">
11807	<desc>
11808	Supports being used as a format for differencing media (see <link
11809	to="IMedium::createDiffStorage"/>).
11810	</desc>
11811	</const>
11812
11813	<const name="Asynchronous" value="0x20">
11814	<desc>
11815	Supports asynchronous I/O operations for at least some configurations.
11816	</desc>
11817	</const>
11818
11819	<const name="File" value="0x40">
11820	<desc>
11821	The format backend operates on files (the <link to="IMedium::location"/>
11822	attribute of the medium specifies a file used to store medium
11823	data; for a list of supported file extensions see
11824	<link to="IMediumFormat::describeFileExtensions"/>).
11825	</desc>
11826	</const>
11827
11828	<const name="Properties" value="0x80">
11829	<desc>
11830	The format backend uses the property interface to configure the storage
11831	location and properties (the <link to="IMediumFormat::describeProperties"/>
11832	method is used to get access to properties supported by the given medium format).
11833	</desc>
11834	</const>
11835
11836	<const name="TcpNetworking" value="0x100">
11837	<desc>
11838	The format backend uses the TCP networking interface for network access.
11839	</desc>
11840	</const>
11841
11842	<const name="VFS" value="0x200">
11843	<desc>
11844	The format backend supports virtual filesystem functionality.
11845	</desc>
11846	</const>
11847
11848	<const name="CapabilityMask" value="0x3FF"/>
11849	</enum>
11850
11851	<interface
11852	name="IMediumFormat" extends="$unknown"
11853	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11854	wsmap="managed"
11855	>
11856	<desc>
11857	The IMediumFormat interface represents a medium format.
11858
11859	Each medium format has an associated backend which is used to handle
11860	media stored in this format. This interface provides information
11861	about the properties of the associated backend.
11862
11863	Each medium format is identified by a string represented by the
11864	<link to="#id"/> attribute. This string is used in calls like
11865	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11866	format.
11867
11868	The list of all supported medium formats can be obtained using
11869	<link to="ISystemProperties::mediumFormats"/>.
11870
11871	<see><link to="IMedium"/></see>
11872	</desc>
11873
11874	<attribute name="id" type="wstring" readonly="yes">
11875	<desc>
11876	Identifier of this format.
11877
11878	The format identifier is a non-@c null non-empty ASCII string. Note that
11879	this string is case-insensitive. This means that, for example, all of
11880	the following strings:
11881	<pre>
11882	"VDI"
11883	"vdi"
11884	"VdI"</pre>
11885	refer to the same medium format.
11886
11887	This string is used in methods of other interfaces where it is necessary
11888	to specify a medium format, such as
11889	<link to="IVirtualBox::createHardDisk"/>.
11890	</desc>
11891	</attribute>
11892
11893	<attribute name="name" type="wstring" readonly="yes">
11894	<desc>
11895	Human readable description of this format.
11896
11897	Mainly for use in file open dialogs.
11898	</desc>
11899	</attribute>
11900
11901	<attribute name="capabilities" type="unsigned long" readonly="yes">
11902	<desc>
11903	Capabilities of the format as a set of bit flags.
11904
11905	For the meaning of individual capability flags see
11906	<link to="MediumFormatCapabilities"/>.
11907	</desc>
11908	</attribute>
11909
11910	<method name="describeFileExtensions">
11911	<desc>
11912	Returns two arrays describing the supported file extensions.
11913
11914	The first array contains the supported extensions and the seconds one
11915	the type each extension supports. Both have the same size.
11916
11917	Note that some backends do not work on files, so this array may be
11918	empty.
11919
11920	<see><link to="IMediumFormat::capabilities"/></see>
11921	</desc>
11922	<param name="extensions" type="wstring" safearray="yes" dir="out">
11923	<desc>The array of supported extensions.</desc>
11924	</param>
11925	<param name="type" type="DeviceType" safearray="yes" dir="out">
11926	<desc>The array which indicates the device type for every given extension.</desc>
11927	</param>
11928	</method>
11929
11930	<method name="describeProperties" const="yes">
11931	<desc>
11932	Returns several arrays describing the properties supported by this
11933	format.
11934
11935	An element with the given index in each array describes one
11936	property. Thus, the number of elements in each returned array is the
11937	same and corresponds to the number of supported properties.
11938
11939	The returned arrays are filled in only if the
11940	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11941	All arguments must be non-@c null.
11942
11943	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11944	</desc>
11945
11946	<param name="names" type="wstring" safearray="yes" dir="out">
11947	<desc>Array of property names.</desc>
11948	</param>
11949	<param name="description" type="wstring" safearray="yes" dir="out">
11950	<desc>Array of property descriptions.</desc>
11951	</param>
11952	<param name="types" type="DataType" safearray="yes" dir="out">
11953	<desc>Array of property types.</desc>
11954	</param>
11955	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11956	<desc>Array of property flags.</desc>
11957	</param>
11958	<param name="defaults" type="wstring" safearray="yes" dir="out">
11959	<desc>Array of default property values.</desc>
11960	</param>
11961	</method>
11962
11963	</interface>
11964
11965
11966	<!--
11967	// IKeyboard
11968	/////////////////////////////////////////////////////////////////////////
11969	-->
11970
11971	<interface
11972	name="IKeyboard" extends="$unknown"
11973	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11974	wsmap="managed"
11975	>
11976	<desc>
11977	The IKeyboard interface represents the virtual machine's keyboard. Used
11978	in <link to="IConsole::keyboard"/>.
11979
11980	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11981	to the virtual machine.
11982
11983	</desc>
11984	<method name="putScancode">
11985	<desc>Sends a scancode to the keyboard.
11986
11987	<result name="VBOX_E_IPRT_ERROR">
11988	Could not send scan code to virtual keyboard.
11989	</result>
11990
11991	</desc>
11992	<param name="scancode" type="long" dir="in"/>
11993	</method>
11994
11995	<method name="putScancodes">
11996	<desc>Sends an array of scancodes to the keyboard.
11997
11998	<result name="VBOX_E_IPRT_ERROR">
11999	Could not send all scan codes to virtual keyboard.
12000	</result>
12001
12002	</desc>
12003	<param name="scancodes" type="long" dir="in" safearray="yes"/>
12004	<param name="codesStored" type="unsigned long" dir="return"/>
12005	</method>
12006
12007	<method name="putCAD">
12008	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
12009	function is nothing special, it is just a convenience function
12010	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
12011
12012	<result name="VBOX_E_IPRT_ERROR">
12013	Could not send all scan codes to virtual keyboard.
12014	</result>
12015
12016	</desc>
12017	</method>
12018
12019	<attribute name="eventSource" type="IEventSource" readonly="yes">
12020	<desc>
12021	Event source for keyboard events.
12022	</desc>
12023	</attribute>
12024
12025	</interface>
12026
12027
12028	<!--
12029	// IMouse
12030	/////////////////////////////////////////////////////////////////////////
12031	-->
12032
12033	<enum
12034	name="MouseButtonState"
12035	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
12036	>
12037	<desc>
12038	Mouse button state.
12039	</desc>
12040
12041	<const name="LeftButton" value="0x01"/>
12042	<const name="RightButton" value="0x02"/>
12043	<const name="MiddleButton" value="0x04"/>
12044	<const name="WheelUp" value="0x08"/>
12045	<const name="WheelDown" value="0x10"/>
12046	<const name="XButton1" value="0x20"/>
12047	<const name="XButton2" value="0x40"/>
12048	<const name="MouseStateMask" value="0x7F"/>
12049	</enum>
12050
12051	<interface
12052	name="IMouse" extends="$unknown"
12053	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
12054	wsmap="managed"
12055	>
12056	<desc>
12057	The IMouse interface represents the virtual machine's mouse. Used in
12058	<link to="IConsole::mouse"/>.
12059
12060	Through this interface, the virtual machine's virtual mouse can be
12061	controlled.
12062	</desc>
12063
12064	<attribute name="absoluteSupported" type="boolean" readonly="yes">
12065	<desc>
12066	Whether the guest OS supports absolute mouse pointer positioning
12067	or not.
12068	<note>
12069	You can use the <link to="IMouseCapabilityChangedEvent"/>
12070	event to be instantly informed about changes of this attribute
12071	during virtual machine execution.
12072	</note>
12073	<see><link to="#putMouseEventAbsolute"/></see>
12074	</desc>
12075	</attribute>
12076
12077	<attribute name="relativeSupported" type="boolean" readonly="yes">
12078	<desc>
12079	Whether the guest OS supports relative mouse pointer positioning
12080	or not.
12081	<note>
12082	You can use the <link to="IMouseCapabilityChangedEvent"/>
12083	event to be instantly informed about changes of this attribute
12084	during virtual machine execution.
12085	</note>
12086	<see><link to="#putMouseEvent"/></see>
12087	</desc>
12088	</attribute>
12089
12090	<attribute name="needsHostCursor" type="boolean" readonly="yes">
12091	<desc>
12092	Whether the guest OS can currently switch to drawing it's own mouse
12093	cursor on demand.
12094	<note>
12095	You can use the <link to="IMouseCapabilityChangedEvent"/>
12096	event to be instantly informed about changes of this attribute
12097	during virtual machine execution.
12098	</note>
12099	<see><link to="#putMouseEvent"/></see>
12100	</desc>
12101	</attribute>
12102
12103	<method name="putMouseEvent">
12104	<desc>
12105	Initiates a mouse event using relative pointer movements
12106	along x and y axis.
12107
12108	<result name="E_ACCESSDENIED">
12109	Console not powered up.
12110	</result>
12111	<result name="VBOX_E_IPRT_ERROR">
12112	Could not send mouse event to virtual mouse.
12113	</result>
12114
12115	</desc>
12116
12117	<param name="dx" type="long" dir="in">
12118	<desc>
12119	Amount of pixels the mouse should move to the right.
12120	Negative values move the mouse to the left.
12121	</desc>
12122	</param>
12123	<param name="dy" type="long" dir="in">
12124	<desc>
12125	Amount of pixels the mouse should move downwards.
12126	Negative values move the mouse upwards.
12127	</desc>
12128	</param>
12129	<param name="dz" type="long" dir="in">
12130	<desc>
12131	Amount of mouse wheel moves.
12132	Positive values describe clockwise wheel rotations,
12133	negative values describe counterclockwise rotations.
12134	</desc>
12135	</param>
12136	<param name="dw" type="long" dir="in">
12137	<desc>
12138	Amount of horizontal mouse wheel moves.
12139	Positive values describe a movement to the left,
12140	negative values describe a movement to the right.
12141	</desc>
12142	</param>
12143	<param name="buttonState" type="long" dir="in">
12144	<desc>
12145	The current state of mouse buttons. Every bit represents
12146	a mouse button as follows:
12147	<table>
12148	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12149	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12150	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12151	</table>
12152	A value of <tt>1</tt> means the corresponding button is pressed.
12153	otherwise it is released.
12154	</desc>
12155	</param>
12156	</method>
12157
12158	<method name="putMouseEventAbsolute">
12159	<desc>
12160	Positions the mouse pointer using absolute x and y coordinates.
12161	These coordinates are expressed in pixels and
12162	start from <tt>[1,1]</tt> which corresponds to the top left
12163	corner of the virtual display.
12164
12165	<result name="E_ACCESSDENIED">
12166	Console not powered up.
12167	</result>
12168	<result name="VBOX_E_IPRT_ERROR">
12169	Could not send mouse event to virtual mouse.
12170	</result>
12171
12172	<note>
12173	This method will have effect only if absolute mouse
12174	positioning is supported by the guest OS.
12175	</note>
12176
12177	<see><link to="#absoluteSupported"/></see>
12178	</desc>
12179
12180	<param name="x" type="long" dir="in">
12181	<desc>
12182	X coordinate of the pointer in pixels, starting from @c 1.
12183	</desc>
12184	</param>
12185	<param name="y" type="long" dir="in">
12186	<desc>
12187	Y coordinate of the pointer in pixels, starting from @c 1.
12188	</desc>
12189	</param>
12190	<param name="dz" type="long" dir="in">
12191	<desc>
12192	Amount of mouse wheel moves.
12193	Positive values describe clockwise wheel rotations,
12194	negative values describe counterclockwise rotations.
12195	</desc>
12196	</param>
12197	<param name="dw" type="long" dir="in">
12198	<desc>
12199	Amount of horizontal mouse wheel moves.
12200	Positive values describe a movement to the left,
12201	negative values describe a movement to the right.
12202	</desc>
12203	</param>
12204	<param name="buttonState" type="long" dir="in">
12205	<desc>
12206	The current state of mouse buttons. Every bit represents
12207	a mouse button as follows:
12208	<table>
12209	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12210	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12211	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12212	</table>
12213	A value of @c 1 means the corresponding button is pressed.
12214	otherwise it is released.
12215	</desc>
12216	</param>
12217	</method>
12218
12219	<attribute name="eventSource" type="IEventSource" readonly="yes">
12220	<desc>
12221	Event source for mouse events.
12222	</desc>
12223	</attribute>
12224
12225	</interface>
12226
12227	<!--
12228	// IDisplay
12229	/////////////////////////////////////////////////////////////////////////
12230	-->
12231
12232	<enum
12233	name="FramebufferPixelFormat"
12234	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12235	>
12236	<desc>
12237	Format of the video memory buffer. Constants represented by this enum can
12238	be used to test for particular values of <link
12239	to="IFramebuffer::pixelFormat"/>. See also <link
12240	to="IFramebuffer::requestResize"/>.
12241
12242	See also www.fourcc.org for more information about FOURCC pixel formats.
12243	</desc>
12244
12245	<const name="Opaque" value="0">
12246	<desc>
12247	Unknown buffer format (the user may not assume any particular format of
12248	the buffer).
12249	</desc>
12250	</const>
12251	<const name="FOURCC_RGB" value="0x32424752">
12252	<desc>
12253	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12254	bit layout).
12255	</desc>
12256	</const>
12257	</enum>
12258
12259	<interface
12260	name="IFramebuffer" extends="$unknown"
12261	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12262	wsmap="suppress"
12263	>
12264	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12265	<desc>Address of the start byte of the frame buffer.</desc>
12266	</attribute>
12267
12268	<attribute name="width" type="unsigned long" readonly="yes">
12269	<desc>Frame buffer width, in pixels.</desc>
12270	</attribute>
12271
12272	<attribute name="height" type="unsigned long" readonly="yes">
12273	<desc>Frame buffer height, in pixels.</desc>
12274	</attribute>
12275
12276	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12277	<desc>
12278	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12279	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12280	are: 8, 15, 16, 24 and 32.
12281	</desc>
12282	</attribute>
12283
12284	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12285	<desc>
12286	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12287	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12288	size of the scan line must be aligned to 32 bits.
12289	</desc>
12290	</attribute>
12291
12292	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12293	<desc>
12294	Frame buffer pixel format. It's either one of the values defined by <link
12295	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12296	<note>
12297	This attribute must never return <link
12298	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12299	<link to="#address"/> points to must be always known.
12300	</note>
12301	</desc>
12302	</attribute>
12303
12304	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12305	<desc>
12306	Defines whether this frame buffer uses the virtual video card's memory
12307	buffer (guest VRAM) directly or not. See <link
12308	to="IFramebuffer::requestResize"/> for more information.
12309	</desc>
12310	</attribute>
12311
12312	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12313	<desc>
12314	Hint from the frame buffer about how much of the standard
12315	screen height it wants to use for itself. This information is
12316	exposed to the guest through the VESA BIOS and VMMDev interface
12317	so that it can use it for determining its video mode table. It
12318	is not guaranteed that the guest respects the value.
12319	</desc>
12320	</attribute>
12321
12322	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12323	<desc>
12324	An alpha-blended overlay which is superposed over the frame buffer.
12325	The initial purpose is to allow the display of icons providing
12326	information about the VM state, including disk activity, in front
12327	ends which do not have other means of doing that. The overlay is
12328	designed to controlled exclusively by IDisplay. It has no locking
12329	of its own, and any changes made to it are not guaranteed to be
12330	visible until the affected portion of IFramebuffer is updated. The
12331	overlay can be created lazily the first time it is requested. This
12332	attribute can also return @c null to signal that the overlay is not
12333	implemented.
12334	</desc>
12335	</attribute>
12336
12337	<attribute name="winId" type="long long" readonly="yes">
12338	<desc>
12339	Platform-dependent identifier of the window where context of this
12340	frame buffer is drawn, or zero if there's no such window.
12341	</desc>
12342	</attribute>
12343
12344	<method name="lock">
12345	<desc>
12346	Locks the frame buffer.
12347	Gets called by the IDisplay object where this frame buffer is
12348	bound to.
12349	</desc>
12350	</method>
12351
12352	<method name="unlock">
12353	<desc>
12354	Unlocks the frame buffer.
12355	Gets called by the IDisplay object where this frame buffer is
12356	bound to.
12357	</desc>
12358	</method>
12359
12360	<method name="notifyUpdate">
12361	<desc>
12362	Informs about an update.
12363	Gets called by the display object where this buffer is
12364	registered.
12365	</desc>
12366	<param name="x" type="unsigned long" dir="in"/>
12367	<param name="y" type="unsigned long" dir="in"/>
12368	<param name="width" type="unsigned long" dir="in"/>
12369	<param name="height" type="unsigned long" dir="in"/>
12370	</method>
12371
12372	<method name="requestResize">
12373	<desc>
12374	Requests a size and pixel format change.
12375
12376	There are two modes of working with the video buffer of the virtual
12377	machine. The <i>indirect</i> mode implies that the IFramebuffer
12378	implementation allocates a memory buffer for the requested display mode
12379	and provides it to the virtual machine. In <i>direct</i> mode, the
12380	IFramebuffer implementation uses the memory buffer allocated and owned
12381	by the virtual machine. This buffer represents the video memory of the
12382	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12383	usually faster because the implementation gets a raw pointer to the
12384	guest VRAM buffer which it can directly use for visualizing the contents
12385	of the virtual display, as opposed to the indirect mode where the
12386	contents of guest VRAM are copied to the memory buffer provided by
12387	the implementation every time a display update occurs.
12388
12389	It is important to note that the direct mode is really fast only when
12390	the implementation uses the given guest VRAM buffer directly, for
12391	example, by blitting it to the window representing the virtual machine's
12392	display, which saves at least one copy operation comparing to the
12393	indirect mode. However, using the guest VRAM buffer directly is not
12394	always possible: the format and the color depth of this buffer may be
12395	not supported by the target window, or it may be unknown (opaque) as in
12396	case of text or non-linear multi-plane VGA video modes. In this case,
12397	the indirect mode (that is always available) should be used as a
12398	fallback: when the guest VRAM contents are copied to the
12399	implementation-provided memory buffer, color and format conversion is
12400	done automatically by the underlying code.
12401
12402	The @a pixelFormat parameter defines whether the direct mode is
12403	available or not. If @a pixelFormat is <link
12404	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12405	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12406	@a bytesPerLine parameters must be ignored and the implementation must use
12407	the indirect mode (where it provides its own buffer in one of the
12408	supported formats). In all other cases, @a pixelFormat together with
12409	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12410	buffer pointed to by the @a VRAM parameter and the implementation is
12411	free to choose which mode to use. To indicate that this frame buffer uses
12412	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12413	attribute must return @c true and <link to="#address"/> must
12414	return exactly the same address that is passed in the @a VRAM parameter
12415	of this method; otherwise it is assumed that the indirect strategy is
12416	chosen.
12417
12418	The @a width and @a height parameters represent the size of the
12419	requested display mode in both modes. In case of indirect mode, the
12420	provided memory buffer should be big enough to store data of the given
12421	display mode. In case of direct mode, it is guaranteed that the given
12422	@a VRAM buffer contains enough space to represent the display mode of the
12423	given size. Note that this frame buffer's <link to="#width"/> and <link
12424	to="#height"/> attributes must return exactly the same values as
12425	passed to this method after the resize is completed (see below).
12426
12427	The @a finished output parameter determines if the implementation has
12428	finished resizing the frame buffer or not. If, for some reason, the
12429	resize cannot be finished immediately during this call, @a finished
12430	must be set to @c false, and the implementation must call
12431	<link to="IDisplay::resizeCompleted"/> after it has returned from
12432	this method as soon as possible. If @a finished is @c false, the
12433	machine will not call any frame buffer methods until
12434	<link to="IDisplay::resizeCompleted"/> is called.
12435
12436	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12437	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12438	this frame buffer must return exactly the same values as specified in the
12439	parameters of this method, after the resize is completed. If the
12440	indirect mode is chosen, these attributes must return values describing
12441	the format of the implementation's own memory buffer <link
12442	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12443	value must always correlate with <link to="#pixelFormat"/>. Note that
12444	the <link to="#pixelFormat"/> attribute must never return <link
12445	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12446
12447	<note>
12448	This method is called by the IDisplay object under the
12449	<link to="#lock"/> provided by this IFramebuffer
12450	implementation. If this method returns @c false in @a finished, then
12451	this lock is not released until
12452	<link to="IDisplay::resizeCompleted"/> is called.
12453	</note>
12454	</desc>
12455	<param name="screenId" type="unsigned long" dir="in">
12456	<desc>
12457	Logical screen number. Must be used in the corresponding call to
12458	<link to="IDisplay::resizeCompleted"/> if this call is made.
12459	</desc>
12460	</param>
12461	<param name="pixelFormat" type="unsigned long" dir="in">
12462	<desc>
12463	Pixel format of the memory buffer pointed to by @a VRAM.
12464	See also <link to="FramebufferPixelFormat"/>.
12465	</desc>
12466	</param>
12467	<param name="VRAM" type="octet" mod="ptr" dir="in">
12468	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12469	</param>
12470	<param name="bitsPerPixel" type="unsigned long" dir="in">
12471	<desc>Color depth, bits per pixel.</desc>
12472	</param>
12473	<param name="bytesPerLine" type="unsigned long" dir="in">
12474	<desc>Size of one scan line, in bytes.</desc>
12475	</param>
12476	<param name="width" type="unsigned long" dir="in">
12477	<desc>Width of the guest display, in pixels.</desc>
12478	</param>
12479	<param name="height" type="unsigned long" dir="in">
12480	<desc>Height of the guest display, in pixels.</desc>
12481	</param>
12482	<param name="finished" type="boolean" dir="return">
12483	<desc>
12484	Can the VM start using the new frame buffer immediately
12485	after this method returns or it should wait for
12486	<link to="IDisplay::resizeCompleted"/>.
12487	</desc>
12488	</param>
12489	</method>
12490
12491	<method name="videoModeSupported">
12492	<desc>
12493	Returns whether the frame buffer implementation is willing to
12494	support a given video mode. In case it is not able to render
12495	the video mode (or for some reason not willing), it should
12496	return @c false. Usually this method is called when the guest
12497	asks the VMM device whether a given video mode is supported
12498	so the information returned is directly exposed to the guest.
12499	It is important that this method returns very quickly.
12500	</desc>
12501	<param name="width" type="unsigned long" dir="in"/>
12502	<param name="height" type="unsigned long" dir="in"/>
12503	<param name="bpp" type="unsigned long" dir="in"/>
12504	<param name="supported" type="boolean" dir="return"/>
12505	</method>
12506
12507	<method name="getVisibleRegion">
12508	<desc>
12509	Returns the visible region of this frame buffer.
12510
12511	If the @a rectangles parameter is @c null then the value of the
12512	@a count parameter is ignored and the number of elements necessary to
12513	describe the current visible region is returned in @a countCopied.
12514
12515	If @a rectangles is not @c null but @a count is less
12516	than the required number of elements to store region data, the method
12517	will report a failure. If @a count is equal or greater than the
12518	required number of elements, then the actual number of elements copied
12519	to the provided array will be returned in @a countCopied.
12520
12521	<note>
12522	The address of the provided array must be in the process space of
12523	this IFramebuffer object.
12524	</note>
12525	<note>
12526	Method not yet implemented.
12527	</note>
12528	</desc>
12529	<param name="rectangles" type="octet" mod="ptr" dir="in">
12530	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12531	</param>
12532	<param name="count" type="unsigned long" dir="in">
12533	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12534	</param>
12535	<param name="countCopied" type="unsigned long" dir="return">
12536	<desc>Number of elements copied to the @a rectangles array.</desc>
12537	</param>
12538	</method>
12539
12540	<method name="setVisibleRegion">
12541	<desc>
12542	Suggests a new visible region to this frame buffer. This region
12543	represents the area of the VM display which is a union of regions of
12544	all top-level windows of the guest operating system running inside the
12545	VM (if the Guest Additions for this system support this
12546	functionality). This information may be used by the frontends to
12547	implement the seamless desktop integration feature.
12548
12549	<note>
12550	The address of the provided array must be in the process space of
12551	this IFramebuffer object.
12552	</note>
12553	<note>
12554	The IFramebuffer implementation must make a copy of the provided
12555	array of rectangles.
12556	</note>
12557	<note>
12558	Method not yet implemented.
12559	</note>
12560	</desc>
12561	<param name="rectangles" type="octet" mod="ptr" dir="in">
12562	<desc>Pointer to the @c RTRECT array.</desc>
12563	</param>
12564	<param name="count" type="unsigned long" dir="in">
12565	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12566	</param>
12567	</method>
12568
12569	<method name="processVHWACommand">
12570	<desc>
12571	Posts a Video HW Acceleration Command to the frame buffer for processing.
12572	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12573	are posted from quest to the host to be processed by the host hardware.
12574
12575	<note>
12576	The address of the provided command must be in the process space of
12577	this IFramebuffer object.
12578	</note>
12579	</desc>
12580
12581	<param name="command" type="octet" mod="ptr" dir="in">
12582	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12583	</param>
12584	</method>
12585
12586	</interface>
12587
12588	<interface
12589	name="IFramebufferOverlay" extends="IFramebuffer"
12590	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12591	wsmap="suppress"
12592	>
12593	<desc>
12594	The IFramebufferOverlay interface represents an alpha blended overlay
12595	for displaying status icons above an IFramebuffer. It is always created
12596	not visible, so that it must be explicitly shown. It only covers a
12597	portion of the IFramebuffer, determined by its width, height and
12598	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12599	that order) format, and may be written to directly. Do re-read the
12600	width though, after setting it, as it may be adjusted (increased) to
12601	make it more suitable for the front end.
12602	</desc>
12603	<attribute name="x" type="unsigned long" readonly="yes">
12604	<desc>X position of the overlay, relative to the frame buffer.</desc>
12605	</attribute>
12606
12607	<attribute name="y" type="unsigned long" readonly="yes">
12608	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12609	</attribute>
12610
12611	<attribute name="visible" type="boolean" readonly="no">
12612	<desc>
12613	Whether the overlay is currently visible.
12614	</desc>
12615	</attribute>
12616
12617	<attribute name="alpha" type="unsigned long" readonly="no">
12618	<desc>
12619	The global alpha value for the overlay. This may or may not be
12620	supported by a given front end.
12621	</desc>
12622	</attribute>
12623
12624	<method name="move">
12625	<desc>
12626	Changes the overlay's position relative to the IFramebuffer.
12627	</desc>
12628	<param name="x" type="unsigned long" dir="in"/>
12629	<param name="y" type="unsigned long" dir="in"/>
12630	</method>
12631
12632	</interface>
12633
12634	<interface
12635	name="IDisplay" extends="$unknown"
12636	uuid="4b75c45c-e22e-4b75-b7cd-7ce9a83bb36e"
12637	wsmap="managed"
12638	>
12639	<desc>
12640	The IDisplay interface represents the virtual machine's display.
12641
12642	The object implementing this interface is contained in each
12643	<link to="IConsole::display"/> attribute and represents the visual
12644	output of the virtual machine.
12645
12646	The virtual display supports pluggable output targets represented by the
12647	IFramebuffer interface. Examples of the output target are a window on
12648	the host computer or an RDP session's display on a remote computer.
12649	</desc>
12650	<method name="getScreenResolution">
12651	<desc>Queries display width, height and color depth for given screen.</desc>
12652	<param name="screenId" type="unsigned long" dir="in"/>
12653	<param name="width" type="unsigned long" dir="out"/>
12654	<param name="height" type="unsigned long" dir="out"/>
12655	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12656	</method>
12657
12658	<method name="setFramebuffer">
12659	<desc>
12660	Sets the framebuffer for given screen.
12661	</desc>
12662	<param name="screenId" type="unsigned long" dir="in"/>
12663	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12664	</method>
12665
12666	<method name="getFramebuffer">
12667	<desc>
12668	Queries the framebuffer for given screen.
12669	</desc>
12670	<param name="screenId" type="unsigned long" dir="in"/>
12671	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12672	<param name="xOrigin" type="long" dir="out"/>
12673	<param name="yOrigin" type="long" dir="out"/>
12674	</method>
12675
12676	<method name="setVideoModeHint">
12677	<desc>
12678	Asks VirtualBox to request the given video mode from
12679	the guest. This is just a hint and it cannot be guaranteed
12680	that the requested resolution will be used. Guest Additions
12681	are required for the request to be seen by guests. The caller
12682	should issue the request and wait for a resolution change and
12683	after a timeout retry.
12684
12685	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12686	parameters means that the corresponding values should be taken from the
12687	current video mode (i.e. left unchanged).
12688
12689	If the guest OS supports multi-monitor configuration then the @a display
12690	parameter specifies the number of the guest display to send the hint to:
12691	@c 0 is the primary display, @c 1 is the first secondary and
12692	so on. If the multi-monitor configuration is not supported, @a display
12693	must be @c 0.
12694
12695	<result name="E_INVALIDARG">
12696	The @a display is not associated with any monitor.
12697	</result>
12698
12699	</desc>
12700	<param name="width" type="unsigned long" dir="in"/>
12701	<param name="height" type="unsigned long" dir="in"/>
12702	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12703	<param name="display" type="unsigned long" dir="in"/>
12704	</method>
12705
12706	<method name="setSeamlessMode">
12707	<desc>
12708	Enables or disables seamless guest display rendering (seamless desktop
12709	integration) mode.
12710	<note>
12711	Calling this method has no effect if <link
12712	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12713	does not return @c Active.
12714	</note>
12715	</desc>
12716	<param name="enabled" type="boolean" dir="in"/>
12717	</method>
12718
12719	<method name="takeScreenShot">
12720	<desc>
12721	Takes a screen shot of the requested size and copies it to the
12722	32-bpp buffer allocated by the caller and pointed to by @a address.
12723	A pixel consists of 4 bytes in order: B, G, R, 0.
12724
12725	<note>This API can be used only locally by a VM process through the
12726	COM/XPCOM C++ API as it requires pointer support. It is not
12727	available for scripting langages, Java or any webservice clients.
12728	Unless you are writing a new VM frontend use
12729	<link to="#takeScreenShotToArray" />.
12730	</note>
12731
12732	<result name="E_NOTIMPL">
12733	Feature not implemented.
12734	</result>
12735	<result name="VBOX_E_IPRT_ERROR">
12736	Could not take a screenshot.
12737	</result>
12738
12739	</desc>
12740	<param name="screenId" type="unsigned long" dir="in"/>
12741	<param name="address" type="octet" mod="ptr" dir="in"/>
12742	<param name="width" type="unsigned long" dir="in"/>
12743	<param name="height" type="unsigned long" dir="in"/>
12744	</method>
12745
12746	<method name="takeScreenShotToArray">
12747	<desc>
12748	Takes a guest screen shot of the requested size and returns it as
12749	an array of bytes in uncompressed 32-bit RGBA format.
12750	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12751
12752	This API is slow, but could be the only option to get guest screenshot
12753	for scriptable languages not allowed to manipulate with addresses
12754	directly.
12755
12756	<result name="E_NOTIMPL">
12757	Feature not implemented.
12758	</result>
12759	<result name="VBOX_E_IPRT_ERROR">
12760	Could not take a screenshot.
12761	</result>
12762	</desc>
12763	<param name="screenId" type="unsigned long" dir="in">
12764	<desc>
12765	Monitor to take screenshot from.
12766	</desc>
12767	</param>
12768	<param name="width" type="unsigned long" dir="in">
12769	<desc>
12770	Desired image width.
12771	</desc>
12772	</param>
12773	<param name="height" type="unsigned long" dir="in">
12774	<desc>
12775	Desired image height.
12776	</desc>
12777	</param>
12778	<param name="screenData" type="octet" dir="return" safearray="yes">
12779	<desc>
12780	Array with resulting screen data.
12781	</desc>
12782	</param>
12783	</method>
12784
12785	<method name="takeScreenShotPNGToArray">
12786	<desc>
12787	Takes a guest screen shot of the requested size and returns it as
12788	PNG image in array.
12789
12790	<result name="E_NOTIMPL">
12791	Feature not implemented.
12792	</result>
12793	<result name="VBOX_E_IPRT_ERROR">
12794	Could not take a screenshot.
12795	</result>
12796	</desc>
12797	<param name="screenId" type="unsigned long" dir="in">
12798	<desc>
12799	Monitor to take the screenshot from.
12800	</desc>
12801	</param>
12802	<param name="width" type="unsigned long" dir="in">
12803	<desc>
12804	Desired image width.
12805	</desc>
12806	</param>
12807	<param name="height" type="unsigned long" dir="in">
12808	<desc>
12809	Desired image height.
12810	</desc>
12811	</param>
12812	<param name="screenData" type="octet" dir="return" safearray="yes">
12813	<desc>
12814	Array with resulting screen data.
12815	</desc>
12816	</param>
12817	</method>
12818
12819	<method name="drawToScreen">
12820	<desc>
12821	Draws a 32-bpp image of the specified size from the given buffer
12822	to the given point on the VM display.
12823
12824	<result name="E_NOTIMPL">
12825	Feature not implemented.
12826	</result>
12827	<result name="VBOX_E_IPRT_ERROR">
12828	Could not draw to screen.
12829	</result>
12830
12831	</desc>
12832	<param name="screenId" type="unsigned long" dir="in">
12833	<desc>
12834	Monitor to take the screenshot from.
12835	</desc>
12836	</param>
12837	<param name="address" type="octet" mod="ptr" dir="in">
12838	<desc>
12839	Address to store the screenshot to
12840	</desc>
12841	</param>
12842	<param name="x" type="unsigned long" dir="in">
12843	<desc>
12844	Relative to the screen top left corner.
12845	</desc>
12846	</param>
12847	<param name="y" type="unsigned long" dir="in">
12848	<desc>
12849	Relative to the screen top left corner.
12850	</desc>
12851	</param>
12852	<param name="width" type="unsigned long" dir="in">
12853	<desc>
12854	Desired image width.
12855	</desc>
12856	</param>
12857	<param name="height" type="unsigned long" dir="in">
12858	<desc>
12859	Desired image height.
12860	</desc>
12861	</param>
12862	</method>
12863
12864	<method name="invalidateAndUpdate">
12865	<desc>
12866	Does a full invalidation of the VM display and instructs the VM
12867	to update it.
12868
12869	<result name="VBOX_E_IPRT_ERROR">
12870	Could not invalidate and update screen.
12871	</result>
12872
12873	</desc>
12874	</method>
12875
12876	<method name="resizeCompleted">
12877	<desc>
12878	Signals that a framebuffer has completed the resize operation.
12879
12880	<result name="VBOX_E_NOT_SUPPORTED">
12881	Operation only valid for external frame buffers.
12882	</result>
12883
12884	</desc>
12885	<param name="screenId" type="unsigned long" dir="in"/>
12886	</method>
12887
12888	<method name="completeVHWACommand">
12889	<desc>
12890	Signals that the Video HW Acceleration command has completed.
12891	</desc>
12892
12893	<param name="command" type="octet" mod="ptr" dir="in">
12894	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12895	</param>
12896	</method>
12897
12898	<method name="viewportChanged">
12899	<desc>
12900	Signals that framebuffer window viewport has changed.
12901
12902	<result name="E_INVALIDARG">
12903	The specified viewport data is invalid.
12904	</result>
12905
12906	</desc>
12907
12908	<param name="screenId" type="unsigned long" dir="in">
12909	<desc>
12910	Monitor to take the screenshot from.
12911	</desc>
12912	</param>
12913	<param name="x" type="unsigned long" dir="in">
12914	<desc>
12915	Framebuffer x offset.
12916	</desc>
12917	</param>
12918	<param name="y" type="unsigned long" dir="in">
12919	<desc>
12920	Framebuffer y offset.
12921	</desc>
12922	</param>
12923	<param name="width" type="unsigned long" dir="in">
12924	<desc>
12925	Viewport width.
12926	</desc>
12927	</param>
12928	<param name="height" type="unsigned long" dir="in">
12929	<desc>
12930	Viewport height.
12931	</desc>
12932	</param>
12933	</method>
12934	</interface>
12935
12936	<!--
12937	// INetworkAdapter
12938	/////////////////////////////////////////////////////////////////////////
12939	-->
12940
12941	<enum
12942	name="NetworkAttachmentType"
12943	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12944	>
12945	<desc>
12946	Network attachment type.
12947	</desc>
12948
12949	<const name="Null" value="0">
12950	<desc>Null value, also means "not attached".</desc>
12951	</const>
12952	<const name="NAT" value="1"/>
12953	<const name="Bridged" value="2"/>
12954	<const name="Internal" value="3"/>
12955	<const name="HostOnly" value="4"/>
12956	<const name="Generic" value="5"/>
12957	</enum>
12958
12959	<enum
12960	name="NetworkAdapterType"
12961	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12962	>
12963	<desc>
12964	Network adapter type.
12965	</desc>
12966
12967	<const name="Null" value="0">
12968	<desc>Null value (never used by the API).</desc>
12969	</const>
12970	<const name="Am79C970A" value="1">
12971	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12972	</const>
12973	<const name="Am79C973" value="2">
12974	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12975	</const>
12976	<const name="I82540EM" value="3">
12977	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12978	</const>
12979	<const name="I82543GC" value="4">
12980	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12981	</const>
12982	<const name="I82545EM" value="5">
12983	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12984	</const>
12985	<const name="Virtio" value="6">
12986	<desc>Virtio network device.</desc>
12987	</const>
12988	</enum>
12989
12990	<enum
12991	name="NetworkAdapterPromiscModePolicy"
12992	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12993	>
12994	<desc>
12995	The promiscuous mode policy of an interface.
12996	</desc>
12997
12998	<const name="Deny" value="1">
12999	<desc>Deny promiscuous mode requests.</desc>
13000	</const>
13001	<const name="AllowNetwork" value="2">
13002	<desc>
13003	Allow promicuous mode, but restrict the scope it to the internal
13004	network so that it only applies to other VMs.
13005	</desc>
13006	</const>
13007	<const name="AllowAll" value="3">
13008	<desc>
13009	Allow promicuous mode, include unrelated traffic going over the wire
13010	and internally on the host.
13011	</desc>
13012	</const>
13013	</enum>
13014
13015	<interface
13016	name="INetworkAdapter" extends="$unknown"
13017	uuid="8b2e705c-0547-4008-b7bc-788757346092"
13018	wsmap="managed"
13019	>
13020	<desc>
13021	Represents a virtual network adapter that is attached to a virtual machine.
13022	Each virtual machine has a fixed number of network adapter slots with one
13023	instance of this attached to each of them. Call
13024	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
13025	is attached to a given slot in a given machine.
13026
13027	Each network adapter can be in one of five attachment modes, which are
13028	represented by the <link to="NetworkAttachmentType" /> enumeration;
13029	see the <link to="#attachmentType" /> attribute.
13030	</desc>
13031
13032	<attribute name="adapterType" type="NetworkAdapterType">
13033	<desc>
13034	Type of the virtual network adapter. Depending on this value,
13035	VirtualBox will provide a different virtual network hardware
13036	to the guest.
13037	</desc>
13038	</attribute>
13039
13040	<attribute name="slot" type="unsigned long" readonly="yes">
13041	<desc>
13042	Slot number this adapter is plugged into. Corresponds to
13043	the value you pass to <link to="IMachine::getNetworkAdapter"/>
13044	to obtain this instance.
13045	</desc>
13046	</attribute>
13047
13048	<attribute name="enabled" type="boolean">
13049	<desc>
13050	Flag whether the network adapter is present in the
13051	guest system. If disabled, the virtual guest hardware will
13052	not contain this network adapter. Can only be changed when
13053	the VM is not running.
13054	</desc>
13055	</attribute>
13056
13057	<attribute name="MACAddress" type="wstring">
13058	<desc>
13059	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
13060	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
13061	</desc>
13062	</attribute>
13063
13064	<attribute name="attachmentType" type="NetworkAttachmentType">
13065	<desc>
13066	Sets/Gets network attachment type of this network adapter.
13067	</desc>
13068	</attribute>
13069
13070	<attribute name="bridgedInterface" type="wstring">
13071	<desc>
13072	Name of the network interface the VM should be bridged to.
13073	</desc>
13074	</attribute>
13075
13076	<attribute name="hostOnlyInterface" type="wstring">
13077	<desc>
13078	Name of the host only network interface the VM is attached to.
13079	</desc>
13080	</attribute>
13081
13082	<attribute name="internalNetwork" type="wstring">
13083	<desc>
13084	Name of the internal network the VM is attached to.
13085	</desc>
13086	</attribute>
13087
13088	<attribute name="NATNetwork" type="wstring">
13089	<desc>
13090	Name of the NAT network the VM is attached to.
13091	</desc>
13092	</attribute>
13093
13094	<attribute name="genericDriver" type="wstring">
13095	<desc>
13096	Name of the driver to use for the "Generic" network attachment type.
13097	</desc>
13098	</attribute>
13099
13100	<attribute name="cableConnected" type="boolean">
13101	<desc>
13102	Flag whether the adapter reports the cable as connected or not.
13103	It can be used to report offline situations to a VM.
13104	</desc>
13105	</attribute>
13106
13107	<attribute name="lineSpeed" type="unsigned long">
13108	<desc>
13109	Line speed reported by custom drivers, in units of 1 kbps.
13110	</desc>
13111	</attribute>
13112
13113	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
13114	<desc>
13115	The promiscuous mode policy of the network adapter when attached to an
13116	internal network, host only network or a bridge.
13117	</desc>
13118	</attribute>
13119
13120	<attribute name="traceEnabled" type="boolean">
13121	<desc>
13122	Flag whether network traffic from/to the network card should be traced.
13123	Can only be toggled when the VM is turned off.
13124	</desc>
13125	</attribute>
13126
13127	<attribute name="traceFile" type="wstring">
13128	<desc>
13129	Filename where a network trace will be stored. If not set, VBox-pid.pcap
13130	will be used.
13131	</desc>
13132	</attribute>
13133
13134	<attribute name="natDriver" type="INATEngine" readonly="yes">
13135	<desc>
13136	Points to the NAT engine which handles the network address translation
13137	for this interface. This is active only when the interface actually uses
13138	NAT.
13139	</desc>
13140	</attribute>
13141
13142	<attribute name="bootPriority" type="unsigned long">
13143	<desc>
13144	Network boot priority of the adapter. Priority 1 is highest. If not set,
13145	the priority is considered to be at the lowest possible setting.
13146	</desc>
13147	</attribute>
13148
13149	<attribute name="bandwidthGroup" type="IBandwidthGroup">
13150	<desc>The bandwidth group this network adapter is assigned to.</desc>
13151	</attribute>
13152
13153	<!-- property methods -->
13154
13155	<method name="getProperty" const="yes">
13156	<desc>
13157	Returns the value of the network attachment property with the given name.
13158
13159	If the requested data @a key does not exist, this function will
13160	succeed and return an empty string in the @a value argument.
13161
13162	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13163	</desc>
13164	<param name="key" type="wstring" dir="in">
13165	<desc>Name of the property to get.</desc>
13166	</param>
13167	<param name="value" type="wstring" dir="return">
13168	<desc>Current property value.</desc>
13169	</param>
13170	</method>
13171
13172	<method name="setProperty">
13173	<desc>
13174	Sets the value of the network attachment property with the given name.
13175
13176	Setting the property value to @c null or an empty string is equivalent
13177	to deleting the existing value.
13178
13179	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13180	</desc>
13181	<param name="key" type="wstring" dir="in">
13182	<desc>Name of the property to set.</desc>
13183	</param>
13184	<param name="value" type="wstring" dir="in">
13185	<desc>Property value to set.</desc>
13186	</param>
13187	</method>
13188
13189	<method name="getProperties" const="yes">
13190	<desc>
13191	Returns values for a group of properties in one call.
13192
13193	The names of the properties to get are specified using the @a names
13194	argument which is a list of comma-separated property names or
13195	an empty string if all properties are to be returned.
13196	<note>Currently the value of this argument is ignored and the method
13197	always returns all existing properties.</note>
13198
13199	The method returns two arrays, the array of property names corresponding
13200	to the @a names argument and the current values of these properties.
13201	Both arrays have the same number of elements with each element at the
13202	given index in the first array corresponds to an element at the same
13203	index in the second array.
13204	</desc>
13205	<param name="names" type="wstring" dir="in">
13206	<desc>
13207	Names of properties to get.
13208	</desc>
13209	</param>
13210	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13211	<desc>Names of returned properties.</desc>
13212	</param>
13213	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13214	<desc>Values of returned properties.</desc>
13215	</param>
13216	</method>
13217
13218	</interface>
13219
13220
13221	<!--
13222	// ISerialPort
13223	/////////////////////////////////////////////////////////////////////////
13224	-->
13225
13226	<enum
13227	name="PortMode"
13228	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13229	>
13230	<desc>
13231	The PortMode enumeration represents possible communication modes for
13232	the virtual serial port device.
13233	</desc>
13234
13235	<const name="Disconnected" value="0">
13236	<desc>Virtual device is not attached to any real host device.</desc>
13237	</const>
13238	<const name="HostPipe" value="1">
13239	<desc>Virtual device is attached to a host pipe.</desc>
13240	</const>
13241	<const name="HostDevice" value="2">
13242	<desc>Virtual device is attached to a host device.</desc>
13243	</const>
13244	<const name="RawFile" value="3">
13245	<desc>Virtual device is attached to a raw file.</desc>
13246	</const>
13247	</enum>
13248
13249	<interface
13250	name="ISerialPort" extends="$unknown"
13251	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13252	wsmap="managed"
13253	>
13254
13255	<desc>
13256	The ISerialPort interface represents the virtual serial port device.
13257
13258	The virtual serial port device acts like an ordinary serial port
13259	inside the virtual machine. This device communicates to the real
13260	serial port hardware in one of two modes: host pipe or host device.
13261
13262	In host pipe mode, the #path attribute specifies the path to the pipe on
13263	the host computer that represents a serial port. The #server attribute
13264	determines if this pipe is created by the virtual machine process at
13265	machine startup or it must already exist before starting machine
13266	execution.
13267
13268	In host device mode, the #path attribute specifies the name of the
13269	serial port device on the host computer.
13270
13271	There is also a third communication mode: the disconnected mode. In this
13272	mode, the guest OS running inside the virtual machine will be able to
13273	detect the serial port, but all port write operations will be discarded
13274	and all port read operations will return no data.
13275
13276	<see><link to="IMachine::getSerialPort"/></see>
13277	</desc>
13278
13279	<attribute name="slot" type="unsigned long" readonly="yes">
13280	<desc>
13281	Slot number this serial port is plugged into. Corresponds to
13282	the value you pass to <link to="IMachine::getSerialPort"/>
13283	to obtain this instance.
13284	</desc>
13285	</attribute>
13286
13287	<attribute name="enabled" type="boolean">
13288	<desc>
13289	Flag whether the serial port is enabled. If disabled,
13290	the serial port will not be reported to the guest OS.
13291	</desc>
13292	</attribute>
13293
13294	<attribute name="IOBase" type="unsigned long">
13295	<desc>Base I/O address of the serial port.</desc>
13296	</attribute>
13297
13298	<attribute name="IRQ" type="unsigned long">
13299	<desc>IRQ number of the serial port.</desc>
13300	</attribute>
13301
13302	<attribute name="hostMode" type="PortMode">
13303	<desc>
13304	How is this port connected to the host.
13305	<note>
13306	Changing this attribute may fail if the conditions for
13307	<link to="#path"/> are not met.
13308	</note>
13309	</desc>
13310	</attribute>
13311
13312	<attribute name="server" type="boolean">
13313	<desc>
13314	Flag whether this serial port acts as a server (creates a new pipe on
13315	the host) or as a client (uses the existing pipe). This attribute is
13316	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13317	</desc>
13318	</attribute>
13319
13320	<attribute name="path" type="wstring">
13321	<desc>
13322	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13323	PortMode_HostPipe, or the host serial device name when
13324	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13325	cases, setting a @c null or empty string as the attribute's value
13326	is an error. Otherwise, the value of this property is ignored.
13327	</desc>
13328	</attribute>
13329
13330	</interface>
13331
13332	<!--
13333	// IParallelPort
13334	/////////////////////////////////////////////////////////////////////////
13335	-->
13336
13337	<interface
13338	name="IParallelPort" extends="$unknown"
13339	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13340	wsmap="managed"
13341	>
13342
13343	<desc>
13344	The IParallelPort interface represents the virtual parallel port device.
13345
13346	The virtual parallel port device acts like an ordinary parallel port
13347	inside the virtual machine. This device communicates to the real
13348	parallel port hardware using the name of the parallel device on the host
13349	computer specified in the #path attribute.
13350
13351	Each virtual parallel port device is assigned a base I/O address and an
13352	IRQ number that will be reported to the guest operating system and used
13353	to operate the given parallel port from within the virtual machine.
13354
13355	<see><link to="IMachine::getParallelPort"/></see>
13356	</desc>
13357
13358	<attribute name="slot" type="unsigned long" readonly="yes">
13359	<desc>
13360	Slot number this parallel port is plugged into. Corresponds to
13361	the value you pass to <link to="IMachine::getParallelPort"/>
13362	to obtain this instance.
13363	</desc>
13364	</attribute>
13365
13366	<attribute name="enabled" type="boolean">
13367	<desc>
13368	Flag whether the parallel port is enabled. If disabled,
13369	the parallel port will not be reported to the guest OS.
13370	</desc>
13371	</attribute>
13372
13373	<attribute name="IOBase" type="unsigned long">
13374	<desc>Base I/O address of the parallel port.</desc>
13375	</attribute>
13376
13377	<attribute name="IRQ" type="unsigned long">
13378	<desc>IRQ number of the parallel port.</desc>
13379	</attribute>
13380
13381	<attribute name="path" type="wstring">
13382	<desc>
13383	Host parallel device name. If this parallel port is enabled, setting a
13384	@c null or an empty string as this attribute's value will result in
13385	an error.
13386	</desc>
13387	</attribute>
13388
13389	</interface>
13390
13391
13392	<!--
13393	// IMachineDebugger
13394	/////////////////////////////////////////////////////////////////////////
13395	-->
13396
13397	<interface
13398	name="IMachineDebugger" extends="$unknown"
13399	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13400	wsmap="suppress"
13401	>
13402	<method name="dumpGuestCore">
13403	<desc>
13404	Takes a core dump of the guest.
13405
13406	See include/VBox/dbgfcorefmt.h for details on the file format.
13407	</desc>
13408	<param name="filename" type="wstring" dir="in">
13409	<desc>
13410	The name of the output file. The file must not exist.
13411	</desc>
13412	</param>
13413	<param name="compression" type="wstring" dir="in">
13414	<desc>
13415	Reserved for future compression method indicator.
13416	</desc>
13417	</param>
13418	</method>
13419
13420	<method name="dumpHostProcessCore">
13421	<desc>
13422	Takes a core dump of the VM process on the host.
13423
13424	This feature is not implemented in the 4.0.0 release but it may show up
13425	in a dot release.
13426	</desc>
13427	<param name="filename" type="wstring" dir="in">
13428	<desc>
13429	The name of the output file. The file must not exist.
13430	</desc>
13431	</param>
13432	<param name="compression" type="wstring" dir="in">
13433	<desc>
13434	Reserved for future compression method indicator.
13435	</desc>
13436	</param>
13437	</method>
13438
13439	<method name="info">
13440	<desc>
13441	Interfaces with the info dumpers (DBGFInfo).
13442
13443	This feature is not implemented in the 4.0.0 release but it may show up
13444	in a dot release.
13445	</desc>
13446	<param name="name" type="wstring" dir="in">
13447	<desc>
13448	The name of the info item.
13449	</desc>
13450	</param>
13451	<param name="args" type="wstring" dir="in">
13452	<desc>
13453	Arguments to the info dumper.
13454	</desc>
13455	</param>
13456	<param name="info" type="wstring" dir="return">
13457	<desc>
13458	The into string.
13459	</desc>
13460	</param>
13461	</method>
13462
13463	<method name="injectNMI">
13464	<desc>
13465	Inject an NMI into a running VT-x/AMD-V VM.
13466	</desc>
13467	</method>
13468
13469	<method name="modifyLogGroups">
13470	<desc>
13471	Modifies the group settings of the debug or release logger.
13472	</desc>
13473	<param name="settings" type="wstring" dir="in">
13474	<desc>
13475	The group settings string. See iprt/log.h for details. To target the
13476	release logger, prefix the string with "release:".
13477	</desc>
13478	</param>
13479	</method>
13480
13481	<method name="modifyLogFlags">
13482	<desc>
13483	Modifies the debug or release logger flags.
13484	</desc>
13485	<param name="settings" type="wstring" dir="in">
13486	<desc>
13487	The flags settings string. See iprt/log.h for details. To target the
13488	release logger, prefix the string with "release:".
13489	</desc>
13490	</param>
13491	</method>
13492
13493	<method name="modifyLogDestinations">
13494	<desc>
13495	Modifies the debug or release logger destinations.
13496	</desc>
13497	<param name="settings" type="wstring" dir="in">
13498	<desc>
13499	The destination settings string. See iprt/log.h for details. To target the
13500	release logger, prefix the string with "release:".
13501	</desc>
13502	</param>
13503	</method>
13504
13505	<method name="readPhysicalMemory">
13506	<desc>
13507	Reads guest physical memory, no side effects (MMIO++).
13508
13509	This feature is not implemented in the 4.0.0 release but may show up
13510	in a dot release.
13511	</desc>
13512	<param name="address" type="long long" dir="in">
13513	<desc>The guest physical address.</desc>
13514	</param>
13515	<param name="size" type="unsigned long" dir="in">
13516	<desc>The number of bytes to read.</desc>
13517	</param>
13518	<param name="bytes" type="octet" safearray="yes" dir="return">
13519	<desc>The bytes read.</desc>
13520	</param>
13521	</method>
13522
13523	<method name="writePhysicalMemory">
13524	<desc>
13525	Writes guest physical memory, access handles (MMIO++) are ignored.
13526
13527	This feature is not implemented in the 4.0.0 release but may show up
13528	in a dot release.
13529	</desc>
13530	<param name="address" type="long long" dir="in">
13531	<desc>The guest physical address.</desc>
13532	</param>
13533	<param name="size" type="unsigned long" dir="in">
13534	<desc>The number of bytes to read.</desc>
13535	</param>
13536	<param name="bytes" type="octet" safearray="yes" dir="in">
13537	<desc>The bytes to write.</desc>
13538	</param>
13539	</method>
13540
13541	<method name="readVirtualMemory">
13542	<desc>
13543	Reads guest virtual memory, no side effects (MMIO++).
13544
13545	This feature is not implemented in the 4.0.0 release but may show up
13546	in a dot release.
13547	</desc>
13548	<param name="cpuId" type="unsigned long" dir="in">
13549	<desc>The identifier of the Virtual CPU.</desc>
13550	</param>
13551	<param name="address" type="long long" dir="in">
13552	<desc>The guest virtual address.</desc>
13553	</param>
13554	<param name="size" type="unsigned long" dir="in">
13555	<desc>The number of bytes to read.</desc>
13556	</param>
13557	<param name="bytes" type="octet" safearray="yes" dir="return">
13558	<desc>The bytes read.</desc>
13559	</param>
13560	</method>
13561
13562	<method name="writeVirtualMemory">
13563	<desc>
13564	Writes guest virtual memory, access handles (MMIO++) are ignored.
13565
13566	This feature is not implemented in the 4.0.0 release but may show up
13567	in a dot release.
13568	</desc>
13569	<param name="cpuId" type="unsigned long" dir="in">
13570	<desc>The identifier of the Virtual CPU.</desc>
13571	</param>
13572	<param name="address" type="long long" dir="in">
13573	<desc>The guest virtual address.</desc>
13574	</param>
13575	<param name="size" type="unsigned long" dir="in">
13576	<desc>The number of bytes to read.</desc>
13577	</param>
13578	<param name="bytes" type="octet" safearray="yes" dir="in">
13579	<desc>The bytes to write.</desc>
13580	</param>
13581	</method>
13582
13583	<method name="detectOS">
13584	<desc>
13585	Tries to (re-)detect the guest OS kernel.
13586
13587	This feature is not implemented in the 4.0.0 release but may show up
13588	in a dot release.
13589	</desc>
13590	<param name="os" type="wstring" dir="return">
13591	<desc>
13592	The detected OS kernel on success.
13593	</desc>
13594	</param>
13595	</method>
13596
13597	<method name="getRegister">
13598	<desc>
13599	Gets one register.
13600
13601	This feature is not implemented in the 4.0.0 release but may show up
13602	in a dot release.
13603	</desc>
13604	<param name="cpuId" type="unsigned long" dir="in">
13605	<desc>The identifier of the Virtual CPU.</desc>
13606	</param>
13607	<param name="name" type="wstring" dir="in">
13608	<desc>The register name, case is ignored.</desc>
13609	</param>
13610	<param name="value" type="wstring" dir="return">
13611	<desc>
13612	The register value. This is usually a hex value (always 0x prefixed)
13613	but other format may be used for floating point registers (TBD).
13614	</desc>
13615	</param>
13616	</method>
13617
13618	<method name="getRegisters">
13619	<desc>
13620	Gets all the registers for the given CPU.
13621
13622	This feature is not implemented in the 4.0.0 release but may show up
13623	in a dot release.
13624	</desc>
13625	<param name="cpuId" type="unsigned long" dir="in">
13626	<desc>The identifier of the Virtual CPU.</desc>
13627	</param>
13628	<param name="names" type="wstring" dir="out" safearray="yes">
13629	<desc>Array containing the lowercase register names.</desc>
13630	</param>
13631	<param name="values" type="wstring" dir="out" safearray="yes">
13632	<desc>
13633	Array paralell to the names holding the register values as if the
13634	register was returned by <link to="IMachineDebugger::getRegister"/>.
13635	</desc>
13636	</param>
13637	</method>
13638
13639	<method name="setRegister">
13640	<desc>
13641	Gets one register.
13642
13643	This feature is not implemented in the 4.0.0 release but may show up
13644	in a dot release.
13645	</desc>
13646	<param name="cpuId" type="unsigned long" dir="in">
13647	<desc>The identifier of the Virtual CPU.</desc>
13648	</param>
13649	<param name="name" type="wstring" dir="in">
13650	<desc>The register name, case is ignored.</desc>
13651	</param>
13652	<param name="value" type="wstring" dir="in">
13653	<desc>
13654	The new register value. Hexadecimal, decimal and octal formattings
13655	are supported in addition to any special formattings returned by
13656	the getters.
13657	</desc>
13658	</param>
13659	</method>
13660
13661	<method name="setRegisters">
13662	<desc>
13663	Sets zero or more registers atomically.
13664
13665	This feature is not implemented in the 4.0.0 release but may show up
13666	in a dot release.
13667	</desc>
13668	<param name="cpuId" type="unsigned long" dir="in">
13669	<desc>The identifier of the Virtual CPU.</desc>
13670	</param>
13671	<param name="names" type="wstring" dir="in" safearray="yes">
13672	<desc>Array containing the register names, case ignored.</desc>
13673	</param>
13674	<param name="values" type="wstring" dir="in" safearray="yes">
13675	<desc>
13676	Array paralell to the names holding the register values. See
13677	<link to="IMachineDebugger::setRegister"/> for formatting
13678	guidelines.
13679	</desc>
13680	</param>
13681	</method>
13682
13683	<method name="dumpGuestStack">
13684	<desc>
13685	Produce a simple stack dump using the current guest state.
13686
13687	This feature is not implemented in the 4.0.0 release but may show up
13688	in a dot release.
13689	</desc>
13690	<param name="cpuId" type="unsigned long" dir="in">
13691	<desc>The identifier of the Virtual CPU.</desc>
13692	</param>
13693	<param name="stack" type="wstring" dir="return">
13694	<desc>String containing the formatted stack dump.</desc>
13695	</param>
13696	</method>
13697
13698	<method name="resetStats">
13699	<desc>
13700	Reset VM statistics.
13701	</desc>
13702	<param name="pattern" type="wstring" dir="in">
13703	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13704	</param>
13705	</method>
13706
13707	<method name="dumpStats">
13708	<desc>
13709	Dumps VM statistics.
13710	</desc>
13711	<param name="pattern" type="wstring" dir="in">
13712	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13713	</param>
13714	</method>
13715
13716	<method name="getStats">
13717	<desc>
13718	Get the VM statistics in a XMLish format.
13719	</desc>
13720	<param name="pattern" type="wstring" dir="in">
13721	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13722	</param>
13723	<param name="withDescriptions" type="boolean" dir="in">
13724	<desc>Whether to include the descriptions.</desc>
13725	</param>
13726	<param name="stats" type="wstring" dir="out">
13727	<desc>The XML document containing the statistics.</desc>
13728	</param>
13729	</method>
13730
13731	<attribute name="singleStep" type="boolean">
13732	<desc>Switch for enabling single-stepping.</desc>
13733	</attribute>
13734
13735	<attribute name="recompileUser" type="boolean">
13736	<desc>Switch for forcing code recompilation for user mode code.</desc>
13737	</attribute>
13738
13739	<attribute name="recompileSupervisor" type="boolean">
13740	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13741	</attribute>
13742
13743	<attribute name="PATMEnabled" type="boolean">
13744	<desc>Switch for enabling and disabling the PATM component.</desc>
13745	</attribute>
13746
13747	<attribute name="CSAMEnabled" type="boolean">
13748	<desc>Switch for enabling and disabling the CSAM component.</desc>
13749	</attribute>
13750
13751	<attribute name="logEnabled" type="boolean">
13752	<desc>Switch for enabling and disabling the debug logger.</desc>
13753	</attribute>
13754
13755	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13756	<desc>The debug logger flags.</desc>
13757	</attribute>
13758
13759	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13760	<desc>The debug logger's group settings.</desc>
13761	</attribute>
13762
13763	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13764	<desc>The debug logger's destination settings.</desc>
13765	</attribute>
13766
13767	<attribute name="logRelFlags" type="wstring" readonly="yes">
13768	<desc>The release logger flags.</desc>
13769	</attribute>
13770
13771	<attribute name="logRelGroups" type="wstring" readonly="yes">
13772	<desc>The release logger's group settings.</desc>
13773	</attribute>
13774
13775	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13776	<desc>The relase logger's destination settings.</desc>
13777	</attribute>
13778
13779	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13780	<desc>
13781	Flag indicating whether the VM is currently making use of CPU hardware
13782	virtualization extensions.
13783	</desc>
13784	</attribute>
13785
13786	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13787	<desc>
13788	Flag indicating whether the VM is currently making use of the nested paging
13789	CPU hardware virtualization extension.
13790	</desc>
13791	</attribute>
13792
13793	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13794	<desc>
13795	Flag indicating whether the VM is currently making use of the VPID
13796	VT-x extension.
13797	</desc>
13798	</attribute>
13799
13800	<attribute name="OSName" type="wstring" readonly="yes">
13801	<desc>
13802	Query the guest OS kernel name as detected by the DBGF.
13803
13804	This feature is not implemented in the 4.0.0 release but may show up
13805	in a dot release.
13806	</desc>
13807	</attribute>
13808
13809	<attribute name="OSVersion" type="wstring" readonly="yes">
13810	<desc>
13811	Query the guest OS kernel version string as detected by the DBGF.
13812
13813	This feature is not implemented in the 4.0.0 release but may show up
13814	in a dot release.
13815	</desc>
13816	</attribute>
13817
13818	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13819	<desc>
13820	Flag indicating whether the VM is currently making use of the Physical
13821	Address Extension CPU feature.
13822	</desc>
13823	</attribute>
13824
13825	<attribute name="virtualTimeRate" type="unsigned long">
13826	<desc>
13827	The rate at which the virtual time runs expressed as a percentage.
13828	The accepted range is 2% to 20000%.
13829	</desc>
13830	</attribute>
13831
13832	<attribute name="VM" type="long long" readonly="yes">
13833	<desc>
13834	Gets the VM handle. This is only for internal use while
13835	we carve the details of this interface.
13836	</desc>
13837	</attribute>
13838
13839	</interface>
13840
13841	<!--
13842	// IUSBController
13843	/////////////////////////////////////////////////////////////////////////
13844	-->
13845
13846	<interface
13847	name="IUSBController" extends="$unknown"
13848	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13849	wsmap="managed"
13850	>
13851	<attribute name="enabled" type="boolean">
13852	<desc>
13853	Flag whether the USB controller is present in the
13854	guest system. If disabled, the virtual guest hardware will
13855	not contain any USB controller. Can only be changed when
13856	the VM is powered off.
13857	</desc>
13858	</attribute>
13859
13860	<attribute name="enabledEhci" type="boolean">
13861	<desc>
13862	Flag whether the USB EHCI controller is present in the
13863	guest system. If disabled, the virtual guest hardware will
13864	not contain a USB EHCI controller. Can only be changed when
13865	the VM is powered off.
13866	</desc>
13867	</attribute>
13868
13869	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13870	<desc>
13871	Flag whether there is an USB proxy available.
13872	</desc>
13873	</attribute>
13874
13875	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13876	<desc>
13877	USB standard version which the controller implements.
13878	This is a BCD which means that the major version is in the
13879	high byte and minor version is in the low byte.
13880	</desc>
13881	</attribute>
13882
13883	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13884	<desc>
13885	List of USB device filters associated with the machine.
13886
13887	If the machine is currently running, these filters are activated
13888	every time a new (supported) USB device is attached to the host
13889	computer that was not ignored by global filters
13890	(<link to="IHost::USBDeviceFilters"/>).
13891
13892	These filters are also activated when the machine is powered up.
13893	They are run against a list of all currently available USB
13894	devices (in states
13895	<link to="USBDeviceState_Available"/>,
13896	<link to="USBDeviceState_Busy"/>,
13897	<link to="USBDeviceState_Held"/>) that were not previously
13898	ignored by global filters.
13899
13900	If at least one filter matches the USB device in question, this
13901	device is automatically captured (attached to) the virtual USB
13902	controller of this machine.
13903
13904	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13905	</desc>
13906	</attribute>
13907
13908	<method name="createDeviceFilter">
13909	<desc>
13910	Creates a new USB device filter. All attributes except
13911	the filter name are set to empty (any match),
13912	<i>active</i> is @c false (the filter is not active).
13913
13914	The created filter can then be added to the list of filters using
13915	<link to="#insertDeviceFilter"/>.
13916
13917	<result name="VBOX_E_INVALID_VM_STATE">
13918	The virtual machine is not mutable.
13919	</result>
13920
13921	<see><link to="#deviceFilters"/></see>
13922	</desc>
13923	<param name="name" type="wstring" dir="in">
13924	<desc>
13925	Filter name. See <link to="IUSBDeviceFilter::name"/>
13926	for more info.
13927	</desc>
13928	</param>
13929	<param name="filter" type="IUSBDeviceFilter" dir="return">
13930	<desc>Created filter object.</desc>
13931	</param>
13932	</method>
13933
13934	<method name="insertDeviceFilter">
13935	<desc>
13936	Inserts the given USB device to the specified position
13937	in the list of filters.
13938
13939	Positions are numbered starting from <tt>0</tt>. If the specified
13940	position is equal to or greater than the number of elements in
13941	the list, the filter is added to the end of the collection.
13942
13943	<note>
13944	Duplicates are not allowed, so an attempt to insert a
13945	filter that is already in the collection, will return an
13946	error.
13947	</note>
13948
13949	<result name="VBOX_E_INVALID_VM_STATE">
13950	Virtual machine is not mutable.
13951	</result>
13952	<result name="E_INVALIDARG">
13953	USB device filter not created within this VirtualBox instance.
13954	</result>
13955	<result name="VBOX_E_INVALID_OBJECT_STATE">
13956	USB device filter already in list.
13957	</result>
13958
13959	<see><link to="#deviceFilters"/></see>
13960	</desc>
13961	<param name="position" type="unsigned long" dir="in">
13962	<desc>Position to insert the filter to.</desc>
13963	</param>
13964	<param name="filter" type="IUSBDeviceFilter" dir="in">
13965	<desc>USB device filter to insert.</desc>
13966	</param>
13967	</method>
13968
13969	<method name="removeDeviceFilter">
13970	<desc>
13971	Removes a USB device filter from the specified position in the
13972	list of filters.
13973
13974	Positions are numbered starting from <tt>0</tt>. Specifying a
13975	position equal to or greater than the number of elements in
13976	the list will produce an error.
13977
13978	<see><link to="#deviceFilters"/></see>
13979
13980	<result name="VBOX_E_INVALID_VM_STATE">
13981	Virtual machine is not mutable.
13982	</result>
13983	<result name="E_INVALIDARG">
13984	USB device filter list empty or invalid @a position.
13985	</result>
13986
13987	</desc>
13988	<param name="position" type="unsigned long" dir="in">
13989	<desc>Position to remove the filter from.</desc>
13990	</param>
13991	<param name="filter" type="IUSBDeviceFilter" dir="return">
13992	<desc>Removed USB device filter.</desc>
13993	</param>
13994	</method>
13995
13996	</interface>
13997
13998
13999	<!--
14000	// IUSBDevice
14001	/////////////////////////////////////////////////////////////////////////
14002	-->
14003
14004	<interface
14005	name="IUSBDevice" extends="$unknown"
14006	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
14007	wsmap="managed"
14008	>
14009	<desc>
14010	The IUSBDevice interface represents a virtual USB device attached to the
14011	virtual machine.
14012
14013	A collection of objects implementing this interface is stored in the
14014	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
14015	attached to a running virtual machine's USB controller.
14016	</desc>
14017
14018	<attribute name="id" type="uuid" mod="string" readonly="yes">
14019	<desc>
14020	Unique USB device ID. This ID is built from #vendorId,
14021	#productId, #revision and #serialNumber.
14022	</desc>
14023	</attribute>
14024
14025	<attribute name="vendorId" type="unsigned short" readonly="yes">
14026	<desc>Vendor ID.</desc>
14027	</attribute>
14028
14029	<attribute name="productId" type="unsigned short" readonly="yes">
14030	<desc>Product ID.</desc>
14031	</attribute>
14032
14033	<attribute name="revision" type="unsigned short" readonly="yes">
14034	<desc>
14035	Product revision number. This is a packed BCD represented as
14036	unsigned short. The high byte is the integer part and the low
14037	byte is the decimal.
14038	</desc>
14039	</attribute>
14040
14041	<attribute name="manufacturer" type="wstring" readonly="yes">
14042	<desc>Manufacturer string.</desc>
14043	</attribute>
14044
14045	<attribute name="product" type="wstring" readonly="yes">
14046	<desc>Product string.</desc>
14047	</attribute>
14048
14049	<attribute name="serialNumber" type="wstring" readonly="yes">
14050	<desc>Serial number string.</desc>
14051	</attribute>
14052
14053	<attribute name="address" type="wstring" readonly="yes">
14054	<desc>Host specific address of the device.</desc>
14055	</attribute>
14056
14057	<attribute name="port" type="unsigned short" readonly="yes">
14058	<desc>
14059	Host USB port number the device is physically
14060	connected to.
14061	</desc>
14062	</attribute>
14063
14064	<attribute name="version" type="unsigned short" readonly="yes">
14065	<desc>
14066	The major USB version of the device - 1 or 2.
14067	</desc>
14068	</attribute>
14069
14070	<attribute name="portVersion" type="unsigned short" readonly="yes">
14071	<desc>
14072	The major USB version of the host USB port the device is
14073	physically connected to - 1 or 2. For devices not connected to
14074	anything this will have the same value as the version attribute.
14075	</desc>
14076	</attribute>
14077
14078	<attribute name="remote" type="boolean" readonly="yes">
14079	<desc>
14080	Whether the device is physically connected to a remote VRDE
14081	client or to a local host machine.
14082	</desc>
14083	</attribute>
14084
14085	</interface>
14086
14087
14088	<!--
14089	// IUSBDeviceFilter
14090	/////////////////////////////////////////////////////////////////////////
14091	-->
14092
14093	<interface
14094	name="IUSBDeviceFilter" extends="$unknown"
14095	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
14096	wsmap="managed"
14097	>
14098	<desc>
14099	The IUSBDeviceFilter interface represents an USB device filter used
14100	to perform actions on a group of USB devices.
14101
14102	This type of filters is used by running virtual machines to
14103	automatically capture selected USB devices once they are physically
14104	attached to the host computer.
14105
14106	A USB device is matched to the given device filter if and only if all
14107	attributes of the device match the corresponding attributes of the
14108	filter (that is, attributes are joined together using the logical AND
14109	operation). On the other hand, all together, filters in the list of
14110	filters carry the semantics of the logical OR operation. So if it is
14111	desirable to create a match like "this vendor id OR this product id",
14112	one needs to create two filters and specify "any match" (see below)
14113	for unused attributes.
14114
14115	All filter attributes used for matching are strings. Each string
14116	is an expression representing a set of values of the corresponding
14117	device attribute, that will match the given filter. Currently, the
14118	following filtering expressions are supported:
14119
14120	<ul>
14121	<li><i>Interval filters</i>. Used to specify valid intervals for
14122	integer device attributes (Vendor ID, Product ID and Revision).
14123	The format of the string is:
14124
14125	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
14126
14127	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
14128	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
14129	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
14130	is omitted before a dash (<tt>-</tt>), the minimum possible integer
14131	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
14132	possible integer is assumed.
14133	</li>
14134	<li><i>Boolean filters</i>. Used to specify acceptable values for
14135	boolean device attributes. The format of the string is:
14136
14137	<tt>true\|false\|yes\|no\|0\|1</tt>
14138
14139	</li>
14140	<li><i>Exact match</i>. Used to specify a single value for the given
14141	device attribute. Any string that doesn't start with <tt>int:</tt>
14142	represents the exact match. String device attributes are compared to
14143	this string including case of symbols. Integer attributes are first
14144	converted to a string (see individual filter attributes) and then
14145	compared ignoring case.
14146
14147	</li>
14148	<li><i>Any match</i>. Any value of the corresponding device attribute
14149	will match the given filter. An empty or @c null string is
14150	used to construct this type of filtering expressions.
14151
14152	</li>
14153	</ul>
14154
14155	<note>
14156	On the Windows host platform, interval filters are not currently
14157	available. Also all string filter attributes
14158	(<link to="#manufacturer"/>, <link to="#product"/>,
14159	<link to="#serialNumber"/>) are ignored, so they behave as
14160	<i>any match</i> no matter what string expression is specified.
14161	</note>
14162
14163	<see><link to="IUSBController::deviceFilters"/>,
14164	<link to="IHostUSBDeviceFilter"/></see>
14165	</desc>
14166
14167	<attribute name="name" type="wstring">
14168	<desc>
14169	Visible name for this filter.
14170	This name is used to visually distinguish one filter from another,
14171	so it can neither be @c null nor an empty string.
14172	</desc>
14173	</attribute>
14174
14175	<attribute name="active" type="boolean">
14176	<desc>Whether this filter active or has been temporarily disabled.</desc>
14177	</attribute>
14178
14179	<attribute name="vendorId" type="wstring">
14180	<desc>
14181	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14182	The string representation for the <i>exact matching</i>
14183	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14184	(including leading zeroes).
14185	</desc>
14186	</attribute>
14187
14188	<attribute name="productId" type="wstring">
14189	<desc>
14190	<link to="IUSBDevice::productId">Product ID</link> filter.
14191	The string representation for the <i>exact matching</i>
14192	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14193	(including leading zeroes).
14194	</desc>
14195	</attribute>
14196
14197	<attribute name="revision" type="wstring">
14198	<desc>
14199	<link to="IUSBDevice::productId">Product revision number</link>
14200	filter. The string representation for the <i>exact matching</i>
14201	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14202	of the integer part of the revision, and <tt>F</tt> is the
14203	decimal digit of its fractional part (including leading and
14204	trailing zeros).
14205	Note that for interval filters, it's best to use the hexadecimal
14206	form, because the revision is stored as a 16 bit packed BCD value;
14207	so the expression <tt>int:0x0100-0x0199</tt> will match any
14208	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14209	</desc>
14210	</attribute>
14211
14212	<attribute name="manufacturer" type="wstring">
14213	<desc>
14214	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14215	</desc>
14216	</attribute>
14217
14218	<attribute name="product" type="wstring">
14219	<desc>
14220	<link to="IUSBDevice::product">Product</link> filter.
14221	</desc>
14222	</attribute>
14223
14224	<attribute name="serialNumber" type="wstring">
14225	<desc>
14226	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14227	</desc>
14228	</attribute>
14229
14230	<attribute name="port" type="wstring">
14231	<desc>
14232	<link to="IUSBDevice::port">Host USB port</link> filter.
14233	</desc>
14234	</attribute>
14235
14236	<attribute name="remote" type="wstring">
14237	<desc>
14238	<link to="IUSBDevice::remote">Remote state</link> filter.
14239	<note>
14240	This filter makes sense only for machine USB filters,
14241	i.e. it is ignored by IHostUSBDeviceFilter objects.
14242	</note>
14243	</desc>
14244	</attribute>
14245
14246	<attribute name="maskedInterfaces" type="unsigned long">
14247	<desc>
14248	This is an advanced option for hiding one or more USB interfaces
14249	from the guest. The value is a bit mask where the bits that are set
14250	means the corresponding USB interface should be hidden, masked off
14251	if you like.
14252	This feature only works on Linux hosts.
14253	</desc>
14254	</attribute>
14255
14256	</interface>
14257
14258
14259	<!--
14260	// IHostUSBDevice
14261	/////////////////////////////////////////////////////////////////////////
14262	-->
14263
14264	<enum
14265	name="USBDeviceState"
14266	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14267	>
14268	<desc>
14269	USB device state. This enumeration represents all possible states
14270	of the USB device physically attached to the host computer regarding
14271	its state on the host computer and availability to guest computers
14272	(all currently running virtual machines).
14273
14274	Once a supported USB device is attached to the host, global USB
14275	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14276	either ignore the device, or put it to USBDeviceState_Held state, or do
14277	nothing. Unless the device is ignored by global filters, filters of all
14278	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14279	activated that can put it to USBDeviceState_Captured state.
14280
14281	If the device was ignored by global filters, or didn't match
14282	any filters at all (including guest ones), it is handled by the host
14283	in a normal way. In this case, the device state is determined by
14284	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14285	or USBDeviceState_Available, depending on the current device usage.
14286
14287	Besides auto-capturing based on filters, the device can be manually
14288	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14289	state is USBDeviceState_Busy, USBDeviceState_Available or
14290	USBDeviceState_Held.
14291
14292	<note>
14293	Due to differences in USB stack implementations in Linux and Win32,
14294	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14295	only to the Linux version of the product. This also means that (<link
14296	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14297	device state is USBDeviceState_Held.
14298	</note>
14299
14300	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14301	</desc>
14302
14303	<const name="NotSupported" value="0">
14304	<desc>
14305	Not supported by the VirtualBox server, not available to guests.
14306	</desc>
14307	</const>
14308	<const name="Unavailable" value="1">
14309	<desc>
14310	Being used by the host computer exclusively,
14311	not available to guests.
14312	</desc>
14313	</const>
14314	<const name="Busy" value="2">
14315	<desc>
14316	Being used by the host computer, potentially available to guests.
14317	</desc>
14318	</const>
14319	<const name="Available" value="3">
14320	<desc>
14321	Not used by the host computer, available to guests (the host computer
14322	can also start using the device at any time).
14323	</desc>
14324	</const>
14325	<const name="Held" value="4">
14326	<desc>
14327	Held by the VirtualBox server (ignored by the host computer),
14328	available to guests.
14329	</desc>
14330	</const>
14331	<const name="Captured" value="5">
14332	<desc>
14333	Captured by one of the guest computers, not available
14334	to anybody else.
14335	</desc>
14336	</const>
14337	</enum>
14338
14339	<interface
14340	name="IHostUSBDevice" extends="IUSBDevice"
14341	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14342	wsmap="managed"
14343	>
14344	<desc>
14345	The IHostUSBDevice interface represents a physical USB device attached
14346	to the host computer.
14347
14348	Besides properties inherited from IUSBDevice, this interface adds the
14349	<link to="#state"/> property that holds the current state of the USB
14350	device.
14351
14352	<see><link to="IHost::USBDevices"/>,
14353	<link to="IHost::USBDeviceFilters"/></see>
14354	</desc>
14355
14356	<attribute name="state" type="USBDeviceState" readonly="yes">
14357	<desc>
14358	Current state of the device.
14359	</desc>
14360	</attribute>
14361
14362	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14363
14364	</interface>
14365
14366
14367	<!--
14368	// IHostUSBDeviceFilter
14369	/////////////////////////////////////////////////////////////////////////
14370	-->
14371
14372	<enum
14373	name="USBDeviceFilterAction"
14374	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14375	>
14376	<desc>
14377	Actions for host USB device filters.
14378	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14379	</desc>
14380
14381	<const name="Null" value="0">
14382	<desc>Null value (never used by the API).</desc>
14383	</const>
14384	<const name="Ignore" value="1">
14385	<desc>Ignore the matched USB device.</desc>
14386	</const>
14387	<const name="Hold" value="2">
14388	<desc>Hold the matched USB device.</desc>
14389	</const>
14390	</enum>
14391
14392	<interface
14393	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14394	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14395	wsmap="managed"
14396	>
14397	<desc>
14398	The IHostUSBDeviceFilter interface represents a global filter for a
14399	physical USB device used by the host computer. Used indirectly in
14400	<link to="IHost::USBDeviceFilters"/>.
14401
14402	Using filters of this type, the host computer determines the initial
14403	state of the USB device after it is physically attached to the
14404	host's USB controller.
14405
14406	<note>
14407	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14408	filters, because it makes sense only for
14409	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14410	</note>
14411
14412	<see><link to="IHost::USBDeviceFilters"/></see>
14413	</desc>
14414
14415	<attribute name="action" type="USBDeviceFilterAction">
14416	<desc>
14417	Action performed by the host when an attached USB device
14418	matches this filter.
14419	</desc>
14420	</attribute>
14421
14422	</interface>
14423
14424	<!--
14425	// IAudioAdapter
14426	/////////////////////////////////////////////////////////////////////////
14427	-->
14428
14429	<enum
14430	name="AudioDriverType"
14431	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14432	>
14433	<desc>
14434	Host audio driver type.
14435	</desc>
14436
14437	<const name="Null" value="0">
14438	<desc>Null value, also means "dummy audio driver".</desc>
14439	</const>
14440	<const name="WinMM" value="1">
14441	<desc>Windows multimedia (Windows hosts only).</desc>
14442	</const>
14443	<const name="OSS" value="2">
14444	<desc>Open Sound System (Linux hosts only).</desc>
14445	</const>
14446	<const name="ALSA" value="3">
14447	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14448	</const>
14449	<const name="DirectSound" value="4">
14450	<desc>DirectSound (Windows hosts only).</desc>
14451	</const>
14452	<const name="CoreAudio" value="5">
14453	<desc>CoreAudio (Mac hosts only).</desc>
14454	</const>
14455	<const name="MMPM" value="6">
14456	<desc>Reserved for historical reasons.</desc>
14457	</const>
14458	<const name="Pulse" value="7">
14459	<desc>PulseAudio (Linux hosts only).</desc>
14460	</const>
14461	<const name="SolAudio" value="8">
14462	<desc>Solaris audio (Solaris hosts only).</desc>
14463	</const>
14464	</enum>
14465
14466	<enum
14467	name="AudioControllerType"
14468	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14469	>
14470	<desc>
14471	Virtual audio controller type.
14472	</desc>
14473
14474	<const name="AC97" value="0"/>
14475	<const name="SB16" value="1"/>
14476	<const name="HDA" value="2"/>
14477	</enum>
14478
14479	<interface
14480	name="IAudioAdapter" extends="$unknown"
14481	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14482	wsmap="managed"
14483	>
14484	<desc>
14485	The IAudioAdapter interface represents the virtual audio adapter of
14486	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14487	</desc>
14488	<attribute name="enabled" type="boolean">
14489	<desc>
14490	Flag whether the audio adapter is present in the
14491	guest system. If disabled, the virtual guest hardware will
14492	not contain any audio adapter. Can only be changed when
14493	the VM is not running.
14494	</desc>
14495	</attribute>
14496	<attribute name="audioController" type="AudioControllerType">
14497	<desc>
14498	The audio hardware we emulate.
14499	</desc>
14500	</attribute>
14501	<attribute name="audioDriver" type="AudioDriverType">
14502	<desc>
14503	Audio driver the adapter is connected to. This setting
14504	can only be changed when the VM is not running.
14505	</desc>
14506	</attribute>
14507	</interface>
14508
14509	<enum
14510	name="AuthType"
14511	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14512	>
14513	<desc>
14514	VirtualBox authentication type.
14515	</desc>
14516
14517	<const name="Null" value="0">
14518	<desc>Null value, also means "no authentication".</desc>
14519	</const>
14520	<const name="External" value="1"/>
14521	<const name="Guest" value="2"/>
14522	</enum>
14523
14524	<!--
14525	// IVRDEServer
14526	/////////////////////////////////////////////////////////////////////////
14527	-->
14528
14529	<interface
14530	name="IVRDEServer" extends="$unknown"
14531	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14532	wsmap="managed"
14533	>
14534	<attribute name="enabled" type="boolean">
14535	<desc>VRDE server status.</desc>
14536	</attribute>
14537
14538	<attribute name="authType" type="AuthType">
14539	<desc>VRDE authentication method.</desc>
14540	</attribute>
14541
14542	<attribute name="authTimeout" type="unsigned long">
14543	<desc>Timeout for guest authentication. Milliseconds.</desc>
14544	</attribute>
14545
14546	<attribute name="allowMultiConnection" type="boolean">
14547	<desc>
14548	Flag whether multiple simultaneous connections to the VM are permitted.
14549	Note that this will be replaced by a more powerful mechanism in the future.
14550	</desc>
14551	</attribute>
14552
14553	<attribute name="reuseSingleConnection" type="boolean">
14554	<desc>
14555	Flag whether the existing connection must be dropped and a new connection
14556	must be established by the VRDE server, when a new client connects in single
14557	connection mode.
14558	</desc>
14559	</attribute>
14560
14561	<attribute name="VRDEExtPack" type="wstring">
14562	<desc>
14563	The name of Extension Pack providing VRDE for this VM. Overrides
14564	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14565	</desc>
14566	</attribute>
14567
14568	<attribute name="authLibrary" type="wstring">
14569	<desc>
14570	Library used for authentication of RDP clients by this VM. Overrides
14571	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14572	</desc>
14573	</attribute>
14574
14575	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14576	<desc>
14577	Array of names of properties, which are supported by this VRDE server.
14578	</desc>
14579	</attribute>
14580
14581	<method name="setVRDEProperty">
14582	<desc>
14583	Sets a VRDE specific property string.
14584
14585	If you pass @c null or empty string as a key @a value, the given @a key
14586	will be deleted.
14587
14588	</desc>
14589	<param name="key" type="wstring" dir="in">
14590	<desc>Name of the key to set.</desc>
14591	</param>
14592	<param name="value" type="wstring" dir="in">
14593	<desc>Value to assign to the key.</desc>
14594	</param>
14595	</method>
14596
14597	<method name="getVRDEProperty" const="yes">
14598	<desc>
14599	Returns a VRDE specific property string.
14600
14601	If the requested data @a key does not exist, this function will
14602	succeed and return an empty string in the @a value argument.
14603
14604	</desc>
14605	<param name="key" type="wstring" dir="in">
14606	<desc>Name of the key to get.</desc>
14607	</param>
14608	<param name="value" type="wstring" dir="return">
14609	<desc>Value of the requested key.</desc>
14610	</param>
14611	</method>
14612
14613	</interface>
14614
14615
14616	<!--
14617	// ISharedFolder
14618	/////////////////////////////////////////////////////////////////////////
14619	-->
14620
14621	<interface
14622	name="ISharedFolder" extends="$unknown"
14623	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14624	wsmap="struct"
14625	>
14626	<desc>
14627	The ISharedFolder interface represents a folder in the host computer's
14628	file system accessible from the guest OS running inside a virtual
14629	machine using an associated logical name.
14630
14631	There are three types of shared folders:
14632	<ul>
14633	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14634	folders available to all virtual machines.</li>
14635	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14636	VM-specific shared folders available to the given virtual machine at
14637	startup.</li>
14638	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14639	VM-specific shared folders created in the session context (for
14640	example, when the virtual machine is running) and automatically
14641	discarded when the session is closed (the VM is powered off).</li>
14642	</ul>
14643
14644	Logical names of shared folders must be unique within the given scope
14645	(global, permanent or transient). However, they do not need to be unique
14646	across scopes. In this case, the definition of the shared folder in a
14647	more specific scope takes precedence over definitions in all other
14648	scopes. The order of precedence is (more specific to more general):
14649	<ol>
14650	<li>Transient definitions</li>
14651	<li>Permanent definitions</li>
14652	<li>Global definitions</li>
14653	</ol>
14654
14655	For example, if MyMachine has a shared folder named
14656	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14657	transient shared folder named <tt>C_DRIVE</tt> (that points
14658	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14659	of <tt>C_DRIVE</tt> in the guest OS so
14660	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14661	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14662	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14663	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14664	to <tt>C:\\</tt> if it still exists.
14665
14666	Note that permanent and transient shared folders of different machines
14667	are in different name spaces, so they don't overlap and don't need to
14668	have unique logical names.
14669
14670	<note>
14671	Global shared folders are not implemented in the current version of the
14672	product.
14673	</note>
14674	</desc>
14675
14676	<attribute name="name" type="wstring" readonly="yes">
14677	<desc>Logical name of the shared folder.</desc>
14678	</attribute>
14679
14680	<attribute name="hostPath" type="wstring" readonly="yes">
14681	<desc>Full path to the shared folder in the host file system.</desc>
14682	</attribute>
14683
14684	<attribute name="accessible" type="boolean" readonly="yes">
14685	<desc>
14686	Whether the folder defined by the host path is currently
14687	accessible or not.
14688	For example, the folder can be inaccessible if it is placed
14689	on the network share that is not available by the time
14690	this property is read.
14691	</desc>
14692	</attribute>
14693
14694	<attribute name="writable" type="boolean" readonly="yes">
14695	<desc>
14696	Whether the folder defined by the host path is writable or
14697	not.
14698	</desc>
14699	</attribute>
14700
14701	<attribute name="autoMount" type="boolean" readonly="yes">
14702	<desc>
14703	Whether the folder gets automatically mounted by the guest or not.
14704	</desc>
14705	</attribute>
14706
14707	<attribute name="lastAccessError" type="wstring" readonly="yes">
14708	<desc>
14709	Text message that represents the result of the last accessibility
14710	check.
14711
14712	Accessibility checks are performed each time the <link to="#accessible"/>
14713	attribute is read. An empty string is returned if the last
14714	accessibility check was successful. A non-empty string indicates a
14715	failure and should normally describe a reason of the failure (for
14716	example, a file read error).
14717	</desc>
14718	</attribute>
14719
14720	</interface>
14721
14722	<!--
14723	// ISession
14724	/////////////////////////////////////////////////////////////////////////
14725	-->
14726
14727	<interface
14728	name="IInternalSessionControl" extends="$unknown"
14729	uuid="9ddb5449-f463-47cb-a717-d6f22da3b3a2"
14730	internal="yes"
14731	wsmap="suppress"
14732	>
14733	<method name="getPID">
14734	<desc>PID of the process that has created this Session object.
14735	</desc>
14736	<param name="pid" type="unsigned long" dir="return"/>
14737	</method>
14738
14739	<method name="getRemoteConsole">
14740	<desc>
14741	Returns the console object suitable for remote control.
14742
14743	<result name="VBOX_E_INVALID_VM_STATE">
14744	Session state prevents operation.
14745	</result>
14746	<result name="VBOX_E_INVALID_OBJECT_STATE">
14747	Session type prevents operation.
14748	</result>
14749
14750	</desc>
14751	<param name="console" type="IConsole" dir="return"/>
14752	</method>
14753
14754	<method name="assignMachine">
14755	<desc>
14756	Assigns the machine object associated with this direct-type
14757	session or informs the session that it will be a remote one
14758	(if @a machine == @c null).
14759
14760	<result name="VBOX_E_INVALID_VM_STATE">
14761	Session state prevents operation.
14762	</result>
14763	<result name="VBOX_E_INVALID_OBJECT_STATE">
14764	Session type prevents operation.
14765	</result>
14766
14767	</desc>
14768	<param name="machine" type="IMachine" dir="in"/>
14769	</method>
14770
14771	<method name="assignRemoteMachine">
14772	<desc>
14773	Assigns the machine and the (remote) console object associated with
14774	this remote-type session.
14775
14776	<result name="VBOX_E_INVALID_VM_STATE">
14777	Session state prevents operation.
14778	</result>
14779
14780	</desc>
14781	<param name="machine" type="IMachine" dir="in"/>
14782	<param name="console" type="IConsole" dir="in"/>
14783	</method>
14784
14785	<method name="updateMachineState">
14786	<desc>
14787	Updates the machine state in the VM process.
14788	Must be called only in certain cases
14789	(see the method implementation).
14790
14791	<result name="VBOX_E_INVALID_VM_STATE">
14792	Session state prevents operation.
14793	</result>
14794	<result name="VBOX_E_INVALID_OBJECT_STATE">
14795	Session type prevents operation.
14796	</result>
14797
14798	</desc>
14799	<param name="aMachineState" type="MachineState" dir="in"/>
14800	</method>
14801
14802	<method name="uninitialize">
14803	<desc>
14804	Uninitializes (closes) this session. Used by VirtualBox to close
14805	the corresponding remote session when the direct session dies
14806	or gets closed.
14807
14808	<result name="VBOX_E_INVALID_VM_STATE">
14809	Session state prevents operation.
14810	</result>
14811
14812	</desc>
14813	</method>
14814
14815	<method name="onNetworkAdapterChange">
14816	<desc>
14817	Triggered when settings of a network adapter of the
14818	associated virtual machine have changed.
14819
14820	<result name="VBOX_E_INVALID_VM_STATE">
14821	Session state prevents operation.
14822	</result>
14823	<result name="VBOX_E_INVALID_OBJECT_STATE">
14824	Session type prevents operation.
14825	</result>
14826
14827	</desc>
14828	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14829	<param name="changeAdapter" type="boolean" dir="in"/>
14830	</method>
14831
14832	<method name="onSerialPortChange">
14833	<desc>
14834	Triggered when settings of a serial port of the
14835	associated virtual machine have changed.
14836
14837	<result name="VBOX_E_INVALID_VM_STATE">
14838	Session state prevents operation.
14839	</result>
14840	<result name="VBOX_E_INVALID_OBJECT_STATE">
14841	Session type prevents operation.
14842	</result>
14843
14844	</desc>
14845	<param name="serialPort" type="ISerialPort" dir="in"/>
14846	</method>
14847
14848	<method name="onParallelPortChange">
14849	<desc>
14850	Triggered when settings of a parallel port of the
14851	associated virtual machine have changed.
14852
14853	<result name="VBOX_E_INVALID_VM_STATE">
14854	Session state prevents operation.
14855	</result>
14856	<result name="VBOX_E_INVALID_OBJECT_STATE">
14857	Session type prevents operation.
14858	</result>
14859
14860	</desc>
14861	<param name="parallelPort" type="IParallelPort" dir="in"/>
14862	</method>
14863
14864	<method name="onStorageControllerChange">
14865	<desc>
14866	Triggered when settings of a storage controller of the
14867	associated virtual machine have changed.
14868
14869	<result name="VBOX_E_INVALID_VM_STATE">
14870	Session state prevents operation.
14871	</result>
14872	<result name="VBOX_E_INVALID_OBJECT_STATE">
14873	Session type prevents operation.
14874	</result>
14875
14876	</desc>
14877	</method>
14878
14879	<method name="onMediumChange">
14880	<desc>
14881	Triggered when attached media of the
14882	associated virtual machine have changed.
14883
14884	<result name="VBOX_E_INVALID_VM_STATE">
14885	Session state prevents operation.
14886	</result>
14887	<result name="VBOX_E_INVALID_OBJECT_STATE">
14888	Session type prevents operation.
14889	</result>
14890
14891	</desc>
14892
14893	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14894	<desc>The medium attachment which changed.</desc>
14895	</param>
14896	<param name="force" type="boolean" dir="in">
14897	<desc>If the medium change was forced.</desc>
14898	</param>
14899	</method>
14900
14901	<method name="onStorageDeviceChange">
14902	<desc>
14903	Triggered when attached storage devices of the
14904	associated virtual machine have changed.
14905
14906	<result name="VBOX_E_INVALID_VM_STATE">
14907	Session state prevents operation.
14908	</result>
14909	<result name="VBOX_E_INVALID_OBJECT_STATE">
14910	Session type prevents operation.
14911	</result>
14912
14913	</desc>
14914
14915	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14916	<desc>The medium attachment which changed.</desc>
14917	</param>
14918	<param name="remove" type="boolean" dir="in">
14919	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14920	</param>
14921	</method>
14922
14923	<method name="onClipboardModeChange">
14924	<desc>
14925	Notification when the shared clipboard mode changes.
14926	</desc>
14927	<param name="clipboardMode" type="ClipboardMode" dir="in">
14928	<desc>The new shared clipboard mode.</desc>
14929	</param>
14930	</method>
14931
14932	<method name="onCPUChange">
14933	<desc>
14934	Notification when a CPU changes.
14935	</desc>
14936	<param name="cpu" type="unsigned long" dir="in">
14937	<desc>The CPU which changed</desc>
14938	</param>
14939	<param name="add" type="boolean" dir="in">
14940	<desc>Flag whether the CPU was added or removed</desc>
14941	</param>
14942	</method>
14943
14944	<method name="onCPUExecutionCapChange">
14945	<desc>
14946	Notification when the CPU execution cap changes.
14947	</desc>
14948	<param name="executionCap" type="unsigned long" dir="in">
14949	<desc>The new CPU execution cap value. (1-100)</desc>
14950	</param>
14951	</method>
14952
14953	<method name="onVRDEServerChange">
14954	<desc>
14955	Triggered when settings of the VRDE server object of the
14956	associated virtual machine have changed.
14957
14958	<result name="VBOX_E_INVALID_VM_STATE">
14959	Session state prevents operation.
14960	</result>
14961	<result name="VBOX_E_INVALID_OBJECT_STATE">
14962	Session type prevents operation.
14963	</result>
14964
14965	</desc>
14966	<param name="restart" type="boolean" dir="in">
14967	<desc>Flag whether the server must be restarted</desc>
14968	</param>
14969	</method>
14970
14971	<method name="onUSBControllerChange">
14972	<desc>
14973	Triggered when settings of the USB controller object of the
14974	associated virtual machine have changed.
14975
14976	<result name="VBOX_E_INVALID_VM_STATE">
14977	Session state prevents operation.
14978	</result>
14979	<result name="VBOX_E_INVALID_OBJECT_STATE">
14980	Session type prevents operation.
14981	</result>
14982
14983	</desc>
14984	</method>
14985
14986	<method name="onSharedFolderChange">
14987	<desc>
14988	Triggered when a permanent (global or machine) shared folder has been
14989	created or removed.
14990	<note>
14991	We don't pass shared folder parameters in this notification because
14992	the order in which parallel notifications are delivered is not defined,
14993	therefore it could happen that these parameters were outdated by the
14994	time of processing this notification.
14995	</note>
14996
14997	<result name="VBOX_E_INVALID_VM_STATE">
14998	Session state prevents operation.
14999	</result>
15000	<result name="VBOX_E_INVALID_OBJECT_STATE">
15001	Session type prevents operation.
15002	</result>
15003
15004	</desc>
15005	<param name="global" type="boolean" dir="in"/>
15006	</method>
15007
15008	<method name="onUSBDeviceAttach">
15009	<desc>
15010	Triggered when a request to capture a USB device (as a result
15011	of matched USB filters or direct call to
15012	<link to="IConsole::attachUSBDevice"/>) has completed.
15013	A @c null @a error object means success, otherwise it
15014	describes a failure.
15015
15016	<result name="VBOX_E_INVALID_VM_STATE">
15017	Session state prevents operation.
15018	</result>
15019	<result name="VBOX_E_INVALID_OBJECT_STATE">
15020	Session type prevents operation.
15021	</result>
15022
15023	</desc>
15024	<param name="device" type="IUSBDevice" dir="in"/>
15025	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
15026	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
15027	</method>
15028
15029	<method name="onUSBDeviceDetach">
15030	<desc>
15031	Triggered when a request to release the USB device (as a result
15032	of machine termination or direct call to
15033	<link to="IConsole::detachUSBDevice"/>) has completed.
15034	A @c null @a error object means success, otherwise it
15035	describes a failure.
15036
15037	<result name="VBOX_E_INVALID_VM_STATE">
15038	Session state prevents operation.
15039	</result>
15040	<result name="VBOX_E_INVALID_OBJECT_STATE">
15041	Session type prevents operation.
15042	</result>
15043
15044	</desc>
15045	<param name="id" type="uuid" mod="string" dir="in"/>
15046	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
15047	</method>
15048
15049	<method name="onShowWindow">
15050	<desc>
15051	Called by <link to="IMachine::canShowConsoleWindow"/> and by
15052	<link to="IMachine::showConsoleWindow"/> in order to notify
15053	console listeners
15054	<link to="ICanShowWindowEvent"/>
15055	and <link to="IShowWindowEvent"/>.
15056
15057	<result name="VBOX_E_INVALID_OBJECT_STATE">
15058	Session type prevents operation.
15059	</result>
15060
15061	</desc>
15062	<param name="check" type="boolean" dir="in"/>
15063	<param name="canShow" type="boolean" dir="out"/>
15064	<param name="winId" type="long long" dir="out"/>
15065	</method>
15066
15067	<method name="onBandwidthGroupChange">
15068	<desc>
15069	Notification when one of the bandwidth groups change.
15070	</desc>
15071	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
15072	<desc>The bandwidth group which changed.</desc>
15073	</param>
15074	</method>
15075
15076	<method name="accessGuestProperty">
15077	<desc>
15078	Called by <link to="IMachine::getGuestProperty"/> and by
15079	<link to="IMachine::setGuestProperty"/> in order to read and
15080	modify guest properties.
15081
15082	<result name="VBOX_E_INVALID_VM_STATE">
15083	Machine session is not open.
15084	</result>
15085	<result name="VBOX_E_INVALID_OBJECT_STATE">
15086	Session type is not direct.
15087	</result>
15088
15089	</desc>
15090	<param name="name" type="wstring" dir="in"/>
15091	<param name="value" type="wstring" dir="in"/>
15092	<param name="flags" type="wstring" dir="in"/>
15093	<param name="isSetter" type="boolean" dir="in"/>
15094	<param name="retValue" type="wstring" dir="out"/>
15095	<param name="retTimestamp" type="long long" dir="out"/>
15096	<param name="retFlags" type="wstring" dir="out"/>
15097	</method>
15098
15099	<method name="enumerateGuestProperties" const="yes">
15100	<desc>
15101	Return a list of the guest properties matching a set of patterns along
15102	with their values, time stamps and flags.
15103
15104	<result name="VBOX_E_INVALID_VM_STATE">
15105	Machine session is not open.
15106	</result>
15107	<result name="VBOX_E_INVALID_OBJECT_STATE">
15108	Session type is not direct.
15109	</result>
15110
15111	</desc>
15112	<param name="patterns" type="wstring" dir="in">
15113	<desc>
15114	The patterns to match the properties against as a comma-separated
15115	string. If this is empty, all properties currently set will be
15116	returned.
15117	</desc>
15118	</param>
15119	<param name="key" type="wstring" dir="out" safearray="yes">
15120	<desc>
15121	The key names of the properties returned.
15122	</desc>
15123	</param>
15124	<param name="value" type="wstring" dir="out" safearray="yes">
15125	<desc>
15126	The values of the properties returned. The array entries match the
15127	corresponding entries in the @a key array.
15128	</desc>
15129	</param>
15130	<param name="timestamp" type="long long" dir="out" safearray="yes">
15131	<desc>
15132	The time stamps of the properties returned. The array entries match
15133	the corresponding entries in the @a key array.
15134	</desc>
15135	</param>
15136	<param name="flags" type="wstring" dir="out" safearray="yes">
15137	<desc>
15138	The flags of the properties returned. The array entries match the
15139	corresponding entries in the @a key array.
15140	</desc>
15141	</param>
15142	</method>
15143
15144	<method name="onlineMergeMedium">
15145	<desc>
15146	Triggers online merging of a hard disk. Used internally when deleting
15147	a snapshot while a VM referring to the same hard disk chain is running.
15148
15149	<result name="VBOX_E_INVALID_VM_STATE">
15150	Machine session is not open.
15151	</result>
15152	<result name="VBOX_E_INVALID_OBJECT_STATE">
15153	Session type is not direct.
15154	</result>
15155
15156	</desc>
15157	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
15158	<desc>The medium attachment to identify the medium chain.</desc>
15159	</param>
15160	<param name="sourceIdx" type="unsigned long" dir="in">
15161	<desc>The index of the source image in the chain.
15162	Redundant, but drastically reduces IPC.</desc>
15163	</param>
15164	<param name="targetIdx" type="unsigned long" dir="in">
15165	<desc>The index of the target image in the chain.
15166	Redundant, but drastically reduces IPC.</desc>
15167	</param>
15168	<param name="source" type="IMedium" dir="in">
15169	<desc>Merge source medium.</desc>
15170	</param>
15171	<param name="target" type="IMedium" dir="in">
15172	<desc>Merge target medium.</desc>
15173	</param>
15174	<param name="mergeForward" type="boolean" dir="in">
15175	<desc>Merge direction.</desc>
15176	</param>
15177	<param name="parentForTarget" type="IMedium" dir="in">
15178	<desc>For forward merges: new parent for target medium.</desc>
15179	</param>
15180	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
15181	<desc>For backward merges: list of media which need their parent UUID
15182	updated.</desc>
15183	</param>
15184	<param name="progress" type="IProgress" dir="in">
15185	<desc>
15186	Progress object for this operation.
15187	</desc>
15188	</param>
15189	</method>
15190
15191	<method name="enableVMMStatistics">
15192	<desc>
15193	Enables or disables collection of VMM RAM statistics.
15194
15195	<result name="VBOX_E_INVALID_VM_STATE">
15196	Machine session is not open.
15197	</result>
15198	<result name="VBOX_E_INVALID_OBJECT_STATE">
15199	Session type is not direct.
15200	</result>
15201
15202	</desc>
15203	<param name="enable" type="boolean" dir="in">
15204	<desc>True enables statistics collection.</desc>
15205	</param>
15206	</method>
15207
15208	</interface>
15209
15210	<interface
15211	name="ISession" extends="$unknown"
15212	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15213	wsmap="managed"
15214	>
15215	<desc>
15216	The ISession interface represents a client process and allows for locking
15217	virtual machines (represented by IMachine objects) to prevent conflicting
15218	changes to the machine.
15219
15220	Any caller wishing to manipulate a virtual machine needs to create a session
15221	object first, which lives in its own process space. Such session objects are
15222	then associated with <link to="IMachine" /> objects living in the VirtualBox
15223	server process to coordinate such changes.
15224
15225	There are two typical scenarios in which sessions are used:
15226
15227	<ul>
15228	<li>To alter machine settings or control a running virtual machine, one
15229	needs to lock a machine for a given session (client process) by calling
15230	<link to="IMachine::lockMachine"/>.
15231
15232	Whereas multiple sessions may control a running virtual machine, only
15233	one process can obtain a write lock on the machine to prevent conflicting
15234	changes. A write lock is also needed if a process wants to actually run a
15235	virtual machine in its own context, such as the VirtualBox GUI or
15236	VBoxHeadless front-ends. They must also lock a machine for their own
15237	sessions before they are allowed to power up the virtual machine.
15238
15239	As a result, no machine settings can be altered while another process is
15240	already using it, either because that process is modifying machine settings
15241	or because the machine is running.
15242	</li>
15243	<li>
15244	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15245	VirtualBox GUI or VBoxHeadless), one would use
15246	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15247	as its first parameter. This session then identifies the caller and lets the
15248	caller control the started machine (for example, pause machine execution or
15249	power it down) as well as be notified about machine execution state changes.
15250	</li>
15251	</ul>
15252
15253	How sessions objects are created in a client process depends on whether you use
15254	the Main API via COM or via the webservice:
15255
15256	<ul>
15257	<li>When using the COM API directly, an object of the Session class from the
15258	VirtualBox type library needs to be created. In regular COM C++ client code,
15259	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15260	This object will then act as a local session object in further calls to open
15261	a session.
15262	</li>
15263
15264	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15265	a session object automatically whenever <link to="IWebsessionManager::logon" />
15266	is called. A managed object reference to that session object can be retrieved by
15267	calling <link to="IWebsessionManager::getSessionObject" />.
15268	</li>
15269	</ul>
15270	</desc>
15271
15272	<attribute name="state" type="SessionState" readonly="yes">
15273	<desc>Current state of this session.</desc>
15274	</attribute>
15275
15276	<attribute name="type" type="SessionType" readonly="yes">
15277	<desc>
15278	Type of this session. The value of this attribute is valid only
15279	if the session currently has a machine locked (i.e. its
15280	<link to="#state" /> is Locked), otherwise an error will be returned.
15281	</desc>
15282	</attribute>
15283
15284	<attribute name="machine" type="IMachine" readonly="yes">
15285	<desc>Machine object associated with this session.</desc>
15286	</attribute>
15287
15288	<attribute name="console" type="IConsole" readonly="yes">
15289	<desc>Console object associated with this session.</desc>
15290	</attribute>
15291
15292	<method name="unlockMachine">
15293	<desc>
15294	Unlocks a machine that was previously locked for the current session.
15295
15296	Calling this method is required every time a machine has been locked
15297	for a particular session using the <link to="IMachine::launchVMProcess" />
15298	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15299	the machine will be set to <link to="MachineState_Aborted" /> on the
15300	server, and changes made to the machine settings will be lost.
15301
15302	Generally, it is recommended to unlock all machines explicitly
15303	before terminating the application (regardless of the reason for
15304	the termination).
15305
15306	<note>
15307	Do not expect the session state (<link to="ISession::state" />
15308	to return to "Unlocked" immediately after you invoke this method,
15309	particularly if you have started a new VM process. The session
15310	state will automatically return to "Unlocked" once the VM is no
15311	longer executing, which can of course take a very long time.
15312	</note>
15313
15314	<result name="E_UNEXPECTED">
15315	Session is not locked.
15316	</result>
15317
15318	</desc>
15319	</method>
15320
15321	</interface>
15322
15323	<!--
15324	// IStorageController
15325	/////////////////////////////////////////////////////////////////////////
15326	-->
15327
15328	<enum
15329	name="StorageBus"
15330	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15331	>
15332	<desc>
15333	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15334	see <link to="IStorageController::bus" />.
15335	</desc>
15336	<const name="Null" value="0">
15337	<desc>@c null value. Never used by the API.</desc>
15338	</const>
15339	<const name="IDE" value="1"/>
15340	<const name="SATA" value="2"/>
15341	<const name="SCSI" value="3"/>
15342	<const name="Floppy" value="4"/>
15343	<const name="SAS" value="5"/>
15344	</enum>
15345
15346	<enum
15347	name="StorageControllerType"
15348	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15349	>
15350	<desc>
15351	The exact variant of storage controller hardware presented
15352	to the guest; see <link to="IStorageController::controllerType" />.
15353	</desc>
15354
15355	<const name="Null" value="0">
15356	<desc>@c null value. Never used by the API.</desc>
15357	</const>
15358	<const name="LsiLogic" value="1">
15359	<desc>A SCSI controller of the LsiLogic variant.</desc>
15360	</const>
15361	<const name="BusLogic" value="2">
15362	<desc>A SCSI controller of the BusLogic variant.</desc>
15363	</const>
15364	<const name="IntelAhci" value="3">
15365	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15366	</const>
15367	<const name="PIIX3" value="4">
15368	<desc>An IDE controller of the PIIX3 variant.</desc>
15369	</const>
15370	<const name="PIIX4" value="5">
15371	<desc>An IDE controller of the PIIX4 variant.</desc>
15372	</const>
15373	<const name="ICH6" value="6">
15374	<desc>An IDE controller of the ICH6 variant.</desc>
15375	</const>
15376	<const name="I82078" value="7">
15377	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15378	</const>
15379	<const name="LsiLogicSas" value="8">
15380	<desc>A variant of the LsiLogic controller using SAS.</desc>
15381	</const>
15382	</enum>
15383
15384	<enum
15385	name="ChipsetType"
15386	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15387	>
15388	<desc>
15389	Type of emulated chipset (mostly southbridge).
15390	</desc>
15391
15392	<const name="Null" value="0">
15393	<desc>@c null value. Never used by the API.</desc>
15394	</const>
15395	<const name="PIIX3" value="1">
15396	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15397	</const>
15398	<const name="ICH9" value="2">
15399	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15400	</const>
15401	</enum>
15402
15403	<interface
15404	name="IStorageController" extends="$unknown"
15405	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15406	wsmap="managed"
15407	>
15408	<desc>
15409	Represents a storage controller that is attached to a virtual machine
15410	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15411	attached to storage controllers in a real computer, virtual drives
15412	(represented by <link to="IMediumAttachment" />) are attached to virtual
15413	storage controllers, represented by this interface.
15414
15415	As opposed to physical hardware, VirtualBox has a very generic concept
15416	of a storage controller, and for purposes of the Main API, all virtual
15417	storage is attached to virtual machines via instances of this interface.
15418	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15419	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15420	is used, certain sub-types may be available and can be selected in
15421	<link to="#controllerType" />.
15422
15423	Depending on these settings, the guest operating system might see
15424	significantly different virtual hardware.
15425	</desc>
15426
15427	<attribute name="name" type="wstring" readonly="yes">
15428	<desc>
15429	Name of the storage controller, as originally specified with
15430	<link to="IMachine::addStorageController" />. This then uniquely
15431	identifies this controller with other method calls such as
15432	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15433	</desc>
15434	</attribute>
15435
15436	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15437	<desc>
15438	Maximum number of devices which can be attached to one port.
15439	</desc>
15440	</attribute>
15441
15442	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15443	<desc>
15444	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15445	</desc>
15446	</attribute>
15447
15448	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15449	<desc>
15450	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15451	</desc>
15452	</attribute>
15453
15454	<attribute name="instance" type="unsigned long">
15455	<desc>
15456	The instance number of the device in the running VM.
15457	</desc>
15458	</attribute>
15459
15460	<attribute name="portCount" type="unsigned long">
15461	<desc>
15462	The number of currently usable ports on the controller.
15463	The minimum and maximum number of ports for one controller are
15464	stored in <link to="IStorageController::minPortCount"/>
15465	and <link to="IStorageController::maxPortCount"/>.
15466	</desc>
15467	</attribute>
15468
15469	<attribute name="bus" type="StorageBus" readonly="yes">
15470	<desc>
15471	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15472	</desc>
15473	</attribute>
15474
15475	<attribute name="controllerType" type="StorageControllerType">
15476	<desc>
15477	The exact variant of storage controller hardware presented
15478	to the guest.
15479	Depending on this value, VirtualBox will provide a different
15480	virtual storage controller hardware to the guest.
15481	For SATA, SAS and floppy controllers, only one variant is
15482	available, but for IDE and SCSI, there are several.
15483
15484	For SCSI controllers, the default type is LsiLogic.
15485	</desc>
15486	</attribute>
15487
15488	<attribute name="useHostIOCache" type="boolean">
15489	<desc>
15490	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15491	caches and use synchronous file APIs on the host. This was the only option in the API before
15492	VirtualBox 3.2 and is still the default for IDE controllers.
15493
15494	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15495	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15496	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15497	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15498	virtual machines are running at the same time to prevent I/O cache related hangs.
15499	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15500	</desc>
15501	</attribute>
15502
15503	<attribute name="bootable" type="boolean" readonly="yes">
15504	<desc>
15505	Returns whether it is possible to boot from disks attached to this controller.
15506	</desc>
15507	</attribute>
15508
15509	<method name="getIDEEmulationPort">
15510	<desc>
15511	Gets the corresponding port number which is emulated as an IDE device.
15512	Works only with SATA controllers.
15513
15514	<result name="E_INVALIDARG">
15515	The @a devicePosition is not in the range 0 to 3.
15516	</result>
15517	<result name="E_NOTIMPL">
15518	The storage controller type is not SATAIntelAhci.
15519	</result>
15520
15521	</desc>
15522	<param name="devicePosition" type="long" dir="in"/>
15523	<param name="portNumber" type="long" dir="return"/>
15524	</method>
15525
15526	<method name="setIDEEmulationPort">
15527	<desc>
15528	Sets the port number which is emulated as an IDE device.
15529	Works only with SATA controllers.
15530
15531	<result name="E_INVALIDARG">
15532	The @a devicePosition is not in the range 0 to 3 or the
15533	@a portNumber is not in the range 0 to 29.
15534	</result>
15535	<result name="E_NOTIMPL">
15536	The storage controller type is not SATAIntelAhci.
15537	</result>
15538
15539	</desc>
15540	<param name="devicePosition" type="long" dir="in"/>
15541	<param name="portNumber" type="long" dir="in"/>
15542	</method>
15543
15544	</interface>
15545
15546	<if target="wsdl">
15547
15548	<!--
15549	// IManagedObjectRef
15550	/////////////////////////////////////////////////////////////////////////
15551	-->
15552
15553	<interface
15554	name="IManagedObjectRef" extends="$unknown"
15555	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15556	internal="yes"
15557	wsmap="managed"
15558	wscpp="hardcoded"
15559	>
15560	<desc>
15561	Managed object reference.
15562
15563	Only within the webservice, a managed object reference (which is really
15564	an opaque number) allows a webservice client to address an object
15565	that lives in the address space of the webservice server.
15566
15567	Behind each managed object reference, there is a COM object that lives
15568	in the webservice server's address space. The COM object is not freed
15569	until the managed object reference is released, either by an explicit
15570	call to <link to="IManagedObjectRef::release" /> or by logging off from
15571	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15572	all objects created during the webservice session.
15573
15574	Whenever a method call of the VirtualBox API returns a COM object, the
15575	webservice representation of that method will instead return a
15576	managed object reference, which can then be used to invoke methods
15577	on that object.
15578	</desc>
15579
15580	<method name="getInterfaceName">
15581	<desc>
15582	Returns the name of the interface that this managed object represents,
15583	for example, "IMachine", as a string.
15584	</desc>
15585	<param name="return" type="wstring" dir="return"/>
15586	</method>
15587
15588	<method name="release">
15589	<desc>
15590	Releases this managed object reference and frees the resources that
15591	were allocated for it in the webservice server process. After calling
15592	this method, the identifier of the reference can no longer be used.
15593	</desc>
15594	</method>
15595
15596	</interface>
15597
15598	<!--
15599	// IWebsessionManager
15600	/////////////////////////////////////////////////////////////////////////
15601	-->
15602
15603	<interface
15604	name="IWebsessionManager" extends="$unknown"
15605	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15606	internal="yes"
15607	wsmap="global"
15608	wscpp="hardcoded"
15609	>
15610	<desc>
15611	Websession manager. This provides essential services
15612	to webservice clients.
15613	</desc>
15614	<method name="logon">
15615	<desc>
15616	Logs a new client onto the webservice and returns a managed object reference to
15617	the IVirtualBox instance, which the client can then use as a basis to further
15618	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15619	interface, in one way or the other.
15620	</desc>
15621	<param name="username" type="wstring" dir="in"/>
15622	<param name="password" type="wstring" dir="in"/>
15623	<param name="return" type="IVirtualBox" dir="return"/>
15624	</method>
15625
15626	<method name="getSessionObject">
15627	<desc>
15628	Returns a managed object reference to the internal ISession object that was created
15629	for this web service session when the client logged on.
15630
15631	<see><link to="ISession"/></see>
15632	</desc>
15633	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15634	<param name="return" type="ISession" dir="return"/>
15635	</method>
15636
15637	<method name="logoff">
15638	<desc>
15639	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
15640	and destroys all resources associated with the session (most importantly, all
15641	managed objects created in the server while the session was active).
15642	</desc>
15643	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15644	</method>
15645
15646	</interface>
15647
15648	</if>
15649
15650	<!--
15651	// IPerformanceCollector & friends
15652	/////////////////////////////////////////////////////////////////////////
15653	-->
15654
15655	<interface
15656	name="IPerformanceMetric" extends="$unknown"
15657	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15658	>
15659	<desc>
15660	The IPerformanceMetric interface represents parameters of the given
15661	performance metric.
15662	</desc>
15663
15664	<attribute name="metricName" type="wstring" readonly="yes">
15665	<desc>
15666	Name of the metric.
15667	</desc>
15668	</attribute>
15669
15670	<attribute name="object" type="$unknown" readonly="yes">
15671	<desc>
15672	Object this metric belongs to.
15673	</desc>
15674	</attribute>
15675
15676	<attribute name="description" type="wstring" readonly="yes">
15677	<desc>
15678	Textual description of the metric.
15679	</desc>
15680	</attribute>
15681
15682	<attribute name="period" type="unsigned long" readonly="yes">
15683	<desc>
15684	Time interval between samples, measured in seconds.
15685	</desc>
15686	</attribute>
15687
15688	<attribute name="count" type="unsigned long" readonly="yes">
15689	<desc>
15690	Number of recent samples retained by the performance collector for this
15691	metric.
15692
15693	When the collected sample count exceeds this number, older samples
15694	are discarded.
15695	</desc>
15696	</attribute>
15697
15698	<attribute name="unit" type="wstring" readonly="yes">
15699	<desc>
15700	Unit of measurement.
15701	</desc>
15702	</attribute>
15703
15704	<attribute name="minimumValue" type="long" readonly="yes">
15705	<desc>
15706	Minimum possible value of this metric.
15707	</desc>
15708	</attribute>
15709
15710	<attribute name="maximumValue" type="long" readonly="yes">
15711	<desc>
15712	Maximum possible value of this metric.
15713	</desc>
15714	</attribute>
15715	</interface>
15716
15717	<interface
15718	name="IPerformanceCollector" extends="$unknown"
15719	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15720	wsmap="managed"
15721	>
15722	<desc>
15723	The IPerformanceCollector interface represents a service that collects
15724	and stores performance metrics data.
15725
15726	Performance metrics are associated with objects of interfaces like IHost
15727	and IMachine. Each object has a distinct set of performance metrics. The
15728	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15729
15730	Metric data is collected at the specified intervals and is retained
15731	internally. The interval and the number of retained samples can be set
15732	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15733	and collection settings are not persistent, they are discarded as soon as
15734	VBoxSVC process terminates. Moreover, metric settings and data associated
15735	with a particular VM only exist while VM is running. They disappear as
15736	soon as VM shuts down. It is not possible to set up metrics for machines
15737	that are powered off. One needs to start VM first, then set up metric
15738	collection parameters.
15739
15740	Metrics are organized hierarchically, with each level separated by a
15741	slash (/) character. Generally, the scheme for metric names is like this:
15742
15743	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15744
15745	"Category/Metric" together form the base metric name. A base metric is
15746	the smallest unit for which a sampling interval and the number of
15747	retained samples can be set. Only base metrics can be enabled and
15748	disabled. All sub-metrics are collected when their base metric is
15749	collected. Collected values for any set of sub-metrics can be queried
15750	with <link to="IPerformanceCollector::queryMetricsData" />.
15751
15752	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15753	category, "Load" metric, "User" submetric, "average" aggregate. An
15754	aggregate function is computed over all retained data. Valid aggregate
15755	functions are:
15756
15757	<ul>
15758	<li>avg -- average</li>
15759	<li>min -- minimum</li>
15760	<li>max -- maximum</li>
15761	</ul>
15762
15763	When setting up metric parameters, querying metric data, enabling or
15764	disabling metrics wildcards can be used in metric names to specify a
15765	subset of metrics. For example, to select all CPU-related metrics
15766	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15767	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15768
15769	The valid names for base metrics are:
15770
15771	<ul>
15772	<li>CPU/Load</li>
15773	<li>CPU/MHz</li>
15774	<li>RAM/Usage</li>
15775	<li>RAM/VMM</li>
15776	</ul>
15777
15778	The general sequence for collecting and retrieving the metrics is:
15779	<ul>
15780	<li>
15781	Obtain an instance of IPerformanceCollector with
15782	<link to="IVirtualBox::performanceCollector" />
15783	</li>
15784	<li>
15785	Allocate and populate an array with references to objects the metrics
15786	will be collected for. Use references to IHost and IMachine objects.
15787	</li>
15788	<li>
15789	Allocate and populate an array with base metric names the data will
15790	be collected for.
15791	</li>
15792	<li>
15793	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15794	the metric data will be collected and stored.
15795	</li>
15796	<li>
15797	Wait for the data to get collected.
15798	</li>
15799	<li>
15800	Allocate and populate an array with references to objects the metric
15801	values will be queried for. You can re-use the object array used for
15802	setting base metrics.
15803	</li>
15804	<li>
15805	Allocate and populate an array with metric names the data will be
15806	collected for. Note that metric names differ from base metric names.
15807	</li>
15808	<li>
15809	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15810	that have been collected so far are returned. Note that the values
15811	are still retained internally and data collection continues.
15812	</li>
15813	</ul>
15814
15815	For an example of usage refer to the following files in VirtualBox SDK:
15816	<ul>
15817	<li>
15818	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15819	</li>
15820	<li>
15821	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15822	</li>
15823	</ul>
15824	</desc>
15825
15826	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15827	<desc>
15828	Array of unique names of metrics.
15829
15830	This array represents all metrics supported by the performance
15831	collector. Individual objects do not necessarily support all of them.
15832	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15833	list of supported metrics for a particular object.
15834	</desc>
15835	</attribute>
15836
15837	<method name="getMetrics">
15838	<desc>
15839	Returns parameters of specified metrics for a set of objects.
15840	<note>
15841	@c Null metrics array means all metrics. @c Null object array means
15842	all existing objects.
15843	</note>
15844	</desc>
15845	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15846	<desc>
15847	Metric name filter. Currently, only a comma-separated list of metrics
15848	is supported.
15849	</desc>
15850	</param>
15851	<param name="objects" type="$unknown" dir="in" safearray="yes">
15852	<desc>
15853	Set of objects to return metric parameters for.
15854	</desc>
15855	</param>
15856	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15857	<desc>
15858	Array of returned metric parameters.
15859	</desc>
15860	</param>
15861	</method>
15862
15863	<method name="setupMetrics">
15864	<desc>
15865	Sets parameters of specified base metrics for a set of objects. Returns
15866	an array of <link to="IPerformanceMetric" /> describing the metrics
15867	have been affected.
15868	<note>
15869	@c Null or empty metric name array means all metrics. @c Null or
15870	empty object array means all existing objects. If metric name array
15871	contains a single element and object array contains many, the single
15872	metric name array element is applied to each object array element to
15873	form metric/object pairs.
15874	</note>
15875	</desc>
15876	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15877	<desc>
15878	Metric name filter. Comma-separated list of metrics with wildcard
15879	support.
15880	</desc>
15881	</param>
15882	<param name="objects" type="$unknown" dir="in" safearray="yes">
15883	<desc>
15884	Set of objects to setup metric parameters for.
15885	</desc>
15886	</param>
15887	<param name="period" type="unsigned long" dir="in">
15888	<desc>
15889	Time interval in seconds between two consecutive samples of
15890	performance data.
15891	</desc>
15892	</param>
15893	<param name="count" type="unsigned long" dir="in">
15894	<desc>
15895	Number of samples to retain in performance data history. Older
15896	samples get discarded.
15897	</desc>
15898	</param>
15899	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15900	<desc>
15901	Array of metrics that have been modified by the call to this method.
15902	</desc>
15903	</param>
15904	</method>
15905
15906	<method name="enableMetrics">
15907	<desc>
15908	Turns on collecting specified base metrics. Returns an array of
15909	<link to="IPerformanceMetric" /> describing the metrics have been
15910	affected.
15911	<note>
15912	@c Null or empty metric name array means all metrics. @c Null or
15913	empty object array means all existing objects. If metric name array
15914	contains a single element and object array contains many, the single
15915	metric name array element is applied to each object array element to
15916	form metric/object pairs.
15917	</note>
15918	</desc>
15919	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15920	<desc>
15921	Metric name filter. Comma-separated list of metrics with wildcard
15922	support.
15923	</desc>
15924	</param>
15925	<param name="objects" type="$unknown" dir="in" safearray="yes">
15926	<desc>
15927	Set of objects to enable metrics for.
15928	</desc>
15929	</param>
15930	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15931	<desc>
15932	Array of metrics that have been modified by the call to this method.
15933	</desc>
15934	</param>
15935	</method>
15936
15937	<method name="disableMetrics">
15938	<desc>
15939	Turns off collecting specified base metrics. Returns an array of
15940	<link to="IPerformanceMetric" /> describing the metrics have been
15941	affected.
15942	<note>
15943	@c Null or empty metric name array means all metrics. @c Null or
15944	empty object array means all existing objects. If metric name array
15945	contains a single element and object array contains many, the single
15946	metric name array element is applied to each object array element to
15947	form metric/object pairs.
15948	</note>
15949	</desc>
15950	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15951	<desc>
15952	Metric name filter. Comma-separated list of metrics with wildcard
15953	support.
15954	</desc>
15955	</param>
15956	<param name="objects" type="$unknown" dir="in" safearray="yes">
15957	<desc>
15958	Set of objects to disable metrics for.
15959	</desc>
15960	</param>
15961	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15962	<desc>
15963	Array of metrics that have been modified by the call to this method.
15964	</desc>
15965	</param>
15966	</method>
15967
15968	<method name="queryMetricsData">
15969	<desc>
15970	Queries collected metrics data for a set of objects.
15971
15972	The data itself and related metric information are returned in seven
15973	parallel and one flattened array of arrays. Elements of
15974	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15975	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15976	the same index describe one set of values corresponding to a single
15977	metric.
15978
15979	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15980	start and length of a sub-array is indicated by
15981	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15982	value for metric <tt>metricNames[i]</tt> is at
15983	<tt>returnData[returnIndices[i]]</tt>.
15984
15985	<note>
15986	@c Null or empty metric name array means all metrics. @c Null or
15987	empty object array means all existing objects. If metric name array
15988	contains a single element and object array contains many, the single
15989	metric name array element is applied to each object array element to
15990	form metric/object pairs.
15991	</note>
15992	<note>
15993	Data collection continues behind the scenes after call to @c
15994	queryMetricsData. The return data can be seen as the snapshot of the
15995	current state at the time of @c queryMetricsData call. The internally
15996	kept metric values are not cleared by the call. This makes possible
15997	querying different subsets of metrics or aggregates with subsequent
15998	calls. If periodic querying is needed it is highly suggested to query
15999	the values with @c interval*count period to avoid confusion. This way
16000	a completely new set of data values will be provided by each query.
16001	</note>
16002	</desc>
16003	<param name="metricNames" type="wstring" dir="in" safearray="yes">
16004	<desc>
16005	Metric name filter. Comma-separated list of metrics with wildcard
16006	support.
16007	</desc>
16008	</param>
16009	<param name="objects" type="$unknown" dir="in" safearray="yes">
16010	<desc>
16011	Set of objects to query metrics for.
16012	</desc>
16013	</param>
16014	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
16015	<desc>
16016	Names of metrics returned in @c returnData.
16017	</desc>
16018	</param>
16019	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
16020	<desc>
16021	Objects associated with metrics returned in @c returnData.
16022	</desc>
16023	</param>
16024	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
16025	<desc>
16026	Units of measurement for each returned metric.
16027	</desc>
16028	</param>
16029	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
16030	<desc>
16031	Divisor that should be applied to return values in order to get
16032	floating point values. For example:
16033	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
16034	will retrieve the floating point value of i-th sample of the first
16035	metric.
16036	</desc>
16037	</param>
16038	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
16039	<desc>
16040	Sequence numbers of the first elements of value sequences of
16041	particular metrics returned in @c returnData. For aggregate metrics
16042	it is the sequence number of the sample the aggregate started
16043	calculation from.
16044	</desc>
16045	</param>
16046	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
16047	<desc>
16048	Indices of the first elements of value sequences of particular
16049	metrics returned in @c returnData.
16050	</desc>
16051	</param>
16052	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
16053	<desc>
16054	Lengths of value sequences of particular metrics.
16055	</desc>
16056	</param>
16057	<param name="returnData" type="long" dir="return" safearray="yes">
16058	<desc>
16059	Flattened array of all metric data containing sequences of values for
16060	each metric.
16061	</desc>
16062	</param>
16063	</method>
16064
16065	</interface>
16066
16067	<enum
16068	name="NATAliasMode"
16069	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
16070	>
16071	<desc></desc>
16072	<const name="AliasLog" value="0x1">
16073	<desc></desc>
16074	</const>
16075	<const name="AliasProxyOnly" value="0x02">
16076	<desc></desc>
16077	</const>
16078	<const name="AliasUseSamePorts" value="0x04">
16079	<desc></desc>
16080	</const>
16081	</enum>
16082
16083	<enum
16084	name="NATProtocol"
16085	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
16086	>
16087	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
16088	<const name="UDP" value="0">
16089	<desc>Port-forwarding uses UDP protocol.</desc>
16090	</const>
16091	<const name="TCP" value="1">
16092	<desc>Port-forwarding uses TCP protocol.</desc>
16093	</const>
16094	</enum>
16095
16096	<interface
16097	name="INATEngine" extends="$unknown"
16098	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
16099	wsmap="managed"
16100	>
16101	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
16102	allows for changing NAT behavior such as port-forwarding rules. This interface is
16103	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
16104	<attribute name="network" type="wstring">
16105	<desc>The network attribute of the NAT engine (the same value is used with built-in
16106	DHCP server to fill corresponding fields of DHCP leases).</desc>
16107	</attribute>
16108	<attribute name="hostIP" type="wstring">
16109	<desc>IP of host interface to bind all opened sockets to.
16110	<note>Changing this does not change binding of port forwarding.</note>
16111	</desc>
16112	</attribute>
16113	<attribute name="tftpPrefix" type="wstring">
16114	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
16115	the corresponding fields of DHCP leases.</desc>
16116	</attribute>
16117	<attribute name="tftpBootFile" type="wstring">
16118	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
16119	the corresponding fields of DHCP leases.</desc>
16120	</attribute>
16121	<attribute name="tftpNextServer" type="wstring">
16122	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
16123	the corresponding fields of DHCP leases.
16124	<note>The preferred form is IPv4 addresses.</note>
16125	</desc>
16126	</attribute>
16127	<attribute name="aliasMode" type="unsigned long">
16128	<desc></desc>
16129	</attribute>
16130	<attribute name="dnsPassDomain" type="boolean">
16131	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
16132	</attribute>
16133	<attribute name="dnsProxy" type="boolean">
16134	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16135	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
16136	</attribute>
16137	<attribute name="dnsUseHostResolver" type="boolean">
16138	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16139	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
16140	</attribute>
16141	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
16142	<desc>Array of NAT port-forwarding rules in string representation, in the following
16143	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
16144	</attribute>
16145	<method name="setNetworkSettings">
16146	<desc>Sets network configuration of the NAT engine.</desc>
16147	<param name="mtu" type="unsigned long" dir="in">
16148	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
16149	</param>
16150	<param name="sockSnd" type="unsigned long" dir="in">
16151	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
16152	</param>
16153	<param name="sockRcv" type="unsigned long" dir="in">
16154	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
16155	</param>
16156	<param name="TcpWndSnd" type="unsigned long" dir="in">
16157	<desc>Initial size of the NAT engine's sending TCP window in bytes when
16158	establishing a new TCP connection.</desc>
16159	</param>
16160	<param name="TcpWndRcv" type="unsigned long" dir="in">
16161	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
16162	establishing a new TCP connection.</desc>
16163	</param>
16164	</method>
16165	<method name="getNetworkSettings">
16166	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
16167	for parameter descriptions.</desc>
16168	<param name="mtu" type="unsigned long" dir="out" />
16169	<param name="sockSnd" type="unsigned long" dir="out" />
16170	<param name="sockRcv" type="unsigned long" dir="out" />
16171	<param name="TcpWndSnd" type="unsigned long" dir="out" />
16172	<param name="TcpWndRcv" type="unsigned long" dir="out" />
16173	</method>
16174	<method name="addRedirect">
16175	<desc>Adds a new NAT port-forwarding rule.</desc>
16176	<param name="name" type="wstring" dir="in">
16177	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
16178	auto-generates one using the other parameters.</desc>
16179	</param>
16180	<param name="proto" type="NATProtocol" dir="in">
16181	<desc>Protocol handled with the rule.</desc>
16182	</param>
16183	<param name="hostIp" type="wstring" dir="in">
16184	<desc>IP of the host interface to which the rule should apply. An empty ip address is
16185	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
16186	</param>
16187	<param name="hostPort" type="unsigned short" dir="in">
16188	<desc>The port number to listen on.</desc>
16189	</param>
16190	<param name="guestIp" type="wstring" dir="in">
16191	<desc>The IP address of the guest which the NAT engine will forward matching packets
16192	to. An empty IP address is acceptable, in which case the NAT engine will forward
16193	packets to the first DHCP lease (x.x.x.15).</desc>
16194	</param>
16195	<param name="guestPort" type="unsigned short" dir="in">
16196	<desc>The port number to forward.</desc>
16197	</param>
16198	</method>
16199	<method name="removeRedirect">
16200	<desc>Removes a port-forwarding rule that was previously registered.</desc>
16201	<param name="name" type="wstring" dir="in">
16202	<desc>The name of the rule to delete.</desc>
16203	</param>
16204	</method>
16205	</interface>
16206
16207	<!--
16208	// IExtPackManager
16209	/////////////////////////////////////////////////////////////////////////
16210	-->
16211
16212	<interface
16213	name="IExtPackPlugIn" extends="$unknown"
16214	uuid="58000040-e718-4746-bbce-4b86d96da461"
16215	wsmap="suppress"
16216	>
16217	<desc>
16218	Interface for keeping information about a plug-in that ships with an
16219	extension pack.
16220	</desc>
16221	<attribute name="name" type="wstring" readonly="yes">
16222	<desc>The plug-in name.</desc>
16223	</attribute>
16224	<attribute name="description" type="wstring" readonly="yes">
16225	<desc>The plug-in description.</desc>
16226	</attribute>
16227	<attribute name="frontend" type="wstring" readonly="yes">
16228	<desc>
16229	The name of the frontend or component name this plug-in plugs into.
16230	</desc>
16231	</attribute>
16232	<attribute name="modulePath" type="wstring" readonly="yes">
16233	<desc> The module path. </desc>
16234	</attribute>
16235	</interface>
16236
16237	<interface
16238	name="IExtPackBase" extends="$unknown"
16239	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16240	wsmap="suppress"
16241	>
16242	<desc>
16243	Interface for querying information about an extension pack as well as
16244	accessing COM objects within it.
16245	</desc>
16246	<attribute name="name" type="wstring" readonly="yes">
16247	<desc>The extension pack name. This is unique.</desc>
16248	</attribute>
16249	<attribute name="description" type="wstring" readonly="yes">
16250	<desc>The extension pack description.</desc>
16251	</attribute>
16252	<attribute name="version" type="wstring" readonly="yes">
16253	<desc>
16254	The extension pack version string. This is restricted to the dotted
16255	version number and optionally a build indicator. No tree revision or
16256	tag will be included in the string as those things are available as
16257	separate properties. An optional publisher tag may be present like for
16258	<link to="IVirtualBox::version"/>.
16259
16260	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16261	</desc>
16262	</attribute>
16263	<attribute name="revision" type="unsigned long" readonly="yes">
16264	<desc>The extension pack internal revision number.</desc>
16265	</attribute>
16266	<attribute name="edition" type="wstring" readonly="yes">
16267	<desc>
16268	Edition indicator. This is usually empty.
16269
16270	Can for instance be used to help distinguishing between two editions
16271	of the same extension pack where only the license, service contract or
16272	something differs.
16273	</desc>
16274	</attribute>
16275	<attribute name="VRDEModule" type="wstring" readonly="yes">
16276	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16277	</attribute>
16278	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16279	<desc>Plug-ins provided by this extension pack.</desc>
16280	</attribute>
16281	<attribute name="usable" type="boolean" readonly="yes">
16282	<desc>
16283	Indicates whether the extension pack is usable or not.
16284
16285	There are a number of reasons why an extension pack might be unusable,
16286	typical examples would be broken installation/file or that it is
16287	incompatible with the current VirtualBox version.
16288	</desc>
16289	</attribute>
16290	<attribute name="whyUnusable" type="wstring" readonly="yes">
16291	<desc>
16292	String indicating why the extension pack is not usable. This is an
16293	empty string if usable and always a non-empty string if not usable.
16294	</desc>
16295	</attribute>
16296	<attribute name="showLicense" type="boolean" readonly="yes">
16297	<desc>Whether to show the license before installation</desc>
16298	</attribute>
16299	<attribute name="license" type="wstring" readonly="yes">
16300	<desc>
16301	The default HTML license text for the extension pack. Same as
16302	calling <link to="#queryLicense">queryLicense</link> with
16303	preferredLocale and preferredLanguage as empty strings and format set
16304	to html.
16305	</desc>
16306	</attribute>
16307
16308	<method name="queryLicense">
16309	<desc>
16310	Full feature version of the license attribute.
16311	</desc>
16312	<param name="preferredLocale" type="wstring" dir="in">
16313	<desc>
16314	The preferred license locale. Pass an empty string to get the default
16315	license.
16316	</desc>
16317	</param>
16318	<param name="preferredLanguage" type="wstring" dir="in">
16319	<desc>
16320	The preferred license language. Pass an empty string to get the
16321	default language for the locale.
16322	</desc>
16323	</param>
16324	<param name="format" type="wstring" dir="in">
16325	<desc>
16326	The license format: html, rtf or txt. If a license is present there
16327	will always be an HTML of it, the rich text format (RTF) and plain
16328	text (txt) versions are optional. If
16329	</desc>
16330	</param>
16331	<param name="licenseText" type="wstring" dir="return">
16332	<desc>The license text.</desc>
16333	</param>
16334	</method>
16335
16336	</interface>
16337
16338	<interface
16339	name="IExtPack" extends="IExtPackBase"
16340	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16341	wsmap="suppress"
16342	>
16343	<desc>
16344	Interface for querying information about an extension pack as well as
16345	accessing COM objects within it.
16346	</desc>
16347	<method name="queryObject">
16348	<desc>
16349	Queries the IUnknown interface to an object in the extension pack
16350	main module. This allows plug-ins and others to talk directly to an
16351	extension pack.
16352	</desc>
16353	<param name="objUuid" type="wstring" dir="in">
16354	<desc>The object ID. What exactly this is </desc>
16355	</param>
16356	<param name="returnInterface" type="$unknown" dir="return">
16357	<desc>The queried interface.</desc>
16358	</param>
16359	</method>
16360	</interface>
16361
16362	<interface
16363	name="IExtPackFile" extends="IExtPackBase"
16364	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16365	wsmap="suppress"
16366	>
16367	<desc>
16368	Extension pack file (aka tarball, .vbox-extpack) representation returned
16369	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16370	extension pack information with the addition of the file name.
16371	</desc>
16372	<attribute name="filePath" type="wstring" readonly="yes">
16373	<desc>
16374	The path to the extension pack file.
16375	</desc>
16376	</attribute>
16377
16378	<method name="install">
16379	<desc>
16380	Install the extension pack.
16381	</desc>
16382	<param name="replace" type="boolean" dir="in">
16383	<desc>
16384	Set this to automatically uninstall any existing extension pack with
16385	the same name as the one being installed.
16386	</desc>
16387	</param>
16388	<param name="displayInfo" type="wstring" dir="in">
16389	<desc>
16390	Platform specific display information. Reserved for future hacks.
16391	</desc>
16392	</param>
16393	<param name="progess" type="IProgress" dir="return">
16394	<desc>
16395	Progress object for the operation.
16396	</desc>
16397	</param>
16398	</method>
16399	</interface>
16400
16401	<interface
16402	name="IExtPackManager" extends="$unknown"
16403	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16404	wsmap="suppress"
16405	>
16406	<desc>
16407	Interface for managing VirtualBox Extension Packs.
16408
16409	TODO: Describe extension packs, how they are managed and how to create
16410	one.
16411	</desc>
16412
16413	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16414	<desc>
16415	List of the installed extension packs.
16416	</desc>
16417	</attribute>
16418
16419	<method name="find">
16420	<desc>
16421	Returns the extension pack with the specified name if found.
16422
16423	<result name="VBOX_E_OBJECT_NOT_FOUND">
16424	No extension pack matching @a name was found.
16425	</result>
16426	</desc>
16427	<param name="name" type="wstring" dir="in">
16428	<desc>The name of the extension pack to locate.</desc>
16429	</param>
16430	<param name="returnData" type="IExtPack" dir="return">
16431	<desc>The extension pack if found.</desc>
16432	</param>
16433	</method>
16434
16435	<method name="openExtPackFile">
16436	<desc>
16437	Attempts to open an extension pack file in preparation for
16438	installation.
16439	</desc>
16440	<param name="path" type="wstring" dir="in">
16441	<desc>The path of the extension pack tarball. This can optionally be
16442	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16443	</param>
16444	<param name="file" type="IExtPackFile" dir="return">
16445	<desc>The interface of the extension pack file object.</desc>
16446	</param>
16447	</method>
16448
16449	<method name="uninstall">
16450	<desc>Uninstalls an extension pack, removing all related files.</desc>
16451	<param name="name" type="wstring" dir="in">
16452	<desc>The name of the extension pack to uninstall.</desc>
16453	</param>
16454	<param name="forcedRemoval" type="boolean" dir="in">
16455	<desc>
16456	Forced removal of the extension pack. This means that the uninstall
16457	hook will not be called.
16458	</desc>
16459	</param>
16460	<param name="displayInfo" type="wstring" dir="in">
16461	<desc>
16462	Platform specific display information. Reserved for future hacks.
16463	</desc>
16464	</param>
16465	<param name="progess" type="IProgress" dir="return">
16466	<desc>
16467	Progress object for the operation.
16468	</desc>
16469	</param>
16470	</method>
16471
16472	<method name="cleanup">
16473	<desc>Cleans up failed installs and uninstalls</desc>
16474	</method>
16475
16476	<method name="queryAllPlugInsForFrontend">
16477	<desc>
16478	Gets the path to all the plug-in modules for a given frontend.
16479
16480	This is a convenience method that is intended to simplify the plug-in
16481	loading process for a frontend.
16482	</desc>
16483	<param name="frontendName" type="wstring" dir="in">
16484	<desc>The name of the frontend or component.</desc>
16485	</param>
16486	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16487	<desc>Array containing the plug-in modules (full paths).</desc>
16488	</param>
16489	</method>
16490
16491	<method name="isExtPackUsable">
16492	<desc>Check if the given extension pack is loaded and usable.</desc>
16493	<param name="name" type="wstring" dir="in">
16494	<desc>The name of the extension pack to check for.</desc>
16495	</param>
16496	<param name="usable" type="boolean" dir="return">
16497	<desc>Is the given extension pack loaded and usable.</desc>
16498	</param>
16499	</method>
16500
16501	</interface>
16502
16503	<!--
16504	// BandwidthGroupType
16505	/////////////////////////////////////////////////////////////////////////
16506	-->
16507	<enum
16508	name="BandwidthGroupType"
16509	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16510
16511	<desc>
16512	Type of a bandwidth control group.
16513	</desc>
16514
16515	<const name="Null" value="0">
16516	<desc>
16517	Null type, must be first.
16518	</desc>
16519	</const>
16520
16521	<const name="Disk" value="1">
16522	<desc>
16523	The bandwidth group controls disk I/O.
16524	</desc>
16525	</const>
16526
16527	<const name="Network" value="2">
16528	<desc>
16529	The bandwidth group controls network I/O.
16530	</desc>
16531	</const>
16532
16533	</enum>
16534
16535	<!--
16536	// IBandwidthGroup
16537	/////////////////////////////////////////////////////////////////////////
16538	-->
16539	<interface
16540	name="IBandwidthGroup" extends="$unknown"
16541	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16542	wsmap="managed"
16543	>
16544	<desc>Represents one bandwidth group.</desc>
16545
16546	<attribute name="name" type="wstring" readonly="yes">
16547	<desc>Name of the group.</desc>
16548	</attribute>
16549
16550	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16551	<desc>Type of the group.</desc>
16552	</attribute>
16553
16554	<attribute name="reference" type="unsigned long" readonly="yes">
16555	<desc>How many devices/medium attachements use this group.</desc>
16556	</attribute>
16557
16558	<attribute name="maxBytesPerSec" type="long long">
16559	<desc>The maximum number of bytes which can be transfered by all
16560	entities attached to this group during one second.</desc>
16561	</attribute>
16562
16563	</interface>
16564
16565	<!--
16566	// IBandwidthControl
16567	/////////////////////////////////////////////////////////////////////////
16568	-->
16569	<interface
16570	name="IBandwidthControl" extends="$unknown"
16571	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16572	wsmap="managed"
16573	>
16574	<desc>
16575	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16576	This includes network and disk I/O.
16577	</desc>
16578
16579	<attribute name="numGroups" type="unsigned long" readonly="yes">
16580	<desc>
16581	The current number of existing bandwidth groups managed.
16582	</desc>
16583	</attribute>
16584
16585	<method name="createBandwidthGroup">
16586	<desc>
16587	Creates a new bandwidth group.
16588	</desc>
16589
16590	<param name="name" type="wstring" dir="in">
16591	<desc>Name of the bandwidth group.</desc>
16592	</param>
16593	<param name="type" type="BandwidthGroupType" dir="in">
16594	<desc>The type of the bandwidth group (network or disk).</desc>
16595	</param>
16596	<param name="maxBytesPerSec" type="long long" dir="in">
16597	<desc>The maximum number of bytes which can be transfered by all
16598	entities attached to this group during one second.</desc>
16599	</param>
16600	</method>
16601
16602	<method name="deleteBandwidthGroup">
16603	<desc>
16604	Deletes a new bandwidth group.
16605	</desc>
16606
16607	<param name="name" type="wstring" dir="in">
16608	<desc>Name of the bandwidth group to delete.</desc>
16609	</param>
16610	</method>
16611
16612	<method name="getBandwidthGroup" const="yes">
16613	<desc>
16614	Get a bandwidth group by name.
16615	</desc>
16616
16617	<param name="name" type="wstring" dir="in">
16618	<desc>Name of the bandwidth group to get.</desc>
16619	</param>
16620	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16621	<desc>Where to store the bandwidth group on success.</desc>
16622	</param>
16623	</method>
16624
16625	<method name="getAllBandwidthGroups" const="yes">
16626	<desc>
16627	Get all managed bandwidth groups.
16628	</desc>
16629
16630	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16631	<desc>The array of managed bandwidth groups.</desc>
16632	</param>
16633	</method>
16634	</interface>
16635
16636	<!--
16637	// IVirtualBoxClient
16638	/////////////////////////////////////////////////////////////////////////
16639	-->
16640
16641	<interface
16642	name="IVirtualBoxClient" extends="$unknown"
16643	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16644	wsmap="suppress"
16645	>
16646	<desc>
16647	Convenience interface for client applications. Treat this as a
16648	singleton, i.e. never create more than one instance of this interface.
16649
16650	At the moment only available for clients of the local API (not usable
16651	via the webservice). Once the session logic is redesigned this might
16652	change.
16653	</desc>
16654
16655	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16656	<desc>
16657	Reference to the server-side API root object.
16658	</desc>
16659	</attribute>
16660
16661	<attribute name="session" type="ISession" readonly="yes">
16662	<desc>
16663	Create a new session object and return the reference to it.
16664	</desc>
16665	</attribute>
16666
16667	<attribute name="eventSource" type="IEventSource" readonly="yes">
16668	<desc>
16669	Event source for VirtualBoxClient events.
16670	</desc>
16671	</attribute>
16672
16673	</interface>
16674
16675	<!--
16676	// Events
16677	/////////////////////////////////////////////////////////////////////////
16678	-->
16679	<enum
16680	name="VBoxEventType"
16681	uuid="100cf5c8-7dd4-4600-8d75-636d211479c9"
16682	>
16683
16684	<desc>
16685	Type of an event.
16686	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16687	</desc>
16688
16689	<const name="Invalid" value="0">
16690	<desc>
16691	Invalid event, must be first.
16692	</desc>
16693	</const>
16694
16695	<const name="Any" value="1">
16696	<desc>
16697	Wildcard for all events.
16698	Events of this type are never delivered, and only used in
16699	<link to="IEventSource::registerListener"/> call to simplify registration.
16700	</desc>
16701	</const>
16702
16703	<const name="Vetoable" value="2">
16704	<desc>
16705	Wildcard for all vetoable events. Events of this type are never delivered, and only
16706	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16707	</desc>
16708	</const>
16709
16710	<const name="MachineEvent" value="3">
16711	<desc>
16712	Wildcard for all machine events. Events of this type are never delivered, and only used in
16713	<link to="IEventSource::registerListener"/> call to simplify registration.
16714	</desc>
16715	</const>
16716
16717	<const name="SnapshotEvent" value="4">
16718	<desc>
16719	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16720	<link to="IEventSource::registerListener"/> call to simplify registration.
16721	</desc>
16722	</const>
16723
16724	<const name="InputEvent" value="5">
16725	<desc>
16726	Wildcard for all input device (keyboard, mouse) events.
16727	Events of this type are never delivered, and only used in
16728	<link to="IEventSource::registerListener"/> call to simplify registration.
16729	</desc>
16730	</const>
16731
16732	<const name="LastWildcard" value="31">
16733	<desc>
16734	Last wildcard.
16735	</desc>
16736	</const>
16737
16738	<const name="OnMachineStateChanged" value="32">
16739	<desc>
16740	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16741	</desc>
16742	</const>
16743	<const name="OnMachineDataChanged" value="33">
16744	<desc>
16745	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16746	</desc>
16747	</const>
16748	<const name="OnExtraDataChanged" value="34">
16749	<desc>
16750	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16751	</desc>
16752	</const>
16753	<const name="OnExtraDataCanChange" value="35">
16754	<desc>
16755	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16756	</desc>
16757	</const>
16758	<const name="OnMediumRegistered" value="36">
16759	<desc>
16760	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16761	</desc>
16762	</const>
16763	<const name="OnMachineRegistered" value="37">
16764	<desc>
16765	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16766	</desc>
16767	</const>
16768	<const name="OnSessionStateChanged" value="38">
16769	<desc>
16770	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16771	</desc>
16772	</const>
16773	<const name="OnSnapshotTaken" value="39">
16774	<desc>
16775	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16776	</desc>
16777	</const>
16778	<const name="OnSnapshotDeleted" value="40">
16779	<desc>
16780	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16781	</desc>
16782	</const>
16783	<const name="OnSnapshotChanged" value="41">
16784	<desc>
16785	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16786	</desc>
16787	</const>
16788	<const name="OnGuestPropertyChanged" value="42">
16789	<desc>
16790	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16791	</desc>
16792	</const>
16793	<!-- Console events -->
16794	<const name="OnMousePointerShapeChanged" value="43">
16795	<desc>
16796	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16797	</desc>
16798	</const>
16799	<const name="OnMouseCapabilityChanged" value="44">
16800	<desc>
16801	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16802	</desc>
16803	</const>
16804	<const name="OnKeyboardLedsChanged" value="45">
16805	<desc>
16806	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16807	</desc>
16808	</const>
16809	<const name="OnStateChanged" value="46">
16810	<desc>
16811	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16812	</desc>
16813	</const>
16814	<const name="OnAdditionsStateChanged" value="47">
16815	<desc>
16816	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16817	</desc>
16818	</const>
16819	<const name="OnNetworkAdapterChanged" value="48">
16820	<desc>
16821	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16822	</desc>
16823	</const>
16824	<const name="OnSerialPortChanged" value="49">
16825	<desc>
16826	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16827	</desc>
16828	</const>
16829	<const name="OnParallelPortChanged" value="50">
16830	<desc>
16831	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16832	</desc>
16833	</const>
16834	<const name="OnStorageControllerChanged" value="51">
16835	<desc>
16836	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16837	</desc>
16838	</const>
16839	<const name="OnMediumChanged" value="52">
16840	<desc>
16841	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16842	</desc>
16843	</const>
16844	<const name="OnVRDEServerChanged" value="53">
16845	<desc>
16846	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16847	</desc>
16848	</const>
16849	<const name="OnUSBControllerChanged" value="54">
16850	<desc>
16851	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16852	</desc>
16853	</const>
16854	<const name="OnUSBDeviceStateChanged" value="55">
16855	<desc>
16856	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16857	</desc>
16858	</const>
16859	<const name="OnSharedFolderChanged" value="56">
16860	<desc>
16861	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16862	</desc>
16863	</const>
16864	<const name="OnRuntimeError" value="57">
16865	<desc>
16866	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16867	</desc>
16868	</const>
16869	<const name="OnCanShowWindow" value="58">
16870	<desc>
16871	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16872	</desc>
16873	</const>
16874	<const name="OnShowWindow" value="59">
16875	<desc>
16876	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16877	</desc>
16878	</const>
16879	<const name="OnCPUChanged" value="60">
16880	<desc>
16881	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16882	</desc>
16883	</const>
16884	<const name="OnVRDEServerInfoChanged" value="61">
16885	<desc>
16886	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16887	</desc>
16888	</const>
16889	<const name="OnEventSourceChanged" value="62">
16890	<desc>
16891	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16892	</desc>
16893	</const>
16894	<const name="OnCPUExecutionCapChanged" value="63">
16895	<desc>
16896	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16897	</desc>
16898	</const>
16899	<const name="OnGuestKeyboard" value="64">
16900	<desc>
16901	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16902	</desc>
16903	</const>
16904	<const name="OnGuestMouse" value="65">
16905	<desc>
16906	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16907	</desc>
16908	</const>
16909	<const name="OnNATRedirect" value="66">
16910	<desc>
16911	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16912	</desc>
16913	</const>
16914	<const name="OnHostPciDevicePlug" value="67">
16915	<desc>
16916	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16917	</desc>
16918	</const>
16919	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16920	<desc>
16921	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16922	</desc>
16923	</const>
16924	<const name="OnBandwidthGroupChanged" value="69">
16925	<desc>
16926	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16927	</desc>
16928	</const>
16929	<const name="OnGuestMonitorChanged" value="70">
16930	<desc>
16931	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16932	</desc>
16933	</const>
16934	<const name="OnStorageDeviceChanged" value="71">
16935	<desc>
16936	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16937	</desc>
16938	</const>
16939	<const name="OnClipboardModeChanged" value="72">
16940	<desc>
16941	See <link to="IClipboardModeChangedEvent">IClipboardModeChangedEvent</link>.
16942	</desc>
16943	</const>
16944
16945	<!-- Last event marker -->
16946	<const name="Last" value="73">
16947	<desc>
16948	Must be last event, used for iterations and structures relying on numerical event values.
16949	</desc>
16950	</const>
16951
16952	</enum>
16953
16954	<interface
16955	name="IEventSource" extends="$unknown"
16956	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16957	wsmap="managed"
16958	>
16959	<desc>
16960	Event source. Generally, any object which could generate events can be an event source,
16961	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16962	an event source can work with listeners in either active or passive mode. In active mode it is up to
16963	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16964	event source keeps track of pending events for each listener and returns available events on demand.
16965
16966	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16967	</desc>
16968
16969	<method name="createListener">
16970	<desc>
16971	Creates a new listener object, useful for passive mode.
16972	</desc>
16973	<param name="listener" type="IEventListener" dir="return"/>
16974	</method>
16975
16976	<method name="createAggregator">
16977	<desc>
16978	Creates an aggregator event source, collecting events from multiple sources.
16979	This way a single listener can listen for events coming from multiple sources,
16980	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16981	</desc>
16982	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16983	<desc>
16984	Subordinate event source this one aggregatres.
16985	</desc>
16986	</param>
16987	<param name="result" type="IEventSource" dir="return">
16988	<desc>
16989	Event source aggregating passed sources.
16990	</desc>
16991	</param>
16992	</method>
16993
16994	<method name="registerListener">
16995	<desc>
16996	Register an event listener.
16997
16998	<note>
16999	To avoid system overload, the VirtualBox server process checks if passive event
17000	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
17001	current implementation, if more than 500 pending events are detected for a passive
17002	event listener, it is forcefully unregistered by the system, and further
17003	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
17004	</note>
17005	</desc>
17006	<param name="listener" type="IEventListener" dir="in">
17007	<desc>Listener to register.</desc>
17008	</param>
17009	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
17010	<desc>
17011	Event types listener is interested in. One can use wildcards like -
17012	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
17013	than one event.
17014	</desc>
17015	</param>
17016	<param name="active" type="boolean" dir="in">
17017	<desc>
17018	Which mode this listener is operating in.
17019	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
17020	In passive mode, an internal event queue is created for this this IEventListener.
17021	For each event coming in, it is added to queues for all interested registered passive
17022	listeners. It is then up to the external code to call the listener's
17023	<link to="IEventListener::handleEvent" /> method. When done with an event, the
17024	external code must call <link to="#eventProcessed" />.
17025	</desc>
17026	</param>
17027	</method>
17028
17029	<method name="unregisterListener">
17030	<desc>
17031	Unregister an event listener. If listener is passive, and some waitable events are still
17032	in queue they are marked as processed automatically.
17033	</desc>
17034	<param name="listener" type="IEventListener" dir="in">
17035	<desc>Listener to unregister.</desc>
17036	</param>
17037	</method>
17038
17039	<method name="fireEvent">
17040	<desc>
17041	Fire an event for this source.
17042	</desc>
17043	<param name="event" type="IEvent" dir="in">
17044	<desc>Event to deliver.</desc>
17045	</param>
17046	<param name="timeout" type="long" dir="in">
17047	<desc>
17048	Maximum time to wait for event processing (if event is waitable), in ms;
17049	0 = no wait, -1 = indefinite wait.
17050	</desc>
17051	</param>
17052	<param name="result" type="boolean" dir="return">
17053	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
17054	</param>
17055	</method>
17056
17057	<method name="getEvent">
17058	<desc>
17059	Get events from this peer's event queue (for passive mode). Calling this method
17060	regularly is required for passive event listeners to avoid system overload;
17061	see <link to="IEventSource::registerListener" /> for details.
17062
17063	<result name="VBOX_E_OBJECT_NOT_FOUND">
17064	Listener is not registered, or autounregistered.
17065	</result>
17066	</desc>
17067	<param name="listener" type="IEventListener" dir="in">
17068	<desc>Which listener to get data for.</desc>
17069	</param>
17070	<param name="timeout" type="long" dir="in">
17071	<desc>
17072	Maximum time to wait for events, in ms;
17073	0 = no wait, -1 = indefinite wait.
17074	</desc>
17075	</param>
17076	<param name="event" type="IEvent" dir="return">
17077	<desc>Event retrieved, or null if none available.</desc>
17078	</param>
17079	</method>
17080
17081	<method name="eventProcessed">
17082	<desc>
17083	Must be called for waitable events after a particular listener finished its
17084	event processing. When all listeners of a particular event have called this
17085	method, the system will then call <link to="IEvent::setProcessed" />.
17086	</desc>
17087	<param name="listener" type="IEventListener" dir="in">
17088	<desc>Which listener processed event.</desc>
17089	</param>
17090	<param name="event" type="IEvent" dir="in">
17091	<desc>Which event.</desc>
17092	</param>
17093	</method>
17094
17095	</interface>
17096
17097	<interface
17098	name="IEventListener" extends="$unknown"
17099	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
17100	wsmap="managed"
17101	>
17102	<desc>
17103	Event listener. An event listener can work in either active or passive mode, depending on the way
17104	it was registered.
17105	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
17106	</desc>
17107
17108	<method name="handleEvent">
17109	<desc>
17110	Handle event callback for active listeners. It is not called for
17111	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
17112	and having received acknowledgement from all passive listeners via
17113	<link to="IEventSource::eventProcessed"/>, the event is marked as
17114	processed and <link to="IEvent::waitProcessed"/> will return
17115	immediately.
17116	</desc>
17117	<param name="event" type="IEvent" dir="in">
17118	<desc>Event available.</desc>
17119	</param>
17120	</method>
17121
17122	</interface>
17123
17124	<interface
17125	name="IEvent" extends="$unknown"
17126	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
17127	wsmap="managed"
17128	>
17129	<desc>
17130	Abstract parent interface for VirtualBox events. Actual events will typically implement
17131	a more specific interface which derives from this (see below).
17132
17133	<b>Introduction to VirtualBox events</b>
17134
17135	Generally speaking, an event (represented by this interface) signals that something
17136	happened, while an event listener (see <link to="IEventListener" />) represents an
17137	entity that is interested in certain events. In order for this to work with
17138	unidirectional protocols (i.e. web services), the concepts of passive and active
17139	listener are used.
17140
17141	Event consumers can register themselves as listeners, providing an array of
17142	events they are interested in (see <link to="IEventSource::registerListener" />).
17143	When an event triggers, the listener is notified about the event. The exact
17144	mechanism of the notification depends on whether the listener was registered as
17145	an active or passive listener:
17146
17147	<ul>
17148	<li>An active listener is very similar to a callback: it is a function invoked
17149	by the API. As opposed to the callbacks that were used in the API before
17150	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
17151	</li>
17152
17153	<li>Passive listeners are somewhat trickier to implement, but do not require
17154	a client function to be callable, which is not an option with scripting
17155	languages or web service clients. Internally the <link to="IEventSource" />
17156	implementation maintains an event queue for each passive listener, and
17157	newly arrived events are put in this queue. When the listener calls
17158	<link to="IEventSource::getEvent"/>, first element from its internal event
17159	queue is returned. When the client completes processing of an event,
17160	the <link to="IEventSource::eventProcessed" /> function must be called,
17161	acknowledging that the event was processed. It supports implementing
17162	waitable events. On passive listener unregistration, all events from its
17163	queue are auto-acknowledged.
17164	</li>
17165	</ul>
17166
17167	Waitable events are useful in situations where the event generator wants to track
17168	delivery or a party wants to wait until all listeners have completed the event. A
17169	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
17170	listeners might veto a certain action, and thus the event producer has to make
17171	sure that all listeners have processed the event and not vetoed before taking
17172	the action.
17173
17174	A given event may have both passive and active listeners at the same time.
17175
17176	<b>Using events</b>
17177
17178	Any VirtualBox object capable of producing externally visible events provides an
17179	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
17180	This event source object is notified by VirtualBox once something has happened, so
17181	consumers may register event listeners with this event source. To register a listener,
17182	an object implementing the <link to="IEventListener" /> interface must be provided.
17183	For active listeners, such an object is typically created by the consumer, while for
17184	passive listeners <link to="IEventSource::createListener" /> should be used. Please
17185	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
17186
17187	Once created, the listener must be registered to listen for the desired events
17188	(see <link to="IEventSource::registerListener" />), providing an array of
17189	<link to="VBoxEventType" /> enums. Those elements can either be the individual
17190	event IDs or wildcards matching multiple event IDs.
17191
17192	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
17193	called automatically when the event is triggered, while passive listeners have to call
17194	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
17195	an event processing loop.
17196
17197	The IEvent interface is an abstract parent interface for all such VirtualBox events
17198	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
17199	or the event processing loop is to check the <link to="#type" /> attribute of the event and
17200	then cast to the appropriate specific interface using @c QueryInterface().
17201	</desc>
17202
17203	<attribute name="type" readonly="yes" type="VBoxEventType">
17204	<desc>
17205	Event type.
17206	</desc>
17207	</attribute>
17208
17209	<attribute name="source" readonly="yes" type="IEventSource">
17210	<desc>
17211	Source of this event.
17212	</desc>
17213	</attribute>
17214
17215	<attribute name="waitable" readonly="yes" type="boolean">
17216	<desc>
17217	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17218	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17219	as no additional overhead associated with waitability imposed.
17220	Waitable events are needed when one need to be able to wait for particular event processed,
17221	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17222	until all consumers confirmed events.
17223	</desc>
17224	</attribute>
17225
17226	<method name="setProcessed">
17227	<desc>
17228	Internal method called by the system when all listeners of a particular event have called
17229	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17230	</desc>
17231	</method>
17232
17233	<method name="waitProcessed">
17234	<desc>
17235	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17236	described semantics, for non-waitable returns true immediately.
17237	</desc>
17238	<param name="timeout" type="long" dir="in">
17239	<desc>
17240	Maximum time to wait for event processeing, in ms;
17241	0 = no wait, -1 = indefinite wait.
17242	</desc>
17243	</param>
17244	<param name="result" type="boolean" dir="return">
17245	<desc>If this event was processed before timeout.</desc>
17246	</param>
17247	</method>
17248	</interface>
17249
17250
17251	<interface
17252	name="IReusableEvent" extends="IEvent"
17253	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17254	wsmap="managed"
17255	>
17256	<desc>Base abstract interface for all reusable events.</desc>
17257
17258	<attribute name="generation" readonly="yes" type="unsigned long">
17259	<desc>Current generation of event, incremented on reuse.</desc>
17260	</attribute>
17261
17262	<method name="reuse">
17263	<desc>
17264	Marks an event as reused, increments 'generation', fields shall no
17265	longer be considered valid.
17266	</desc>
17267	</method>
17268	</interface>
17269
17270	<interface
17271	name="IMachineEvent" extends="IEvent"
17272	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17273	wsmap="managed" id="MachineEvent"
17274	>
17275	<desc>Base abstract interface for all machine events.</desc>
17276
17277	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17278	<desc>ID of the machine this event relates to.</desc>
17279	</attribute>
17280
17281	</interface>
17282
17283	<interface
17284	name="IMachineStateChangedEvent" extends="IMachineEvent"
17285	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17286	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17287	>
17288	<desc>Machine state change event.</desc>
17289
17290	<attribute name="state" readonly="yes" type="MachineState">
17291	<desc>New execution state.</desc>
17292	</attribute>
17293	</interface>
17294
17295	<interface
17296	name="IMachineDataChangedEvent" extends="IMachineEvent"
17297	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17298	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17299	>
17300	<desc>
17301	Any of the settings of the given machine has changed.
17302	</desc>
17303
17304	<attribute name="temporary" readonly="yes" type="boolean">
17305	<desc>@c true if the settings change is temporary. All permanent
17306	settings changes will trigger an event, and only temporary settings
17307	changes for running VMs will trigger an event. Note: sending events
17308	for temporary changes is NOT IMPLEMENTED.</desc>
17309	</attribute>
17310	</interface>
17311
17312	<interface
17313	name="IMediumRegisteredEvent" extends="IEvent"
17314	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17315	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17316	>
17317	<desc>
17318	The given medium was registered or unregistered
17319	within this VirtualBox installation.
17320	</desc>
17321
17322	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17323	<desc>ID of the medium this event relates to.</desc>
17324	</attribute>
17325
17326	<attribute name="mediumType" readonly="yes" type="DeviceType">
17327	<desc>Type of the medium this event relates to.</desc>
17328	</attribute>
17329
17330	<attribute name="registered" type="boolean" readonly="yes">
17331	<desc>
17332	If @c true, the medium was registered, otherwise it was
17333	unregistered.
17334	</desc>
17335	</attribute>
17336	</interface>
17337
17338	<interface
17339	name="IMachineRegisteredEvent" extends="IMachineEvent"
17340	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17341	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17342	>
17343	<desc>
17344	The given machine was registered or unregistered
17345	within this VirtualBox installation.
17346	</desc>
17347
17348	<attribute name="registered" type="boolean" readonly="yes">
17349	<desc>
17350	If @c true, the machine was registered, otherwise it was
17351	unregistered.
17352	</desc>
17353	</attribute>
17354	</interface>
17355
17356	<interface
17357	name="ISessionStateChangedEvent" extends="IMachineEvent"
17358	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17359	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17360	>
17361	<desc>
17362	The state of the session for the given machine was changed.
17363	<see><link to="IMachine::sessionState"/></see>
17364	</desc>
17365
17366	<attribute name="state" type="SessionState" readonly="yes">
17367	<desc>
17368	New session state.
17369	</desc>
17370	</attribute>
17371	</interface>
17372
17373	<interface
17374	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17375	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17376	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17377	>
17378	<desc>
17379	Notification when a guest property has changed.
17380	</desc>
17381
17382	<attribute name="name" readonly="yes" type="wstring">
17383	<desc>
17384	The name of the property that has changed.
17385	</desc>
17386	</attribute>
17387
17388	<attribute name="value" readonly="yes" type="wstring">
17389	<desc>
17390	The new property value.
17391	</desc>
17392	</attribute>
17393
17394	<attribute name="flags" readonly="yes" type="wstring">
17395	<desc>
17396	The new property flags.
17397	</desc>
17398	</attribute>
17399
17400	</interface>
17401
17402	<interface
17403	name="ISnapshotEvent" extends="IMachineEvent"
17404	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17405	wsmap="managed" id="SnapshotEvent"
17406	>
17407	<desc>Base interface for all snapshot events.</desc>
17408
17409	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17410	<desc>ID of the snapshot this event relates to.</desc>
17411	</attribute>
17412
17413	</interface>
17414
17415	<interface
17416	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17417	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17418	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17419	>
17420	<desc>
17421	A new snapshot of the machine has been taken.
17422	<see><link to="ISnapshot"/></see>
17423	</desc>
17424	</interface>
17425
17426	<interface
17427	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17428	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17429	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17430	>
17431	<desc>
17432	Snapshot of the given machine has been deleted.
17433
17434	<note>
17435	This notification is delivered <b>after</b> the snapshot
17436	object has been uninitialized on the server (so that any
17437	attempt to call its methods will return an error).
17438	</note>
17439
17440	<see><link to="ISnapshot"/></see>
17441	</desc>
17442	</interface>
17443
17444	<interface
17445	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17446	uuid="07541941-8079-447a-a33e-47a69c7980db"
17447	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17448	>
17449	<desc>
17450	Snapshot properties (name and/or description) have been changed.
17451	<see><link to="ISnapshot"/></see>
17452	</desc>
17453	</interface>
17454
17455	<interface
17456	name="IMousePointerShapeChangedEvent" extends="IEvent"
17457	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17458	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17459	>
17460	<desc>
17461	Notification when the guest mouse pointer shape has
17462	changed. The new shape data is given.
17463	</desc>
17464
17465	<attribute name="visible" type="boolean" readonly="yes">
17466	<desc>
17467	Flag whether the pointer is visible.
17468	</desc>
17469	</attribute>
17470	<attribute name="alpha" type="boolean" readonly="yes">
17471	<desc>
17472	Flag whether the pointer has an alpha channel.
17473	</desc>
17474	</attribute>
17475	<attribute name="xhot" type="unsigned long" readonly="yes">
17476	<desc>
17477	The pointer hot spot X coordinate.
17478	</desc>
17479	</attribute>
17480	<attribute name="yhot" type="unsigned long" readonly="yes">
17481	<desc>
17482	The pointer hot spot Y coordinate.
17483	</desc>
17484	</attribute>
17485	<attribute name="width" type="unsigned long" readonly="yes">
17486	<desc>
17487	Width of the pointer shape in pixels.
17488	</desc>
17489	</attribute>
17490	<attribute name="height" type="unsigned long" readonly="yes">
17491	<desc>
17492	Height of the pointer shape in pixels.
17493	</desc>
17494	</attribute>
17495	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17496	<desc>
17497	Shape buffer arrays.
17498
17499	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17500	followed by a 32-bpp XOR (color) mask.
17501
17502	For pointers without alpha channel the XOR mask pixels are 32
17503	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17504	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17505
17506	An AND mask is used for pointers with alpha channel, so if the
17507	callback does not support alpha, the pointer could be
17508	displayed as a normal color pointer.
17509
17510	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17511	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17512	height</tt>. The padding bits at the end of each scanline are
17513	undefined.
17514
17515	The XOR mask follows the AND mask on the next 4-byte aligned
17516	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17517	Bytes in the gap between the AND and the XOR mask are undefined.
17518	The XOR mask scanlines have no gap between them and the size of
17519	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17520
17521	<note>
17522	If @a shape is 0, only the pointer visibility is changed.
17523	</note>
17524	</desc>
17525	</attribute>
17526	</interface>
17527
17528	<interface
17529	name="IMouseCapabilityChangedEvent" extends="IEvent"
17530	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17531	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17532	>
17533	<desc>
17534	Notification when the mouse capabilities reported by the
17535	guest have changed. The new capabilities are passed.
17536	</desc>
17537	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17538	<desc>
17539	Supports absolute coordinates.
17540	</desc>
17541	</attribute>
17542	<attribute name="supportsRelative" type="boolean" readonly="yes">
17543	<desc>
17544	Supports relative coordinates.
17545	</desc>
17546	</attribute>
17547	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17548	<desc>
17549	If host cursor is needed.
17550	</desc>
17551	</attribute>
17552	</interface>
17553
17554	<interface
17555	name="IKeyboardLedsChangedEvent" extends="IEvent"
17556	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17557	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17558	>
17559	<desc>
17560	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17561	to alter the state of the keyboard LEDs.
17562	</desc>
17563	<attribute name="numLock" type="boolean" readonly="yes">
17564	<desc>
17565	NumLock status.
17566	</desc>
17567	</attribute>
17568	<attribute name="capsLock" type="boolean" readonly="yes">
17569	<desc>
17570	CapsLock status.
17571	</desc>
17572	</attribute>
17573	<attribute name="scrollLock" type="boolean" readonly="yes">
17574	<desc>
17575	ScrollLock status.
17576	</desc>
17577	</attribute>
17578	</interface>
17579
17580	<interface
17581	name="IStateChangedEvent" extends="IEvent"
17582	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17583	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17584	>
17585	<desc>
17586	Notification when the execution state of the machine has changed.
17587	The new state is given.
17588	</desc>
17589	<attribute name="state" type="MachineState" readonly="yes">
17590	<desc>
17591	New machine state.
17592	</desc>
17593	</attribute>
17594	</interface>
17595
17596	<interface
17597	name="IAdditionsStateChangedEvent" extends="IEvent"
17598	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17599	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17600	>
17601	<desc>
17602	Notification when a Guest Additions property changes.
17603	Interested callees should query IGuest attributes to
17604	find out what has changed.
17605	</desc>
17606	</interface>
17607
17608	<interface
17609	name="INetworkAdapterChangedEvent" extends="IEvent"
17610	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17611	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17612	>
17613	<desc>
17614	Notification when a property of one of the
17615	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17616	changes. Interested callees should use INetworkAdapter methods and
17617	attributes to find out what has changed.
17618	</desc>
17619	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17620	<desc>
17621	Network adapter that is subject to change.
17622	</desc>
17623	</attribute>
17624	</interface>
17625
17626	<interface
17627	name="ISerialPortChangedEvent" extends="IEvent"
17628	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17629	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17630	>
17631	<desc>
17632	Notification when a property of one of the
17633	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17634	Interested callees should use ISerialPort methods and attributes
17635	to find out what has changed.
17636	</desc>
17637	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17638	<desc>
17639	Serial port that is subject to change.
17640	</desc>
17641	</attribute>
17642	</interface>
17643
17644	<interface
17645	name="IParallelPortChangedEvent" extends="IEvent"
17646	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17647	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17648	>
17649	<desc>
17650	Notification when a property of one of the
17651	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17652	changes. Interested callees should use ISerialPort methods and
17653	attributes to find out what has changed.
17654	</desc>
17655	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17656	<desc>
17657	Parallel port that is subject to change.
17658	</desc>
17659	</attribute>
17660	</interface>
17661
17662	<interface
17663	name="IStorageControllerChangedEvent" extends="IEvent"
17664	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17665	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17666	>
17667	<desc>
17668	Notification when a
17669	<link to="IMachine::mediumAttachments">medium attachment</link>
17670	changes.
17671	</desc>
17672	</interface>
17673
17674	<interface
17675	name="IMediumChangedEvent" extends="IEvent"
17676	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17677	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17678	>
17679	<desc>
17680	Notification when a
17681	<link to="IMachine::mediumAttachments">medium attachment</link>
17682	changes.
17683	</desc>
17684	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17685	<desc>
17686	Medium attachment that is subject to change.
17687	</desc>
17688	</attribute>
17689	</interface>
17690
17691	<interface
17692	name="IClipboardModeChangedEvent" extends="IEvent"
17693	uuid="cac21692-7997-4595-a731-3a509db604e5"
17694	wsmap="managed" autogen="VBoxEvent" id="OnClipboardModeChanged"
17695	>
17696	<desc>
17697	Notification when the shared clipboard mode changes.
17698	</desc>
17699	<attribute name="clipboardMode" type="ClipboardMode" readonly="yes">
17700	<desc>
17701	The new clipboard mode.
17702	</desc>
17703	</attribute>
17704	</interface>
17705
17706	<interface
17707	name="ICPUChangedEvent" extends="IEvent"
17708	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17709	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17710	>
17711	<desc>
17712	Notification when a CPU changes.
17713	</desc>
17714	<attribute name="cpu" type="unsigned long" readonly="yes">
17715	<desc>
17716	The CPU which changed.
17717	</desc>
17718	</attribute>
17719	<attribute name="add" type="boolean" readonly="yes">
17720	<desc>
17721	Flag whether the CPU was added or removed.
17722	</desc>
17723	</attribute>
17724	</interface>
17725
17726	<interface
17727	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17728	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17729	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17730	>
17731	<desc>
17732	Notification when the CPU execution cap changes.
17733	</desc>
17734	<attribute name="executionCap" type="unsigned long" readonly="yes">
17735	<desc>
17736	The new CPU execution cap value. (1-100)
17737	</desc>
17738	</attribute>
17739	</interface>
17740
17741	<interface
17742	name="IGuestKeyboardEvent" extends="IEvent"
17743	uuid="88394258-7006-40d4-b339-472ee3801844"
17744	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17745	>
17746	<desc>
17747	Notification when guest keyboard event happens.
17748	</desc>
17749	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17750	<desc>
17751	Array of scancodes.
17752	</desc>
17753	</attribute>
17754	</interface>
17755
17756	<interface
17757	name="IGuestMouseEvent" extends="IReusableEvent"
17758	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17759	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17760	>
17761	<desc>
17762	Notification when guest mouse event happens.
17763	</desc>
17764
17765	<attribute name="absolute" type="boolean" readonly="yes">
17766	<desc>
17767	If this event is relative or absolute.
17768	</desc>
17769	</attribute>
17770
17771	<attribute name="x" type="long" readonly="yes">
17772	<desc>
17773	New X position, or X delta.
17774	</desc>
17775	</attribute>
17776
17777	<attribute name="y" type="long" readonly="yes">
17778	<desc>
17779	New Y position, or Y delta.
17780	</desc>
17781	</attribute>
17782
17783	<attribute name="z" type="long" readonly="yes">
17784	<desc>
17785	Z delta.
17786	</desc>
17787	</attribute>
17788
17789	<attribute name="w" type="long" readonly="yes">
17790	<desc>
17791	W delta.
17792	</desc>
17793	</attribute>
17794
17795	<attribute name="buttons" type="long" readonly="yes">
17796	<desc>
17797	Button state bitmask.
17798	</desc>
17799	</attribute>
17800
17801	</interface>
17802
17803
17804	<interface
17805	name="IVRDEServerChangedEvent" extends="IEvent"
17806	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17807	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17808	>
17809	<desc>
17810	Notification when a property of the
17811	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17812	Interested callees should use IVRDEServer methods and attributes to
17813	find out what has changed.
17814	</desc>
17815	</interface>
17816
17817	<interface
17818	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17819	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17820	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17821	>
17822	<desc>
17823	Notification when the status of the VRDE server changes. Interested callees
17824	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17825	attributes to find out what is the current status.
17826	</desc>
17827	</interface>
17828
17829	<interface
17830	name="IUSBControllerChangedEvent" extends="IEvent"
17831	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17832	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17833	>
17834	<desc>
17835	Notification when a property of the virtual
17836	<link to="IMachine::USBController">USB controller</link> changes.
17837	Interested callees should use IUSBController methods and attributes to
17838	find out what has changed.
17839	</desc>
17840	</interface>
17841
17842	<interface
17843	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17844	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17845	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17846	>
17847	<desc>
17848	Notification when a USB device is attached to or detached from
17849	the virtual USB controller.
17850
17851	This notification is sent as a result of the indirect
17852	request to attach the device because it matches one of the
17853	machine USB filters, or as a result of the direct request
17854	issued by <link to="IConsole::attachUSBDevice"/> or
17855	<link to="IConsole::detachUSBDevice"/>.
17856
17857	This notification is sent in case of both a succeeded and a
17858	failed request completion. When the request succeeds, the
17859	@a error parameter is @c null, and the given device has been
17860	already added to (when @a attached is @c true) or removed from
17861	(when @a attached is @c false) the collection represented by
17862	<link to="IConsole::USBDevices"/>. On failure, the collection
17863	doesn't change and the @a error parameter represents the error
17864	message describing the failure.
17865	</desc>
17866	<attribute name="device" type="IUSBDevice" readonly="yes">
17867	<desc>
17868	Device that is subject to state change.
17869	</desc>
17870	</attribute>
17871	<attribute name="attached" type="boolean" readonly="yes">
17872	<desc>
17873	@c true if the device was attached and @c false otherwise.
17874	</desc>
17875	</attribute>
17876	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17877	<desc>
17878	@c null on success or an error message object on failure.
17879	</desc>
17880	</attribute>
17881	</interface>
17882
17883	<interface
17884	name="ISharedFolderChangedEvent" extends="IEvent"
17885	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17886	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17887	>
17888	<desc>
17889	Notification when a shared folder is added or removed.
17890	The @a scope argument defines one of three scopes:
17891	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17892	(<link to="Scope_Global">Global</link>),
17893	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17894	the machine (<link to="Scope_Machine">Machine</link>) or <link
17895	to="IConsole::sharedFolders">transient shared folders</link> of the
17896	machine (<link to="Scope_Session">Session</link>). Interested callees
17897	should use query the corresponding collections to find out what has
17898	changed.
17899	</desc>
17900	<attribute name="scope" type="Scope" readonly="yes">
17901	<desc>
17902	Scope of the notification.
17903	</desc>
17904	</attribute>
17905	</interface>
17906
17907	<interface
17908	name="IRuntimeErrorEvent" extends="IEvent"
17909	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17910	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17911	>
17912	<desc>
17913	Notification when an error happens during the virtual
17914	machine execution.
17915
17916	There are three kinds of runtime errors:
17917	<ul>
17918	<li><i>fatal</i></li>
17919	<li><i>non-fatal with retry</i></li>
17920	<li><i>non-fatal warnings</i></li>
17921	</ul>
17922
17923	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17924	to @c true. In case of fatal errors, the virtual machine
17925	execution is always paused before calling this notification, and
17926	the notification handler is supposed either to immediately save
17927	the virtual machine state using <link to="IConsole::saveState"/>
17928	or power it off using <link to="IConsole::powerDown"/>.
17929	Resuming the execution can lead to unpredictable results.
17930
17931	<b>Non-fatal</b> errors and warnings are indicated by the
17932	@a fatal parameter set to @c false. If the virtual machine
17933	is in the Paused state by the time the error notification is
17934	received, it means that the user can <i>try to resume</i> the machine
17935	execution after attempting to solve the problem that caused the
17936	error. In this case, the notification handler is supposed
17937	to show an appropriate message to the user (depending on the
17938	value of the @a id parameter) that offers several actions such
17939	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17940	wants to retry, the notification handler should continue
17941	the machine execution using the <link to="IConsole::resume"/>
17942	call. If the machine execution is not Paused during this
17943	notification, then it means this notification is a <i>warning</i>
17944	(for example, about a fatal condition that can happen very soon);
17945	no immediate action is required from the user, the machine
17946	continues its normal execution.
17947
17948	Note that in either case the notification handler
17949	<b>must not</b> perform any action directly on a thread
17950	where this notification is called. Everything it is allowed to
17951	do is to post a message to another thread that will then talk
17952	to the user and take the corresponding action.
17953
17954	Currently, the following error identifiers are known:
17955	<ul>
17956	<li><tt>"HostMemoryLow"</tt></li>
17957	<li><tt>"HostAudioNotResponding"</tt></li>
17958	<li><tt>"VDIStorageFull"</tt></li>
17959	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17960	</ul>
17961	</desc>
17962	<attribute name="fatal" type="boolean" readonly="yes">
17963	<desc>
17964	Whether the error is fatal or not.
17965	</desc>
17966	</attribute>
17967	<attribute name="id" type="wstring" readonly="yes">
17968	<desc>
17969	Error identifier.
17970	</desc>
17971	</attribute>
17972	<attribute name="message" type="wstring" readonly="yes">
17973	<desc>
17974	Optional error message.
17975	</desc>
17976	</attribute>
17977	</interface>
17978
17979
17980	<interface
17981	name="IEventSourceChangedEvent" extends="IEvent"
17982	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17983	waitable="yes"
17984	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17985	>
17986	<desc>
17987	Notification when an event source state changes (listener added or removed).
17988	</desc>
17989
17990	<attribute name="listener" type="IEventListener" readonly="yes">
17991	<desc>
17992	Event listener which has changed.
17993	</desc>
17994	</attribute>
17995
17996	<attribute name="add" type="boolean" readonly="yes">
17997	<desc>
17998	Flag whether listener was added or removed.
17999	</desc>
18000	</attribute>
18001	</interface>
18002
18003	<interface
18004	name="IExtraDataChangedEvent" extends="IEvent"
18005	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
18006	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
18007	>
18008	<desc>
18009	Notification when machine specific or global extra data
18010	has changed.
18011	</desc>
18012	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
18013	<desc>
18014	ID of the machine this event relates to.
18015	Null for global extra data changes.
18016	</desc>
18017	</attribute>
18018	<attribute name="key" type="wstring" readonly="yes">
18019	<desc>
18020	Extra data key that has changed.
18021	</desc>
18022	</attribute>
18023	<attribute name="value" type="wstring" readonly="yes">
18024	<desc>
18025	Extra data value for the given key.
18026	</desc>
18027	</attribute>
18028	</interface>
18029
18030	<interface
18031	name="IVetoEvent" extends="IEvent"
18032	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
18033	wsmap="managed"
18034	>
18035	<desc>Base abstract interface for veto events.</desc>
18036
18037	<method name="addVeto">
18038	<desc>
18039	Adds a veto on this event.
18040	</desc>
18041	<param name="reason" type="wstring" dir="in">
18042	<desc>
18043	Reason for veto, could be null or empty string.
18044	</desc>
18045	</param>
18046	</method>
18047
18048	<method name="isVetoed">
18049	<desc>
18050	If this event was vetoed.
18051	</desc>
18052	<param name="result" type="boolean" dir="return">
18053	<desc>
18054	Reason for veto.
18055	</desc>
18056	</param>
18057	</method>
18058
18059	<method name="getVetos">
18060	<desc>
18061	Current veto reason list, if size is 0 - no veto.
18062	</desc>
18063	<param name="result" type="wstring" dir="return" safearray="yes">
18064	<desc>
18065	Array of reasons for veto provided by different event handlers.
18066	</desc>
18067	</param>
18068	</method>
18069
18070	</interface>
18071
18072	<interface
18073	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
18074	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
18075	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
18076	waitable="true"
18077	>
18078	<desc>
18079	Notification when someone tries to change extra data for
18080	either the given machine or (if @c null) global extra data.
18081	This gives the chance to veto against changes.
18082	</desc>
18083	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
18084	<desc>
18085	ID of the machine this event relates to.
18086	Null for global extra data changes.
18087	</desc>
18088	</attribute>
18089	<attribute name="key" type="wstring" readonly="yes">
18090	<desc>
18091	Extra data key that has changed.
18092	</desc>
18093	</attribute>
18094	<attribute name="value" type="wstring" readonly="yes">
18095	<desc>
18096	Extra data value for the given key.
18097	</desc>
18098	</attribute>
18099	</interface>
18100
18101	<interface
18102	name="ICanShowWindowEvent" extends="IVetoEvent"
18103	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
18104	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
18105	waitable="true"
18106	>
18107	<desc>
18108	Notification when a call to
18109	<link to="IMachine::canShowConsoleWindow"/> is made by a
18110	front-end to check if a subsequent call to
18111	<link to="IMachine::showConsoleWindow"/> can succeed.
18112
18113	The callee should give an answer appropriate to the current
18114	machine state using event veto. This answer must
18115	remain valid at least until the next
18116	<link to="IConsole::state">machine state</link> change.
18117	</desc>
18118	</interface>
18119
18120	<interface
18121	name="IShowWindowEvent" extends="IEvent"
18122	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
18123	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
18124	waitable="true"
18125	>
18126	<desc>
18127	Notification when a call to
18128	<link to="IMachine::showConsoleWindow"/>
18129	requests the console window to be activated and brought to
18130	foreground on the desktop of the host PC.
18131
18132	This notification should cause the VM console process to
18133	perform the requested action as described above. If it is
18134	impossible to do it at a time of this notification, this
18135	method should return a failure.
18136
18137	Note that many modern window managers on many platforms
18138	implement some sort of focus stealing prevention logic, so
18139	that it may be impossible to activate a window without the
18140	help of the currently active application (which is supposedly
18141	an initiator of this notification). In this case, this method
18142	must return a non-zero identifier that represents the
18143	top-level window of the VM console process. The caller, if it
18144	represents a currently active process, is responsible to use
18145	this identifier (in a platform-dependent manner) to perform
18146	actual window activation.
18147
18148	This method must set @a winId to zero if it has performed all
18149	actions necessary to complete the request and the console
18150	window is now active and in foreground, to indicate that no
18151	further action is required on the caller's side.
18152	</desc>
18153	<attribute name="winId" type="long long">
18154	<desc>
18155	Platform-dependent identifier of the top-level VM console
18156	window, or zero if this method has performed all actions
18157	necessary to implement the <i>show window</i> semantics for
18158	the given platform and/or this VirtualBox front-end.
18159	</desc>
18160	</attribute>
18161	</interface>
18162
18163	<interface
18164	name="INATRedirectEvent" extends="IMachineEvent"
18165	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
18166	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
18167	>
18168	<desc>
18169	Notification when NAT redirect rule added or removed.
18170	</desc>
18171	<attribute name="slot" type="unsigned long" readonly="yes">
18172	<desc>
18173	Adapter which NAT attached to.
18174	</desc>
18175	</attribute>
18176	<attribute name="remove" type="boolean" readonly="yes">
18177	<desc>
18178	Whether rule remove or add.
18179	</desc>
18180	</attribute>
18181	<attribute name="name" type="wstring" readonly="yes">
18182	<desc>
18183	Name of the rule.
18184	</desc>
18185	</attribute>
18186	<attribute name="proto" type="NATProtocol" readonly="yes">
18187	<desc>
18188	Protocol (TCP or UDP) of the redirect rule.
18189	</desc>
18190	</attribute>
18191	<attribute name="hostIp" type="wstring" readonly="yes">
18192	<desc>
18193	Host ip address to bind socket on.
18194	</desc>
18195	</attribute>
18196	<attribute name="hostPort" type="long" readonly="yes">
18197	<desc>
18198	Host port to bind socket on.
18199	</desc>
18200	</attribute>
18201	<attribute name="guestIp" type="wstring" readonly="yes">
18202	<desc>
18203	Guest ip address to redirect to.
18204	</desc>
18205	</attribute>
18206	<attribute name="guestPort" type="long" readonly="yes">
18207	<desc>
18208	Guest port to redirect to.
18209	</desc>
18210	</attribute>
18211	</interface>
18212
18213	<interface
18214	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
18215	waitable="yes"
18216	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
18217	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
18218	>
18219	<desc>
18220	Notification when host PCI device is plugged/unplugged. Plugging
18221	usually takes place on VM startup, unplug - when
18222	<link to="IMachine::detachHostPciDevice"/> is called.
18223
18224	<see><link to="IMachine::detachHostPciDevice"/></see>
18225
18226	</desc>
18227
18228	<attribute name="plugged" type="boolean" readonly="yes">
18229	<desc>
18230	If device successfully plugged or unplugged.
18231	</desc>
18232	</attribute>
18233
18234	<attribute name="success" type="boolean" readonly="yes">
18235	<desc>
18236	If operation was successful, if false - 'message' attribute
18237	may be of interest.
18238	</desc>
18239	</attribute>
18240
18241	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18242	<desc>
18243	Attachment info for this device.
18244	</desc>
18245	</attribute>
18246
18247	<attribute name="message" type="wstring" readonly="yes">
18248	<desc>
18249	Optional error message.
18250	</desc>
18251	</attribute>
18252
18253	</interface>
18254
18255	<interface
18256	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18257	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18258	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18259	>
18260	<desc>
18261	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18262	unexpected circumstances) or available again.
18263	</desc>
18264
18265	<attribute name="available" type="boolean" readonly="yes">
18266	<desc>
18267	Whether VBoxSVC is available now.
18268	</desc>
18269	</attribute>
18270	</interface>
18271
18272	<interface
18273	name="IBandwidthGroupChangedEvent" extends="IEvent"
18274	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18275	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18276	>
18277	<desc>
18278	Notification when one of the bandwidth groups changed
18279	</desc>
18280	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18281	<desc>
18282	The changed bandwidth group.
18283	</desc>
18284	</attribute>
18285	</interface>
18286
18287	<enum
18288	name="GuestMonitorChangedEventType"
18289	uuid="ef172985-7e36-4297-95be-e46396968d66"
18290	>
18291
18292	<desc>
18293	How the guest monitor has been changed.
18294	</desc>
18295
18296	<const name="Enabled" value="0">
18297	<desc>
18298	The guest monitor has been enabled by the guest.
18299	</desc>
18300	</const>
18301
18302	<const name="Disabled" value="1">
18303	<desc>
18304	The guest monitor has been disabled by the guest.
18305	</desc>
18306	</const>
18307
18308	<const name="NewOrigin" value="2">
18309	<desc>
18310	The guest monitor origin has changed in the guest.
18311	</desc>
18312	</const>
18313	</enum>
18314
18315	<interface
18316	name="IGuestMonitorChangedEvent" extends="IEvent"
18317	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18318	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18319	>
18320	<desc>
18321	Notification when the guest enables one of its monitors.
18322	</desc>
18323
18324	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18325	<desc>
18326	What was changed for this guest monitor.
18327	</desc>
18328	</attribute>
18329
18330	<attribute name="screenId" type="unsigned long" readonly="yes">
18331	<desc>
18332	The monitor which was changed.
18333	</desc>
18334	</attribute>
18335
18336	<attribute name="originX" type="unsigned long" readonly="yes">
18337	<desc>
18338	Physical X origin relative to the primary screen.
18339	Valid for Enabled and NewOrigin.
18340	</desc>
18341	</attribute>
18342
18343	<attribute name="originY" type="unsigned long" readonly="yes">
18344	<desc>
18345	Physical Y origin relative to the primary screen.
18346	Valid for Enabled and NewOrigin.
18347	</desc>
18348	</attribute>
18349
18350	<attribute name="width" type="unsigned long" readonly="yes">
18351	<desc>
18352	Width of the screen.
18353	Valid for Enabled.
18354	</desc>
18355	</attribute>
18356
18357	<attribute name="height" type="unsigned long" readonly="yes">
18358	<desc>
18359	Height of the screen.
18360	Valid for Enabled.
18361	</desc>
18362	</attribute>
18363
18364	</interface>
18365
18366	<interface
18367	name="IStorageDeviceChangedEvent" extends="IEvent"
18368	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18369	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18370	>
18371	<desc>
18372	Notification when a
18373	<link to="IMachine::mediumAttachments">storage device</link>
18374	is attached or removed.
18375	</desc>
18376	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18377	<desc>
18378	Storage device that is subject to change.
18379	</desc>
18380	</attribute>
18381	<attribute name="removed" type="boolean" readonly="yes">
18382	<desc>
18383	Flag whether the device was removed or added to the VM.
18384	</desc>
18385	</attribute>
18386	</interface>
18387
18388	<module name="VBoxSVC" context="LocalServer">
18389	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18390	namespace="virtualbox.org">
18391	<interface name="IVirtualBox" default="yes"/>
18392	</class>
18393	</module>
18394
18395	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18396	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18397	namespace="virtualbox.org">
18398	<interface name="IVirtualBoxClient" default="yes"/>
18399	</class>
18400
18401	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18402	namespace="virtualbox.org">
18403	<interface name="ISession" default="yes"/>
18404	</class>
18405	</module>
18406
18407	</library>
18408
18409	</idl>
18410
18411	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format