VirtualBox.xidl@ 36670

Last change on this file since 36670 was 36630, checked in by vboxsync, 14 years ago
PCI: Main and VBoxManage work
Property svn:eol-style set to `native`
File size: 616.7 KB

Line
1	<?xml version="1.0" ?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). Note that when pointers representing input
275	arguments (such as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490
491	<const name="Future" value="99999">
492	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
493	</const>
494	</enum>
495
496	<enum
497	name="AccessMode"
498	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
499	>
500	<desc>
501	Access mode for opening files.
502	</desc>
503
504	<const name="ReadOnly" value="1"/>
505	<const name="ReadWrite" value="2"/>
506	</enum>
507
508	<enum
509	name="MachineState"
510	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
511	>
512	<desc>
513	Virtual machine execution state.
514
515	This enumeration represents possible values of the <link
516	to="IMachine::state"/> attribute.
517
518	Below is the basic virtual machine state diagram. It shows how the state
519	changes during virtual machine execution. The text in square braces shows
520	a method of the IConsole interface that performs the given state
521	transition.
522
523	<pre>
524	+---------[powerDown()] <- Stuck <--[failure]-+
525	V \|
526	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
527	\| \| \| \| V \|
528	\| Aborted -----+ +--> Running --[pause()]--> Paused
529	\| \| ^ \| ^ \|
530	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
531	\| ^ \| \| \| \|
532	\| \| +-----------------------------------------+-\|-------------------+ +
533	\| \| \| \| \|
534	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
535	\| \| \| \|
536	\| +-------- Saving <--------[saveState()]<----------+---------------------+
537	\| \| \|
538	+-------------- Stopping -------[powerDown()]<----------+---------------------+
539	</pre>
540
541	Note that states to the right from PoweredOff, Aborted and Saved in the
542	above diagram are called <i>online VM states</i>. These states
543	represent the virtual machine which is being executed in a dedicated
544	process (usually with a GUI window attached to it where you can see the
545	activity of the virtual machine and interact with it). There are two
546	special pseudo-states, FirstOnline and LastOnline, that can be used in
547	relational expressions to detect if the given machine state is online or
548	not:
549
550	<pre>
551	if (machine.GetState() >= MachineState_FirstOnline &&
552	machine.GetState() <= MachineState_LastOnline)
553	{
554	...the machine is being executed...
555	}
556	</pre>
557
558	When the virtual machine is in one of the online VM states (that is, being
559	executed), only a few machine settings can be modified. Methods working
560	with such settings contain an explicit note about that. An attempt to
561	change any oter setting or perform a modifying operation during this time
562	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
563
564	All online states except Running, Paused and Stuck are transitional: they
565	represent temporary conditions of the virtual machine that will last as
566	long as the operation that initiated such a condition.
567
568	The Stuck state is a special case. It means that execution of the machine
569	has reached the "Guru Meditation" condition. This condition indicates an
570	internal VMM (virtual machine manager) failure which may happen as a
571	result of either an unhandled low-level virtual hardware exception or one
572	of the recompiler exceptions (such as the <i>too-many-traps</i>
573	condition).
574
575	Note also that any online VM state may transit to the Aborted state. This
576	happens if the process that is executing the virtual machine terminates
577	unexpectedly (for example, crashes). Other than that, the Aborted state is
578	equivalent to PoweredOff.
579
580	There are also a few additional state diagrams that do not deal with
581	virtual machine execution and therefore are shown separately. The states
582	shown on these diagrams are called <i>offline VM states</i> (this includes
583	PoweredOff, Aborted and Saved too).
584
585	The first diagram shows what happens when a lengthy setup operation is
586	being executed (such as <link to="IMachine::attachDevice"/>).
587
588	<pre>
589	+----------------------------------(same state as before the call)------+
590	\| \|
591	+-> PoweredOff --+ \|
592	\| \| \|
593	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
594	\| \|
595	+-> Saved -------+
596	</pre>
597
598	The next two diagrams demonstrate the process of taking a snapshot of a
599	powered off virtual machine, restoring the state to that as of a snapshot
600	or deleting a snapshot, respectively.
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| +-->[takeSnapshot()] -------------------> Saving ------+
607	+-> Aborted -----+
608
609	+-> PoweredOff --+
610	\| \|
611	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
612	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
613	+-> Saved -------+ \|
614	\| \|
615	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
616	</pre>
617
618	Note that the Saving state is present in both the offline state group and
619	online state group. Currently, the only way to determine what group is
620	assumed in a particular case is to remember the previous machine state: if
621	it was Running or Paused, then Saving is an online state, otherwise it is
622	an offline state. This inconsistency may be removed in one of the future
623	versions of VirtualBox by adding a new state.
624
625	<note internal="yes">
626	For whoever decides to touch this enum: In order to keep the
627	comparisons involving FirstOnline and LastOnline pseudo-states valid,
628	the numeric values of these states must be correspondingly updated if
629	needed: for any online VM state, the condition
630	<tt>FirstOnline <= state <= LastOnline</tt> must be
631	@c true. The same relates to transient states for which
632	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
633	@c true.
634	</note>
635	</desc>
636
637	<const name="Null" value="0">
638	<desc>Null value (never used by the API).</desc>
639	</const>
640	<const name="PoweredOff" value="1">
641	<desc>
642	The machine is not running and has no saved execution state; it has
643	either never been started or been shut down successfully.
644	</desc>
645	</const>
646	<const name="Saved" value="2">
647	<desc>
648	The machine is not currently running, but the execution state of the machine
649	has been saved to an external file when it was running, from where
650	it can be resumed.
651	</desc>
652	</const>
653	<const name="Teleported" value="3">
654	<desc>
655	The machine was teleported to a different host (or process) and then
656	powered off. Take care when powering it on again may corrupt resources
657	it shares with the teleportation target (e.g. disk and network).
658	</desc>
659	</const>
660	<const name="Aborted" value="4">
661	<desc>
662	The process running the machine has terminated abnormally. This may
663	indicate a crash of the VM process in host execution context, or
664	the VM process has been terminated externally.
665	</desc>
666	</const>
667	<const name="Running" value="5">
668	<desc>
669	The machine is currently being executed.
670	<note internal="yes">
671	For whoever decides to touch this enum: In order to keep the
672	comparisons in the old source code valid, this state must immediately
673	precede the Paused state.
674	TODO: Lift this spectacularly wonderful restriction.
675	</note>
676	</desc>
677	</const>
678	<const name="Paused" value="6">
679	<desc>
680	Execution of the machine has been paused.
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons in the old source code valid, this state must immediately
684	follow the Running state.
685	TODO: Lift this spectacularly wonderful restriction.
686	</note>
687	</desc>
688	</const>
689	<const name="Stuck" value="7">
690	<desc>
691	Execution of the machine has reached the "Guru Meditation"
692	condition. This indicates a severe error in the hypervisor itself.
693	<note internal="yes">
694	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
695	"Guru", perhaps? Or are there some other VMM states that are
696	intended to be lumped in here as well?
697	</note>
698	</desc>
699	</const>
700	<const name="Teleporting" value="8">
701	<desc>
702	The machine is about to be teleported to a different host or process.
703	It is possible to pause a machine in this state, but it will go to the
704	@c TeleportingPausedVM state and it will not be
705	possible to resume it again unless the teleportation fails.
706	</desc>
707	</const>
708	<const name="LiveSnapshotting" value="9">
709	<desc>
710	A live snapshot is being taken. The machine is running normally, but
711	some of the runtime configuration options are inaccessible. Also, if
712	paused while in this state it will transition to
713	@c Saving and it will not be resume the
714	execution until the snapshot operation has completed.
715	</desc>
716	</const>
717	<const name="Starting" value="10">
718	<desc>
719	Machine is being started after powering it on from a
720	zero execution state.
721	</desc>
722	</const>
723	<const name="Stopping" value="11">
724	<desc>
725	Machine is being normally stopped powering it off, or after the guest OS
726	has initiated a shutdown sequence.
727	</desc>
728	</const>
729	<const name="Saving" value="12">
730	<desc>
731	Machine is saving its execution state to a file, or an online
732	snapshot of the machine is being taken.
733	</desc>
734	</const>
735	<const name="Restoring" value="13">
736	<desc>
737	Execution state of the machine is being restored from a file
738	after powering it on from the saved execution state.
739	</desc>
740	</const>
741	<const name="TeleportingPausedVM" value="14">
742	<desc>
743	The machine is being teleported to another host or process, but it is
744	not running. This is the paused variant of the
745	@c state.
746	</desc>
747	</const>
748	<const name="TeleportingIn" value="15">
749	<desc>
750	Teleporting the machine state in from another host or process.
751	</desc>
752	</const>
753	<const name="FaultTolerantSyncing" value="16">
754	<desc>
755	The machine is being synced with a fault tolerant VM running elsewhere.
756	</desc>
757	</const>
758	<const name="DeletingSnapshotOnline" value="17">
759	<desc>
760	Like @c DeletingSnapshot, but the merging of media is ongoing in
761	the background while the machine is running.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotPaused" value="18">
765	<desc>
766	Like @c DeletingSnapshotOnline, but the machine was paused when the
767	merging of differencing media was started.
768	</desc>
769	</const>
770	<const name="RestoringSnapshot" value="19">
771	<desc>
772	A machine snapshot is being restored; this typically does not take long.
773	</desc>
774	</const>
775	<const name="DeletingSnapshot" value="20">
776	<desc>
777	A machine snapshot is being deleted; this can take a long time since this
778	may require merging differencing media. This value indicates that the
779	machine is not running while the snapshot is being deleted.
780	</desc>
781	</const>
782	<const name="SettingUp" value="21">
783	<desc>
784	Lengthy setup operation is in progress.
785	</desc>
786	</const>
787
788	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
789	<desc>
790	Pseudo-state: first online state (for use in relational expressions).
791	</desc>
792	</const>
793	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
794	<desc>
795	Pseudo-state: last online state (for use in relational expressions).
796	</desc>
797	</const>
798
799	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
800	<desc>
801	Pseudo-state: first transient state (for use in relational expressions).
802	</desc>
803	</const>
804	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
805	<desc>
806	Pseudo-state: last transient state (for use in relational expressions).
807	</desc>
808	</const>
809
810	</enum>
811
812	<enum
813	name="SessionState"
814	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
815	>
816	<desc>
817	Session state. This enumeration represents possible values of
818	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
819	attributes.
820	</desc>
821
822	<const name="Null" value="0">
823	<desc>Null value (never used by the API).</desc>
824	</const>
825	<const name="Unlocked" value="1">
826	<desc>
827	In <link to="IMachine::sessionState"/>, this means that the machine
828	is not locked for any sessions.
829
830	In <link to="ISession::state"/>, this means that no machine is
831	currently locked for this session.
832	</desc>
833	</const>
834	<const name="Locked" value="2">
835	<desc>
836	In <link to="IMachine::sessionState"/>, this means that the machine
837	is currently locked for a session, whose process identifier can
838	then be found in the <link to="IMachine::sessionPid" /> attribute.
839
840	In <link to="ISession::state"/>, this means that a machine is
841	currently locked for this session, and the mutable machine object
842	can be found in the <link to="ISession::machine"/> attribute
843	(see <link to="IMachine::lockMachine" /> for details).
844	</desc>
845	</const>
846	<const name="Spawning" value="3">
847	<desc>
848	A new process is being spawned for the machine as a result of
849	<link to="IMachine::launchVMProcess"/> call. This state also occurs
850	as a short transient state during an <link to="IMachine::lockMachine"/>
851	call.
852	</desc>
853	</const>
854	<const name="Unlocking" value="4">
855	<desc>
856	The session is being unlocked.
857	</desc>
858	</const>
859	</enum>
860
861	<enum
862	name="CPUPropertyType"
863	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
864	>
865	<desc>
866	Virtual CPU property type. This enumeration represents possible values of the
867	IMachine get- and setCPUProperty methods.
868	</desc>
869	<const name="Null" value="0">
870	<desc>Null value (never used by the API).</desc>
871	</const>
872	<const name="PAE" value="1">
873	<desc>
874	This setting determines whether VirtualBox will expose the Physical Address
875	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
876	is not available, it will not be reported.
877	</desc>
878	</const>
879	<const name="Synthetic" value="2">
880	<desc>
881	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
882	teleporting between host systems that differ significantly.
883	</desc>
884	</const>
885	</enum>
886
887
888	<enum
889	name="HWVirtExPropertyType"
890	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
891	>
892	<desc>
893	Hardware virtualization property type. This enumeration represents possible values
894	for the <link to="IMachine::getHWVirtExProperty"/> and
895	<link to="IMachine::setHWVirtExProperty"/> methods.
896	</desc>
897	<const name="Null" value="0">
898	<desc>Null value (never used by the API).</desc>
899	</const>
900	<const name="Enabled" value="1">
901	<desc>
902	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
903	such extensions are not available, they will not be used.
904	</desc>
905	</const>
906	<const name="Exclusive" value="2">
907	<desc>
908	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
909	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
910	feature of the host. To share these with other hypervisors, you must disable this property.
911	</desc>
912	</const>
913	<const name="VPID" value="3">
914	<desc>
915	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
916	</desc>
917	</const>
918	<const name="NestedPaging" value="4">
919	<desc>
920	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
921	</desc>
922	</const>
923	<const name="LargePages" value="5">
924	<desc>
925	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
926	</desc>
927	</const>
928	<const name="Force" value="6">
929	<desc>
930	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
931	not set, there will be an automatic fallback to software virtualization.
932	</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="FaultToleranceState"
938	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
939	>
940	<desc>
941	Used with <link to="IMachine::faultToleranceState" />.
942	</desc>
943	<const name="Inactive" value="1">
944	<desc>No fault tolerance enabled.</desc>
945	</const>
946	<const name="Master" value="2">
947	<desc>Fault tolerant master VM.</desc>
948	</const>
949	<const name="Standby" value="3">
950	<desc>Fault tolerant standby VM.</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="LockType"
956	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
957	>
958	<desc>
959	Used with <link to="IMachine::lockMachine" />.
960	</desc>
961	<const name="Write" value="2">
962	<desc>Lock the machine for writing.</desc>
963	</const>
964	<const name="Shared" value="1">
965	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
966	</const>
967	</enum>
968
969	<enum
970	name="SessionType"
971	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
972	>
973	<desc>
974	Session type. This enumeration represents possible values of the
975	<link to="ISession::type"/> attribute.
976	</desc>
977
978	<const name="Null" value="0">
979	<desc>Null value (never used by the API).</desc>
980	</const>
981	<const name="WriteLock" value="1">
982	<desc>
983	Session has acquired an exclusive write lock on a machine
984	using <link to="IMachine::lockMachine"/>.
985	</desc>
986	</const>
987	<const name="Remote" value="2">
988	<desc>
989	Session has launched a VM process using
990	<link to="IMachine::launchVMProcess"/>
991	</desc>
992	</const>
993	<const name="Shared" value="3">
994	<desc>
995	Session has obtained a link to another session using
996	<link to="IMachine::lockMachine"/>
997	</desc>
998	</const>
999	</enum>
1000
1001	<enum
1002	name="DeviceType"
1003	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1004	>
1005	<desc>
1006	Device type.
1007	</desc>
1008	<const name="Null" value="0">
1009	<desc>
1010	Null value, may also mean "no device" (not allowed for
1011	<link to="IConsole::getDeviceActivity"/>).
1012	</desc>
1013	</const>
1014	<const name="Floppy" value="1">
1015	<desc>Floppy device.</desc>
1016	</const>
1017	<const name="DVD" value="2">
1018	<desc>CD/DVD-ROM device.</desc>
1019	</const>
1020	<const name="HardDisk" value="3">
1021	<desc>Hard disk device.</desc>
1022	</const>
1023	<const name="Network" value="4">
1024	<desc>Network device.</desc>
1025	</const>
1026	<const name="USB" value="5">
1027	<desc>USB device.</desc>
1028	</const>
1029	<const name="SharedFolder" value="6">
1030	<desc>Shared folder device.</desc>
1031	</const>
1032	</enum>
1033
1034	<enum
1035	name="DeviceActivity"
1036	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1037	>
1038	<desc>
1039	Device activity for <link to="IConsole::getDeviceActivity"/>.
1040	</desc>
1041
1042	<const name="Null" value="0"/>
1043	<const name="Idle" value="1"/>
1044	<const name="Reading" value="2"/>
1045	<const name="Writing" value="3"/>
1046	</enum>
1047
1048	<enum
1049	name="ClipboardMode"
1050	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1051	>
1052	<desc>
1053	Host-Guest clipboard interchange mode.
1054	</desc>
1055
1056	<const name="Disabled" value="0"/>
1057	<const name="HostToGuest" value="1"/>
1058	<const name="GuestToHost" value="2"/>
1059	<const name="Bidirectional" value="3"/>
1060	</enum>
1061
1062	<enum
1063	name="Scope"
1064	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1065	>
1066	<desc>
1067	Scope of the operation.
1068
1069	A generic enumeration used in various methods to define the action or
1070	argument scope.
1071	</desc>
1072
1073	<const name="Global" value="0"/>
1074	<const name="Machine" value="1"/>
1075	<const name="Session" value="2"/>
1076	</enum>
1077
1078	<enum
1079	name="BIOSBootMenuMode"
1080	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1081	>
1082	<desc>
1083	BIOS boot menu mode.
1084	</desc>
1085
1086	<const name="Disabled" value="0"/>
1087	<const name="MenuOnly" value="1"/>
1088	<const name="MessageAndMenu" value="2"/>
1089	</enum>
1090
1091	<enum
1092	name="ProcessorFeature"
1093	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1094	>
1095	<desc>
1096	CPU features.
1097	</desc>
1098
1099	<const name="HWVirtEx" value="0"/>
1100	<const name="PAE" value="1"/>
1101	<const name="LongMode" value="2"/>
1102	<const name="NestedPaging" value="3"/>
1103	</enum>
1104
1105	<enum
1106	name="FirmwareType"
1107	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1108	>
1109	<desc>
1110	Firmware type.
1111	</desc>
1112	<const name="BIOS" value="1">
1113	<desc>BIOS Firmware.</desc>
1114	</const>
1115	<const name="EFI" value="2">
1116	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1117	</const>
1118	<const name="EFI32" value="3">
1119	<desc>Efi firmware, 32-bit.</desc>
1120	</const>
1121	<const name="EFI64" value="4">
1122	<desc>Efi firmware, 64-bit.</desc>
1123	</const>
1124	<const name="EFIDUAL" value="5">
1125	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1126	</const>
1127	</enum>
1128
1129	<enum
1130	name="PointingHidType"
1131	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1132	>
1133	<desc>
1134	Type of pointing device used in a virtual machine.
1135	</desc>
1136	<const name="None" value="1">
1137	<desc>No mouse.</desc>
1138	</const>
1139	<const name="PS2Mouse" value="2">
1140	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1141	</const>
1142	<const name="USBMouse" value="3">
1143	<desc>USB mouse (relative pointer).</desc>
1144	</const>
1145	<const name="USBTablet" value="4">
1146	<desc>USB tablet (absolute pointer).</desc>
1147	</const>
1148	<const name="ComboMouse" value="5">
1149	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1150	Using of such device can have negative performance implications. </desc>
1151	</const>
1152	</enum>
1153
1154	<enum
1155	name="KeyboardHidType"
1156	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1157	>
1158	<desc>
1159	Type of keyboard device used in a virtual machine.
1160	</desc>
1161	<const name="None" value="1">
1162	<desc>No keyboard.</desc>
1163	</const>
1164	<const name="PS2Keyboard" value="2">
1165	<desc>PS/2 keyboard.</desc>
1166	</const>
1167	<const name="USBKeyboard" value="3">
1168	<desc>USB keyboard.</desc>
1169	</const>
1170	<const name="ComboKeyboard" value="4">
1171	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1172	Using of such device can have negative performance implications. </desc>
1173	</const>
1174	</enum>
1175
1176	<!--
1177	// IVirtualBoxErrorInfo
1178	/////////////////////////////////////////////////////////////////////////
1179	-->
1180
1181	<interface
1182	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1183	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1184	supportsErrorInfo="no"
1185	wsmap="managed"
1186	>
1187	<desc>
1188	The IVirtualBoxErrorInfo interface represents extended error information.
1189
1190	Extended error information can be set by VirtualBox components after
1191	unsuccessful or partially successful method invocation. This information
1192	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1193	and then shown to the client in addition to the plain 32-bit result code.
1194
1195	In MS COM, this interface extends the IErrorInfo interface,
1196	in XPCOM, it extends the nsIException interface. In both cases,
1197	it provides a set of common attributes to retrieve error
1198	information.
1199
1200	Sometimes invocation of some component's method may involve methods of
1201	other components that may also fail (independently of this method's
1202	failure), or a series of non-fatal errors may precede a fatal error that
1203	causes method failure. In cases like that, it may be desirable to preserve
1204	information about all errors happened during method invocation and deliver
1205	it to the caller. The <link to="#next"/> attribute is intended
1206	specifically for this purpose and allows to represent a chain of errors
1207	through a single IVirtualBoxErrorInfo object set after method invocation.
1208
1209	Note that errors are stored to a chain in the reverse order, i.e. the
1210	initial error object you query right after method invocation is the last
1211	error set by the callee, the object it points to in the @a next attribute
1212	is the previous error and so on, up to the first error (which is the last
1213	in the chain).
1214	</desc>
1215
1216	<attribute name="resultCode" type="long" readonly="yes">
1217	<desc>
1218	Result code of the error.
1219	Usually, it will be the same as the result code returned
1220	by the method that provided this error information, but not
1221	always. For example, on Win32, CoCreateInstance() will most
1222	likely return E_NOINTERFACE upon unsuccessful component
1223	instantiation attempt, but not the value the component factory
1224	returned. Value is typed 'long', not 'result',
1225	to make interface usable from scripting languages.
1226	<note>
1227	In MS COM, there is no equivalent.
1228	In XPCOM, it is the same as nsIException::result.
1229	</note>
1230	</desc>
1231	</attribute>
1232
1233	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1234	<desc>
1235	UUID of the interface that defined the error.
1236	<note>
1237	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1238	data type.
1239	In XPCOM, there is no equivalent.
1240	</note>
1241	</desc>
1242	</attribute>
1243
1244	<attribute name="component" type="wstring" readonly="yes">
1245	<desc>
1246	Name of the component that generated the error.
1247	<note>
1248	In MS COM, it is the same as IErrorInfo::GetSource.
1249	In XPCOM, there is no equivalent.
1250	</note>
1251	</desc>
1252	</attribute>
1253
1254	<attribute name="text" type="wstring" readonly="yes">
1255	<desc>
1256	Text description of the error.
1257	<note>
1258	In MS COM, it is the same as IErrorInfo::GetDescription.
1259	In XPCOM, it is the same as nsIException::message.
1260	</note>
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1265	<desc>
1266	Next error object if there is any, or @c null otherwise.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::inner.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	</interface>
1275
1276	<!--
1277	// IVirtualBox
1278	/////////////////////////////////////////////////////////////////////////
1279	-->
1280
1281	<interface
1282	name="IDHCPServer" extends="$unknown"
1283	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1284	wsmap="managed"
1285	>
1286	<desc>
1287	The IDHCPServer interface represents the vbox dhcp server configuration.
1288
1289	To enumerate all the dhcp servers on the host, use the
1290	<link to="IVirtualBox::DHCPServers"/> attribute.
1291	</desc>
1292
1293	<attribute name="enabled" type="boolean">
1294	<desc>
1295	specifies if the dhcp server is enabled
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="IPAddress" type="wstring" readonly="yes">
1300	<desc>
1301	specifies server IP
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="networkMask" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server network mask
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkName" type="wstring" readonly="yes">
1312	<desc>
1313	specifies internal network name the server is used for
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="lowerIP" type="wstring" readonly="yes">
1318	<desc>
1319	specifies from IP address in server address range
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="upperIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies to IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<method name="setConfiguration">
1330	<desc>
1331	configures the server
1332	<result name="E_INVALIDARG">
1333	invalid configuration supplied
1334	</result>
1335	</desc>
1336	<param name="IPAddress" type="wstring" dir="in">
1337	<desc>
1338	server IP address
1339	</desc>
1340	</param>
1341	<param name="networkMask" type="wstring" dir="in">
1342	<desc>
1343	server network mask
1344	</desc>
1345	</param>
1346	<param name="FromIPAddress" type="wstring" dir="in">
1347	<desc>
1348	server From IP address for address range
1349	</desc>
1350	</param>
1351	<param name="ToIPAddress" type="wstring" dir="in">
1352	<desc>
1353	server To IP address for address range
1354	</desc>
1355	</param>
1356	</method>
1357
1358	<method name="start">
1359	<desc>
1360	Starts DHCP server process.
1361	<result name="E_FAIL">
1362	Failed to start the process.
1363	</result>
1364	</desc>
1365	<param name="networkName" type="wstring" dir="in">
1366	<desc>
1367	Name of internal network DHCP server should attach to.
1368	</desc>
1369	</param>
1370	<param name="trunkName" type="wstring" dir="in">
1371	<desc>
1372	Name of internal network trunk.
1373	</desc>
1374	</param>
1375	<param name="trunkType" type="wstring" dir="in">
1376	<desc>
1377	Type of internal network trunk.
1378	</desc>
1379	</param>
1380	</method>
1381
1382	<method name="stop">
1383	<desc>
1384	Stops DHCP server process.
1385	<result name="E_FAIL">
1386	Failed to stop the process.
1387	</result>
1388	</desc>
1389	</method>
1390	</interface>
1391
1392	<interface
1393	name="IVirtualBox" extends="$unknown"
1394	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1395	wsmap="managed"
1396	>
1397	<desc>
1398	The IVirtualBox interface represents the main interface exposed by the
1399	product that provides virtual machine management.
1400
1401	An instance of IVirtualBox is required for the product to do anything
1402	useful. Even though the interface does not expose this, internally,
1403	IVirtualBox is implemented as a singleton and actually lives in the
1404	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1405	IVirtualBox can track the state of all virtual machines on a particular
1406	host, regardless of which frontend started them.
1407
1408	To enumerate all the virtual machines on the host, use the
1409	<link to="IVirtualBox::machines"/> attribute.
1410	</desc>
1411
1412	<attribute name="version" type="wstring" readonly="yes">
1413	<desc>
1414	A string representing the version number of the product. The
1415	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1416	last number represents the build number and will frequently change.
1417	</desc>
1418	</attribute>
1419
1420	<attribute name="revision" type="unsigned long" readonly="yes">
1421	<desc>
1422	The internal build revision number of the product.
1423	</desc>
1424	</attribute>
1425
1426	<attribute name="packageType" type="wstring" readonly="yes">
1427	<desc>
1428	A string representing the package type of this product. The
1429	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1430	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1431	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1432	this.
1433	</desc>
1434	</attribute>
1435
1436	<attribute name="homeFolder" type="wstring" readonly="yes">
1437	<desc>
1438	Full path to the directory where the global settings file,
1439	<tt>VirtualBox.xml</tt>, is stored.
1440
1441	In this version of VirtualBox, the value of this property is
1442	always <tt><user_dir>/.VirtualBox</tt> (where
1443	<tt><user_dir></tt> is the path to the user directory,
1444	as determined by the host OS), and cannot be changed.
1445
1446	This path is also used as the base to resolve relative paths in
1447	places where relative paths are allowed (unless otherwise
1448	expressly indicated).
1449	</desc>
1450	</attribute>
1451
1452	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1453	<desc>
1454	Full name of the global settings file.
1455	The value of this property corresponds to the value of
1456	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1457	</desc>
1458	</attribute>
1459
1460	<attribute name="host" type="IHost" readonly="yes">
1461	<desc>Associated host object.</desc>
1462	</attribute>
1463
1464	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1465	<desc>Associated system information object.</desc>
1466	</attribute>
1467
1468	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1469	<desc>
1470	Array of machine objects registered within this VirtualBox instance.
1471	</desc>
1472	</attribute>
1473
1474	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1475	<desc>
1476	Array of medium objects known to this VirtualBox installation.
1477
1478	This array contains only base media. All differencing
1479	media of the given base medium can be enumerated using
1480	<link to="IMedium::children"/>.
1481	</desc>
1482	</attribute>
1483
1484	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1485	<desc>
1486	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1487	</desc>
1488	</attribute>
1489
1490	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1491	<desc>
1492	Array of floppy image objects currently in use by this VirtualBox instance.
1493	</desc>
1494	</attribute>
1495
1496	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1497
1498	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1499
1500	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1501	<desc>
1502	Collection of global shared folders. Global shared folders are
1503	available to all virtual machines.
1504
1505	New shared folders are added to the collection using
1506	<link to="#createSharedFolder"/>. Existing shared folders can be
1507	removed using <link to="#removeSharedFolder"/>.
1508
1509	<note>
1510	In the current version of the product, global shared folders are not
1511	implemented and therefore this collection is always empty.
1512	</note>
1513	</desc>
1514	</attribute>
1515
1516	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1517	<desc>
1518	Associated performance collector object.
1519	</desc>
1520	</attribute>
1521
1522	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1523	<desc>
1524	DHCP servers.
1525	</desc>
1526	</attribute>
1527
1528	<attribute name="eventSource" type="IEventSource" readonly="yes">
1529	<desc>
1530	Event source for VirtualBox events.
1531	</desc>
1532	</attribute>
1533
1534	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1535	<desc>
1536	The extension pack manager.
1537	</desc>
1538	</attribute>
1539
1540
1541	<method name="composeMachineFilename">
1542	<desc>
1543	Returns a recommended full path of the settings file name for a new virtual
1544	machine.
1545
1546	This API serves two purposes:
1547
1548	<ul>
1549	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1550	for the @a settingsFile argument there, which means that API should use
1551	a recommended default file name.</li>
1552
1553	<li>It can be called manually by a client software before creating a machine,
1554	e.g. if that client wants to pre-create the machine directory to create
1555	virtual hard disks in that directory together with the new machine
1556	settings file. In that case, the file name should be stripped from the
1557	full settings file path returned by this function to obtain the
1558	machine directory.</li>
1559	</ul>
1560
1561	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1562	details about the machine name.
1563
1564	If @a baseFolder is a @c null or empty string (which is recommended), the
1565	default machine settings folder
1566	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1567	a base folder for the created machine, resulting in a file name like
1568	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1569	will be used.
1570
1571	This method does not access the host disks. In particular, it does not check
1572	for whether a machine of this name already exists.
1573	</desc>
1574	<param name="name" type="wstring" dir="in">
1575	<desc>Suggested machine name.</desc>
1576	</param>
1577	<param name="baseFolder" type="wstring" dir="in">
1578	<desc>Base machine folder (optional).</desc>
1579	</param>
1580	<param name="file" type="wstring" dir="return">
1581	<desc>Fully qualified path where the machine would be created.</desc>
1582	</param>
1583	</method>
1584
1585	<method name="createMachine">
1586	<desc>
1587	Creates a new virtual machine by creating a machine settings file at
1588	the given location.
1589
1590	VirtualBox machine settings files use a custom XML dialect. Starting
1591	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1592	and machine files can be created at arbitrary locations.
1593
1594	However, it is is recommended that machines be created in the default
1595	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1596	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1597	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1598	is called automatically to have such a recommended name composed based
1599	on the machine name given in the @a name argument.
1600
1601	If the resulting settings file already exists, this method will fail,
1602	unless @a forceOverwrite is set.
1603
1604	The new machine is created unregistered, with the initial configuration
1605	set according to the specified guest OS type. A typical sequence of
1606	actions to create a new virtual machine is as follows:
1607
1608	<ol>
1609	<li>
1610	Call this method to have a new machine created. The returned machine
1611	object will be "mutable" allowing to change any machine property.
1612	</li>
1613
1614	<li>
1615	Configure the machine using the appropriate attributes and methods.
1616	</li>
1617
1618	<li>
1619	Call <link to="IMachine::saveSettings" /> to write the settings
1620	to the machine's XML settings file. The configuration of the newly
1621	created machine will not be saved to disk until this method is
1622	called.
1623	</li>
1624
1625	<li>
1626	Call <link to="#registerMachine" /> to add the machine to the list
1627	of machines known to VirtualBox.
1628	</li>
1629	</ol>
1630
1631	The specified guest OS type identifier must match an ID of one of known
1632	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1633	array.
1634
1635	Optionally, you may specify an UUID of to assign to the created machine.
1636	However, this is not recommended and you should normally pass an empty
1637	(@c null) UUID to this method so that a new UUID will be automatically
1638	generated for every created machine. You can use UUID
1639	00000000-0000-0000-0000-000000000000 as @c null value.
1640
1641	<note>
1642	There is no way to change the name of the settings file or
1643	subfolder of the created machine directly.
1644	</note>
1645
1646	<result name="VBOX_E_OBJECT_NOT_FOUND">
1647	@a osTypeId is invalid.
1648	</result>
1649	<result name="VBOX_E_FILE_ERROR">
1650	Resulting settings file name is invalid or the settings file already
1651	exists or could not be created due to an I/O error.
1652	</result>
1653	<result name="E_INVALIDARG">
1654	@a name is empty or @c null.
1655	</result>
1656	</desc>
1657
1658	<param name="settingsFile" type="wstring" dir="in">
1659	<desc>Fully qualified path where the settings file should be created,
1660	or NULL for a default folder and file based on the @a name argument
1661	(see <link to="#composeMachineFilename" />).</desc>
1662	</param>
1663	<param name="name" type="wstring" dir="in">
1664	<desc>Machine name.</desc>
1665	</param>
1666	<param name="osTypeId" type="wstring" dir="in">
1667	<desc>Guest OS Type ID.</desc>
1668	</param>
1669	<param name="id" type="uuid" mod="string" dir="in">
1670	<desc>Machine UUID (optional).</desc>
1671	</param>
1672	<param name="forceOverwrite" type="boolean" dir="in">
1673	<desc>If true, an existing machine settings file will be overwritten.</desc>
1674	</param>
1675	<param name="machine" type="IMachine" dir="return">
1676	<desc>Created machine object.</desc>
1677	</param>
1678	</method>
1679
1680	<method name="openMachine">
1681	<desc>
1682	Opens a virtual machine from the existing settings file.
1683	The opened machine remains unregistered until you call
1684	<link to="#registerMachine"/>.
1685
1686	The specified settings file name must be fully qualified.
1687	The file must exist and be a valid machine XML settings file
1688	whose contents will be used to construct the machine object.
1689
1690	<result name="VBOX_E_FILE_ERROR">
1691	Settings file name invalid, not found or sharing violation.
1692	</result>
1693	</desc>
1694	<param name="settingsFile" type="wstring" dir="in">
1695	<desc>
1696	Name of the machine settings file.
1697	</desc>
1698	</param>
1699	<param name="machine" type="IMachine" dir="return">
1700	<desc>Opened machine object.</desc>
1701	</param>
1702	<note>
1703	<link to="IMachine::settingsModified"/> will return
1704	@c false for the created machine, until any of machine settings
1705	are changed.
1706	</note>
1707	</method>
1708
1709	<method name="registerMachine">
1710	<desc>
1711
1712	Registers the machine previously created using
1713	<link to="#createMachine"/> or opened using
1714	<link to="#openMachine"/> within this VirtualBox installation. After
1715	successful method invocation, the
1716	<link to="IMachineRegisteredEvent"/> event is fired.
1717
1718	<note>
1719	This method implicitly calls <link to="IMachine::saveSettings"/>
1720	to save all current machine settings before registering it.
1721	</note>
1722
1723	<result name="VBOX_E_OBJECT_NOT_FOUND">
1724	No matching virtual machine found.
1725	</result>
1726	<result name="VBOX_E_INVALID_OBJECT_STATE">
1727	Virtual machine was not created within this VirtualBox instance.
1728	</result>
1729
1730	</desc>
1731	<param name="machine" type="IMachine" dir="in"/>
1732	</method>
1733
1734	<method name="findMachine">
1735	<desc>
1736	Attempts to find a virtual machine given its name or UUID.
1737
1738	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1739	cannot safely be determined.</note>
1740
1741	<result name="VBOX_E_OBJECT_NOT_FOUND">
1742	Could not find registered machine matching @a nameOrId.
1743	</result>
1744
1745	</desc>
1746	<param name="nameOrId" type="wstring" dir="in">
1747	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1748	</param>
1749	<param name="machine" type="IMachine" dir="return">
1750	<desc>Machine object, if found.</desc>
1751	</param>
1752	</method>
1753
1754	<method name="createAppliance">
1755	<desc>
1756	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1757	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1758	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1759	</desc>
1760	<param name="appliance" type="IAppliance" dir="return">
1761	<desc>New appliance.</desc>
1762	</param>
1763	</method>
1764
1765	<method name="createHardDisk">
1766	<desc>
1767	Creates a new base medium object that will use the given storage
1768	format and location for medium data.
1769
1770	Note that the actual storage unit is not created by this method. In
1771	order to do it, and before you are able to attach the created medium
1772	to virtual machines, you must call one of the following methods to
1773	allocate a format-specific storage unit at the specified location:
1774	<ul>
1775	<li><link to="IMedium::createBaseStorage"/></li>
1776	<li><link to="IMedium::createDiffStorage"/></li>
1777	</ul>
1778
1779	Some medium attributes, such as <link to="IMedium::id"/>, may
1780	remain uninitialized until the medium storage unit is successfully
1781	created by one of the above methods.
1782
1783	After the storage unit is successfully created, it will be
1784	accessible through the <link to="#findMedium"/> method and can
1785	be found in the <link to="#hardDisks"/> array.
1786
1787	The list of all storage formats supported by this VirtualBox
1788	installation can be obtained using
1789	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1790	attribute is empty or @c null then the default storage format
1791	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1792	be used for creating a storage unit of the medium.
1793
1794	Note that the format of the location string is storage format specific.
1795	See <link to="IMedium::location"/> and IMedium for more details.
1796
1797	<result name="VBOX_E_OBJECT_NOT_FOUND">
1798	@a format identifier is invalid. See
1799	<link to="ISystemProperties::mediumFormats"/>.
1800	</result>
1801	<result name="VBOX_E_FILE_ERROR">
1802	@a location is a not valid file name (for file-based formats only).
1803	</result>
1804	</desc>
1805	<param name="format" type="wstring" dir="in">
1806	<desc>
1807	Identifier of the storage format to use for the new medium.
1808	</desc>
1809	</param>
1810	<param name="location" type="wstring" dir="in">
1811	<desc>
1812	Location of the storage unit for the new medium.
1813	</desc>
1814	</param>
1815	<param name="medium" type="IMedium" dir="return">
1816	<desc>Created medium object.</desc>
1817	</param>
1818	</method>
1819
1820	<method name="openMedium">
1821	<desc>
1822	Opens a medium from an existing storage location.
1823
1824	Once a medium has been opened, it can be passed to other VirtualBox
1825	methods, in particular to <link to="IMachine::attachDevice" />.
1826
1827	Depending on the given device type, the file at the storage location
1828	must be in one of the media formats understood by VirtualBox:
1829
1830	<ul>
1831	<li>With a "HardDisk" device type, the file must be a hard disk image
1832	in one of the formats supported by VirtualBox (see
1833	<link to="ISystemProperties::mediumFormats" />).
1834	After this method succeeds, if the medium is a base medium, it
1835	will be added to the <link to="#hardDisks"/> array attribute. </li>
1836	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1837	After this method succeeds, the medium will be added to the
1838	<link to="#DVDImages"/> array attribute.</li>
1839	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1840	After this method succeeds, the medium will be added to the
1841	<link to="#floppyImages"/> array attribute.</li>
1842	</ul>
1843
1844	After having been opened, the medium can be found by the <link to="#findMedium"/>
1845	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1846
1847	The UUID of the newly opened medium will either be retrieved from the
1848	storage location, if the format supports it (e.g. for hard disk images),
1849	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1850	If for some reason you need to change the medium's UUID, use
1851	<link to="IMedium::setIDs" />.
1852
1853	If a differencing hard disk medium is to be opened by this method, the
1854	operation will succeed only if its parent medium and all ancestors,
1855	if any, are already known to this VirtualBox installation (for example,
1856	were opened by this method before).
1857
1858	This method attempts to guess the storage format of the specified medium
1859	by reading medium data at the specified location.
1860
1861	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1862	the image is opened for read/write access and must have according permissions,
1863	as VirtualBox may actually write status information into the disk's metadata
1864	sections.
1865
1866	Note that write access is required for all typical hard disk usage in VirtualBox,
1867	since VirtualBox may need to write metadata such as a UUID into the image.
1868	The only exception is opening a source image temporarily for copying and
1869	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1870	again soon.
1871
1872	The format of the location string is storage format specific. See
1873	<link to="IMedium::location"/> and IMedium for more details.
1874
1875	<result name="VBOX_E_FILE_ERROR">
1876	Invalid medium storage file location or could not find the medium
1877	at the specified location.
1878	</result>
1879	<result name="VBOX_E_IPRT_ERROR">
1880	Could not get medium storage format.
1881	</result>
1882	<result name="E_INVALIDARG">
1883	Invalid medium storage format.
1884	</result>
1885	<result name="VBOX_E_INVALID_OBJECT_STATE">
1886	Medium has already been added to a media registry.
1887	</result>
1888	</desc>
1889	<param name="location" type="wstring" dir="in">
1890	<desc>
1891	Location of the storage unit that contains medium data in one of
1892	the supported storage formats.
1893	</desc>
1894	</param>
1895	<param name="deviceType" type="DeviceType" dir="in">
1896	<desc>
1897	Must be one of "HardDisk", "DVD" or "Floppy".
1898	</desc>
1899	</param>
1900	<param name="accessMode" type="AccessMode" dir="in">
1901	<desc>Whether to open the image in read/write or read-only mode. For
1902	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1903	</param>
1904	<param name="medium" type="IMedium" dir="return">
1905	<desc>Opened medium object.</desc>
1906	</param>
1907	</method>
1908
1909	<method name="findMedium">
1910	<desc>
1911	Returns a medium of the given type that uses the given fully qualified
1912	location or UUID to store medium data.
1913
1914	The given medium must be known to this VirtualBox installation, i.e.
1915	it must be previously created by <link to="#createHardDisk"/> or opened
1916	by <link to="#openMedium"/>.
1917
1918	The search is done by comparing the value of the @a location argument to
1919	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1920	attributes of each known medium.
1921
1922	On case sensitive file systems, a case sensitive comparison is performed,
1923	otherwise the case of symbols in the file path is ignored.
1924
1925	<result name="VBOX_E_OBJECT_NOT_FOUND">
1926	No medium object matching @a location found.
1927	</result>
1928	</desc>
1929	<param name="location" type="wstring" dir="in">
1930	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1931	</param>
1932	<param name="type" type="DeviceType" dir="in">
1933	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1934	</param>
1935	<param name="medium" type="IMedium" dir="return">
1936	<desc>Medium object, if found.</desc>
1937	</param>
1938	</method>
1939
1940	<method name="getGuestOSType">
1941	<desc>
1942	Returns an object describing the specified guest OS type.
1943
1944	The requested guest OS type is specified using a string which is a
1945	mnemonic identifier of the guest operating system, such as
1946	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1947	particular virtual machine can be read or set using the
1948	<link to="IMachine::OSTypeId"/> attribute.
1949
1950	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1951	available guest OS type objects. Each object has an
1952	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1953	the guest OS this object describes.
1954
1955	<result name="E_INVALIDARG">
1956	@a id is not a valid Guest OS type.
1957	</result>
1958
1959	</desc>
1960	<param name="id" type="uuid" mod="string" dir="in">
1961	<desc>Guest OS type ID string.</desc>
1962	</param>
1963	<param name="type" type="IGuestOSType" dir="return">
1964	<desc>Guest OS type object.</desc>
1965	</param>
1966	</method>
1967
1968	<method name="createSharedFolder">
1969	<desc>
1970	Creates a new global shared folder by associating the given logical
1971	name with the given host path, adds it to the collection of shared
1972	folders and starts sharing it. Refer to the description of
1973	<link to="ISharedFolder"/> to read more about logical names.
1974	<note>
1975	In the current implementation, this operation is not
1976	implemented.
1977	</note>
1978	</desc>
1979	<param name="name" type="wstring" dir="in">
1980	<desc>Unique logical name of the shared folder.</desc>
1981	</param>
1982	<param name="hostPath" type="wstring" dir="in">
1983	<desc>Full path to the shared folder in the host file system.</desc>
1984	</param>
1985	<param name="writable" type="boolean" dir="in">
1986	<desc>Whether the share is writable or readonly</desc>
1987	</param>
1988	<param name="automount" type="boolean" dir="in">
1989	<desc>Whether the share gets automatically mounted by the guest
1990	or not.</desc>
1991	</param>
1992	</method>
1993
1994	<method name="removeSharedFolder">
1995	<desc>
1996	Removes the global shared folder with the given name previously
1997	created by <link to="#createSharedFolder"/> from the collection of
1998	shared folders and stops sharing it.
1999	<note>
2000	In the current implementation, this operation is not
2001	implemented.
2002	</note>
2003	</desc>
2004	<param name="name" type="wstring" dir="in">
2005	<desc>Logical name of the shared folder to remove.</desc>
2006	</param>
2007	</method>
2008
2009	<method name="getExtraDataKeys">
2010	<desc>
2011	Returns an array representing the global extra data keys which currently
2012	have values defined.
2013	</desc>
2014	<param name="value" type="wstring" dir="return" safearray="yes">
2015	<desc>Array of extra data keys.</desc>
2016	</param>
2017	</method>
2018
2019	<method name="getExtraData">
2020	<desc>
2021	Returns associated global extra data.
2022
2023	If the requested data @a key does not exist, this function will
2024	succeed and return an empty string in the @a value argument.
2025
2026	<result name="VBOX_E_FILE_ERROR">
2027	Settings file not accessible.
2028	</result>
2029	<result name="VBOX_E_XML_ERROR">
2030	Could not parse the settings file.
2031	</result>
2032
2033	</desc>
2034	<param name="key" type="wstring" dir="in">
2035	<desc>Name of the data key to get.</desc>
2036	</param>
2037	<param name="value" type="wstring" dir="return">
2038	<desc>Value of the requested data key.</desc>
2039	</param>
2040	</method>
2041
2042	<method name="setExtraData">
2043	<desc>
2044	Sets associated global extra data.
2045
2046	If you pass @c null or empty string as a key @a value, the given @a key
2047	will be deleted.
2048
2049	<note>
2050	Before performing the actual data change, this method will ask all
2051	registered event listener using the
2052	<link to="IExtraDataCanChangeEvent"/>
2053	notification for a permission. If one of the listeners refuses the
2054	new value, the change will not be performed.
2055	</note>
2056	<note>
2057	On success, the
2058	<link to="IExtraDataChangedEvent"/> notification
2059	is called to inform all registered listeners about a successful data
2060	change.
2061	</note>
2062
2063	<result name="VBOX_E_FILE_ERROR">
2064	Settings file not accessible.
2065	</result>
2066	<result name="VBOX_E_XML_ERROR">
2067	Could not parse the settings file.
2068	</result>
2069	<result name="E_ACCESSDENIED">
2070	Modification request refused.
2071	</result>
2072
2073	</desc>
2074	<param name="key" type="wstring" dir="in">
2075	<desc>Name of the data key to set.</desc>
2076	</param>
2077	<param name="value" type="wstring" dir="in">
2078	<desc>Value to assign to the key.</desc>
2079	</param>
2080	</method>
2081
2082	<!--method name="createDHCPServerForInterface">
2083	<desc>
2084	Creates a dhcp server settings to be used for the given interface
2085	<result name="E_INVALIDARG">
2086	Host network interface @a name already exists.
2087	</result>
2088	</desc>
2089	<param name="interface" type="IHostNetworkInterface" dir="in">
2090	<desc>Network Interface</desc>
2091	</param>
2092	<param name="server" type="IDHCPServer" dir="out">
2093	<desc>Dhcp server settings</desc>
2094	</param>
2095	</method-->
2096
2097	<method name="createDHCPServer">
2098	<desc>
2099	Creates a dhcp server settings to be used for the given internal network name
2100	<result name="E_INVALIDARG">
2101	Host network interface @a name already exists.
2102	</result>
2103	</desc>
2104	<param name="name" type="wstring" dir="in">
2105	<desc>server name</desc>
2106	</param>
2107	<param name="server" type="IDHCPServer" dir="return">
2108	<desc>Dhcp server settings</desc>
2109	</param>
2110	</method>
2111
2112	<method name="findDHCPServerByNetworkName">
2113	<desc>
2114	Searches a dhcp server settings to be used for the given internal network name
2115	<result name="E_INVALIDARG">
2116	Host network interface @a name already exists.
2117	</result>
2118
2119	</desc>
2120	<param name="name" type="wstring" dir="in">
2121	<desc>server name</desc>
2122	</param>
2123	<param name="server" type="IDHCPServer" dir="return">
2124	<desc>Dhcp server settings</desc>
2125	</param>
2126	</method>
2127
2128	<!--method name="findDHCPServerForInterface">
2129	<desc>
2130	Searches a dhcp server settings to be used for the given interface
2131	<result name="E_INVALIDARG">
2132	Host network interface @a name already exists.
2133	</result>
2134	</desc>
2135	<param name="interface" type="IHostNetworkInterface" dir="in">
2136	<desc>Network Interface</desc>
2137	</param>
2138	<param name="server" type="IDHCPServer" dir="out">
2139	<desc>Dhcp server settings</desc>
2140	</param>
2141	</method-->
2142
2143	<method name="removeDHCPServer">
2144	<desc>
2145	Removes the dhcp server settings
2146	<result name="E_INVALIDARG">
2147	Host network interface @a name already exists.
2148	</result>
2149	</desc>
2150	<param name="server" type="IDHCPServer" dir="in">
2151	<desc>Dhcp server settings to be removed</desc>
2152	</param>
2153	</method>
2154
2155
2156	<method name="checkFirmwarePresent">
2157	<desc>
2158	Check if this VirtualBox installation has a firmware
2159	of the given type available, either system-wide or per-user.
2160	Optionally, this may return a hint where this firmware can be
2161	downloaded from.
2162	</desc>
2163	<param name="firmwareType" type="FirmwareType" dir="in">
2164	<desc>
2165	Type of firmware to check.
2166	</desc>
2167	</param>
2168	<param name="version" type="wstring" dir="in">
2169	<desc>Expected version number, usually empty string (presently ignored).</desc>
2170	</param>
2171
2172	<param name="url" type="wstring" dir="out">
2173	<desc>
2174	Suggested URL to download this firmware from.
2175	</desc>
2176	</param>
2177
2178	<param name="file" type="wstring" dir="out">
2179	<desc>
2180	Filename of firmware, only valid if result == TRUE.
2181	</desc>
2182	</param>
2183
2184	<param name="result" type="boolean" dir="return">
2185	<desc>If firmware of this type and version is available.</desc>
2186	</param>
2187	</method>
2188
2189	</interface>
2190
2191	<!--
2192	// IVFSExplorer
2193	/////////////////////////////////////////////////////////////////////////
2194	-->
2195
2196	<enum
2197	name="VFSType"
2198	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2199	>
2200	<desc>
2201	Virtual file systems supported by VFSExplorer.
2202	</desc>
2203
2204	<const name="File" value="1" />
2205	<const name="Cloud" value="2" />
2206	<const name="S3" value="3" />
2207	<const name="WebDav" value="4" />
2208	</enum>
2209
2210	<enum
2211	name="VFSFileType"
2212	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2213	>
2214	<desc>
2215	File types known by VFSExplorer.
2216	</desc>
2217
2218	<const name="Unknown" value="1" />
2219	<const name="Fifo" value="2" />
2220	<const name="DevChar" value="3" />
2221	<const name="Directory" value="4" />
2222	<const name="DevBlock" value="5" />
2223	<const name="File" value="6" />
2224	<const name="SymLink" value="7" />
2225	<const name="Socket" value="8" />
2226	<const name="WhiteOut" value="9" />
2227	</enum>
2228
2229	<interface
2230	name="IVFSExplorer" extends="$unknown"
2231	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2232	wsmap="managed"
2233	>
2234	<desc>
2235	The VFSExplorer interface unifies access to different file system
2236	types. This includes local file systems as well remote file systems like
2237	S3. For a list of supported types see <link to="VFSType" />.
2238	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2239	</desc>
2240
2241	<attribute name="path" type="wstring" readonly="yes">
2242	<desc>Returns the current path in the virtual file system.</desc>
2243	</attribute>
2244
2245	<attribute name="type" type="VFSType" readonly="yes">
2246	<desc>Returns the file system type which is currently in use.</desc>
2247	</attribute>
2248
2249	<method name="update">
2250	<desc>Updates the internal list of files/directories from the
2251	current directory level. Use <link to="#entryList" /> to get the full list
2252	after a call to this method.</desc>
2253
2254	<param name="aProgress" type="IProgress" dir="return">
2255	<desc>Progress object to track the operation completion.</desc>
2256	</param>
2257	</method>
2258
2259	<method name="cd">
2260	<desc>Change the current directory level.</desc>
2261
2262	<param name="aDir" type="wstring" dir="in">
2263	<desc>The name of the directory to go in.</desc>
2264	</param>
2265
2266	<param name="aProgress" type="IProgress" dir="return">
2267	<desc>Progress object to track the operation completion.</desc>
2268	</param>
2269	</method>
2270
2271	<method name="cdUp">
2272	<desc>Go one directory upwards from the current directory level.</desc>
2273
2274	<param name="aProgress" type="IProgress" dir="return">
2275	<desc>Progress object to track the operation completion.</desc>
2276	</param>
2277	</method>
2278
2279	<method name="entryList">
2280	<desc>Returns a list of files/directories after a call to <link
2281	to="#update" />. The user is responsible for keeping this internal
2282	list up do date.</desc>
2283
2284	<param name="aNames" type="wstring" safearray="yes" dir="out">
2285	<desc>The list of names for the entries.</desc>
2286	</param>
2287
2288	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2289	<desc>The list of types for the entries.</desc>
2290	</param>
2291
2292	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2293	<desc>The list of sizes (in bytes) for the entries.</desc>
2294	</param>
2295
2296	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2297	<desc>The list of file modes (in octal form) for the entries.</desc>
2298	</param>
2299	</method>
2300
2301	<method name="exists">
2302	<desc>Checks if the given file list exists in the current directory
2303	level.</desc>
2304
2305	<param name="aNames" type="wstring" safearray="yes" dir="in">
2306	<desc>The names to check.</desc>
2307	</param>
2308
2309	<param name="aExists" type="wstring" safearray="yes" dir="return">
2310	<desc>The names which exist.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="remove">
2315	<desc>Deletes the given files in the current directory level.</desc>
2316
2317	<param name="aNames" type="wstring" safearray="yes" dir="in">
2318	<desc>The names to remove.</desc>
2319	</param>
2320
2321	<param name="aProgress" type="IProgress" dir="return">
2322	<desc>Progress object to track the operation completion.</desc>
2323	</param>
2324	</method>
2325
2326	</interface>
2327
2328	<!--
2329	// IAppliance
2330	/////////////////////////////////////////////////////////////////////////
2331	-->
2332
2333	<interface
2334	name="IAppliance" extends="$unknown"
2335	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2336	wsmap="managed"
2337	>
2338	<desc>
2339	Represents a platform-independent appliance in OVF format. An instance of this is returned
2340	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2341	virtual machines within an appliance with VirtualBox.
2342
2343	The OVF standard suggests two different physical file formats:
2344
2345	<ol>
2346	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2347	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2348	this descriptor file references other files such as disk images, as OVF appliances typically
2349	do, those additional files must be in the same directory as the descriptor file.</li>
2350
2351	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2352	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2353	files and optionally other files.
2354
2355	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2356	be added with a later version.</li>
2357	</ol>
2358
2359	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2360	<link to="IMachine" /> involves the following sequence of API calls:
2361
2362	<ol>
2363	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2364	</li>
2365
2366	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2367	would like to import. So long as this file is syntactically valid, this will succeed
2368	and fill the appliance object with the parsed data from the OVF file.
2369	</li>
2370
2371	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2372	contents of the IAppliance attributes accordingly. These can be inspected by a
2373	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2374	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2375	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2376	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2377	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2378	The GUI can then give the user the option to confirm and/or change these suggestions.
2379	</li>
2380
2381	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2382	virtual system (machine) to override the suggestions made by the interpret() routine.
2383	</li>
2384
2385	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2386	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2387	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2388	can be found in the <link to="#machines" /> array attribute.
2389	</li>
2390	</ol>
2391
2392	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2393
2394	<ol>
2395	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2396	an empty IAppliance object.
2397	</li>
2398
2399	<li>For each machine you would like to export, call <link to="IMachine::export" />
2400	with the IAppliance object you just created. Each such call creates one instance of
2401	<link to="IVirtualSystemDescription" /> inside the appliance.
2402	</li>
2403
2404	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2405	virtual system (machine) to override the suggestions made by the export() routine.
2406	</li>
2407
2408	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2409	file written.</li>
2410	</ol>
2411
2412	</desc>
2413
2414	<attribute name="path" type="wstring" readonly="yes">
2415	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2416	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2417	<link to="#write" /> (for export).
2418	This attribute is empty until one of these methods has been called.
2419	</desc>
2420	</attribute>
2421
2422	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2423	<desc>
2424	Array of virtual disk definitions. One such description exists for each
2425	disk definition in the OVF; each string array item represents one such piece of
2426	disk information, with the information fields separated by tab (\\t) characters.
2427
2428	The caller should be prepared for additional fields being appended to
2429	this string in future versions of VirtualBox and therefore check for
2430	the number of tabs in the strings returned.
2431
2432	In the current version, the following eight fields are returned per string
2433	in the array:
2434
2435	<ol>
2436	<li>Disk ID (unique string identifier given to disk)</li>
2437
2438	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2439
2440	<li>Populated size (optional unsigned integer indicating the current size of the
2441	disk; can be approximate; -1 if unspecified)</li>
2442
2443	<li>Format (string identifying the disk format, typically
2444	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2445
2446	<li>Reference (where to find the disk image, typically a file name; if empty,
2447	then the disk should be created on import)</li>
2448
2449	<li>Image size (optional unsigned integer indicating the size of the image,
2450	which need not necessarily be the same as the values specified above, since
2451	the image may be compressed or sparse; -1 if not specified)</li>
2452
2453	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2454	presently unsupported and always -1)</li>
2455
2456	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2457	</ol>
2458	</desc>
2459	</attribute>
2460
2461	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2462	<desc> Array of virtual system descriptions. One such description is created
2463	for each virtual system (machine) found in the OVF.
2464	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2465	(for export) has been called.
2466	</desc>
2467	</attribute>
2468
2469	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2470	<desc>
2471	Contains the UUIDs of the machines created from the information in this appliances. This is only
2472	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2473	succeeded.
2474	</desc>
2475	</attribute>
2476
2477	<method name="read">
2478	<desc>
2479	Reads an OVF file into the appliance object.
2480
2481	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2482	mere fact that this method returns successfully does not mean that VirtualBox supports all
2483	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2484	</desc>
2485	<param name="file" type="wstring" dir="in">
2486	<desc>
2487	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2488	on whether the appliance is distributed as a set of files or as a single file, respectively).
2489	</desc>
2490	</param>
2491	<param name="aProgress" type="IProgress" dir="return">
2492	<desc>Progress object to track the operation completion.</desc>
2493	</param>
2494	</method>
2495
2496	<method name="interpret">
2497	<desc>
2498	Interprets the OVF data that was read when the appliance was constructed. After
2499	calling this method, one can inspect the
2500	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2501	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2502	the appliance.
2503
2504	Calling this method is the second step of importing an appliance into VirtualBox;
2505	see <link to="IAppliance" /> for an overview.
2506
2507	After calling this method, one should call <link to="#getWarnings" /> to find out
2508	if problems were encountered during the processing which might later lead to
2509	errors.
2510	</desc>
2511	</method>
2512
2513	<method name="importMachines">
2514	<desc>
2515	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2516	and other interfaces that match the information contained in the appliance as
2517	closely as possible, as represented by the import instructions in the
2518	<link to="#virtualSystemDescriptions" /> array.
2519
2520	Calling this method is the final step of importing an appliance into VirtualBox;
2521	see <link to="IAppliance" /> for an overview.
2522
2523	Since importing the appliance will most probably involve copying and converting
2524	disk images, which can take a long time, this method operates asynchronously and
2525	returns an IProgress object to allow the caller to monitor the progress.
2526
2527	After the import succeeded, the UUIDs of the IMachine instances created can be
2528	retrieved from the <link to="#machines" /> array attribute.
2529	</desc>
2530
2531	<param name="aProgress" type="IProgress" dir="return">
2532	<desc>Progress object to track the operation completion.</desc>
2533	</param>
2534	</method>
2535
2536	<method name="createVFSExplorer">
2537	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2538
2539	<param name="aUri" type="wstring" dir="in">
2540	<desc>The URI describing the file system to use.</desc>
2541	</param>
2542
2543	<param name="aExplorer" type="IVFSExplorer" dir="return">
2544	<desc></desc>
2545	</param>
2546	</method>
2547
2548	<method name="write">
2549	<desc>
2550	Writes the contents of the appliance exports into a new OVF file.
2551
2552	Calling this method is the final step of exporting an appliance from VirtualBox;
2553	see <link to="IAppliance" /> for an overview.
2554
2555	Since exporting the appliance will most probably involve copying and converting
2556	disk images, which can take a long time, this method operates asynchronously and
2557	returns an IProgress object to allow the caller to monitor the progress.
2558	</desc>
2559	<param name="format" type="wstring" dir="in">
2560	<desc>
2561	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2562	future versions of VirtualBox may support additional formats.
2563	</desc>
2564	</param>
2565	<param name="manifest" type="boolean" dir="in">
2566	<desc>
2567	Indicate if the optional manifest file (.mf) should be written. The manifest file
2568	is used for integrity checks prior import.
2569	</desc>
2570	</param>
2571	<param name="path" type="wstring" dir="in">
2572	<desc>
2573	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2574	on whether the appliance is distributed as a set of files or as a single file, respectively).
2575	</desc>
2576	</param>
2577	<param name="progress" type="IProgress" dir="return">
2578	<desc>Progress object to track the operation completion.</desc>
2579	</param>
2580	</method>
2581
2582	<method name="getWarnings">
2583	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2584
2585	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2586	<desc></desc>
2587	</param>
2588	</method>
2589
2590	</interface>
2591
2592	<enum
2593	name="VirtualSystemDescriptionType"
2594	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2595	>
2596	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2597	a configuration value.</desc>
2598
2599	<const name="Ignore" value="1" />
2600	<const name="OS" value="2" />
2601	<const name="Name" value="3" />
2602	<const name="Product" value="4" />
2603	<const name="Vendor" value="5" />
2604	<const name="Version" value="6" />
2605	<const name="ProductUrl" value="7" />
2606	<const name="VendorUrl" value="8" />
2607	<const name="Description" value="9" />
2608	<const name="License" value="10" />
2609	<const name="Miscellaneous" value="11" />
2610	<const name="CPU" value="12" />
2611	<const name="Memory" value="13" />
2612	<const name="HardDiskControllerIDE" value="14" />
2613	<const name="HardDiskControllerSATA" value="15" />
2614	<const name="HardDiskControllerSCSI" value="16" />
2615	<const name="HardDiskControllerSAS" value="17" />
2616	<const name="HardDiskImage" value="18" />
2617	<const name="Floppy" value="19" />
2618	<const name="CDROM" value="20" />
2619	<const name="NetworkAdapter" value="21" />
2620	<const name="USBController" value="22" />
2621	<const name="SoundCard" value="23" />
2622
2623	</enum>
2624
2625	<enum
2626	name="VirtualSystemDescriptionValueType"
2627	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2628	>
2629	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2630	type to fetch.</desc>
2631
2632	<const name="Reference" value="1" />
2633	<const name="Original" value="2" />
2634	<const name="Auto" value="3" />
2635	<const name="ExtraConfig" value="4" />
2636
2637	</enum>
2638
2639	<interface
2640	name="IVirtualSystemDescription" extends="$unknown"
2641	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2642	wsmap="managed"
2643	>
2644
2645	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2646	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2647	<link to="IAppliance::interpret" /> has been called, that array contains information
2648	about how the virtual systems described in the OVF should best be imported into
2649	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2650	import an OVF into VirtualBox.
2651	</desc>
2652
2653	<attribute name="count" type="unsigned long" readonly="yes">
2654	<desc>Return the number of virtual system description entries.</desc>
2655	</attribute>
2656
2657	<method name="getDescription">
2658	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2659	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2660
2661	The list below identifies the value sets that are possible depending on the
2662	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2663	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2664	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2665	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2666	the @a aExtraConfigValues[] array item may also be used.
2667
2668	<ul>
2669	<li>
2670	"OS": the guest operating system type. There must be exactly one such array item on import. The
2671	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2672	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2673	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2674	</li>
2675	<li>
2676	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2677	if none is present on import, then an automatic name will be created from the operating system
2678	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2679	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2680	<link to="IMachine" /> name that does not exist yet.
2681	</li>
2682	<li>
2683	"Description": an arbitrary description.
2684	</li>
2685	<li>
2686	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2687	code to display such a license for agreement; the Main API does not enforce any such policy.
2688	</li>
2689	<li>
2690	Miscellaneous: reserved for future use.
2691	</li>
2692	<li>
2693	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2694	</li>
2695	<li>
2696	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2697	is present on import, then VirtualBox will set a meaningful default based on the operating system
2698	type.
2699	</li>
2700	<li>
2701	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2702	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2703	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2704	writes into the OVF.
2705	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2706	type can use to specify which hard disk controller a virtual disk should be connected to.
2707	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2708	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2709	its virtual machines supports four channels (primary master, primary slave, secondary master,
2710	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2711	</li>
2712	<li>
2713	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2714	has no value in @a aOvfValues[] or @a aVBoxValues[].
2715	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2716	</li>
2717	<li>
2718	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2719	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2720	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2721	whereas VirtualBox considers it a class of storage controllers of its own; see
2722	<link to="StorageControllerType" />).
2723	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2724	</li>
2725	<li>
2726	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2727	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2728
2729	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2730	a path since the image file should be in the same location as the OVF file itself), whereas the
2731	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2732	hard disk image. This means that on import the image will be copied and converted from the
2733	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2734
2735	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2736	format: "controller=<index>;channel=<c>"
2737	In this string, <index> must be an integer specifying the hard disk controller to connect
2738	the image to. That number must be the index of an array item with one of the hard disk controller
2739	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2740	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2741	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2742	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2743	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2744	</li>
2745	<li>
2746	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2747	attachment information as with "HardDiskImage" items.
2748	</li>
2749	<li>
2750	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2751	attachment information as with "HardDiskImage" items.
2752	</li>
2753	<li>
2754	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2755	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2756	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2757	</li>
2758	<li>
2759	"USBController": a USB controller. There can be at most one such item. If and only if such an
2760	item ispresent, USB support will be enabled for the new virtual machine.
2761	</li>
2762	<li>
2763	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2764	present, sound support will be enabled for the new virtual machine. Note that the virtual
2765	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2766	may be different from the virtual soundcard expected by the appliance.
2767	</li>
2768	</ul>
2769
2770	</desc>
2771
2772	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2773	<desc></desc>
2774	</param>
2775
2776	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2777	<desc></desc>
2778	</param>
2779
2780	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2781	<desc></desc>
2782	</param>
2783
2784	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2785	<desc></desc>
2786	</param>
2787
2788	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2789	<desc></desc>
2790	</param>
2791
2792	</method>
2793
2794	<method name="getDescriptionByType">
2795	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2796	should be returned.</desc>
2797
2798	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2799	<desc></desc>
2800	</param>
2801
2802	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2803	<desc></desc>
2804	</param>
2805
2806	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2807	<desc></desc>
2808	</param>
2809
2810	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2811	<desc></desc>
2812	</param>
2813
2814	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2815	<desc></desc>
2816	</param>
2817
2818	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2819	<desc></desc>
2820	</param>
2821
2822	</method>
2823
2824	<method name="getValuesByType">
2825	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2826	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2827	values.</desc>
2828
2829	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2830	<desc></desc>
2831	</param>
2832
2833	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2834	<desc></desc>
2835	</param>
2836
2837	<param name="aValues" type="wstring" dir="return" safearray="yes">
2838	<desc></desc>
2839	</param>
2840
2841	</method>
2842
2843	<method name="setFinalValues">
2844	<desc>
2845	This method allows the appliance's user to change the configuration for the virtual
2846	system descriptions. For each array item returned from <link to="#getDescription" />,
2847	you must pass in one boolean value and one configuration value.
2848
2849	Each item in the boolean array determines whether the particular configuration item
2850	should be enabled.
2851	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2852	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2853	and SoundCard.
2854
2855	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2856	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2857	the configuration remains unchanged. Please see the documentation for getDescription()
2858	for valid configuration values for the individual array item types. If the
2859	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2860	</desc>
2861
2862	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2871	<desc></desc>
2872	</param>
2873	</method>
2874
2875	<method name="addDescription">
2876	<desc>
2877	This method adds an additional description entry to the stack of already
2878	available descriptions for this virtual system. This is handy for writing
2879	values which aren't directly supported by VirtualBox. One example would
2880	be the License type of <link to="VirtualSystemDescriptionType" />.
2881	</desc>
2882
2883	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2884	<desc></desc>
2885	</param>
2886
2887	<param name="aVBoxValue" type="wstring" dir="in">
2888	<desc></desc>
2889	</param>
2890
2891	<param name="aExtraConfigValue" type="wstring" dir="in">
2892	<desc></desc>
2893	</param>
2894	</method>
2895	</interface>
2896
2897
2898	<!--
2899	// IMachine
2900	/////////////////////////////////////////////////////////////////////////
2901	-->
2902
2903	<interface
2904	name="IInternalMachineControl" extends="$unknown"
2905	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2906	internal="yes"
2907	wsmap="suppress"
2908	>
2909	<method name="setRemoveSavedStateFile">
2910	<desc>
2911	Updates the flag whether the saved state file is removed on a
2912	machine state change from Saved to PoweredOff.
2913	</desc>
2914	<param name="aRemove" type="boolean" dir="in"/>
2915	</method>
2916
2917	<method name="updateState">
2918	<desc>
2919	Updates the VM state.
2920	<note>
2921	This operation will also update the settings file with the correct
2922	information about the saved state file and delete this file from disk
2923	when appropriate.
2924	</note>
2925	</desc>
2926	<param name="state" type="MachineState" dir="in"/>
2927	</method>
2928
2929	<method name="getIPCId">
2930	<param name="id" type="wstring" dir="return"/>
2931	</method>
2932
2933	<method name="beginPowerUp">
2934	<desc>
2935	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2936	gives it the progress object that should be part of any pending
2937	<link to="IMachine::launchVMProcess"/> operations. The progress
2938	object may be called back to reflect an early cancelation, so some care
2939	have to be taken with respect to any cancelation callbacks. The console
2940	object will call <link to="IInternalMachineControl::endPowerUp"/>
2941	to signal the completion of the progress object.
2942	</desc>
2943	<param name="aProgress" type="IProgress" dir="in" />
2944	</method>
2945
2946	<method name="endPowerUp">
2947	<desc>
2948	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2949	This method may query status information from the progress object it
2950	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2951	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2952	call in order to complete that progress object.
2953	</desc>
2954	<param name="result" type="long" dir="in"/>
2955	</method>
2956
2957	<method name="beginPoweringDown">
2958	<desc>
2959	Called by the VM process to inform the server it wants to
2960	stop the VM execution and power down.
2961	</desc>
2962	<param name="progress" type="IProgress" dir="out">
2963	<desc>
2964	Progress object created by VBoxSVC to wait until
2965	the VM is powered down.
2966	</desc>
2967	</param>
2968	</method>
2969
2970	<method name="endPoweringDown">
2971	<desc>
2972	Called by the VM process to inform the server that powering
2973	down previously requested by #beginPoweringDown is either
2974	successfully finished or there was a failure.
2975
2976	<result name="VBOX_E_FILE_ERROR">
2977	Settings file not accessible.
2978	</result>
2979	<result name="VBOX_E_XML_ERROR">
2980	Could not parse the settings file.
2981	</result>
2982
2983	</desc>
2984
2985	<param name="result" type="long" dir="in">
2986	<desc>@c S_OK to indicate success.
2987	</desc>
2988	</param>
2989	<param name="errMsg" type="wstring" dir="in">
2990	<desc>@c human readable error message in case of failure.
2991	</desc>
2992	</param>
2993	</method>
2994
2995	<method name="runUSBDeviceFilters">
2996	<desc>
2997	Asks the server to run USB devices filters of the associated
2998	machine against the given USB device and tell if there is
2999	a match.
3000	<note>
3001	Intended to be used only for remote USB devices. Local
3002	ones don't require to call this method (this is done
3003	implicitly by the Host and USBProxyService).
3004	</note>
3005	</desc>
3006	<param name="device" type="IUSBDevice" dir="in"/>
3007	<param name="matched" type="boolean" dir="out"/>
3008	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3009	</method>
3010
3011	<method name="captureUSBDevice">
3012	<desc>
3013	Requests a capture of the given host USB device.
3014	When the request is completed, the VM process will
3015	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3016	notification.
3017	</desc>
3018	<param name="id" type="uuid" mod="string" dir="in"/>
3019	</method>
3020
3021	<method name="detachUSBDevice">
3022	<desc>
3023	Notification that a VM is going to detach (@a done = @c false) or has
3024	already detached (@a done = @c true) the given USB device.
3025	When the @a done = @c true request is completed, the VM process will
3026	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3027	notification.
3028	<note>
3029	In the @a done = @c true case, the server must run its own filters
3030	and filters of all VMs but this one on the detached device
3031	as if it were just attached to the host computer.
3032	</note>
3033	</desc>
3034	<param name="id" type="uuid" mod="string" dir="in"/>
3035	<param name="done" type="boolean" dir="in"/>
3036	</method>
3037
3038	<method name="autoCaptureUSBDevices">
3039	<desc>
3040	Requests a capture all matching USB devices attached to the host.
3041	When the request is completed, the VM process will
3042	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3043	notification per every captured device.
3044	</desc>
3045	</method>
3046
3047	<method name="detachAllUSBDevices">
3048	<desc>
3049	Notification that a VM that is being powered down. The done
3050	parameter indicates whether which stage of the power down
3051	we're at. When @a done = @c false the VM is announcing its
3052	intentions, while when @a done = @c true the VM is reporting
3053	what it has done.
3054	<note>
3055	In the @a done = @c true case, the server must run its own filters
3056	and filters of all VMs but this one on all detach devices as
3057	if they were just attached to the host computer.
3058	</note>
3059	</desc>
3060	<param name="done" type="boolean" dir="in"/>
3061	</method>
3062
3063	<method name="onSessionEnd">
3064	<desc>
3065	Triggered by the given session object when the session is about
3066	to close normally.
3067	</desc>
3068	<param name="session" type="ISession" dir="in">
3069	<desc>Session that is being closed</desc>
3070	</param>
3071	<param name="progress" type="IProgress" dir="return">
3072	<desc>
3073	Used to wait until the corresponding machine is actually
3074	dissociated from the given session on the server.
3075	Returned only when this session is a direct one.
3076	</desc>
3077	</param>
3078	</method>
3079
3080	<method name="beginSavingState">
3081	<desc>
3082	Called by the VM process to inform the server it wants to
3083	save the current state and stop the VM execution.
3084	</desc>
3085	<param name="progress" type="IProgress" dir="out">
3086	<desc>
3087	Progress object created by VBoxSVC to wait until
3088	the state is saved.
3089	</desc>
3090	</param>
3091	<param name="stateFilePath" type="wstring" dir="out">
3092	<desc>
3093	File path the VM process must save the execution state to.
3094	</desc>
3095	</param>
3096	</method>
3097
3098	<method name="endSavingState">
3099	<desc>
3100	Called by the VM process to inform the server that saving
3101	the state previously requested by #beginSavingState is either
3102	successfully finished or there was a failure.
3103
3104	<result name="VBOX_E_FILE_ERROR">
3105	Settings file not accessible.
3106	</result>
3107	<result name="VBOX_E_XML_ERROR">
3108	Could not parse the settings file.
3109	</result>
3110
3111	</desc>
3112
3113	<param name="result" type="long" dir="in">
3114	<desc>@c S_OK to indicate success.
3115	</desc>
3116	</param>
3117	<param name="errMsg" type="wstring" dir="in">
3118	<desc>@c human readable error message in case of failure.
3119	</desc>
3120	</param>
3121	</method>
3122
3123	<method name="adoptSavedState">
3124	<desc>
3125	Gets called by IConsole::adoptSavedState.
3126	<result name="VBOX_E_FILE_ERROR">
3127	Invalid saved state file path.
3128	</result>
3129	</desc>
3130	<param name="savedStateFile" type="wstring" dir="in">
3131	<desc>Path to the saved state file to adopt.</desc>
3132	</param>
3133	</method>
3134
3135	<method name="beginTakingSnapshot">
3136	<desc>
3137	Called from the VM process to request from the server to perform the
3138	server-side actions of creating a snapshot (creating differencing images
3139	and the snapshot object).
3140
3141	<result name="VBOX_E_FILE_ERROR">
3142	Settings file not accessible.
3143	</result>
3144	<result name="VBOX_E_XML_ERROR">
3145	Could not parse the settings file.
3146	</result>
3147	</desc>
3148	<param name="initiator" type="IConsole" dir="in">
3149	<desc>The console object that initiated this call.</desc>
3150	</param>
3151	<param name="name" type="wstring" dir="in">
3152	<desc>Snapshot name.</desc>
3153	</param>
3154	<param name="description" type="wstring" dir="in">
3155	<desc>Snapshot description.</desc>
3156	</param>
3157	<param name="consoleProgress" type="IProgress" dir="in">
3158	<desc>
3159	Progress object created by the VM process tracking the
3160	snapshot's progress. This has the following sub-operations:
3161	<ul>
3162	<li>setting up (weight 1);</li>
3163	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3164	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3165	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3166	<li>finishing up (weight 1)</li>
3167	</ul>
3168	</desc>
3169	</param>
3170	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3171	<desc>
3172	Whether this is an online snapshot (i.e. the machine is running).
3173	</desc>
3174	</param>
3175	<param name="stateFilePath" type="wstring" dir="out">
3176	<desc>
3177	File path the VM process must save the execution state to.
3178	</desc>
3179	</param>
3180	</method>
3181
3182	<method name="endTakingSnapshot">
3183	<desc>
3184	Called by the VM process to inform the server that the snapshot
3185	previously requested by #beginTakingSnapshot is either
3186	successfully taken or there was a failure.
3187	</desc>
3188
3189	<param name="success" type="boolean" dir="in">
3190	<desc>@c true to indicate success and @c false otherwise</desc>
3191	</param>
3192	</method>
3193
3194	<method name="deleteSnapshot">
3195	<desc>
3196	Gets called by IConsole::deleteSnapshot.
3197	<result name="VBOX_E_INVALID_OBJECT_STATE">
3198	Snapshot has more than one child snapshot.
3199	</result>
3200	</desc>
3201	<param name="initiator" type="IConsole" dir="in">
3202	<desc>The console object that initiated this call.</desc>
3203	</param>
3204	<param name="id" type="uuid" mod="string" dir="in">
3205	<desc>UUID of the snapshot to delete.</desc>
3206	</param>
3207	<param name="machineState" type="MachineState" dir="out">
3208	<desc>New machine state after this operation is started.</desc>
3209	</param>
3210	<param name="progress" type="IProgress" dir="return">
3211	<desc>Progress object to track the operation completion.</desc>
3212	</param>
3213	</method>
3214
3215	<method name="finishOnlineMergeMedium">
3216	<desc>
3217	Gets called by IConsole::onlineMergeMedium.
3218	</desc>
3219	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3220	<desc>The medium attachment which needs to be cleaned up.</desc>
3221	</param>
3222	<param name="source" type="IMedium" dir="in">
3223	<desc>Merge source medium.</desc>
3224	</param>
3225	<param name="target" type="IMedium" dir="in">
3226	<desc>Merge target medium.</desc>
3227	</param>
3228	<param name="mergeForward" type="boolean" dir="in">
3229	<desc>Merge direction.</desc>
3230	</param>
3231	<param name="parentForTarget" type="IMedium" dir="in">
3232	<desc>For forward merges: new parent for target medium.</desc>
3233	</param>
3234	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3235	<desc>For backward merges: list of media which need their parent UUID
3236	updated.</desc>
3237	</param>
3238	</method>
3239
3240	<method name="restoreSnapshot">
3241	<desc>
3242	Gets called by IConsole::RestoreSnapshot.
3243	</desc>
3244	<param name="initiator" type="IConsole" dir="in">
3245	<desc>The console object that initiated this call.</desc>
3246	</param>
3247	<param name="snapshot" type="ISnapshot" dir="in">
3248	<desc>The snapshot to restore the VM state from.</desc>
3249	</param>
3250	<param name="machineState" type="MachineState" dir="out">
3251	<desc>New machine state after this operation is started.</desc>
3252	</param>
3253	<param name="progress" type="IProgress" dir="return">
3254	<desc>Progress object to track the operation completion.</desc>
3255	</param>
3256	</method>
3257
3258	<method name="pullGuestProperties">
3259	<desc>
3260	Get the list of the guest properties matching a set of patterns along
3261	with their values, time stamps and flags and give responsibility for
3262	managing properties to the console.
3263	</desc>
3264	<param name="name" type="wstring" dir="out" safearray="yes">
3265	<desc>
3266	The names of the properties returned.
3267	</desc>
3268	</param>
3269	<param name="value" type="wstring" dir="out" safearray="yes">
3270	<desc>
3271	The values of the properties returned. The array entries match the
3272	corresponding entries in the @a name array.
3273	</desc>
3274	</param>
3275	<param name="timestamp" type="long long" dir="out" safearray="yes">
3276	<desc>
3277	The time stamps of the properties returned. The array entries match
3278	the corresponding entries in the @a name array.
3279	</desc>
3280	</param>
3281	<param name="flags" type="wstring" dir="out" safearray="yes">
3282	<desc>
3283	The flags of the properties returned. The array entries match the
3284	corresponding entries in the @a name array.
3285	</desc>
3286	</param>
3287	</method>
3288
3289	<method name="pushGuestProperty">
3290	<desc>
3291	Update a single guest property in IMachine.
3292	</desc>
3293	<param name="name" type="wstring" dir="in">
3294	<desc>
3295	The name of the property to be updated.
3296	</desc>
3297	</param>
3298	<param name="value" type="wstring" dir="in">
3299	<desc>
3300	The value of the property.
3301	</desc>
3302	</param>
3303	<param name="timestamp" type="long long" dir="in">
3304	<desc>
3305	The timestamp of the property.
3306	</desc>
3307	</param>
3308	<param name="flags" type="wstring" dir="in">
3309	<desc>
3310	The flags of the property.
3311	</desc>
3312	</param>
3313	</method>
3314
3315	<method name="lockMedia">
3316	<desc>
3317	Locks all media attached to the machine for writing and parents of
3318	attached differencing media (if any) for reading. This operation is
3319	atomic so that if it fails no media is actually locked.
3320
3321	This method is intended to be called when the machine is in Starting or
3322	Restoring state. The locked media will be automatically unlocked when
3323	the machine is powered off or crashed.
3324	</desc>
3325	</method>
3326	<method name="unlockMedia">
3327	<desc>
3328	Unlocks all media previously locked using
3329	<link to="IInternalMachineControl::lockMedia"/>.
3330
3331	This method is intended to be used with teleportation so that it is
3332	possible to teleport between processes on the same machine.
3333	</desc>
3334	</method>
3335	</interface>
3336
3337	<interface
3338	name="IBIOSSettings" extends="$unknown"
3339	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3340	wsmap="managed"
3341	>
3342	<desc>
3343	The IBIOSSettings interface represents BIOS settings of the virtual
3344	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3345	</desc>
3346	<attribute name="logoFadeIn" type="boolean">
3347	<desc>Fade in flag for BIOS logo animation.</desc>
3348	</attribute>
3349
3350	<attribute name="logoFadeOut" type="boolean">
3351	<desc>Fade out flag for BIOS logo animation.</desc>
3352	</attribute>
3353
3354	<attribute name="logoDisplayTime" type="unsigned long">
3355	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3356	</attribute>
3357
3358	<attribute name="logoImagePath" type="wstring">
3359	<desc>
3360	Local file system path for external BIOS splash image. Empty string
3361	means the default image is shown on boot.
3362	</desc>
3363	</attribute>
3364
3365	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3366	<desc>Mode of the BIOS boot device menu.</desc>
3367	</attribute>
3368
3369	<attribute name="ACPIEnabled" type="boolean">
3370	<desc>ACPI support flag.</desc>
3371	</attribute>
3372
3373	<attribute name="IOAPICEnabled" type="boolean">
3374	<desc>
3375	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3376	and support IRQs above 15.
3377	</desc>
3378	</attribute>
3379
3380	<attribute name="timeOffset" type="long long">
3381	<desc>
3382	Offset in milliseconds from the host system time. This allows for
3383	guests running with a different system date/time than the host.
3384	It is equivalent to setting the system date/time in the BIOS except
3385	it is not an absolute value but a relative one. Guest Additions
3386	time synchronization honors this offset.
3387	</desc>
3388	</attribute>
3389
3390	<attribute name="PXEDebugEnabled" type="boolean">
3391	<desc>
3392	PXE debug logging flag. If set, VirtualBox will write extensive
3393	PXE trace information to the release log.
3394	</desc>
3395	</attribute>
3396
3397	</interface>
3398
3399	<enum
3400	name="CleanupMode"
3401	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3402	>
3403	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3404	</desc>
3405	<const name="UnregisterOnly" value="1">
3406	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3407	</const>
3408	<const name="DetachAllReturnNone" value="2">
3409	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3410	</const>
3411	<const name="DetachAllReturnHardDisksOnly" value="3">
3412	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3413	</const>
3414	<const name="Full" value="4">
3415	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3416	</const>
3417	</enum>
3418
3419	<interface
3420	name="IPciAddress" extends="$unknown"
3421	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3422	wsmap="struct"
3423	>
3424
3425	<desc>
3426	Address on the PCI bus.
3427	</desc>
3428
3429	<attribute name="bus" type="short">
3430	<desc>
3431	Bus number.
3432	</desc>
3433	</attribute>
3434
3435	<attribute name="device" type="short">
3436	<desc>
3437	Device number.
3438	</desc>
3439	</attribute>
3440
3441	<attribute name="devFunction" type="short">
3442	<desc>
3443	Device function number.
3444	</desc>
3445	</attribute>
3446
3447	<method name="asLong">
3448	<desc>
3449	Convert PCI address into long.
3450	</desc>
3451	<param name="result" type="long" dir="return" />
3452	</method>
3453
3454	<method name="fromLong">
3455	<desc>
3456	Make PCI address from long.
3457	</desc>
3458	<param name="number" type="long" dir="in" />
3459	</method>
3460	</interface>
3461
3462	<interface
3463	name="IPciDeviceAttachment" extends="$unknown"
3464	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3465	wsmap="struct"
3466	>
3467
3468	<desc>
3469	Information about PCI attachments.
3470	</desc>
3471
3472	<attribute name="name" type="wstring" readonly="yes">
3473	<desc>
3474	Device name.
3475	</desc>
3476	</attribute>
3477
3478	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3479	<desc>
3480	If this is physical or virtual device.
3481	</desc>
3482	</attribute>
3483
3484	<attribute name="hostAddress" type="long" readonly="yes">
3485	<desc>
3486	Address of device on the host, applicable only to host devices.
3487	</desc>
3488	</attribute>
3489
3490	<attribute name="guestAddress" type="long" readonly="yes">
3491	<desc>
3492	Address of device on the guest.
3493	</desc>
3494	</attribute>
3495
3496	</interface>
3497
3498
3499	<interface
3500	name="IMachine" extends="$unknown"
3501	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3502	wsmap="managed"
3503	>
3504	<desc>
3505	The IMachine interface represents a virtual machine, or guest, created
3506	in VirtualBox.
3507
3508	This interface is used in two contexts. First of all, a collection of
3509	objects implementing this interface is stored in the
3510	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3511	machines that are currently registered with this VirtualBox
3512	installation. Also, once a session has been opened for the given virtual
3513	machine (e.g. the virtual machine is running), the machine object
3514	associated with the open session can be queried from the session object;
3515	see <link to="ISession"/> for details.
3516
3517	The main role of this interface is to expose the settings of the virtual
3518	machine and provide methods to change various aspects of the virtual
3519	machine's configuration. For machine objects stored in the
3520	<link to="IVirtualBox::machines"/> collection, all attributes are
3521	read-only unless explicitly stated otherwise in individual attribute
3522	and method descriptions.
3523
3524	In order to change a machine setting, a session for this machine must be
3525	opened using one of the <link to="IMachine::lockMachine" /> or
3526	<link to="IMachine::launchVMProcess"/> methods. After the
3527	machine has been successfully locked for a session, a mutable machine object
3528	needs to be queried from the session object and then the desired settings
3529	changes can be applied to the returned object using IMachine attributes and
3530	methods. See the <link to="ISession"/> interface description for more
3531	information about sessions.
3532
3533	Note that IMachine does not provide methods to control virtual machine
3534	execution (such as start the machine, or power it down) -- these methods
3535	are grouped in a separate interface called <link to="IConsole" />.
3536
3537	<see>ISession, IConsole</see>
3538	</desc>
3539
3540	<attribute name="parent" type="IVirtualBox" readonly="yes">
3541	<desc>Associated parent object.</desc>
3542	</attribute>
3543
3544	<attribute name="accessible" type="boolean" readonly="yes">
3545	<desc>
3546	Whether this virtual machine is currently accessible or not.
3547
3548	A machine is always deemed accessible unless it is registered <i>and</i>
3549	its settings file cannot be read or parsed (either because the file itself
3550	is unavailable or has invalid XML contents).
3551
3552	Every time this property is read, the accessibility state of
3553	this machine is re-evaluated. If the returned value is @c false,
3554	the <link to="#accessError"/> property may be used to get the
3555	detailed error information describing the reason of
3556	inaccessibility, including XML error messages.
3557
3558	When the machine is inaccessible, only the following properties
3559	can be used on it:
3560	<ul>
3561	<li><link to="#parent"/></li>
3562	<li><link to="#id"/></li>
3563	<li><link to="#settingsFilePath"/></li>
3564	<li><link to="#accessible"/></li>
3565	<li><link to="#accessError"/></li>
3566	</ul>
3567
3568	An attempt to access any other property or method will return
3569	an error.
3570
3571	The only possible action you can perform on an inaccessible
3572	machine is to unregister it using the
3573	<link to="IMachine::unregister"/> call (or, to check
3574	for the accessibility state once more by querying this
3575	property).
3576
3577	<note>
3578	In the current implementation, once this property returns
3579	@c true, the machine will never become inaccessible
3580	later, even if its settings file cannot be successfully
3581	read/written any more (at least, until the VirtualBox
3582	server is restarted). This limitation may be removed in
3583	future releases.
3584	</note>
3585	</desc>
3586	</attribute>
3587
3588	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3589	<desc>
3590	Error information describing the reason of machine
3591	inaccessibility.
3592
3593	Reading this property is only valid after the last call to
3594	<link to="#accessible"/> returned @c false (i.e. the
3595	machine is currently inaccessible). Otherwise, a @c null
3596	IVirtualBoxErrorInfo object will be returned.
3597	</desc>
3598	</attribute>
3599
3600	<attribute name="name" type="wstring">
3601	<desc>
3602	Name of the virtual machine.
3603
3604	Besides being used for human-readable identification purposes
3605	everywhere in VirtualBox, the virtual machine name is also used
3606	as a name of the machine's settings file and as a name of the
3607	subdirectory this settings file resides in. Thus, every time you
3608	change the value of this property, the settings file will be
3609	renamed once you call <link to="#saveSettings"/> to confirm the
3610	change. The containing subdirectory will be also renamed, but
3611	only if it has exactly the same name as the settings file
3612	itself prior to changing this property (for backward compatibility
3613	with previous API releases). The above implies the following
3614	limitations:
3615	<ul>
3616	<li>The machine name cannot be empty.</li>
3617	<li>The machine name can contain only characters that are valid
3618	file name characters according to the rules of the file
3619	system used to store VirtualBox configuration.</li>
3620	<li>You cannot have two or more machines with the same name
3621	if they use the same subdirectory for storing the machine
3622	settings files.</li>
3623	<li>You cannot change the name of the machine if it is running,
3624	or if any file in the directory containing the settings file
3625	is being used by another running machine or by any other
3626	process in the host operating system at a time when
3627	<link to="#saveSettings"/> is called.
3628	</li>
3629	</ul>
3630	If any of the above limitations are hit, <link to="#saveSettings"/>
3631	will return an appropriate error message explaining the exact
3632	reason and the changes you made to this machine will not be saved.
3633
3634	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3635	file is recommended, but not enforced. (Previous versions always
3636	used a generic ".xml" extension.)
3637	</desc>
3638	</attribute>
3639
3640	<attribute name="description" type="wstring">
3641	<desc>
3642	Description of the virtual machine.
3643
3644	The description attribute can contain any text and is
3645	typically used to describe the hardware and software
3646	configuration of the virtual machine in detail (i.e. network
3647	settings, versions of the installed software and so on).
3648	</desc>
3649	</attribute>
3650
3651	<attribute name="id" type="uuid" mod="string" readonly="yes">
3652	<desc>UUID of the virtual machine.</desc>
3653	</attribute>
3654
3655	<attribute name="OSTypeId" type="wstring">
3656	<desc>
3657	User-defined identifier of the Guest OS type.
3658	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3659	an IGuestOSType object representing details about the given
3660	Guest OS type.
3661	<note>
3662	This value may differ from the value returned by
3663	<link to="IGuest::OSTypeId"/> if Guest Additions are
3664	installed to the guest OS.
3665	</note>
3666	</desc>
3667	</attribute>
3668
3669	<attribute name="HardwareVersion" type="wstring">
3670	<desc>Hardware version identifier. Internal use only for now.</desc>
3671	</attribute>
3672
3673	<attribute name="hardwareUUID" type="uuid" mod="string">
3674	<desc>
3675	The UUID presented to the guest via memory tables, hardware and guest
3676	properties. For most VMs this is the same as the @a id, but for VMs
3677	which have been cloned or teleported it may be the same as the source
3678	VM. This latter is because the guest shouldn't notice that it was
3679	cloned or teleported.
3680	</desc>
3681	</attribute>
3682
3683	<attribute name="CPUCount" type="unsigned long">
3684	<desc>Number of virtual CPUs in the VM.</desc>
3685	</attribute>
3686
3687	<attribute name="CPUHotPlugEnabled" type="boolean">
3688	<desc>
3689	This setting determines whether VirtualBox allows CPU
3690	hotplugging for this machine.</desc>
3691	</attribute>
3692
3693	<attribute name="CPUExecutionCap" type="unsigned long">
3694	<desc>
3695	Means to limit the number of CPU cycles a guest can use. The unit
3696	is percentage of host CPU cycles per second. The valid range
3697	is 1 - 100. 100 (the default) implies no limit.
3698	</desc>
3699	</attribute>
3700
3701	<attribute name="memorySize" type="unsigned long">
3702	<desc>System memory size in megabytes.</desc>
3703	</attribute>
3704
3705	<attribute name="memoryBalloonSize" type="unsigned long">
3706	<desc>Memory balloon size in megabytes.</desc>
3707	</attribute>
3708
3709	<attribute name="PageFusionEnabled" type="boolean">
3710	<desc>
3711	This setting determines whether VirtualBox allows page
3712	fusion for this machine (64 bits host only).
3713	</desc>
3714	</attribute>
3715
3716	<attribute name="VRAMSize" type="unsigned long">
3717	<desc>Video memory size in megabytes.</desc>
3718	</attribute>
3719
3720	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3721	<desc>
3722	This setting determines whether VirtualBox allows this machine to make
3723	use of the 3D graphics support available on the host.</desc>
3724	</attribute>
3725
3726	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3727	<desc>
3728	This setting determines whether VirtualBox allows this machine to make
3729	use of the 2D video acceleration support available on the host.</desc>
3730	</attribute>
3731
3732	<attribute name="monitorCount" type="unsigned long">
3733	<desc>
3734	Number of virtual monitors.
3735	<note>
3736	Only effective on Windows XP and later guests with
3737	Guest Additions installed.
3738	</note>
3739	</desc>
3740	</attribute>
3741
3742	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3743	<desc>Object containing all BIOS settings.</desc>
3744	</attribute>
3745
3746	<attribute name="firmwareType" type="FirmwareType">
3747	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3748	bootstrap in this VM.</desc>
3749	</attribute>
3750
3751	<attribute name="pointingHidType" type="PointingHidType">
3752	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3753	The default is typically "PS2Mouse" but can vary depending on the
3754	requirements of the guest operating system.</desc>
3755	</attribute>
3756
3757	<attribute name="keyboardHidType" type="KeyboardHidType">
3758	<desc>Type of keyboard HID used in this VM.
3759	The default is typically "PS2Keyboard" but can vary depending on the
3760	requirements of the guest operating system.</desc>
3761	</attribute>
3762
3763	<attribute name="hpetEnabled" type="boolean">
3764	<desc>This attribute controls if High Precision Event Timer (HPET) is
3765	enabled in this VM. Use this property if you want to provide guests
3766	with additional time source, or if guest requires HPET to function correctly.
3767	Default is false.</desc>
3768	</attribute>
3769
3770	<attribute name="chipsetType" type="ChipsetType">
3771	<desc>Chipset type used in this VM.</desc>
3772	</attribute>
3773
3774	<attribute name="snapshotFolder" type="wstring">
3775	<desc>
3776	Full path to the directory used to store snapshot data
3777	(differencing media and saved state files) of this machine.
3778
3779	The initial value of this property is
3780	<tt><</tt><link to="#settingsFilePath">
3781	path_to_settings_file</link><tt>>/<</tt>
3782	<link to="#id">machine_uuid</link>
3783	<tt>></tt>.
3784
3785	Currently, it is an error to try to change this property on
3786	a machine that has snapshots (because this would require to
3787	move possibly large files to a different location).
3788	A separate method will be available for this purpose later.
3789
3790	<note>
3791	Setting this property to @c null or to an empty string will restore
3792	the initial value.
3793	</note>
3794	<note>
3795	When setting this property, the specified path can be
3796	absolute (full path) or relative to the directory where the
3797	<link to="#settingsFilePath">machine settings file</link>
3798	is located. When reading this property, a full path is
3799	always returned.
3800	</note>
3801	<note>
3802	The specified path may not exist, it will be created
3803	when necessary.
3804	</note>
3805	</desc>
3806	</attribute>
3807
3808	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3809	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3810	</attribute>
3811
3812	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3813	<desc>Array of media attached to this machine.</desc>
3814	</attribute>
3815
3816	<attribute name="USBController" type="IUSBController" readonly="yes">
3817	<desc>
3818	Associated USB controller object.
3819
3820	<note>
3821	If USB functionality is not available in the given edition of
3822	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3823	</note>
3824	</desc>
3825	</attribute>
3826
3827	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3828	<desc>Associated audio adapter, always present.</desc>
3829	</attribute>
3830
3831	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3832	<desc>Array of storage controllers attached to this machine.</desc>
3833	</attribute>
3834
3835	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3836	<desc>
3837	Full name of the file containing machine settings data.
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="settingsModified" type="boolean" readonly="yes">
3842	<desc>
3843	Whether the settings of this machine have been modified
3844	(but neither yet saved nor discarded).
3845	<note>
3846	Reading this property is only valid on instances returned
3847	by <link to="ISession::machine"/> and on new machines
3848	created by <link to="IVirtualBox::createMachine"/> or opened
3849	by <link to="IVirtualBox::openMachine"/> but not
3850	yet registered, or on unregistered machines after calling
3851	<link to="IMachine::unregister"/>. For all other
3852	cases, the settings can never be modified.
3853	</note>
3854	<note>
3855	For newly created unregistered machines, the value of this
3856	property is always @c true until <link to="#saveSettings"/>
3857	is called (no matter if any machine settings have been
3858	changed after the creation or not). For opened machines
3859	the value is set to @c false (and then follows to normal rules).
3860	</note>
3861	</desc>
3862	</attribute>
3863
3864	<attribute name="sessionState" type="SessionState" readonly="yes">
3865	<desc>Current session state for this machine.</desc>
3866	</attribute>
3867
3868	<attribute name="sessionType" type="wstring" readonly="yes">
3869	<desc>
3870	Type of the session. If <link to="#sessionState"/> is
3871	Spawning or Locked, this attribute contains the
3872	same value as passed to the
3873	<link to="IMachine::launchVMProcess"/> method in the
3874	@a type parameter. If the session was used with
3875	<link to="IMachine::lockMachine" />, or if
3876	<link to="#sessionState"/> is SessionClosed, the value of this
3877	attribute is an empty string.
3878	</desc>
3879	</attribute>
3880
3881	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3882	<desc>
3883	Identifier of the session process. This attribute contains the
3884	platform-dependent identifier of the process whose session was
3885	used with <link to="IMachine::lockMachine" /> call. The returned
3886	value is only valid if <link to="#sessionState"/> is Locked or
3887	Unlocking by the time this property is read.
3888	</desc>
3889	</attribute>
3890
3891	<attribute name="state" type="MachineState" readonly="yes">
3892	<desc>Current execution state of this machine.</desc>
3893	</attribute>
3894
3895	<attribute name="lastStateChange" type="long long" readonly="yes">
3896	<desc>
3897	Time stamp of the last execution state change,
3898	in milliseconds since 1970-01-01 UTC.
3899	</desc>
3900	</attribute>
3901
3902	<attribute name="stateFilePath" type="wstring" readonly="yes">
3903	<desc>
3904	Full path to the file that stores the execution state of
3905	the machine when it is in the <link to="MachineState_Saved"/> state.
3906	<note>
3907	When the machine is not in the Saved state, this attribute is
3908	an empty string.
3909	</note>
3910	</desc>
3911	</attribute>
3912
3913	<attribute name="logFolder" type="wstring" readonly="yes">
3914	<desc>
3915	Full path to the folder that stores a set of rotated log files
3916	recorded during machine execution. The most recent log file is
3917	named <tt>VBox.log</tt>, the previous log file is
3918	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3919	in the current version).
3920	</desc>
3921	</attribute>
3922
3923	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3924	<desc>
3925	Current snapshot of this machine. This is @c null if the machine
3926	currently has no snapshots. If it is not @c null, then it was
3927	set by one of <link to="IConsole::takeSnapshot" />,
3928	<link to="IConsole::deleteSnapshot" />
3929	or <link to="IConsole::restoreSnapshot" />, depending on which
3930	was called last. See <link to="ISnapshot"/> for details.
3931	</desc>
3932	</attribute>
3933
3934	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3935	<desc>
3936	Number of snapshots taken on this machine. Zero means the
3937	machine doesn't have any snapshots.
3938	</desc>
3939	</attribute>
3940
3941	<attribute name="currentStateModified" type="boolean" readonly="yes">
3942	<desc>
3943	Returns @c true if the current state of the machine is not
3944	identical to the state stored in the current snapshot.
3945
3946	The current state is identical to the current snapshot only
3947	directly after one of the following calls are made:
3948
3949	<ul>
3950	<li><link to="IConsole::restoreSnapshot"/>
3951	</li>
3952	<li><link to="IConsole::takeSnapshot"/> (issued on a
3953	"powered off" or "saved" machine, for which
3954	<link to="#settingsModified"/> returns @c false)
3955	</li>
3956	</ul>
3957
3958	The current state remains identical until one of the following
3959	happens:
3960	<ul>
3961	<li>settings of the machine are changed</li>
3962	<li>the saved state is deleted</li>
3963	<li>the current snapshot is deleted</li>
3964	<li>an attempt to execute the machine is made</li>
3965	</ul>
3966
3967	<note>
3968	For machines that don't have snapshots, this property is
3969	always @c false.
3970	</note>
3971	</desc>
3972	</attribute>
3973
3974	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3975	<desc>
3976	Collection of shared folders for this machine (permanent shared
3977	folders). These folders are shared automatically at machine startup
3978	and available only to the guest OS installed within this machine.
3979
3980	New shared folders are added to the collection using
3981	<link to="#createSharedFolder"/>. Existing shared folders can be
3982	removed using <link to="#removeSharedFolder"/>.
3983	</desc>
3984	</attribute>
3985
3986	<attribute name="clipboardMode" type="ClipboardMode">
3987	<desc>
3988	Synchronization mode between the host OS clipboard
3989	and the guest OS clipboard.
3990	</desc>
3991	</attribute>
3992
3993	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3994	<desc>
3995	A comma-separated list of simple glob patterns. Changes to guest
3996	properties whose name matches one of the patterns will generate an
3997	<link to="IGuestPropertyChangedEvent"/> signal.
3998	</desc>
3999	</attribute>
4000
4001	<attribute name="teleporterEnabled" type="boolean">
4002	<desc>
4003	When set to @a true, the virtual machine becomes a target teleporter
4004	the next time it is powered on. This can only set to @a true when the
4005	VM is in the @a PoweredOff or @a Aborted state.
4006
4007	<!-- This property is automatically set to @a false when the VM is powered
4008	on. (bird: This doesn't work yet ) -->
4009	</desc>
4010	</attribute>
4011
4012	<attribute name="teleporterPort" type="unsigned long">
4013	<desc>
4014	The TCP port the target teleporter will listen for incoming
4015	teleportations on.
4016
4017	0 means the port is automatically selected upon power on. The actual
4018	value can be read from this property while the machine is waiting for
4019	incoming teleportations.
4020	</desc>
4021	</attribute>
4022
4023	<attribute name="teleporterAddress" type="wstring">
4024	<desc>
4025	The address the target teleporter will listen on. If set to an empty
4026	string, it will listen on all addresses.
4027	</desc>
4028	</attribute>
4029
4030	<attribute name="teleporterPassword" type="wstring">
4031	<desc>
4032	The password to check for on the target teleporter. This is just a
4033	very basic measure to prevent simple hacks and operators accidentally
4034	beaming a virtual machine to the wrong place.
4035	</desc>
4036	</attribute>
4037
4038	<attribute name="faultToleranceState" type="FaultToleranceState">
4039	<desc>
4040	Fault tolerance state; disabled, source or target.
4041	This property can be changed at any time. If you change it for a running
4042	VM, then the fault tolerance address and port must be set beforehand.
4043	</desc>
4044	</attribute>
4045
4046	<attribute name="faultTolerancePort" type="unsigned long">
4047	<desc>
4048	The TCP port the fault tolerance source or target will use for
4049	communication.
4050	</desc>
4051	</attribute>
4052
4053	<attribute name="faultToleranceAddress" type="wstring">
4054	<desc>
4055	The address the fault tolerance source or target.
4056	</desc>
4057	</attribute>
4058
4059	<attribute name="faultTolerancePassword" type="wstring">
4060	<desc>
4061	The password to check for on the standby VM. This is just a
4062	very basic measure to prevent simple hacks and operators accidentally
4063	choosing the wrong standby VM.
4064	</desc>
4065	</attribute>
4066
4067	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4068	<desc>
4069	The interval in ms used for syncing the state between source and target.
4070	</desc>
4071	</attribute>
4072
4073	<attribute name="RTCUseUTC" type="boolean">
4074	<desc>
4075	When set to @a true, the RTC device of the virtual machine will run
4076	in UTC time, otherwise in local time. Especially Unix guests prefer
4077	the time in UTC.
4078	</desc>
4079	</attribute>
4080
4081	<attribute name="ioCacheEnabled" type="boolean">
4082	<desc>
4083	When set to @a true, the builtin I/O cache of the virtual machine
4084	will be enabled.
4085	</desc>
4086	</attribute>
4087
4088	<attribute name="ioCacheSize" type="unsigned long">
4089	<desc>
4090	Maximum size of the I/O cache in MB.
4091	</desc>
4092	</attribute>
4093
4094	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4095	<desc>
4096	Bandwidth control manager.
4097	</desc>
4098	</attribute>
4099
4100	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4101	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4102	attached to the machine use IConsole::attachedPciDevices attribute, as
4103	this attribute is intended to list only devices additional to what
4104	described in virtual hardware config. Usually, this list keeps host's
4105	physical devices assigned to the particular machine.
4106	</desc>
4107	</attribute>
4108
4109	<method name="lockMachine">
4110	<desc>
4111	Locks the machine for the given session to enable the caller
4112	to make changes to the machine or start the VM or control
4113	VM execution.
4114
4115	There are two ways to lock a machine for such uses:
4116
4117	<ul>
4118	<li>If you want to make changes to the machine settings,
4119	you must obtain an exclusive write lock on the machine
4120	by setting @a lockType to @c Write.
4121
4122	This will only succeed if no other process has locked
4123	the machine to prevent conflicting changes. Only after
4124	an exclusive write lock has been obtained using this method, one
4125	can change all VM settings or execute the VM in the process
4126	space of the session object. (Note that the latter is only of
4127	interest if you actually want to write a new front-end for
4128	virtual machines; but this API gets called internally by
4129	the existing front-ends such as VBoxHeadless and the VirtualBox
4130	GUI to acquire a write lock on the machine that they are running.)
4131
4132	On success, write-locking the machine for a session creates
4133	a second copy of the IMachine object. It is this second object
4134	upon which changes can be made; in VirtualBox terminology, the
4135	second copy is "mutable". It is only this second, mutable machine
4136	object upon which you can call methods that change the
4137	machine state. After having called this method, you can
4138	obtain this second, mutable machine object using the
4139	<link to="ISession::machine" /> attribute.
4140	</li>
4141	<li>If you only want to check the machine state or control
4142	machine execution without actually changing machine
4143	settings (e.g. to get access to VM statistics or take
4144	a snapshot or save the machine state), then set the
4145	@a lockType argument to @c Shared.
4146
4147	If no other session has obtained a lock, you will obtain an
4148	exclusive write lock as described above. However, if another
4149	session has already obtained such a lock, then a link to that
4150	existing session will be established which allows you
4151	to control that existing session.
4152
4153	To find out which type of lock was obtained, you can
4154	inspect <link to="ISession::type" />, which will have been
4155	set to either @c WriteLock or @c Shared.
4156	</li>
4157	</ul>
4158
4159	In either case, you can get access to the <link to="IConsole" />
4160	object which controls VM execution.
4161
4162	Also in all of the above cases, one must always call
4163	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4164	the machine's state will eventually be set to "Aborted".
4165
4166	To change settings on a machine, the following sequence is typically
4167	performed:
4168
4169	<ol>
4170	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4171
4172	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4173
4174	<li>Change the settings of the machine by invoking IMachine methods.</li>
4175
4176	<li>Call <link to="IMachine::saveSettings" />.</li>
4177
4178	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4179	</ol>
4180
4181	<result name="E_UNEXPECTED">
4182	Virtual machine not registered.
4183	</result>
4184	<result name="E_ACCESSDENIED">
4185	Process not started by OpenRemoteSession.
4186	</result>
4187	<result name="VBOX_E_INVALID_OBJECT_STATE">
4188	Session already open or being opened.
4189	</result>
4190	<result name="VBOX_E_VM_ERROR">
4191	Failed to assign machine to session.
4192	</result>
4193	</desc>
4194	<param name="session" type="ISession" dir="in">
4195	<desc>
4196	Session object for which the machine will be locked.
4197	</desc>
4198	</param>
4199	<param name="lockType" type="LockType" dir="in">
4200	<desc>
4201	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4202	If set to @c Shared, then either acquire an exclusive write lock or establish
4203	a link to an existing session.
4204	</desc>
4205	</param>
4206	</method>
4207
4208	<method name="launchVMProcess">
4209	<desc>
4210	Spawns a new process that will execute the virtual machine and obtains a shared
4211	lock on the machine for the calling session.
4212
4213	If launching the VM succeeds, the new VM process will create its own session
4214	and write-lock the machine for it, preventing conflicting changes from other
4215	processes. If the machine is already locked (because it is already running or
4216	because another session has a write lock), launching the VM process will therefore
4217	fail. Reversely, future attempts to obtain a write lock will also fail while the
4218	machine is running.
4219
4220	The caller's session object remains separate from the session opened by the new
4221	VM process. It receives its own <link to="IConsole" /> object which can be used
4222	to control machine execution, but it cannot be used to change all VM settings
4223	which would be available after a <link to="#lockMachine" /> call.
4224
4225	The caller must eventually release the session's shared lock by calling
4226	<link to="ISession::unlockMachine" /> on the local session object once this call
4227	has returned. However, the session's state (see <link to="ISession::state" />)
4228	will not return to "Unlocked" until the remote session has also unlocked
4229	the machine (i.e. the machine has stopped running).
4230
4231	Launching a VM process can take some time (a new VM is started in a new process,
4232	for which memory and other resources need to be set up). Because of this,
4233	an <link to="IProgress" /> object is returned to allow the caller to wait
4234	for this asynchronous operation to be completed. Until then, the caller's
4235	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4236	and <link to="ISession::console" /> attributes cannot be accessed.
4237	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4238	similar calls to wait for completion. Completion is signalled when the VM
4239	is powered on. If launching the VM fails, error messages can be queried
4240	via the progress object, if available.
4241
4242	The progress object will have at least 2 sub-operations. The first
4243	operation covers the period up to the new VM process calls powerUp.
4244	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4245	progress object. Because <link to="IConsole::powerUp"/> may require
4246	some extra sub-operations, the <link to="IProgress::operationCount"/>
4247	may change at the completion of operation.
4248
4249	For details on the teleportation progress operation, see
4250	<link to="IConsole::powerUp"/>.
4251
4252	The @a environment argument is a string containing definitions of
4253	environment variables in the following format:
4254	@code
4255	NAME[=VALUE]\n
4256	NAME[=VALUE]\n
4257	...
4258	@endcode
4259	where <tt>\\n</tt> is the new line character. These environment
4260	variables will be appended to the environment of the VirtualBox server
4261	process. If an environment variable exists both in the server process
4262	and in this list, the value from this list takes precedence over the
4263	server's variable. If the value of the environment variable is
4264	omitted, this variable will be removed from the resulting environment.
4265	If the environment string is @c null or empty, the server environment
4266	is inherited by the started process as is.
4267
4268	<result name="E_UNEXPECTED">
4269	Virtual machine not registered.
4270	</result>
4271	<result name="E_INVALIDARG">
4272	Invalid session type @a type.
4273	</result>
4274	<result name="VBOX_E_OBJECT_NOT_FOUND">
4275	No machine matching @a machineId found.
4276	</result>
4277	<result name="VBOX_E_INVALID_OBJECT_STATE">
4278	Session already open or being opened.
4279	</result>
4280	<result name="VBOX_E_IPRT_ERROR">
4281	Launching process for machine failed.
4282	</result>
4283	<result name="VBOX_E_VM_ERROR">
4284	Failed to assign machine to session.
4285	</result>
4286	</desc>
4287	<param name="session" type="ISession" dir="in">
4288	<desc>
4289	Client session object to which the VM process will be connected (this
4290	must be in "Unlocked" state).
4291	</desc>
4292	</param>
4293	<param name="type" type="wstring" dir="in">
4294	<desc>
4295	Front-end to use for the new VM process. The following are currently supported:
4296	<ul>
4297	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4298	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4299	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4300	</ul>
4301	</desc>
4302	</param>
4303	<param name="environment" type="wstring" dir="in">
4304	<desc>
4305	Environment to pass to the VM process.
4306	</desc>
4307	</param>
4308	<param name="progress" type="IProgress" dir="return">
4309	<desc>Progress object to track the operation completion.</desc>
4310	</param>
4311	</method>
4312
4313	<method name="setBootOrder">
4314	<desc>
4315	Puts the given device to the specified position in
4316	the boot order.
4317
4318	To indicate that no device is associated with the given position,
4319	<link to="DeviceType_Null"/> should be used.
4320
4321	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4322
4323	<result name="E_INVALIDARG">
4324	Boot @a position out of range.
4325	</result>
4326	<result name="E_NOTIMPL">
4327	Booting from USB @a device currently not supported.
4328	</result>
4329
4330	</desc>
4331	<param name="position" type="unsigned long" dir="in">
4332	<desc>
4333	Position in the boot order (@c 1 to the total number of
4334	devices the machine can boot from, as returned by
4335	<link to="ISystemProperties::maxBootPosition"/>).
4336	</desc>
4337	</param>
4338	<param name="device" type="DeviceType" dir="in">
4339	<desc>
4340	The type of the device used to boot at the given position.
4341	</desc>
4342	</param>
4343	</method>
4344
4345	<method name="getBootOrder" const="yes">
4346	<desc>
4347	Returns the device type that occupies the specified
4348	position in the boot order.
4349
4350	@todo [remove?]
4351	If the machine can have more than one device of the returned type
4352	(such as hard disks), then a separate method should be used to
4353	retrieve the individual device that occupies the given position.
4354
4355	If here are no devices at the given position, then
4356	<link to="DeviceType_Null"/> is returned.
4357
4358	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4359
4360	<result name="E_INVALIDARG">
4361	Boot @a position out of range.
4362	</result>
4363
4364	</desc>
4365	<param name="position" type="unsigned long" dir="in">
4366	<desc>
4367	Position in the boot order (@c 1 to the total number of
4368	devices the machine can boot from, as returned by
4369	<link to="ISystemProperties::maxBootPosition"/>).
4370	</desc>
4371	</param>
4372	<param name="device" type="DeviceType" dir="return">
4373	<desc>
4374	Device at the given position.
4375	</desc>
4376	</param>
4377	</method>
4378
4379	<method name="attachDevice">
4380	<desc>
4381	Attaches a device and optionally mounts a medium to the given storage
4382	controller (<link to="IStorageController" />, identified by @a name),
4383	at the indicated port and device.
4384
4385	This method is intended for managing storage devices in general while a
4386	machine is powered off. It can be used to attach and detach fixed
4387	and removable media. The following kind of media can be attached
4388	to a machine:
4389
4390	<ul>
4391	<li>For fixed and removable media, you can pass in a medium that was
4392	previously opened using <link to="IVirtualBox::openMedium" />.
4393	</li>
4394
4395	<li>Only for storage devices supporting removable media (such as
4396	DVDs and floppies), you can also specify a null pointer to
4397	indicate an empty drive or one of the medium objects listed
4398	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4399	arrays to indicate a host drive.
4400	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4401	to change the media while the machine is running.
4402	</li>
4403	</ul>
4404
4405	In a VM's default configuration of virtual machines, the secondary
4406	master of the IDE controller is used for a CD/DVD drive.
4407
4408	After calling this returns successfully, a new instance of
4409	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4410	attachments (see <link to="IMachine::mediumAttachments"/>).
4411
4412	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4413	information about attaching media.
4414
4415	The specified device slot must not have a device attached to it,
4416	or this method will fail.
4417
4418	<note>
4419	You cannot attach a device to a newly created machine until
4420	this machine's settings are saved to disk using
4421	<link to="#saveSettings"/>.
4422	</note>
4423	<note>
4424	If the medium is being attached indirectly, a new differencing medium
4425	will implicitly be created for it and attached instead. If the
4426	changes made to the machine settings (including this indirect
4427	attachment) are later cancelled using <link to="#discardSettings"/>,
4428	this implicitly created differencing medium will implicitly
4429	be deleted.
4430	</note>
4431
4432	<result name="E_INVALIDARG">
4433	SATA device, SATA port, IDE port or IDE slot out of range, or
4434	file or UUID not found.
4435	</result>
4436	<result name="VBOX_E_INVALID_OBJECT_STATE">
4437	Machine must be registered before media can be attached.
4438	</result>
4439	<result name="VBOX_E_INVALID_VM_STATE">
4440	Invalid machine state.
4441	</result>
4442	<result name="VBOX_E_OBJECT_IN_USE">
4443	A medium is already attached to this or another virtual machine.
4444	</result>
4445
4446	</desc>
4447	<param name="name" type="wstring" dir="in">
4448	<desc>Name of the storage controller to attach the device to.</desc>
4449	</param>
4450	<param name="controllerPort" type="long" dir="in">
4451	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4452	the primary controller and 1 specifies the secondary controller.
4453	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4454	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4455	</param>
4456	<param name="device" type="long" dir="in">
4457	<desc>Device slot in the given port to attach the device to. This is only
4458	relevant for IDE controllers, for which 0 specifies the master device and
4459	1 specifies the slave device. For all other controller types, this must
4460	be 0.</desc>
4461	</param>
4462	<param name="type" type="DeviceType" dir="in">
4463	<desc>Device type of the attached device. For media opened by
4464	<link to="IVirtualBox::openMedium" />, this must match the device type
4465	specified there.</desc>
4466	</param>
4467	<param name="medium" type="IMedium" dir="in">
4468	<desc>Medium to mount or NULL for an empty drive.</desc>
4469	</param>
4470	</method>
4471
4472	<method name="detachDevice">
4473	<desc>
4474	Detaches the device attached to a device slot of the specified bus.
4475
4476	Detaching the device from the virtual machine is deferred. This means
4477	that the medium remains associated with the machine when this method
4478	returns and gets actually de-associated only after a successful
4479	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4480	for more detailed information about attaching media.
4481
4482	<note>
4483	You cannot detach a device from a running machine.
4484	</note>
4485	<note>
4486	Detaching differencing media implicitly created by <link
4487	to="#attachDevice"/> for the indirect attachment using this
4488	method will <b>not</b> implicitly delete them. The
4489	<link to="IMedium::deleteStorage"/> operation should be
4490	explicitly performed by the caller after the medium is successfully
4491	detached and the settings are saved with
4492	<link to="#saveSettings"/>, if it is the desired action.
4493	</note>
4494
4495	<result name="VBOX_E_INVALID_VM_STATE">
4496	Attempt to detach medium from a running virtual machine.
4497	</result>
4498	<result name="VBOX_E_OBJECT_NOT_FOUND">
4499	No medium attached to given slot/bus.
4500	</result>
4501	<result name="VBOX_E_NOT_SUPPORTED">
4502	Medium format does not support storage deletion.
4503	</result>
4504
4505	</desc>
4506	<param name="name" type="wstring" dir="in">
4507	<desc>Name of the storage controller to detach the medium from.</desc>
4508	</param>
4509	<param name="controllerPort" type="long" dir="in">
4510	<desc>Port number to detach the medium from.</desc>
4511	</param>
4512	<param name="device" type="long" dir="in">
4513	<desc>Device slot number to detach the medium from.</desc>
4514	</param>
4515	</method>
4516
4517	<method name="passthroughDevice">
4518	<desc>
4519	Sets the passthrough mode of an existing DVD device. Changing the
4520	setting while the VM is running is forbidden. The setting is only used
4521	if at VM start the device is configured as a host DVD drive, in all
4522	other cases it is ignored. The device must already exist; see
4523	<link to="IMachine::attachDevice"/> for how to attach a new device.
4524
4525	The @a controllerPort and @a device parameters specify the device slot and
4526	have have the same meaning as with <link to="IMachine::attachDevice" />.
4527
4528	<result name="E_INVALIDARG">
4529	SATA device, SATA port, IDE port or IDE slot out of range.
4530	</result>
4531	<result name="VBOX_E_INVALID_OBJECT_STATE">
4532	Attempt to modify an unregistered virtual machine.
4533	</result>
4534	<result name="VBOX_E_INVALID_VM_STATE">
4535	Invalid machine state.
4536	</result>
4537
4538	</desc>
4539	<param name="name" type="wstring" dir="in">
4540	<desc>Name of the storage controller.</desc>
4541	</param>
4542	<param name="controllerPort" type="long" dir="in">
4543	<desc>Storage controller port.</desc>
4544	</param>
4545	<param name="device" type="long" dir="in">
4546	<desc>Device slot in the given port.</desc>
4547	</param>
4548	<param name="passthrough" type="boolean" dir="in">
4549	<desc>New value for the passthrough setting.</desc>
4550	</param>
4551	</method>
4552
4553	<method name="setBandwidthGroupForDevice">
4554	<desc>
4555	Sets the bandwidth group of an existing storage device.
4556	The device must already exist; see <link to="IMachine::attachDevice"/>
4557	for how to attach a new device.
4558
4559	The @a controllerPort and @a device parameters specify the device slot and
4560	have have the same meaning as with <link to="IMachine::attachDevice" />.
4561
4562	<result name="E_INVALIDARG">
4563	SATA device, SATA port, IDE port or IDE slot out of range.
4564	</result>
4565	<result name="VBOX_E_INVALID_OBJECT_STATE">
4566	Attempt to modify an unregistered virtual machine.
4567	</result>
4568	<result name="VBOX_E_INVALID_VM_STATE">
4569	Invalid machine state.
4570	</result>
4571
4572	</desc>
4573	<param name="name" type="wstring" dir="in">
4574	<desc>Name of the storage controller.</desc>
4575	</param>
4576	<param name="controllerPort" type="long" dir="in">
4577	<desc>Storage controller port.</desc>
4578	</param>
4579	<param name="device" type="long" dir="in">
4580	<desc>Device slot in the given port.</desc>
4581	</param>
4582	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4583	<desc>New value for the bandwidth group or NULL for no group.</desc>
4584	</param>
4585	</method>
4586
4587	<method name="mountMedium">
4588	<desc>
4589	Mounts a medium (<link to="IMedium" />, identified
4590	by the given UUID @a id) to the given storage controller
4591	(<link to="IStorageController" />, identified by @a name),
4592	at the indicated port and device. The device must already exist;
4593	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4594
4595	This method is intended only for managing removable media, where the
4596	device is fixed but media is changeable at runtime (such as DVDs
4597	and floppies). It cannot be used for fixed media such as hard disks.
4598
4599	The @a controllerPort and @a device parameters specify the device slot and
4600	have have the same meaning as with <link to="IMachine::attachDevice" />.
4601
4602	The specified device slot can have a medium mounted, which will be
4603	unmounted first. Specifying a zero UUID (or an empty string) for
4604	@a medium does just an unmount.
4605
4606	See <link to="IMedium"/> for more detailed information about
4607	attaching media.
4608
4609	<result name="E_INVALIDARG">
4610	SATA device, SATA port, IDE port or IDE slot out of range.
4611	</result>
4612	<result name="VBOX_E_INVALID_OBJECT_STATE">
4613	Attempt to attach medium to an unregistered virtual machine.
4614	</result>
4615	<result name="VBOX_E_INVALID_VM_STATE">
4616	Invalid machine state.
4617	</result>
4618	<result name="VBOX_E_OBJECT_IN_USE">
4619	Medium already attached to this or another virtual machine.
4620	</result>
4621
4622	</desc>
4623	<param name="name" type="wstring" dir="in">
4624	<desc>Name of the storage controller to attach the medium to.</desc>
4625	</param>
4626	<param name="controllerPort" type="long" dir="in">
4627	<desc>Port to attach the medium to.</desc>
4628	</param>
4629	<param name="device" type="long" dir="in">
4630	<desc>Device slot in the given port to attach the medium to.</desc>
4631	</param>
4632	<param name="medium" type="IMedium" dir="in">
4633	<desc>Medium to mount or NULL for an empty drive.</desc>
4634	</param>
4635	<param name="force" type="boolean" dir="in">
4636	<desc>Allows to force unmount/mount of a medium which is locked by
4637	the device slot in the given port to attach the medium to.</desc>
4638	</param>
4639	</method>
4640
4641	<method name="getMedium" const="yes">
4642	<desc>
4643	Returns the virtual medium attached to a device slot of the specified
4644	bus.
4645
4646	Note that if the medium was indirectly attached by
4647	<link to="#mountMedium"/> to the given device slot then this
4648	method will return not the same object as passed to the
4649	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4650	more detailed information about mounting a medium.
4651
4652	<result name="VBOX_E_OBJECT_NOT_FOUND">
4653	No medium attached to given slot/bus.
4654	</result>
4655
4656	</desc>
4657	<param name="name" type="wstring" dir="in">
4658	<desc>Name of the storage controller the medium is attached to.</desc>
4659	</param>
4660	<param name="controllerPort" type="long" dir="in">
4661	<desc>Port to query.</desc>
4662	</param>
4663	<param name="device" type="long" dir="in">
4664	<desc>Device slot in the given port to query.</desc>
4665	</param>
4666	<param name="medium" type="IMedium" dir="return">
4667	<desc>Attached medium object.</desc>
4668	</param>
4669	</method>
4670
4671	<method name="getMediumAttachmentsOfController" const="yes">
4672	<desc>
4673	Returns an array of medium attachments which are attached to the
4674	the controller with the given name.
4675
4676	<result name="VBOX_E_OBJECT_NOT_FOUND">
4677	A storage controller with given name doesn't exist.
4678	</result>
4679	</desc>
4680	<param name="name" type="wstring" dir="in"/>
4681	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4682	</method>
4683
4684	<method name="getMediumAttachment" const="yes">
4685	<desc>
4686	Returns a medium attachment which corresponds to the controller with
4687	the given name, on the given port and device slot.
4688
4689	<result name="VBOX_E_OBJECT_NOT_FOUND">
4690	No attachment exists for the given controller/port/device combination.
4691	</result>
4692	</desc>
4693	<param name="name" type="wstring" dir="in"/>
4694	<param name="controllerPort" type="long" dir="in"/>
4695	<param name="device" type="long" dir="in"/>
4696	<param name="attachment" type="IMediumAttachment" dir="return"/>
4697	</method>
4698
4699	<method name="attachHostPciDevice">
4700	<desc>
4701	Attaches host PCI device with the given (host) PCI address to the
4702	PCI bus of the virtual machine. Please note, that this operation
4703	is two phase, as real attachment will happen when VM will start,
4704	and most information will be delivered as IHostPciDevicePlugEvent
4705	on IVirtualBox event source.
4706
4707	<see>IHostPciDevicePlugEvent</see>
4708
4709	<result name="VBOX_E_INVALID_VM_STATE">
4710	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4711	</result>
4712	<result name="VBOX_E_PDM_ERROR">
4713	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4714	</result>
4715	<result name="VBOX_E_NOT_SUPPORTED">
4716	Hardware or host OS doesn't allow PCI device passthrought.
4717	</result>
4718	</desc>
4719	<param name="hostAddress" type="long" dir="in">
4720	<desc>Address of the host PCI device.</desc>
4721	</param>
4722	<param name="desiredGuestAddress" type="long" dir="in">
4723	<desc>Desired position of this device on guest PCI bus.</desc>
4724	</param>
4725	<param name="tryToUnbind" type="boolean" dir="in">
4726	<desc>If VMM shall try to unbind existing drivers from the
4727	device before attaching it to the guest.</desc>
4728	</param>
4729	</method>
4730
4731	<method name="detachHostPciDevice">
4732	<desc>
4733	Detach host PCI device from the virtual machine.
4734	Also HostPciDevicePlugEvent on IVirtualBox event source
4735	will be delivered. As currently we don't support hot device
4736	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4737
4738	<see>IHostPciDevicePlugEvent</see>
4739
4740	<result name="VBOX_E_INVALID_VM_STATE">
4741	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4742	</result>
4743	<result name="VBOX_E_OBJECT_NOT_FOUND">
4744	This host device is not attached to this machine.
4745	</result>
4746	<result name="VBOX_E_PDM_ERROR">
4747	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4748	</result>
4749	<result name="VBOX_E_NOT_SUPPORTED">
4750	Hardware or host OS doesn't allow PCI device passthrought.
4751	</result>
4752	</desc>
4753	<param name="hostAddress" type="long" dir="in">
4754	<desc>Address of the host PCI device.</desc>
4755	</param>
4756	</method>
4757
4758	<method name="getNetworkAdapter" const="yes">
4759	<desc>
4760	Returns the network adapter associated with the given slot.
4761	Slots are numbered sequentially, starting with zero. The total
4762	number of adapters per machine is defined by the
4763	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
4764	so the maximum slot number is one less than that property's value.
4765
4766	<result name="E_INVALIDARG">
4767	Invalid @a slot number.
4768	</result>
4769
4770	</desc>
4771	<param name="slot" type="unsigned long" dir="in"/>
4772	<param name="adapter" type="INetworkAdapter" dir="return"/>
4773	</method>
4774
4775	<method name="addStorageController">
4776	<desc>
4777	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4778	machine and returns it as an instance of
4779	<link to="IStorageController" />.
4780
4781	@a name identifies the controller for subsequent calls such as
4782	<link to="#getStorageControllerByName" />,
4783	<link to="#getStorageControllerByInstance" />,
4784	<link to="#removeStorageController" />,
4785	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4786
4787	After the controller has been added, you can set its exact
4788	type by setting the <link to="IStorageController::controllerType" />.
4789
4790	<result name="VBOX_E_OBJECT_IN_USE">
4791	A storage controller with given name exists already.
4792	</result>
4793	<result name="E_INVALIDARG">
4794	Invalid @a controllerType.
4795	</result>
4796	</desc>
4797	<param name="name" type="wstring" dir="in"/>
4798	<param name="connectionType" type="StorageBus" dir="in"/>
4799	<param name="controller" type="IStorageController" dir="return"/>
4800	</method>
4801
4802	<method name="getStorageControllerByName" const="yes">
4803	<desc>
4804	Returns a storage controller with the given name.
4805
4806	<result name="VBOX_E_OBJECT_NOT_FOUND">
4807	A storage controller with given name doesn't exist.
4808	</result>
4809	</desc>
4810	<param name="name" type="wstring" dir="in"/>
4811	<param name="storageController" type="IStorageController" dir="return"/>
4812	</method>
4813
4814	<method name="getStorageControllerByInstance" const="yes">
4815	<desc>
4816	Returns a storage controller with the given instance number.
4817
4818	<result name="VBOX_E_OBJECT_NOT_FOUND">
4819	A storage controller with given instance number doesn't exist.
4820	</result>
4821	</desc>
4822	<param name="instance" type="unsigned long" dir="in"/>
4823	<param name="storageController" type="IStorageController" dir="return"/>
4824	</method>
4825
4826	<method name="removeStorageController">
4827	<desc>
4828	Removes a storage controller from the machine.
4829
4830	<result name="VBOX_E_OBJECT_NOT_FOUND">
4831	A storage controller with given name doesn't exist.
4832	</result>
4833	</desc>
4834	<param name="name" type="wstring" dir="in"/>
4835	</method>
4836
4837	<method name="setStorageControllerBootable">
4838	<desc>
4839	Sets the bootable flag of the storage controller with the given name.
4840
4841	<result name="VBOX_E_OBJECT_NOT_FOUND">
4842	A storage controller with given name doesn't exist.
4843	</result>
4844	<result name="VBOX_E_OBJECT_IN_USE">
4845	Another storage controller is marked as bootable already.
4846	</result>
4847	</desc>
4848	<param name="name" type="wstring" dir="in"/>
4849	<param name="bootable" type="boolean" dir="in"/>
4850	</method>
4851
4852	<method name="getSerialPort" const="yes">
4853	<desc>
4854	Returns the serial port associated with the given slot.
4855	Slots are numbered sequentially, starting with zero. The total
4856	number of serial ports per machine is defined by the
4857	<link to="ISystemProperties::serialPortCount"/> property,
4858	so the maximum slot number is one less than that property's value.
4859
4860	<result name="E_INVALIDARG">
4861	Invalid @a slot number.
4862	</result>
4863
4864	</desc>
4865	<param name="slot" type="unsigned long" dir="in"/>
4866	<param name="port" type="ISerialPort" dir="return"/>
4867	</method>
4868
4869	<method name="getParallelPort" const="yes">
4870	<desc>
4871	Returns the parallel port associated with the given slot.
4872	Slots are numbered sequentially, starting with zero. The total
4873	number of parallel ports per machine is defined by the
4874	<link to="ISystemProperties::parallelPortCount"/> property,
4875	so the maximum slot number is one less than that property's value.
4876
4877	<result name="E_INVALIDARG">
4878	Invalid @a slot number.
4879	</result>
4880
4881	</desc>
4882	<param name="slot" type="unsigned long" dir="in"/>
4883	<param name="port" type="IParallelPort" dir="return"/>
4884	</method>
4885
4886	<method name="getExtraDataKeys">
4887	<desc>
4888	Returns an array representing the machine-specific extra data keys
4889	which currently have values defined.
4890	</desc>
4891	<param name="value" type="wstring" dir="return" safearray="yes">
4892	<desc>Array of extra data keys.</desc>
4893	</param>
4894	</method>
4895
4896	<method name="getExtraData">
4897	<desc>
4898	Returns associated machine-specific extra data.
4899
4900	If the requested data @a key does not exist, this function will
4901	succeed and return an empty string in the @a value argument.
4902
4903	<result name="VBOX_E_FILE_ERROR">
4904	Settings file not accessible.
4905	</result>
4906	<result name="VBOX_E_XML_ERROR">
4907	Could not parse the settings file.
4908	</result>
4909
4910	</desc>
4911	<param name="key" type="wstring" dir="in">
4912	<desc>Name of the data key to get.</desc>
4913	</param>
4914	<param name="value" type="wstring" dir="return">
4915	<desc>Value of the requested data key.</desc>
4916	</param>
4917	</method>
4918
4919	<method name="setExtraData">
4920	<desc>
4921	Sets associated machine-specific extra data.
4922
4923	If you pass @c null or an empty string as a key @a value, the given
4924	@a key will be deleted.
4925
4926	<note>
4927	Before performing the actual data change, this method will ask all
4928	registered listeners using the
4929	<link to="IExtraDataCanChangeEvent"/>
4930	notification for a permission. If one of the listeners refuses the
4931	new value, the change will not be performed.
4932	</note>
4933	<note>
4934	On success, the
4935	<link to="IExtraDataChangedEvent"/> notification
4936	is called to inform all registered listeners about a successful data
4937	change.
4938	</note>
4939	<note>
4940	This method can be called outside the machine session and therefore
4941	it's a caller's responsibility to handle possible race conditions
4942	when several clients change the same key at the same time.
4943	</note>
4944
4945	<result name="VBOX_E_FILE_ERROR">
4946	Settings file not accessible.
4947	</result>
4948	<result name="VBOX_E_XML_ERROR">
4949	Could not parse the settings file.
4950	</result>
4951
4952	</desc>
4953	<param name="key" type="wstring" dir="in">
4954	<desc>Name of the data key to set.</desc>
4955	</param>
4956	<param name="value" type="wstring" dir="in">
4957	<desc>Value to assign to the key.</desc>
4958	</param>
4959	</method>
4960
4961	<method name="getCPUProperty" const="yes">
4962	<desc>
4963	Returns the virtual CPU boolean value of the specified property.
4964
4965	<result name="E_INVALIDARG">
4966	Invalid property.
4967	</result>
4968
4969	</desc>
4970	<param name="property" type="CPUPropertyType" dir="in">
4971	<desc>
4972	Property type to query.
4973	</desc>
4974	</param>
4975	<param name="value" type="boolean" dir="return">
4976	<desc>
4977	Property value.
4978	</desc>
4979	</param>
4980	</method>
4981
4982	<method name="setCPUProperty">
4983	<desc>
4984	Sets the virtual CPU boolean value of the specified property.
4985
4986	<result name="E_INVALIDARG">
4987	Invalid property.
4988	</result>
4989
4990	</desc>
4991	<param name="property" type="CPUPropertyType" dir="in">
4992	<desc>
4993	Property type to query.
4994	</desc>
4995	</param>
4996	<param name="value" type="boolean" dir="in">
4997	<desc>
4998	Property value.
4999	</desc>
5000	</param>
5001	</method>
5002
5003	<method name="getCPUIDLeaf" const="yes">
5004	<desc>
5005	Returns the virtual CPU cpuid information for the specified leaf.
5006
5007	Currently supported index values for cpuid:
5008	Standard CPUID leafs: 0 - 0xA
5009	Extended CPUID leafs: 0x80000000 - 0x8000000A
5010
5011	See the Intel and AMD programmer's manuals for detailed information
5012	about the cpuid instruction and its leafs.
5013	<result name="E_INVALIDARG">
5014	Invalid id.
5015	</result>
5016
5017	</desc>
5018	<param name="id" type="unsigned long" dir="in">
5019	<desc>
5020	CPUID leaf index.
5021	</desc>
5022	</param>
5023	<param name="valEax" type="unsigned long" dir="out">
5024	<desc>
5025	CPUID leaf value for register eax.
5026	</desc>
5027	</param>
5028	<param name="valEbx" type="unsigned long" dir="out">
5029	<desc>
5030	CPUID leaf value for register ebx.
5031	</desc>
5032	</param>
5033	<param name="valEcx" type="unsigned long" dir="out">
5034	<desc>
5035	CPUID leaf value for register ecx.
5036	</desc>
5037	</param>
5038	<param name="valEdx" type="unsigned long" dir="out">
5039	<desc>
5040	CPUID leaf value for register edx.
5041	</desc>
5042	</param>
5043	</method>
5044
5045	<method name="setCPUIDLeaf">
5046	<desc>
5047	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5048	are not passed unmodified. VirtualBox clears features that it doesn't support.
5049
5050	Currently supported index values for cpuid:
5051	Standard CPUID leafs: 0 - 0xA
5052	Extended CPUID leafs: 0x80000000 - 0x8000000A
5053
5054	See the Intel and AMD programmer's manuals for detailed information
5055	about the cpuid instruction and its leafs.
5056
5057	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5058	random crashes inside VMs.
5059	<result name="E_INVALIDARG">
5060	Invalid id.
5061	</result>
5062
5063	</desc>
5064	<param name="id" type="unsigned long" dir="in">
5065	<desc>
5066	CPUID leaf index.
5067	</desc>
5068	</param>
5069	<param name="valEax" type="unsigned long" dir="in">
5070	<desc>
5071	CPUID leaf value for register eax.
5072	</desc>
5073	</param>
5074	<param name="valEbx" type="unsigned long" dir="in">
5075	<desc>
5076	CPUID leaf value for register ebx.
5077	</desc>
5078	</param>
5079	<param name="valEcx" type="unsigned long" dir="in">
5080	<desc>
5081	CPUID leaf value for register ecx.
5082	</desc>
5083	</param>
5084	<param name="valEdx" type="unsigned long" dir="in">
5085	<desc>
5086	CPUID leaf value for register edx.
5087	</desc>
5088	</param>
5089	</method>
5090
5091	<method name="removeCPUIDLeaf">
5092	<desc>
5093	Removes the virtual CPU cpuid leaf for the specified index
5094
5095	<result name="E_INVALIDARG">
5096	Invalid id.
5097	</result>
5098
5099	</desc>
5100	<param name="id" type="unsigned long" dir="in">
5101	<desc>
5102	CPUID leaf index.
5103	</desc>
5104	</param>
5105	</method>
5106
5107	<method name="removeAllCPUIDLeaves">
5108	<desc>
5109	Removes all the virtual CPU cpuid leaves
5110	</desc>
5111	</method>
5112
5113	<method name="getHWVirtExProperty" const="yes">
5114	<desc>
5115	Returns the value of the specified hardware virtualization boolean property.
5116
5117	<result name="E_INVALIDARG">
5118	Invalid property.
5119	</result>
5120
5121	</desc>
5122	<param name="property" type="HWVirtExPropertyType" dir="in">
5123	<desc>
5124	Property type to query.
5125	</desc>
5126	</param>
5127	<param name="value" type="boolean" dir="return">
5128	<desc>
5129	Property value.
5130	</desc>
5131	</param>
5132	</method>
5133
5134	<method name="setHWVirtExProperty">
5135	<desc>
5136	Sets a new value for the specified hardware virtualization boolean property.
5137
5138	<result name="E_INVALIDARG">
5139	Invalid property.
5140	</result>
5141
5142	</desc>
5143	<param name="property" type="HWVirtExPropertyType" dir="in">
5144	<desc>
5145	Property type to set.
5146	</desc>
5147	</param>
5148	<param name="value" type="boolean" dir="in">
5149	<desc>
5150	New property value.
5151	</desc>
5152	</param>
5153	</method>
5154
5155	<method name="saveSettings">
5156	<desc>
5157	Saves any changes to machine settings made since the session
5158	has been opened or a new machine has been created, or since the
5159	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5160	For registered machines, new settings become visible to all
5161	other VirtualBox clients after successful invocation of this
5162	method.
5163	<note>
5164	The method sends <link to="IMachineDataChangedEvent"/>
5165	notification event after the configuration has been successfully
5166	saved (only for registered machines).
5167	</note>
5168	<note>
5169	Calling this method is only valid on instances returned
5170	by <link to="ISession::machine"/> and on new machines
5171	created by <link to="IVirtualBox::createMachine"/> but not
5172	yet registered, or on unregistered machines after calling
5173	<link to="IMachine::unregister"/>.
5174	</note>
5175
5176	<result name="VBOX_E_FILE_ERROR">
5177	Settings file not accessible.
5178	</result>
5179	<result name="VBOX_E_XML_ERROR">
5180	Could not parse the settings file.
5181	</result>
5182	<result name="E_ACCESSDENIED">
5183	Modification request refused.
5184	</result>
5185
5186	</desc>
5187	</method>
5188
5189	<method name="discardSettings">
5190	<desc>
5191	Discards any changes to the machine settings made since the session
5192	has been opened or since the last call to <link to="#saveSettings"/>
5193	or <link to="#discardSettings"/>.
5194	<note>
5195	Calling this method is only valid on instances returned
5196	by <link to="ISession::machine"/> and on new machines
5197	created by <link to="IVirtualBox::createMachine"/> or
5198	opened by <link to="IVirtualBox::openMachine"/> but not
5199	yet registered, or on unregistered machines after calling
5200	<link to="IMachine::unregister"/>.
5201	</note>
5202
5203	<result name="VBOX_E_INVALID_VM_STATE">
5204	Virtual machine is not mutable.
5205	</result>
5206
5207	</desc>
5208	</method>
5209
5210	<method name="unregister">
5211	<desc>
5212	Unregisters a machine previously registered with
5213	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5214	cleanup before the machine is unregistered.
5215
5216	This method does not delete any files. It only changes the machine configuration and
5217	the list of registered machines in the VirtualBox object. To delete the files which
5218	belonged to the machine, including the XML file of the machine itself, call
5219	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5220	from this method.
5221
5222	How thoroughly this method cleans up the machine configuration before unregistering
5223	the machine depends on the @a cleanupMode argument.
5224
5225	<ul>
5226	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5227	cleanup will be performed. The call will fail if the machine is in "Saved" state
5228	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5229	It is the responsibility of the caller to delete all such configuration in this mode.
5230	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5231	which it replaces.</li>
5232	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5233	state or if it has snapshots or media attached. All media attached to the current machine
5234	state or in snapshots will be detached. No medium objects will be returned;
5235	all of the machine's media will remain open.</li>
5236	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5237	except that all the hard disk medium objects which were detached from the machine will
5238	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5239	API for closing and deletion.</li>
5240	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5241	that all media will be returned in the array, including removable media like DVDs and
5242	floppies. This might be useful if the user wants to inspect in detail which media were
5243	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5244	in that case because users will typically want to preserve ISO and RAW image files.</li>
5245	</ul>
5246
5247	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5248	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5249	deleted with all its saved states and hard disk images, but images for removable
5250	drives (such as ISO and RAW files) will remain on disk.
5251
5252	This API does not verify whether the media files returned in the array are still
5253	attached to other machines (i.e. shared between several machines). If such a shared
5254	image is passed to <link to="#delete" /> however, closing the image will fail there
5255	and the image will be silently skipped.
5256
5257	This API may, however, move media from this machine's media registry to other media
5258	registries (see <link to="IMedium" /> for details on media registries). For machines
5259	created with VirtualBox 4.0 or later, if media from this machine's media registry
5260	are also attached to another machine (shared attachments), each such medium will be
5261	moved to another machine's registry. This is because without this machine's media
5262	registry, the other machine cannot find its media any more and would become inaccessible.
5263
5264	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5265	before unregistering it. It may also silently call saveSettings() on other machines
5266	if media are moved to other machines' media registries.
5267
5268	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5269	is fired.
5270
5271	The call will fail if the machine is currently locked (see <link to="ISession" />).
5272
5273	<note>
5274	If the given machine is inaccessible (see <link to="#accessible"/>), it
5275	will be unregistered and fully uninitialized right afterwards. As a result,
5276	the returned machine object will be unusable and an attempt to call
5277	<b>any</b> method will return the "Object not ready" error.
5278	</note>
5279
5280	<result name="VBOX_E_INVALID_OBJECT_STATE">
5281	Machine is currently locked for a session.
5282	</result>
5283	</desc>
5284
5285	<param name="cleanupMode" type="CleanupMode" dir="in">
5286	<desc>How to clean up after the machine has been unregistered.</desc>
5287	</param>
5288	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5289	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5290	</param>
5291	</method>
5292
5293	<method name="delete">
5294	<desc>
5295	Deletes the files associated with this machine from disk. If medium objects are passed
5296	in with the @a aMedia argument, they are closed and, if closing was successful, their
5297	storage files are deleted as well. For convenience, this array of media files can be
5298	the same as the one returned from a previous <link to="#unregister" /> call.
5299
5300	This method must only be called on machines which are either write-locked (i.e. on instances
5301	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5302	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5303	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5304
5305	The following files will be deleted by this method:
5306	<ul>
5307	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5308	argument other than "UnregisterOnly", this will delete all saved state files that
5309	the machine had in use; possibly one if the machine was in "Saved" state and one
5310	for each online snapshot that the machine had.</li>
5311	<li>On each medium object passed in the @a aMedia array, this will call
5312	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5313	medium's storage on disk. Since the close() call will fail if the medium is still
5314	in use, e.g. because it is still attached to a second machine; in that case the
5315	storage will not be deleted.</li>
5316	<li>Finally, the machine's own XML file will be deleted.</li>
5317	</ul>
5318
5319	Since deleting large disk image files can be a time-consuming I/O operation, this
5320	method operates asynchronously and returns an IProgress object to allow the caller
5321	to monitor the progress. There will be one sub-operation for each file that is
5322	being deleted (saved state or medium storage file).
5323
5324	<note>
5325	<link to="#settingsModified"/> will return @c true after this
5326	method successfully returns.
5327	</note>
5328
5329	<result name="VBOX_E_INVALID_VM_STATE">
5330	Machine is registered but not write-locked.
5331	</result>
5332	<result name="VBOX_E_IPRT_ERROR">
5333	Could not delete the settings file.
5334	</result>
5335	</desc>
5336	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5337	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5338	</param>
5339	<param name="aProgress" type="IProgress" dir="return">
5340	<desc>Progress object to track the operation completion.</desc>
5341	</param>
5342	</method>
5343
5344	<method name="export">
5345	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5346	steps required to export VirtualBox machines to OVF.
5347	</desc>
5348
5349	<param name="aAppliance" type="IAppliance" dir="in">
5350	<desc>Appliance to export this machine to.</desc>
5351	</param>
5352	<param name="location" type="wstring" dir="in">
5353	<desc>The target location.</desc>
5354	</param>
5355	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5356	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5357	</param>
5358	</method >
5359
5360	<method name="findSnapshot">
5361	<desc>
5362	Returns a snapshot of this machine with the given name or UUID.
5363
5364	Returns a snapshot of this machine with the given UUID.
5365	A @c null argument can be used to obtain the first snapshot
5366	taken on this machine. To traverse the whole tree of snapshots
5367	starting from the root, inspect the root snapshot's
5368	<link to="ISnapshot::children" /> attribute and recurse over those children.
5369
5370	<result name="VBOX_E_OBJECT_NOT_FOUND">
5371	Virtual machine has no snapshots or snapshot not found.
5372	</result>
5373
5374	</desc>
5375	<param name="nameOrId" type="wstring" dir="in">
5376	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5377	</param>
5378	<param name="snapshot" type="ISnapshot" dir="return">
5379	<desc>Snapshot object with the given name.</desc>
5380	</param>
5381	</method>
5382
5383	<method name="createSharedFolder">
5384	<desc>
5385	Creates a new permanent shared folder by associating the given logical
5386	name with the given host path, adds it to the collection of shared
5387	folders and starts sharing it. Refer to the description of
5388	<link to="ISharedFolder"/> to read more about logical names.
5389
5390	<result name="VBOX_E_OBJECT_IN_USE">
5391	Shared folder already exists.
5392	</result>
5393	<result name="VBOX_E_FILE_ERROR">
5394	Shared folder @a hostPath not accessible.
5395	</result>
5396
5397	</desc>
5398	<param name="name" type="wstring" dir="in">
5399	<desc>Unique logical name of the shared folder.</desc>
5400	</param>
5401	<param name="hostPath" type="wstring" dir="in">
5402	<desc>Full path to the shared folder in the host file system.</desc>
5403	</param>
5404	<param name="writable" type="boolean" dir="in">
5405	<desc>Whether the share is writable or readonly.</desc>
5406	</param>
5407	<param name="automount" type="boolean" dir="in">
5408	<desc>Whether the share gets automatically mounted by the guest
5409	or not.</desc>
5410	</param>
5411	</method>
5412
5413	<method name="removeSharedFolder">
5414	<desc>
5415	Removes the permanent shared folder with the given name previously
5416	created by <link to="#createSharedFolder"/> from the collection of
5417	shared folders and stops sharing it.
5418
5419	<result name="VBOX_E_INVALID_VM_STATE">
5420	Virtual machine is not mutable.
5421	</result>
5422	<result name="VBOX_E_OBJECT_NOT_FOUND">
5423	Shared folder @a name does not exist.
5424	</result>
5425
5426	</desc>
5427	<param name="name" type="wstring" dir="in">
5428	<desc>Logical name of the shared folder to remove.</desc>
5429	</param>
5430	</method>
5431
5432	<method name="canShowConsoleWindow">
5433	<desc>
5434	Returns @c true if the VM console process can activate the
5435	console window and bring it to foreground on the desktop of
5436	the host PC.
5437	<note>
5438	This method will fail if a session for this machine is not
5439	currently open.
5440	</note>
5441
5442	<result name="VBOX_E_INVALID_VM_STATE">
5443	Machine session is not open.
5444	</result>
5445
5446	</desc>
5447	<param name="canShow" type="boolean" dir="return">
5448	<desc>
5449	@c true if the console window can be shown and @c false otherwise.
5450	</desc>
5451	</param>
5452	</method>
5453
5454	<method name="showConsoleWindow">
5455	<desc>
5456	Activates the console window and brings it to foreground on
5457	the desktop of the host PC. Many modern window managers on
5458	many platforms implement some sort of focus stealing
5459	prevention logic, so that it may be impossible to activate
5460	a window without the help of the currently active
5461	application. In this case, this method will return a non-zero
5462	identifier that represents the top-level window of the VM
5463	console process. The caller, if it represents a currently
5464	active process, is responsible to use this identifier (in a
5465	platform-dependent manner) to perform actual window
5466	activation.
5467	<note>
5468	This method will fail if a session for this machine is not
5469	currently open.
5470	</note>
5471
5472	<result name="VBOX_E_INVALID_VM_STATE">
5473	Machine session is not open.
5474	</result>
5475
5476	</desc>
5477	<param name="winId" type="long long" dir="return">
5478	<desc>
5479	Platform-dependent identifier of the top-level VM console
5480	window, or zero if this method has performed all actions
5481	necessary to implement the <i>show window</i> semantics for
5482	the given platform and/or VirtualBox front-end.
5483	</desc>
5484	</param>
5485	</method>
5486
5487	<method name="getGuestProperty" const="yes">
5488	<desc>
5489	Reads an entry from the machine's guest property store.
5490
5491	<result name="VBOX_E_INVALID_VM_STATE">
5492	Machine session is not open.
5493	</result>
5494
5495	</desc>
5496	<param name="name" type="wstring" dir="in">
5497	<desc>
5498	The name of the property to read.
5499	</desc>
5500	</param>
5501	<param name="value" type="wstring" dir="out">
5502	<desc>
5503	The value of the property. If the property does not exist then this
5504	will be empty.
5505	</desc>
5506	</param>
5507	<param name="timestamp" type="long long" dir="out">
5508	<desc>
5509	The time at which the property was last modified, as seen by the
5510	server process.
5511	</desc>
5512	</param>
5513	<param name="flags" type="wstring" dir="out">
5514	<desc>
5515	Additional property parameters, passed as a comma-separated list of
5516	"name=value" type entries.
5517	</desc>
5518	</param>
5519	</method>
5520
5521	<method name="getGuestPropertyValue" const="yes">
5522	<desc>
5523	Reads a value from the machine's guest property store.
5524
5525	<result name="VBOX_E_INVALID_VM_STATE">
5526	Machine session is not open.
5527	</result>
5528
5529	</desc>
5530	<param name="property" type="wstring" dir="in">
5531	<desc>
5532	The name of the property to read.
5533	</desc>
5534	</param>
5535	<param name="value" type="wstring" dir="return">
5536	<desc>
5537	The value of the property. If the property does not exist then this
5538	will be empty.
5539	</desc>
5540	</param>
5541	</method>
5542
5543	<method name="getGuestPropertyTimestamp" const="yes">
5544	<desc>
5545	Reads a property timestamp from the machine's guest property store.
5546
5547	<result name="VBOX_E_INVALID_VM_STATE">
5548	Machine session is not open.
5549	</result>
5550
5551	</desc>
5552	<param name="property" type="wstring" dir="in">
5553	<desc>
5554	The name of the property to read.
5555	</desc>
5556	</param>
5557	<param name="value" type="long long" dir="return">
5558	<desc>
5559	The timestamp. If the property does not exist then this will be
5560	empty.
5561	</desc>
5562	</param>
5563	</method>
5564
5565	<method name="setGuestProperty">
5566	<desc>
5567	Sets, changes or deletes an entry in the machine's guest property
5568	store.
5569
5570	<result name="E_ACCESSDENIED">
5571	Property cannot be changed.
5572	</result>
5573	<result name="E_INVALIDARG">
5574	Invalid @a flags.
5575	</result>
5576	<result name="VBOX_E_INVALID_VM_STATE">
5577	Virtual machine is not mutable or session not open.
5578	</result>
5579	<result name="VBOX_E_INVALID_OBJECT_STATE">
5580	Cannot set transient property when machine not running.
5581	</result>
5582
5583	</desc>
5584	<param name="property" type="wstring" dir="in">
5585	<desc>
5586	The name of the property to set, change or delete.
5587	</desc>
5588	</param>
5589	<param name="value" type="wstring" dir="in">
5590	<desc>
5591	The new value of the property to set, change or delete. If the
5592	property does not yet exist and value is non-empty, it will be
5593	created. If the value is @c null or empty, the property will be
5594	deleted if it exists.
5595	</desc>
5596	</param>
5597	<param name="flags" type="wstring" dir="in">
5598	<desc>
5599	Additional property parameters, passed as a comma-separated list of
5600	"name=value" type entries.
5601	</desc>
5602	</param>
5603	</method>
5604
5605	<method name="setGuestPropertyValue">
5606	<desc>
5607	Sets, changes or deletes a value in the machine's guest property
5608	store. The flags field will be left unchanged or created empty for a
5609	new property.
5610
5611	<result name="E_ACCESSDENIED">
5612	Property cannot be changed.
5613	</result>
5614	<result name="VBOX_E_INVALID_VM_STATE">
5615	Virtual machine is not mutable or session not open.
5616	</result>
5617	<result name="VBOX_E_INVALID_OBJECT_STATE">
5618	Cannot set transient property when machine not running.
5619	</result>
5620	</desc>
5621
5622	<param name="property" type="wstring" dir="in">
5623	<desc>
5624	The name of the property to set, change or delete.
5625	</desc>
5626	</param>
5627	<param name="value" type="wstring" dir="in">
5628	<desc>
5629	The new value of the property to set, change or delete. If the
5630	property does not yet exist and value is non-empty, it will be
5631	created. If the value is @c null or empty, the property will be
5632	deleted if it exists.
5633	</desc>
5634	</param>
5635	</method>
5636
5637	<method name="enumerateGuestProperties">
5638	<desc>
5639	Return a list of the guest properties matching a set of patterns along
5640	with their values, time stamps and flags.
5641	</desc>
5642	<param name="patterns" type="wstring" dir="in">
5643	<desc>
5644	The patterns to match the properties against, separated by '\|'
5645	characters. If this is empty or @c null, all properties will match.
5646	</desc>
5647	</param>
5648	<param name="name" type="wstring" dir="out" safearray="yes">
5649	<desc>
5650	The names of the properties returned.
5651	</desc>
5652	</param>
5653	<param name="value" type="wstring" dir="out" safearray="yes">
5654	<desc>
5655	The values of the properties returned. The array entries match the
5656	corresponding entries in the @a name array.
5657	</desc>
5658	</param>
5659	<param name="timestamp" type="long long" dir="out" safearray="yes">
5660	<desc>
5661	The time stamps of the properties returned. The array entries match
5662	the corresponding entries in the @a name array.
5663	</desc>
5664	</param>
5665	<param name="flags" type="wstring" dir="out" safearray="yes">
5666	<desc>
5667	The flags of the properties returned. The array entries match the
5668	corresponding entries in the @a name array.
5669	</desc>
5670	</param>
5671	</method>
5672
5673	<method name="querySavedGuestSize">
5674	<desc>
5675	Returns the guest dimensions from the saved state.
5676	</desc>
5677	<param name="screenId" type="unsigned long" dir="in">
5678	<desc>
5679	Saved guest screen to query info from.
5680	</desc>
5681	</param>
5682	<param name="width" type="unsigned long" dir="out">
5683	<desc>
5684	Guest width at the time of the saved state was taken.
5685	</desc>
5686	</param>
5687	<param name="height" type="unsigned long" dir="out">
5688	<desc>
5689	Guest height at the time of the saved state was taken.
5690	</desc>
5691	</param>
5692	</method>
5693
5694	<method name="querySavedThumbnailSize">
5695	<desc>
5696	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5697	</desc>
5698	<param name="screenId" type="unsigned long" dir="in">
5699	<desc>
5700	Saved guest screen to query info from.
5701	</desc>
5702	</param>
5703	<param name="size" type="unsigned long" dir="out">
5704	<desc>
5705	Size of buffer required to store the bitmap.
5706	</desc>
5707	</param>
5708	<param name="width" type="unsigned long" dir="out">
5709	<desc>
5710	Bitmap width.
5711	</desc>
5712	</param>
5713	<param name="height" type="unsigned long" dir="out">
5714	<desc>
5715	Bitmap height.
5716	</desc>
5717	</param>
5718	</method>
5719
5720	<method name="readSavedThumbnailToArray">
5721	<desc>
5722	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5723	</desc>
5724	<param name="screenId" type="unsigned long" dir="in">
5725	<desc>
5726	Saved guest screen to read from.
5727	</desc>
5728	</param>
5729	<param name="BGR" type="boolean" dir="in">
5730	<desc>
5731	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5732	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5733	</desc>
5734	</param>
5735	<param name="width" type="unsigned long" dir="out">
5736	<desc>
5737	Bitmap width.
5738	</desc>
5739	</param>
5740	<param name="height" type="unsigned long" dir="out">
5741	<desc>
5742	Bitmap height.
5743	</desc>
5744	</param>
5745	<param name="data" type="octet" safearray="yes" dir="return">
5746	<desc>
5747	Array with resulting bitmap data.
5748	</desc>
5749	</param>
5750	</method>
5751
5752	<method name="readSavedThumbnailPNGToArray">
5753	<desc>
5754	Thumbnail in PNG format is retrieved to an array of bytes.
5755	</desc>
5756	<param name="screenId" type="unsigned long" dir="in">
5757	<desc>
5758	Saved guest screen to read from.
5759	</desc>
5760	</param>
5761	<param name="width" type="unsigned long" dir="out">
5762	<desc>
5763	Image width.
5764	</desc>
5765	</param>
5766	<param name="height" type="unsigned long" dir="out">
5767	<desc>
5768	Image height.
5769	</desc>
5770	</param>
5771	<param name="data" type="octet" dir="return" safearray="yes">
5772	<desc>
5773	Array with resulting PNG data.
5774	</desc>
5775	</param>
5776	</method>
5777
5778	<method name="querySavedScreenshotPNGSize">
5779	<desc>
5780	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5781	</desc>
5782	<param name="screenId" type="unsigned long" dir="in">
5783	<desc>
5784	Saved guest screen to query info from.
5785	</desc>
5786	</param>
5787	<param name="size" type="unsigned long" dir="out">
5788	<desc>
5789	Size of buffer required to store the PNG binary data.
5790	</desc>
5791	</param>
5792	<param name="width" type="unsigned long" dir="out">
5793	<desc>
5794	Image width.
5795	</desc>
5796	</param>
5797	<param name="height" type="unsigned long" dir="out">
5798	<desc>
5799	Image height.
5800	</desc>
5801	</param>
5802	</method>
5803
5804	<method name="readSavedScreenshotPNGToArray">
5805	<desc>
5806	Screenshot in PNG format is retrieved to an array of bytes.
5807	</desc>
5808	<param name="screenId" type="unsigned long" dir="in">
5809	<desc>
5810	Saved guest screen to read from.
5811	</desc>
5812	</param>
5813	<param name="width" type="unsigned long" dir="out">
5814	<desc>
5815	Image width.
5816	</desc>
5817	</param>
5818	<param name="height" type="unsigned long" dir="out">
5819	<desc>
5820	Image height.
5821	</desc>
5822	</param>
5823	<param name="data" type="octet" dir="return" safearray="yes">
5824	<desc>
5825	Array with resulting PNG data.
5826	</desc>
5827	</param>
5828	</method>
5829
5830	<method name="hotPlugCPU">
5831	<desc>
5832	Plugs a CPU into the machine.
5833	</desc>
5834	<param name="cpu" type="unsigned long" dir="in">
5835	<desc>
5836	The CPU id to insert.
5837	</desc>
5838	</param>
5839	</method>
5840
5841	<method name="hotUnplugCPU">
5842	<desc>
5843	Removes a CPU from the machine.
5844	</desc>
5845	<param name="cpu" type="unsigned long" dir="in">
5846	<desc>
5847	The CPU id to remove.
5848	</desc>
5849	</param>
5850	</method>
5851
5852	<method name="getCPUStatus">
5853	<desc>
5854	Returns the current status of the given CPU.
5855	</desc>
5856	<param name="cpu" type="unsigned long" dir="in">
5857	<desc>
5858	The CPU id to check for.
5859	</desc>
5860	</param>
5861	<param name="attached" type="boolean" dir="return">
5862	<desc>
5863	Status of the CPU.
5864	</desc>
5865	</param>
5866	</method>
5867
5868	<method name="queryLogFilename">
5869	<desc>
5870	Queries for the VM log file name of an given index. Returns an empty
5871	string if a log file with that index doesn't exists.
5872	</desc>
5873	<param name="idx" type="unsigned long" dir="in">
5874	<desc>
5875	Which log file name to query. 0=current log file.
5876	</desc>
5877	</param>
5878	<param name="filename" type="wstring" dir="return">
5879	<desc>
5880	On return the full path to the log file or an empty string on error.
5881	</desc>
5882	</param>
5883	</method>
5884
5885	<method name="readLog">
5886	<desc>
5887	Reads the VM log file. The chunk size is limited, so even if you
5888	ask for a big piece there might be less data returned.
5889	</desc>
5890	<param name="idx" type="unsigned long" dir="in">
5891	<desc>
5892	Which log file to read. 0=current log file.
5893	</desc>
5894	</param>
5895	<param name="offset" type="long long" dir="in">
5896	<desc>
5897	Offset in the log file.
5898	</desc>
5899	</param>
5900	<param name="size" type="long long" dir="in">
5901	<desc>
5902	Chunk size to read in the log file.
5903	</desc>
5904	</param>
5905	<param name="data" type="octet" dir="return" safearray="yes">
5906	<desc>
5907	Data read from the log file. A data size of 0 means end of file
5908	if the requested chunk size was not 0. This is the unprocessed
5909	file data, i.e. the line ending style depends on the platform of
5910	the system the server is running on.
5911	</desc>
5912	</param>
5913	</method>
5914	</interface>
5915
5916	<!--
5917	// IConsole
5918	/////////////////////////////////////////////////////////////////////////
5919	-->
5920
5921	<interface
5922	name="IVRDEServerInfo" extends="$unknown"
5923	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5924	wsmap="struct"
5925	>
5926	<desc>
5927	Contains information about the remote desktop (VRDE) server capabilities and status.
5928	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5929	</desc>
5930
5931	<attribute name="active" type="boolean" readonly="yes">
5932	<desc>
5933	Whether the remote desktop connection is active.
5934	</desc>
5935	</attribute>
5936
5937	<attribute name="port" type="long" readonly="yes">
5938	<desc>
5939	VRDE server port number. If this property is equal to <tt>0</tt>, then
5940	the VRDE server failed to start, usually because there are no free IP
5941	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5942	server has not yet been started.
5943	</desc>
5944	</attribute>
5945
5946	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5947	<desc>
5948	How many times a client connected.
5949	</desc>
5950	</attribute>
5951
5952	<attribute name="beginTime" type="long long" readonly="yes">
5953	<desc>
5954	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5955	</desc>
5956	</attribute>
5957
5958	<attribute name="endTime" type="long long" readonly="yes">
5959	<desc>
5960	When the last connection was terminated or the current time, if
5961	connection is still active, in milliseconds since 1970-01-01 UTC.
5962	</desc>
5963	</attribute>
5964
5965	<attribute name="bytesSent" type="long long" readonly="yes">
5966	<desc>
5967	How many bytes were sent in last or current, if still active, connection.
5968	</desc>
5969	</attribute>
5970
5971	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5972	<desc>
5973	How many bytes were sent in all connections.
5974	</desc>
5975	</attribute>
5976
5977	<attribute name="bytesReceived" type="long long" readonly="yes">
5978	<desc>
5979	How many bytes were received in last or current, if still active, connection.
5980	</desc>
5981	</attribute>
5982
5983	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5984	<desc>
5985	How many bytes were received in all connections.
5986	</desc>
5987	</attribute>
5988
5989	<attribute name="user" type="wstring" readonly="yes">
5990	<desc>
5991	Login user name supplied by the client.
5992	</desc>
5993	</attribute>
5994
5995	<attribute name="domain" type="wstring" readonly="yes">
5996	<desc>
5997	Login domain name supplied by the client.
5998	</desc>
5999	</attribute>
6000
6001	<attribute name="clientName" type="wstring" readonly="yes">
6002	<desc>
6003	The client name supplied by the client.
6004	</desc>
6005	</attribute>
6006
6007	<attribute name="clientIP" type="wstring" readonly="yes">
6008	<desc>
6009	The IP address of the client.
6010	</desc>
6011	</attribute>
6012
6013	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6014	<desc>
6015	The client software version number.
6016	</desc>
6017	</attribute>
6018
6019	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6020	<desc>
6021	Public key exchange method used when connection was established.
6022	Values: 0 - RDP4 public key exchange scheme.
6023	1 - X509 certificates were sent to client.
6024	</desc>
6025	</attribute>
6026
6027	</interface>
6028
6029	<interface
6030	name="IConsole" extends="$unknown"
6031	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6032	wsmap="managed"
6033	>
6034	<desc>
6035	The IConsole interface represents an interface to control virtual
6036	machine execution.
6037
6038	A console object gets created when a machine has been locked for a
6039	particular session (client process) using <link to="IMachine::lockMachine" />
6040	or <link to="IMachine::launchVMProcess"/>. The console object can
6041	then be found in the session's <link to="ISession::console" /> attribute.
6042
6043	Methods of the IConsole interface allow the caller to query the current
6044	virtual machine execution state, pause the machine or power it down, save
6045	the machine state or take a snapshot, attach and detach removable media
6046	and so on.
6047
6048	<see>ISession</see>
6049	</desc>
6050
6051	<attribute name="machine" type="IMachine" readonly="yes">
6052	<desc>
6053	Machine object for this console session.
6054	<note>
6055	This is a convenience property, it has the same value as
6056	<link to="ISession::machine"/> of the corresponding session
6057	object.
6058	</note>
6059	</desc>
6060	</attribute>
6061
6062	<attribute name="state" type="MachineState" readonly="yes">
6063	<desc>
6064	Current execution state of the machine.
6065	<note>
6066	This property always returns the same value as the corresponding
6067	property of the IMachine object for this console session.
6068	For the process that owns (executes) the VM, this is the
6069	preferable way of querying the VM state, because no IPC
6070	calls are made.
6071	</note>
6072	</desc>
6073	</attribute>
6074
6075	<attribute name="guest" type="IGuest" readonly="yes">
6076	<desc>Guest object.</desc>
6077	</attribute>
6078
6079	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6080	<desc>
6081	Virtual keyboard object.
6082	<note>
6083	If the machine is not running, any attempt to use
6084	the returned object will result in an error.
6085	</note>
6086	</desc>
6087	</attribute>
6088
6089	<attribute name="mouse" type="IMouse" readonly="yes">
6090	<desc>
6091	Virtual mouse object.
6092	<note>
6093	If the machine is not running, any attempt to use
6094	the returned object will result in an error.
6095	</note>
6096	</desc>
6097	</attribute>
6098
6099	<attribute name="display" type="IDisplay" readonly="yes">
6100	<desc>Virtual display object.
6101	<note>
6102	If the machine is not running, any attempt to use
6103	the returned object will result in an error.
6104	</note>
6105	</desc>
6106	</attribute>
6107
6108	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6109	<desc>Debugging interface.</desc>
6110	</attribute>
6111
6112	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6113	<desc>
6114	Collection of USB devices currently attached to the virtual
6115	USB controller.
6116	<note>
6117	The collection is empty if the machine is not running.
6118	</note>
6119	</desc>
6120	</attribute>
6121
6122	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6123	<desc>
6124	List of USB devices currently attached to the remote VRDE client.
6125	Once a new device is physically attached to the remote host computer,
6126	it appears in this list and remains there until detached.
6127	</desc>
6128	</attribute>
6129
6130	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6131	<desc>
6132	Collection of shared folders for the current session. These folders
6133	are called transient shared folders because they are available to the
6134	guest OS running inside the associated virtual machine only for the
6135	duration of the session (as opposed to
6136	<link to="IMachine::sharedFolders"/> which represent permanent shared
6137	folders). When the session is closed (e.g. the machine is powered down),
6138	these folders are automatically discarded.
6139
6140	New shared folders are added to the collection using
6141	<link to="#createSharedFolder"/>. Existing shared folders can be
6142	removed using <link to="#removeSharedFolder"/>.
6143	</desc>
6144	</attribute>
6145
6146	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6147	<desc>
6148	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6149	</desc>
6150	</attribute>
6151
6152	<attribute name="eventSource" type="IEventSource" readonly="yes">
6153	<desc>
6154	Event source for console events.
6155	</desc>
6156	</attribute>
6157
6158	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6159	<desc>Array of PCI devices attached to this machine.</desc>
6160	</attribute>
6161
6162	<method name="powerUp">
6163	<desc>
6164	Starts the virtual machine execution using the current machine
6165	state (that is, its current execution state, current settings and
6166	current storage devices).
6167
6168	<note>
6169	This method is only useful for front-ends that want to actually
6170	execute virtual machines in their own process (like the VirtualBox
6171	or VBoxSDL front-ends). Unless you are intending to write such a
6172	front-end, do not call this method. If you simply want to
6173	start virtual machine execution using one of the existing front-ends
6174	(for example the VirtualBox GUI or headless server), use
6175	<link to="IMachine::launchVMProcess"/> instead; these
6176	front-ends will power up the machine automatically for you.
6177	</note>
6178
6179	If the machine is powered off or aborted, the execution will
6180	start from the beginning (as if the real hardware were just
6181	powered on).
6182
6183	If the machine is in the <link to="MachineState_Saved"/> state,
6184	it will continue its execution the point where the state has
6185	been saved.
6186
6187	If the machine <link to="IMachine::teleporterEnabled"/> property is
6188	enabled on the machine being powered up, the machine will wait for an
6189	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6190	state. The returned progress object will have at least three
6191	operations where the last three are defined as: (1) powering up and
6192	starting TCP server, (2) waiting for incoming teleportations, and
6193	(3) perform teleportation. These operations will be reflected as the
6194	last three operations of the progress objected returned by
6195	<link to="IMachine::launchVMProcess"/> as well.
6196
6197	<see>#saveState</see>
6198
6199	<result name="VBOX_E_INVALID_VM_STATE">
6200	Virtual machine already running.
6201	</result>
6202	<result name="VBOX_E_HOST_ERROR">
6203	Host interface does not exist or name not set.
6204	</result>
6205	<result name="VBOX_E_FILE_ERROR">
6206	Invalid saved state file.
6207	</result>
6208	</desc>
6209	<param name="progress" type="IProgress" dir="return">
6210	<desc>Progress object to track the operation completion.</desc>
6211	</param>
6212	</method>
6213
6214	<method name="powerUpPaused">
6215	<desc>
6216	Identical to powerUp except that the VM will enter the
6217	<link to="MachineState_Paused"/> state, instead of
6218	<link to="MachineState_Running"/>.
6219
6220	<see>#powerUp</see>
6221	<result name="VBOX_E_INVALID_VM_STATE">
6222	Virtual machine already running.
6223	</result>
6224	<result name="VBOX_E_HOST_ERROR">
6225	Host interface does not exist or name not set.
6226	</result>
6227	<result name="VBOX_E_FILE_ERROR">
6228	Invalid saved state file.
6229	</result>
6230	</desc>
6231	<param name="progress" type="IProgress" dir="return">
6232	<desc>Progress object to track the operation completion.</desc>
6233	</param>
6234	</method>
6235
6236	<method name="powerDown">
6237	<desc>
6238	Initiates the power down procedure to stop the virtual machine
6239	execution.
6240
6241	The completion of the power down procedure is tracked using the returned
6242	IProgress object. After the operation is complete, the machine will go
6243	to the PoweredOff state.
6244	<result name="VBOX_E_INVALID_VM_STATE">
6245	Virtual machine must be Running, Paused or Stuck to be powered down.
6246	</result>
6247	</desc>
6248	<param name="progress" type="IProgress" dir="return">
6249	<desc>Progress object to track the operation completion.</desc>
6250	</param>
6251	</method>
6252
6253	<method name="reset">
6254	<desc>Resets the virtual machine.
6255	<result name="VBOX_E_INVALID_VM_STATE">
6256	Virtual machine not in Running state.
6257	</result>
6258	<result name="VBOX_E_VM_ERROR">
6259	Virtual machine error in reset operation.
6260	</result>
6261	</desc>
6262	</method>
6263
6264	<method name="pause">
6265	<desc>Pauses the virtual machine execution.
6266	<result name="VBOX_E_INVALID_VM_STATE">
6267	Virtual machine not in Running state.
6268	</result>
6269	<result name="VBOX_E_VM_ERROR">
6270	Virtual machine error in suspend operation.
6271	</result>
6272	</desc>
6273	</method>
6274
6275	<method name="resume">
6276	<desc>Resumes the virtual machine execution.
6277	<result name="VBOX_E_INVALID_VM_STATE">
6278	Virtual machine not in Paused state.
6279	</result>
6280	<result name="VBOX_E_VM_ERROR">
6281	Virtual machine error in resume operation.
6282	</result>
6283	</desc>
6284	</method>
6285
6286	<method name="powerButton">
6287	<desc>Sends the ACPI power button event to the guest.
6288	<result name="VBOX_E_INVALID_VM_STATE">
6289	Virtual machine not in Running state.
6290	</result>
6291	<result name="VBOX_E_PDM_ERROR">
6292	Controlled power off failed.
6293	</result>
6294	</desc>
6295	</method>
6296
6297	<method name="sleepButton">
6298	<desc>Sends the ACPI sleep button event to the guest.
6299	<result name="VBOX_E_INVALID_VM_STATE">
6300	Virtual machine not in Running state.
6301	</result>
6302	<result name="VBOX_E_PDM_ERROR">
6303	Sending sleep button event failed.
6304	</result>
6305	</desc>
6306	</method>
6307
6308	<method name="getPowerButtonHandled">
6309	<desc>Checks if the last power button event was handled by guest.
6310	<result name="VBOX_E_PDM_ERROR">
6311	Checking if the event was handled by the guest OS failed.
6312	</result>
6313	</desc>
6314	<param name="handled" type="boolean" dir="return"/>
6315	</method>
6316
6317	<method name="getGuestEnteredACPIMode">
6318	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6319	G1 (sleeping). If this method returns @c false, the guest will
6320	most likely not respond to external ACPI events.
6321	<result name="VBOX_E_INVALID_VM_STATE">
6322	Virtual machine not in Running state.
6323	</result>
6324	</desc>
6325	<param name="entered" type="boolean" dir="return"/>
6326	</method>
6327
6328	<method name="saveState">
6329	<desc>
6330	Saves the current execution state of a running virtual machine
6331	and stops its execution.
6332
6333	After this operation completes, the machine will go to the
6334	Saved state. Next time it is powered up, this state will
6335	be restored and the machine will continue its execution from
6336	the place where it was saved.
6337
6338	This operation differs from taking a snapshot to the effect
6339	that it doesn't create new differencing media. Also, once
6340	the machine is powered up from the state saved using this method,
6341	the saved state is deleted, so it will be impossible to return
6342	to this state later.
6343
6344	<note>
6345	On success, this method implicitly calls
6346	<link to="IMachine::saveSettings"/> to save all current machine
6347	settings (including runtime changes to the DVD medium, etc.).
6348	Together with the impossibility to change any VM settings when it is
6349	in the Saved state, this guarantees adequate hardware
6350	configuration of the machine when it is restored from the saved
6351	state file.
6352	</note>
6353
6354	<note>
6355	The machine must be in the Running or Paused state, otherwise
6356	the operation will fail.
6357	</note>
6358	<result name="VBOX_E_INVALID_VM_STATE">
6359	Virtual machine state neither Running nor Paused.
6360	</result>
6361	<result name="VBOX_E_FILE_ERROR">
6362	Failed to create directory for saved state file.
6363	</result>
6364
6365	<see><link to="#takeSnapshot"/></see>
6366	</desc>
6367	<param name="progress" type="IProgress" dir="return">
6368	<desc>Progress object to track the operation completion.</desc>
6369	</param>
6370	</method>
6371
6372	<method name="adoptSavedState">
6373	<desc>
6374	Associates the given saved state file to the virtual machine.
6375
6376	On success, the machine will go to the Saved state. Next time it is
6377	powered up, it will be restored from the adopted saved state and
6378	continue execution from the place where the saved state file was
6379	created.
6380
6381	The specified saved state file path may be absolute or relative to the
6382	folder the VM normally saves the state to (usually,
6383	<link to="IMachine::snapshotFolder"/>).
6384
6385	<note>
6386	It's a caller's responsibility to make sure the given saved state
6387	file is compatible with the settings of this virtual machine that
6388	represent its virtual hardware (memory size, storage disk configuration
6389	etc.). If there is a mismatch, the behavior of the virtual machine
6390	is undefined.
6391	</note>
6392	<result name="VBOX_E_INVALID_VM_STATE">
6393	Virtual machine state neither PoweredOff nor Aborted.
6394	</result>
6395	</desc>
6396	<param name="savedStateFile" type="wstring" dir="in">
6397	<desc>Path to the saved state file to adopt.</desc>
6398	</param>
6399	</method>
6400
6401	<method name="discardSavedState">
6402	<desc>
6403	Forcibly resets the machine to "Powered Off" state if it is
6404	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6405	Next time the machine is powered up, a clean boot will occur.
6406	<note>
6407	This operation is equivalent to resetting or powering off
6408	the machine without doing a proper shutdown of the guest
6409	operating system; as with resetting a running phyiscal
6410	computer, it can can lead to data loss.
6411	</note>
6412	If @a fRemoveFile is @c true, the file in the machine directory
6413	into which the machine state was saved is also deleted. If
6414	this is @c false, then the state can be recovered and later
6415	re-inserted into a machine using <link to="#adoptSavedState" />.
6416	The location of the file can be found in the
6417	<link to="IMachine::stateFilePath" /> attribute.
6418	<result name="VBOX_E_INVALID_VM_STATE">
6419	Virtual machine not in state Saved.
6420	</result>
6421	</desc>
6422	<param name="fRemoveFile" type="boolean" dir="in" >
6423	<desc>Whether to also remove the saved state file.</desc>
6424	</param>
6425	</method>
6426
6427	<method name="getDeviceActivity">
6428	<desc>
6429	Gets the current activity type of a given device or device group.
6430	<result name="E_INVALIDARG">
6431	Invalid device type.
6432	</result>
6433	</desc>
6434	<param name="type" type="DeviceType" dir="in"/>
6435	<param name="activity" type="DeviceActivity" dir="return"/>
6436	</method>
6437
6438	<method name="attachUSBDevice">
6439	<desc>
6440	Attaches a host USB device with the given UUID to the
6441	USB controller of the virtual machine.
6442
6443	The device needs to be in one of the following states:
6444	<link to="USBDeviceState_Busy"/>,
6445	<link to="USBDeviceState_Available"/> or
6446	<link to="USBDeviceState_Held"/>,
6447	otherwise an error is immediately returned.
6448
6449	When the device state is
6450	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6451	be returned if the host computer refuses to release it for some reason.
6452
6453	<see>IUSBController::deviceFilters, USBDeviceState</see>
6454	<result name="VBOX_E_INVALID_VM_STATE">
6455	Virtual machine state neither Running nor Paused.
6456	</result>
6457	<result name="VBOX_E_PDM_ERROR">
6458	Virtual machine does not have a USB controller.
6459	</result>
6460	</desc>
6461	<param name="id" type="uuid" mod="string" dir="in">
6462	<desc>UUID of the host USB device to attach.</desc>
6463	</param>
6464	</method>
6465
6466	<method name="detachUSBDevice">
6467	<desc>
6468	Detaches an USB device with the given UUID from the USB controller
6469	of the virtual machine.
6470
6471	After this method succeeds, the VirtualBox server re-initiates
6472	all USB filters as if the device were just physically attached
6473	to the host, but filters of this machine are ignored to avoid
6474	a possible automatic re-attachment.
6475
6476	<see>IUSBController::deviceFilters, USBDeviceState</see>
6477
6478	<result name="VBOX_E_PDM_ERROR">
6479	Virtual machine does not have a USB controller.
6480	</result>
6481	<result name="E_INVALIDARG">
6482	USB device not attached to this virtual machine.
6483	</result>
6484	</desc>
6485	<param name="id" type="uuid" mod="string" dir="in">
6486	<desc>UUID of the USB device to detach.</desc>
6487	</param>
6488	<param name="device" type="IUSBDevice" dir="return">
6489	<desc>Detached USB device.</desc>
6490	</param>
6491	</method>
6492
6493	<method name="findUSBDeviceByAddress">
6494	<desc>
6495	Searches for a USB device with the given host address.
6496
6497	<result name="VBOX_E_OBJECT_NOT_FOUND">
6498	Given @c name does not correspond to any USB device.
6499	</result>
6500
6501	<see>IUSBDevice::address</see>
6502	</desc>
6503	<param name="name" type="wstring" dir="in">
6504	<desc>
6505	Address of the USB device (as assigned by the host) to
6506	search for.
6507	</desc>
6508	</param>
6509	<param name="device" type="IUSBDevice" dir="return">
6510	<desc>Found USB device object.</desc>
6511	</param>
6512	</method>
6513
6514	<method name="findUSBDeviceById">
6515	<desc>
6516	Searches for a USB device with the given UUID.
6517
6518	<result name="VBOX_E_OBJECT_NOT_FOUND">
6519	Given @c id does not correspond to any USB device.
6520	</result>
6521
6522	<see>IUSBDevice::id</see>
6523	</desc>
6524	<param name="id" type="uuid" mod="string" dir="in">
6525	<desc>UUID of the USB device to search for.</desc>
6526	</param>
6527	<param name="device" type="IUSBDevice" dir="return">
6528	<desc>Found USB device object.</desc>
6529	</param>
6530	</method>
6531
6532	<method name="createSharedFolder">
6533	<desc>
6534	Creates a transient new shared folder by associating the given logical
6535	name with the given host path, adds it to the collection of shared
6536	folders and starts sharing it. Refer to the description of
6537	<link to="ISharedFolder"/> to read more about logical names.
6538
6539	<result name="VBOX_E_INVALID_VM_STATE">
6540	Virtual machine in Saved state or currently changing state.
6541	</result>
6542	<result name="VBOX_E_FILE_ERROR">
6543	Shared folder already exists or not accessible.
6544	</result>
6545	</desc>
6546	<param name="name" type="wstring" dir="in">
6547	<desc>Unique logical name of the shared folder.</desc>
6548	</param>
6549	<param name="hostPath" type="wstring" dir="in">
6550	<desc>Full path to the shared folder in the host file system.</desc>
6551	</param>
6552	<param name="writable" type="boolean" dir="in">
6553	<desc>Whether the share is writable or readonly</desc>
6554	</param>
6555	<param name="automount" type="boolean" dir="in">
6556	<desc>Whether the share gets automatically mounted by the guest
6557	or not.</desc>
6558	</param>
6559	</method>
6560
6561	<method name="removeSharedFolder">
6562	<desc>
6563	Removes a transient shared folder with the given name previously
6564	created by <link to="#createSharedFolder"/> from the collection of
6565	shared folders and stops sharing it.
6566	<result name="VBOX_E_INVALID_VM_STATE">
6567	Virtual machine in Saved state or currently changing state.
6568	</result>
6569	<result name="VBOX_E_FILE_ERROR">
6570	Shared folder does not exists.
6571	</result>
6572	</desc>
6573	<param name="name" type="wstring" dir="in">
6574	<desc>Logical name of the shared folder to remove.</desc>
6575	</param>
6576	</method>
6577
6578	<method name="takeSnapshot">
6579	<desc>
6580	Saves the current execution state
6581	and all settings of the machine and creates differencing images
6582	for all normal (non-independent) media.
6583	See <link to="ISnapshot" /> for an introduction to snapshots.
6584
6585	This method can be called for a PoweredOff, Saved (see
6586	<link to="#saveState"/>), Running or
6587	Paused virtual machine. When the machine is PoweredOff, an
6588	offline snapshot is created. When the machine is Running a live
6589	snapshot is created, and an online snapshot is is created when Paused.
6590
6591	The taken snapshot is always based on the
6592	<link to="IMachine::currentSnapshot">current snapshot</link>
6593	of the associated virtual machine and becomes a new current snapshot.
6594
6595	<note>
6596	This method implicitly calls <link to="IMachine::saveSettings"/> to
6597	save all current machine settings before taking an offline snapshot.
6598	</note>
6599
6600	<result name="VBOX_E_INVALID_VM_STATE">
6601	Virtual machine currently changing state.
6602	</result>
6603	</desc>
6604	<param name="name" type="wstring" dir="in">
6605	<desc>Short name for the snapshot.</desc>
6606	</param>
6607	<param name="description" type="wstring" dir="in">
6608	<desc>Optional description of the snapshot.</desc>
6609	</param>
6610	<param name="progress" type="IProgress" dir="return">
6611	<desc>Progress object to track the operation completion.</desc>
6612	</param>
6613	</method>
6614
6615	<method name="deleteSnapshot">
6616	<desc>
6617	Starts deleting the specified snapshot asynchronously.
6618	See <link to="ISnapshot" /> for an introduction to snapshots.
6619
6620	The execution state and settings of the associated machine stored in
6621	the snapshot will be deleted. The contents of all differencing media of
6622	this snapshot will be merged with the contents of their dependent child
6623	media to keep the medium chain valid (in other words, all changes
6624	represented by media being deleted will be propagated to their child
6625	medium). After that, this snapshot's differencing medium will be
6626	deleted. The parent of this snapshot will become a new parent for all
6627	its child snapshots.
6628
6629	If the deleted snapshot is the current one, its parent snapshot will
6630	become a new current snapshot. The current machine state is not directly
6631	affected in this case, except that currently attached differencing
6632	media based on media of the deleted snapshot will be also merged as
6633	described above.
6634
6635	If the deleted snapshot is the first or current snapshot, then the
6636	respective IMachine attributes will be adjusted. Deleting the current
6637	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6638	to make all current machine settings permanent.
6639
6640	Deleting a snapshot has the following preconditions:
6641
6642	<ul>
6643	<li>Child media of all normal media of the deleted snapshot
6644	must be accessible (see <link to="IMedium::state"/>) for this
6645	operation to succeed. In particular, this means that all virtual
6646	machines whose media are directly or indirectly based on the
6647	media of deleted snapshot must be powered off.</li>
6648
6649	<li>You cannot delete the snapshot if a medium attached to it has
6650	more than once child medium (differencing images) because otherwise
6651	merging would be impossible. This might be the case if there is
6652	more than one child snapshot or differencing images were created
6653	for other reason (e.g. implicitly because of multiple machine
6654	attachments).</li>
6655	</ul>
6656
6657
6658	The virtual machine's <link to="IMachine::state">state</link> is
6659	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6660	"DeletingSnapshotPaused" while this operation is in progress.
6661
6662	<note>
6663	Merging medium contents can be very time and disk space
6664	consuming, if these media are big in size and have many
6665	children. However, if the snapshot being deleted is the last
6666	(head) snapshot on the branch, the operation will be rather
6667	quick.
6668	</note>
6669	<result name="VBOX_E_INVALID_VM_STATE">
6670	The running virtual machine prevents deleting this snapshot. This
6671	happens only in very specific situations, usually snapshots can be
6672	deleted without trouble while a VM is running. The error message
6673	text explains the reason for the failure.
6674	</result>
6675	</desc>
6676	<param name="id" type="uuid" mod="string" dir="in">
6677	<desc>UUID of the snapshot to delete.</desc>
6678	</param>
6679	<param name="progress" type="IProgress" dir="return">
6680	<desc>Progress object to track the operation completion.</desc>
6681	</param>
6682	</method>
6683
6684	<method name="restoreSnapshot">
6685	<desc>
6686	Starts resetting the machine's current state to the state contained
6687	in the given snapshot, asynchronously. All current settings of the
6688	machine will be reset and changes stored in differencing media
6689	will be lost.
6690	See <link to="ISnapshot" /> for an introduction to snapshots.
6691
6692	After this operation is successfully completed, new empty differencing
6693	media are created for all normal media of the machine.
6694
6695	If the given snapshot is an online snapshot, the machine will go to
6696	the <link to="MachineState_Saved"> saved state</link>, so that the
6697	next time it is powered on, the execution state will be restored
6698	from the state of the snapshot.
6699
6700	<note>
6701	The machine must not be running, otherwise the operation will fail.
6702	</note>
6703
6704	<note>
6705	If the machine state is <link to="MachineState_Saved">Saved</link>
6706	prior to this operation, the saved state file will be implicitly
6707	deleted (as if <link to="IConsole::discardSavedState"/> were
6708	called).
6709	</note>
6710
6711	<result name="VBOX_E_INVALID_VM_STATE">
6712	Virtual machine is running.
6713	</result>
6714	</desc>
6715	<param name="snapshot" type="ISnapshot" dir="in">
6716	<desc>The snapshot to restore the VM state from.</desc>
6717	</param>
6718	<param name="progress" type="IProgress" dir="return">
6719	<desc>Progress object to track the operation completion.</desc>
6720	</param>
6721	</method>
6722
6723	<method name="teleport">
6724	<desc>
6725	Teleport the VM to a different host machine or process.
6726
6727	TODO explain the details.
6728
6729	<result name="VBOX_E_INVALID_VM_STATE">
6730	Virtual machine not running or paused.
6731	</result>
6732	</desc>
6733	<param name="hostname" type="wstring" dir="in">
6734	<desc>The name or IP of the host to teleport to.</desc>
6735	</param>
6736	<param name="tcpport" type="unsigned long" dir="in">
6737	<desc>The TCP port to connect to (1..65535).</desc>
6738	</param>
6739	<param name="password" type="wstring" dir="in">
6740	<desc>The password.</desc>
6741	</param>
6742	<param name="maxDowntime" type="unsigned long" dir="in">
6743	<desc>
6744	The maximum allowed downtime given as milliseconds. 0 is not a valid
6745	value. Recommended value: 250 ms.
6746
6747	The higher the value is, the greater the chance for a successful
6748	teleportation. A small value may easily result in the teleportation
6749	process taking hours and eventually fail.
6750
6751	<note>
6752	The current implementation treats this a guideline, not as an
6753	absolute rule.
6754	</note>
6755	</desc>
6756	</param>
6757	<param name="progress" type="IProgress" dir="return">
6758	<desc>Progress object to track the operation completion.</desc>
6759	</param>
6760	</method>
6761
6762	</interface>
6763
6764	<!--
6765	// IHost
6766	/////////////////////////////////////////////////////////////////////////
6767	-->
6768
6769	<enum
6770	name="HostNetworkInterfaceMediumType"
6771	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6772	>
6773	<desc>
6774	Type of encapsulation. Ethernet encapsulation includes both wired and
6775	wireless Ethernet connections.
6776	<see>IHostNetworkInterface</see>
6777	</desc>
6778
6779	<const name="Unknown" value="0">
6780	<desc>
6781	The type of interface cannot be determined.
6782	</desc>
6783	</const>
6784	<const name="Ethernet" value="1">
6785	<desc>
6786	Ethernet frame encapsulation.
6787	</desc>
6788	</const>
6789	<const name="PPP" value="2">
6790	<desc>
6791	Point-to-point protocol encapsulation.
6792	</desc>
6793	</const>
6794	<const name="SLIP" value="3">
6795	<desc>
6796	Serial line IP encapsulation.
6797	</desc>
6798	</const>
6799	</enum>
6800
6801	<enum
6802	name="HostNetworkInterfaceStatus"
6803	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6804	>
6805	<desc>
6806	Current status of the interface.
6807	<see>IHostNetworkInterface</see>
6808	</desc>
6809
6810	<const name="Unknown" value="0">
6811	<desc>
6812	The state of interface cannot be determined.
6813	</desc>
6814	</const>
6815	<const name="Up" value="1">
6816	<desc>
6817	The interface is fully operational.
6818	</desc>
6819	</const>
6820	<const name="Down" value="2">
6821	<desc>
6822	The interface is not functioning.
6823	</desc>
6824	</const>
6825	</enum>
6826
6827	<enum
6828	name="HostNetworkInterfaceType"
6829	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6830	>
6831	<desc>
6832	Network interface type.
6833	</desc>
6834	<const name="Bridged" value="1"/>
6835	<const name="HostOnly" value="2"/>
6836	</enum>
6837
6838	<interface
6839	name="IHostNetworkInterface" extends="$unknown"
6840	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6841	wsmap="managed"
6842	>
6843	<desc>
6844	Represents one of host's network interfaces. IP V6 address and network
6845	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6846	separated by colons.
6847	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6848	</desc>
6849	<attribute name="name" type="wstring" readonly="yes">
6850	<desc>Returns the host network interface name.</desc>
6851	</attribute>
6852
6853	<attribute name="id" type="uuid" mod="string" readonly="yes">
6854	<desc>Returns the interface UUID.</desc>
6855	</attribute>
6856
6857	<attribute name="networkName" type="wstring" readonly="yes">
6858	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6859	</attribute>
6860
6861	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6862	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6863	</attribute>
6864
6865	<attribute name="IPAddress" type="wstring" readonly="yes">
6866	<desc>Returns the IP V4 address of the interface.</desc>
6867	</attribute>
6868
6869	<attribute name="networkMask" type="wstring" readonly="yes">
6870	<desc>Returns the network mask of the interface.</desc>
6871	</attribute>
6872
6873	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6874	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6875	</attribute>
6876
6877	<attribute name="IPV6Address" type="wstring" readonly="yes">
6878	<desc>Returns the IP V6 address of the interface.</desc>
6879	</attribute>
6880
6881	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6882	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6883	</attribute>
6884
6885	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6886	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6887	</attribute>
6888
6889	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6890	<desc>Type of protocol encapsulation used.</desc>
6891	</attribute>
6892
6893	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6894	<desc>Status of the interface.</desc>
6895	</attribute>
6896
6897	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6898	<desc>specifies the host interface type.</desc>
6899	</attribute>
6900
6901	<method name="enableStaticIpConfig">
6902	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6903	<param name="IPAddress" type="wstring" dir="in">
6904	<desc>
6905	IP address.
6906	</desc>
6907	</param>
6908	<param name="networkMask" type="wstring" dir="in">
6909	<desc>
6910	network mask.
6911	</desc>
6912	</param>
6913	</method>
6914
6915	<method name="enableStaticIpConfigV6">
6916	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6917	<param name="IPV6Address" type="wstring" dir="in">
6918	<desc>
6919	IP address.
6920	</desc>
6921	</param>
6922	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6923	<desc>
6924	network mask.
6925	</desc>
6926	</param>
6927	</method>
6928
6929	<method name="enableDynamicIpConfig">
6930	<desc>enables the dynamic IP configuration.</desc>
6931	</method>
6932
6933	<method name="dhcpRediscover">
6934	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6935	</method>
6936
6937	</interface>
6938
6939	<interface
6940	name="IHost" extends="$unknown"
6941	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
6942	wsmap="managed"
6943	>
6944	<desc>
6945	The IHost interface represents the physical machine that this VirtualBox
6946	installation runs on.
6947
6948	An object implementing this interface is returned by the
6949	<link to="IVirtualBox::host" /> attribute. This interface contains
6950	read-only information about the host's physical hardware (such as what
6951	processors and disks are available, what the host operating system is,
6952	and so on) and also allows for manipulating some of the host's hardware,
6953	such as global USB device filters and host interface networking.
6954
6955	</desc>
6956	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6957	<desc>List of DVD drives available on the host.</desc>
6958	</attribute>
6959
6960	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6961	<desc>List of floppy drives available on the host.</desc>
6962	</attribute>
6963
6964	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6965	<desc>
6966	List of USB devices currently attached to the host.
6967	Once a new device is physically attached to the host computer,
6968	it appears in this list and remains there until detached.
6969
6970	<note>
6971	If USB functionality is not available in the given edition of
6972	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6973	</note>
6974	</desc>
6975	</attribute>
6976
6977	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6978	<desc>
6979	List of USB device filters in action.
6980	When a new device is physically attached to the host computer,
6981	filters from this list are applied to it (in order they are stored
6982	in the list). The first matched filter will determine the
6983	<link to="IHostUSBDeviceFilter::action">action</link>
6984	performed on the device.
6985
6986	Unless the device is ignored by these filters, filters of all
6987	currently running virtual machines
6988	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6989
6990	<note>
6991	If USB functionality is not available in the given edition of
6992	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6993	</note>
6994
6995	<see>IHostUSBDeviceFilter, USBDeviceState</see>
6996	</desc>
6997	</attribute>
6998
6999	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7000	<desc>List of host network interfaces currently defined on the host.</desc>
7001	</attribute>
7002
7003	<attribute name="processorCount" type="unsigned long" readonly="yes">
7004	<desc>Number of (logical) CPUs installed in the host system.</desc>
7005	</attribute>
7006
7007	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7008	<desc>Number of (logical) CPUs online in the host system.</desc>
7009	</attribute>
7010
7011	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7012	<desc>Number of physical processor cores installed in the host system.</desc>
7013	</attribute>
7014
7015	<method name="getProcessorSpeed">
7016	<desc>Query the (approximate) maximum speed of a specified host CPU in
7017	Megahertz.
7018	</desc>
7019	<param name="cpuId" type="unsigned long" dir="in">
7020	<desc>
7021	Identifier of the CPU.
7022	</desc>
7023	</param>
7024	<param name="speed" type="unsigned long" dir="return">
7025	<desc>
7026	Speed value. 0 is returned if value is not known or @a cpuId is
7027	invalid.
7028	</desc>
7029	</param>
7030	</method>
7031
7032	<method name="getProcessorFeature">
7033	<desc>Query whether a CPU feature is supported or not.</desc>
7034	<param name="feature" type="ProcessorFeature" dir="in">
7035	<desc>
7036	CPU Feature identifier.
7037	</desc>
7038	</param>
7039	<param name="supported" type="boolean" dir="return">
7040	<desc>
7041	Feature is supported or not.
7042	</desc>
7043	</param>
7044	</method>
7045
7046	<method name="getProcessorDescription">
7047	<desc>Query the model string of a specified host CPU.
7048	</desc>
7049	<param name="cpuId" type="unsigned long" dir="in">
7050	<desc>
7051	Identifier of the CPU.
7052	<note>
7053	The current implementation might not necessarily return the
7054	description for this exact CPU.
7055	</note>
7056	</desc>
7057	</param>
7058	<param name="description" type="wstring" dir="return">
7059	<desc>
7060	Model string. An empty string is returned if value is not known or
7061	@a cpuId is invalid.
7062	</desc>
7063	</param>
7064	</method>
7065
7066	<method name="getProcessorCPUIDLeaf">
7067	<desc>
7068	Returns the CPU cpuid information for the specified leaf.
7069	</desc>
7070	<param name="cpuId" type="unsigned long" dir="in">
7071	<desc>
7072	Identifier of the CPU. The CPU most be online.
7073	<note>
7074	The current implementation might not necessarily return the
7075	description for this exact CPU.
7076	</note>
7077	</desc>
7078	</param>
7079	<param name="leaf" type="unsigned long" dir="in">
7080	<desc>
7081	CPUID leaf index (eax).
7082	</desc>
7083	</param>
7084	<param name="subLeaf" type="unsigned long" dir="in">
7085	<desc>
7086	CPUID leaf sub index (ecx). This currently only applies to cache
7087	information on Intel CPUs. Use 0 if retrieving values for
7088	<link to="IMachine::setCPUIDLeaf"/>.
7089	</desc>
7090	</param>
7091	<param name="valEax" type="unsigned long" dir="out">
7092	<desc>
7093	CPUID leaf value for register eax.
7094	</desc>
7095	</param>
7096	<param name="valEbx" type="unsigned long" dir="out">
7097	<desc>
7098	CPUID leaf value for register ebx.
7099	</desc>
7100	</param>
7101	<param name="valEcx" type="unsigned long" dir="out">
7102	<desc>
7103	CPUID leaf value for register ecx.
7104	</desc>
7105	</param>
7106	<param name="valEdx" type="unsigned long" dir="out">
7107	<desc>
7108	CPUID leaf value for register edx.
7109	</desc>
7110	</param>
7111	</method>
7112
7113	<attribute name="memorySize" type="unsigned long" readonly="yes">
7114	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7115	</attribute>
7116
7117	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7118	<desc>Available system memory in the host system.</desc>
7119	</attribute>
7120
7121	<attribute name="operatingSystem" type="wstring" readonly="yes">
7122	<desc>Name of the host system's operating system.</desc>
7123	</attribute>
7124
7125	<attribute name="OSVersion" type="wstring" readonly="yes">
7126	<desc>Host operating system's version string.</desc>
7127	</attribute>
7128
7129	<attribute name="UTCTime" type="long long" readonly="yes">
7130	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7131	</attribute>
7132
7133	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7134	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7135	</attribute>
7136
7137	<method name="createHostOnlyNetworkInterface">
7138	<desc>
7139	Creates a new adapter for Host Only Networking.
7140	<result name="E_INVALIDARG">
7141	Host network interface @a name already exists.
7142	</result>
7143	</desc>
7144	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7145	<desc>
7146	Created host interface object.
7147	</desc>
7148	</param>
7149	<param name="progress" type="IProgress" dir="return">
7150	<desc>
7151	Progress object to track the operation completion.
7152	</desc>
7153	</param>
7154	</method>
7155
7156	<method name="removeHostOnlyNetworkInterface">
7157	<desc>
7158	Removes the given Host Only Networking interface.
7159	<result name="VBOX_E_OBJECT_NOT_FOUND">
7160	No host network interface matching @a id found.
7161	</result>
7162	</desc>
7163	<param name="id" type="uuid" mod="string" dir="in">
7164	<desc>
7165	Adapter GUID.
7166	</desc>
7167	</param>
7168	<param name="progress" type="IProgress" dir="return">
7169	<desc>
7170	Progress object to track the operation completion.
7171	</desc>
7172	</param>
7173	</method>
7174
7175	<method name="createUSBDeviceFilter">
7176	<desc>
7177	Creates a new USB device filter. All attributes except
7178	the filter name are set to empty (any match),
7179	<i>active</i> is @c false (the filter is not active).
7180
7181	The created filter can be added to the list of filters using
7182	<link to="#insertUSBDeviceFilter"/>.
7183
7184	<see>#USBDeviceFilters</see>
7185	</desc>
7186	<param name="name" type="wstring" dir="in">
7187	<desc>
7188	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7189	</desc>
7190	</param>
7191	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7192	<desc>Created filter object.</desc>
7193	</param>
7194	</method>
7195
7196	<method name="insertUSBDeviceFilter">
7197	<desc>
7198	Inserts the given USB device to the specified position
7199	in the list of filters.
7200
7201	Positions are numbered starting from @c 0. If the specified
7202	position is equal to or greater than the number of elements in
7203	the list, the filter is added at the end of the collection.
7204
7205	<note>
7206	Duplicates are not allowed, so an attempt to insert a
7207	filter already in the list is an error.
7208	</note>
7209	<note>
7210	If USB functionality is not available in the given edition of
7211	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7212	</note>
7213
7214	<see>#USBDeviceFilters</see>
7215
7216	<result name="VBOX_E_INVALID_OBJECT_STATE">
7217	USB device filter is not created within this VirtualBox instance.
7218	</result>
7219	<result name="E_INVALIDARG">
7220	USB device filter already in list.
7221	</result>
7222
7223	</desc>
7224	<param name="position" type="unsigned long" dir="in">
7225	<desc>Position to insert the filter to.</desc>
7226	</param>
7227	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7228	<desc>USB device filter to insert.</desc>
7229	</param>
7230	</method>
7231
7232	<method name="removeUSBDeviceFilter">
7233	<desc>
7234	Removes a USB device filter from the specified position in the
7235	list of filters.
7236
7237	Positions are numbered starting from @c 0. Specifying a
7238	position equal to or greater than the number of elements in
7239	the list will produce an error.
7240
7241	<note>
7242	If USB functionality is not available in the given edition of
7243	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7244	</note>
7245
7246	<see>#USBDeviceFilters</see>
7247
7248	<result name="E_INVALIDARG">
7249	USB device filter list empty or invalid @a position.
7250	</result>
7251
7252	</desc>
7253	<param name="position" type="unsigned long" dir="in">
7254	<desc>Position to remove the filter from.</desc>
7255	</param>
7256	</method>
7257
7258	<method name="findHostDVDDrive">
7259	<desc>
7260	Searches for a host DVD drive with the given @c name.
7261
7262	<result name="VBOX_E_OBJECT_NOT_FOUND">
7263	Given @c name does not correspond to any host drive.
7264	</result>
7265
7266	</desc>
7267	<param name="name" type="wstring" dir="in">
7268	<desc>Name of the host drive to search for</desc>
7269	</param>
7270	<param name="drive" type="IMedium" dir="return">
7271	<desc>Found host drive object</desc>
7272	</param>
7273	</method>
7274
7275	<method name="findHostFloppyDrive">
7276	<desc>
7277	Searches for a host floppy drive with the given @c name.
7278
7279	<result name="VBOX_E_OBJECT_NOT_FOUND">
7280	Given @c name does not correspond to any host floppy drive.
7281	</result>
7282
7283	</desc>
7284	<param name="name" type="wstring" dir="in">
7285	<desc>Name of the host floppy drive to search for</desc>
7286	</param>
7287	<param name="drive" type="IMedium" dir="return">
7288	<desc>Found host floppy drive object</desc>
7289	</param>
7290	</method>
7291
7292	<method name="findHostNetworkInterfaceByName">
7293	<desc>
7294	Searches through all host network interfaces for an interface with
7295	the given @c name.
7296	<note>
7297	The method returns an error if the given @c name does not
7298	correspond to any host network interface.
7299	</note>
7300	</desc>
7301	<param name="name" type="wstring" dir="in">
7302	<desc>Name of the host network interface to search for.</desc>
7303	</param>
7304	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7305	<desc>Found host network interface object.</desc>
7306	</param>
7307	</method>
7308	<method name="findHostNetworkInterfaceById">
7309	<desc>
7310	Searches through all host network interfaces for an interface with
7311	the given GUID.
7312	<note>
7313	The method returns an error if the given GUID does not
7314	correspond to any host network interface.
7315	</note>
7316	</desc>
7317	<param name="id" type="uuid" mod="string" dir="in">
7318	<desc>GUID of the host network interface to search for.</desc>
7319	</param>
7320	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7321	<desc>Found host network interface object.</desc>
7322	</param>
7323	</method>
7324	<method name="findHostNetworkInterfacesOfType">
7325	<desc>
7326	Searches through all host network interfaces and returns a list of interfaces of the specified type
7327	</desc>
7328	<param name="type" type="HostNetworkInterfaceType" dir="in">
7329	<desc>type of the host network interfaces to search for.</desc>
7330	</param>
7331	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7332	<desc>Found host network interface objects.</desc>
7333	</param>
7334	</method>
7335
7336	<method name="findUSBDeviceById">
7337	<desc>
7338	Searches for a USB device with the given UUID.
7339
7340	<result name="VBOX_E_OBJECT_NOT_FOUND">
7341	Given @c id does not correspond to any USB device.
7342	</result>
7343
7344	<see>IHostUSBDevice::id</see>
7345	</desc>
7346	<param name="id" type="uuid" mod="string" dir="in">
7347	<desc>UUID of the USB device to search for.</desc>
7348	</param>
7349	<param name="device" type="IHostUSBDevice" dir="return">
7350	<desc>Found USB device object.</desc>
7351	</param>
7352	</method>
7353
7354	<method name="findUSBDeviceByAddress">
7355	<desc>
7356	Searches for a USB device with the given host address.
7357
7358	<result name="VBOX_E_OBJECT_NOT_FOUND">
7359	Given @c name does not correspond to any USB device.
7360	</result>
7361
7362	<see>IHostUSBDevice::address</see>
7363	</desc>
7364	<param name="name" type="wstring" dir="in">
7365	<desc>
7366	Address of the USB device (as assigned by the host) to
7367	search for.
7368	</desc>
7369	</param>
7370	<param name="device" type="IHostUSBDevice" dir="return">
7371	<desc>Found USB device object.</desc>
7372	</param>
7373	</method>
7374
7375	<method name="generateMACAddress">
7376	<desc>
7377	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7378	</desc>
7379	<param name="address" type="wstring" dir="return">
7380	<desc>New Ethernet MAC address.</desc>
7381	</param>
7382	</method>
7383
7384	</interface>
7385
7386	<!--
7387	// ISystemProperties
7388	/////////////////////////////////////////////////////////////////////////
7389	-->
7390
7391	<interface
7392	name="ISystemProperties"
7393	extends="$unknown"
7394	uuid="2f89cdfe-2d10-43d4-b37f-61760f877f29"
7395	wsmap="managed"
7396	>
7397	<desc>
7398	The ISystemProperties interface represents global properties of the given
7399	VirtualBox installation.
7400
7401	These properties define limits and default values for various attributes
7402	and parameters. Most of the properties are read-only, but some can be
7403	changed by a user.
7404	</desc>
7405
7406	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7407	<desc>Minimum guest system memory in Megabytes.</desc>
7408	</attribute>
7409
7410	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7411	<desc>Maximum guest system memory in Megabytes.</desc>
7412	</attribute>
7413
7414	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7415	<desc>Minimum guest video memory in Megabytes.</desc>
7416	</attribute>
7417
7418	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7419	<desc>Maximum guest video memory in Megabytes.</desc>
7420	</attribute>
7421
7422	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7423	<desc>Minimum CPU count.</desc>
7424	</attribute>
7425
7426	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7427	<desc>Maximum CPU count.</desc>
7428	</attribute>
7429
7430	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7431	<desc>Maximum of monitors which could be connected.</desc>
7432	</attribute>
7433
7434	<attribute name="infoVDSize" type="long long" readonly="yes">
7435	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7436	does not reflect the limits of any virtual disk image format.</desc>
7437	</attribute>
7438
7439	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7440	<desc>
7441	Maximum number of serial ports associated with every
7442	<link to="IMachine"/> instance.
7443	</desc>
7444	</attribute>
7445
7446	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7447	<desc>
7448	Maximum number of parallel ports associated with every
7449	<link to="IMachine"/> instance.
7450	</desc>
7451	</attribute>
7452
7453	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7454	<desc>
7455	Maximum device position in the boot order. This value corresponds
7456	to the total number of devices a machine can boot from, to make it
7457	possible to include all possible devices to the boot list.
7458	<see><link to="IMachine::setBootOrder"/></see>
7459	</desc>
7460	</attribute>
7461
7462	<attribute name="defaultMachineFolder" type="wstring">
7463	<desc>
7464	Full path to the default directory used to create new or open
7465	existing machines when a machine settings file name contains no
7466	path.
7467
7468	Starting with VirtualBox 4.0, by default, this attribute contains
7469	the full path of folder named "VirtualBox VMs" in the user's
7470	home directory, which depends on the host platform.
7471
7472	When setting this attribute, a full path must be specified.
7473	Setting this property to @c null or an empty string or the
7474	special value "Machines" (for compatibility reasons) will restore
7475	that default value.
7476
7477	If the folder specified herein does not exist, it will be created
7478	automatically as needed.
7479
7480	<see>
7481	<link to="IVirtualBox::createMachine"/>,
7482	<link to="IVirtualBox::openMachine"/>
7483	</see>
7484	</desc>
7485	</attribute>
7486
7487	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7488	<desc>
7489	List of all medium storage formats supported by this VirtualBox
7490	installation.
7491
7492	Keep in mind that the medium format identifier
7493	(<link to="IMediumFormat::id"/>) used in other API calls like
7494	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7495	medium format is a case-insensitive string. This means that, for
7496	example, all of the following strings:
7497	<pre>
7498	"VDI"
7499	"vdi"
7500	"VdI"</pre>
7501	refer to the same medium format.
7502
7503	Note that the virtual medium framework is backend-based, therefore
7504	the list of supported formats depends on what backends are currently
7505	installed.
7506
7507	<see>
7508	<link to="IMediumFormat"/>,
7509	</see>
7510	</desc>
7511	</attribute>
7512
7513	<attribute name="defaultHardDiskFormat" type="wstring">
7514	<desc>
7515	Identifier of the default medium format used by VirtualBox.
7516
7517	The medium format set by this attribute is used by VirtualBox
7518	when the medium format was not specified explicitly. One example is
7519	<link to="IVirtualBox::createHardDisk"/> with the empty
7520	format argument. A more complex example is implicit creation of
7521	differencing media when taking a snapshot of a virtual machine:
7522	this operation will try to use a format of the parent medium first
7523	and if this format does not support differencing media the default
7524	format specified by this argument will be used.
7525
7526	The list of supported medium formats may be obtained by the
7527	<link to="#mediumFormats"/> call. Note that the default medium
7528	format must have a capability to create differencing media;
7529	otherwise operations that create media implicitly may fail
7530	unexpectedly.
7531
7532	The initial value of this property is <tt>"VDI"</tt> in the current
7533	version of the VirtualBox product, but may change in the future.
7534
7535	<note>
7536	Setting this property to @c null or empty string will restore the
7537	initial value.
7538	</note>
7539
7540	<see>
7541	<link to="#mediumFormats"/>,
7542	<link to="IMediumFormat::id"/>,
7543	<link to="IVirtualBox::createHardDisk"/>
7544	</see>
7545	</desc>
7546	</attribute>
7547
7548	<attribute name="freeDiskSpaceWarning" type="long long">
7549	<desc>Issue a warning if the free disk space is below (or in some disk
7550	intensive operation is expected to go below) the given size in
7551	bytes.</desc>
7552	</attribute>
7553
7554	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7555	<desc>Issue a warning if the free disk space is below (or in some disk
7556	intensive operation is expected to go below) the given percentage.</desc>
7557	</attribute>
7558
7559	<attribute name="freeDiskSpaceError" type="long long">
7560	<desc>Issue an error if the free disk space is below (or in some disk
7561	intensive operation is expected to go below) the given size in
7562	bytes.</desc>
7563	</attribute>
7564
7565	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7566	<desc>Issue an error if the free disk space is below (or in some disk
7567	intensive operation is expected to go below) the given percentage.</desc>
7568	</attribute>
7569
7570	<attribute name="VRDEAuthLibrary" type="wstring">
7571	<desc>
7572	Library that provides authentication for Remote Desktop clients. The library
7573	is used if a virtual machine's authentication type is set to "external"
7574	in the VM RemoteDisplay configuration.
7575
7576	The system library extension (".DLL" or ".so") must be omitted.
7577	A full path can be specified; if not, then the library must reside on the
7578	system's default library path.
7579
7580	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7581	of that name in one of the default VirtualBox library directories.
7582
7583	For details about VirtualBox authentication libraries and how to implement
7584	them, please refer to the VirtualBox manual.
7585
7586	<note>
7587	Setting this property to @c null or empty string will restore the
7588	initial value.
7589	</note>
7590	</desc>
7591	</attribute>
7592
7593	<attribute name="webServiceAuthLibrary" type="wstring">
7594	<desc>
7595	Library that provides authentication for webservice clients. The library
7596	is used if a virtual machine's authentication type is set to "external"
7597	in the VM RemoteDisplay configuration and will be called from
7598	within the <link to="IWebsessionManager::logon" /> implementation.
7599
7600	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7601	there is no per-VM setting for this, as the webservice is a global
7602	resource (if it is running). Only for this setting (for the webservice),
7603	setting this value to a literal <tt>"null"</tt> string disables authentication,
7604	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7605	no matter what user name and password are supplied.
7606
7607	The initial value of this property is <tt>"VBoxAuth"</tt>,
7608	meaning that the webservice will use the same authentication
7609	library that is used by default for VRDE (again, see
7610	<link to="ISystemProperties::VRDEAuthLibrary" />).
7611	The format and calling convention of authentication libraries
7612	is the same for the webservice as it is for VRDE.
7613
7614	<note>
7615	Setting this property to @c null or empty string will restore the
7616	initial value.
7617	</note>
7618	</desc>
7619	</attribute>
7620
7621	<attribute name="defaultVRDEExtPack" type="wstring">
7622	<desc>
7623	The name of the extension pack providing the default VRDE.
7624
7625	This attribute is for choosing between multiple extension packs
7626	providing VRDE. If only one is installed, it will automatically be the
7627	default one. The attribute value can be empty if no VRDE extension
7628	pack is installed.
7629
7630	For details about VirtualBox Remote Desktop Extension and how to
7631	implement one, please refer to the VirtualBox SDK.
7632	</desc>
7633	</attribute>
7634
7635	<attribute name="LogHistoryCount" type="unsigned long">
7636	<desc>
7637	This value specifies how many old release log files are kept.
7638	</desc>
7639	</attribute>
7640
7641	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7642	<desc>This value hold the default audio driver for the current
7643	system.</desc>
7644	</attribute>
7645
7646
7647	<method name="getMaxNetworkAdapters">
7648	<desc>
7649	Maximum total number of network adapters associated with every
7650	<link to="IMachine"/> instance.
7651	</desc>
7652
7653	<param name="chipset" type="ChipsetType" dir="in">
7654	<desc>The chipset type to get the value for.</desc>
7655	</param>
7656
7657
7658	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7659	<desc>The maximum total number of network adapters allowed.</desc>
7660	</param>
7661
7662	</method>
7663
7664	<method name="getMaxNetworkAdaptersOfType">
7665	<desc>
7666	Maximum number of network adapters of a given attachment type,
7667	associated with every <link to="IMachine"/> instance.
7668	</desc>
7669
7670	<param name="chipset" type="ChipsetType" dir="in">
7671	<desc>The chipset type to get the value for.</desc>
7672	</param>
7673
7674	<param name="type" type="NetworkAttachmentType" dir="in">
7675	<desc>Type of attachment.</desc>
7676	</param>
7677
7678	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7679	<desc>The maximum number of network adapters allowed for
7680	particular chipset and attachment type.</desc>
7681	</param>
7682
7683	</method>
7684
7685
7686	<method name="getMaxDevicesPerPortForStorageBus">
7687	<desc>Returns the maximum number of devices which can be attached to a port
7688	for the given storage bus.</desc>
7689
7690	<param name="bus" type="StorageBus" dir="in">
7691	<desc>The storage bus type to get the value for.</desc>
7692	</param>
7693
7694	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7695	<desc>The maximum number of devices which can be attached to the port for the given
7696	storage bus.</desc>
7697	</param>
7698	</method>
7699
7700	<method name="getMinPortCountForStorageBus">
7701	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7702
7703	<param name="bus" type="StorageBus" dir="in">
7704	<desc>The storage bus type to get the value for.</desc>
7705	</param>
7706
7707	<param name="minPortCount" type="unsigned long" dir="return">
7708	<desc>The minimum number of ports for the given storage bus.</desc>
7709	</param>
7710	</method>
7711
7712	<method name="getMaxPortCountForStorageBus">
7713	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7714
7715	<param name="bus" type="StorageBus" dir="in">
7716	<desc>The storage bus type to get the value for.</desc>
7717	</param>
7718
7719	<param name="maxPortCount" type="unsigned long" dir="return">
7720	<desc>The maximum number of ports for the given storage bus.</desc>
7721	</param>
7722	</method>
7723
7724	<method name="getMaxInstancesOfStorageBus">
7725	<desc>Returns the maximum number of storage bus instances which
7726	can be configured for each VM. This corresponds to the number of
7727	storage controllers one can have. Value may depend on chipset type
7728	used.</desc>
7729
7730	<param name="chipset" type="ChipsetType" dir="in">
7731	<desc>The chipset type to get the value for.</desc>
7732	</param>
7733
7734	<param name="bus" type="StorageBus" dir="in">
7735	<desc>The storage bus type to get the value for.</desc>
7736	</param>
7737
7738	<param name="maxInstances" type="unsigned long" dir="return">
7739	<desc>The maximum number of instances for the given storage bus.</desc>
7740	</param>
7741	</method>
7742
7743	<method name="getDeviceTypesForStorageBus">
7744	<desc>Returns list of all the supported device types
7745	(<link to="DeviceType"/>) for the given type of storage
7746	bus.</desc>
7747
7748	<param name="bus" type="StorageBus" dir="in">
7749	<desc>The storage bus type to get the value for.</desc>
7750	</param>
7751
7752	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7753	<desc>The list of all supported device types for the given storage bus.</desc>
7754	</param>
7755	</method>
7756
7757	<method name="getDefaultIoCacheSettingForStorageController">
7758	<desc>Returns the default I/O cache setting for the
7759	given storage controller</desc>
7760
7761	<param name="controllerType" type="StorageControllerType" dir="in">
7762	<desc>The storage controller to the setting for.</desc>
7763	</param>
7764
7765	<param name="enabled" type="boolean" dir="return">
7766	<desc>Returned flag indicating the default value</desc>
7767	</param>
7768	</method>
7769	</interface>
7770
7771	<!--
7772	// IGuest
7773	/////////////////////////////////////////////////////////////////////////
7774	-->
7775
7776	<interface
7777	name="IGuestOSType" extends="$unknown"
7778	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7779	wsmap="struct"
7780	>
7781	<desc>
7782	</desc>
7783
7784	<attribute name="familyId" type="wstring" readonly="yes">
7785	<desc>Guest OS family identifier string.</desc>
7786	</attribute>
7787
7788	<attribute name="familyDescription" type="wstring" readonly="yes">
7789	<desc>Human readable description of the guest OS family.</desc>
7790	</attribute>
7791
7792	<attribute name="id" type="wstring" readonly="yes">
7793	<desc>Guest OS identifier string.</desc>
7794	</attribute>
7795
7796	<attribute name="description" type="wstring" readonly="yes">
7797	<desc>Human readable description of the guest OS.</desc>
7798	</attribute>
7799
7800	<attribute name="is64Bit" type="boolean" readonly="yes">
7801	<desc>Returns @c true if the given OS is 64-bit</desc>
7802	</attribute>
7803
7804	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7805	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7806	</attribute>
7807
7808	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7809	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7810	</attribute>
7811
7812	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7813	<desc>Recommended RAM size in Megabytes.</desc>
7814	</attribute>
7815
7816	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7817	<desc>Recommended video RAM size in Megabytes.</desc>
7818	</attribute>
7819
7820	<attribute name="recommendedHDD" type="long long" readonly="yes">
7821	<desc>Recommended hard disk size in bytes.</desc>
7822	</attribute>
7823
7824	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7825	<desc>Returns recommended network adapter for this OS type.</desc>
7826	</attribute>
7827
7828	<attribute name="recommendedPae" type="boolean" readonly="yes">
7829	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7830	</attribute>
7831
7832	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7833	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7834	</attribute>
7835
7836	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7837	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7838	</attribute>
7839
7840	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7841	<desc>Recommended storage controller type for HD drives.</desc>
7842	</attribute>
7843
7844	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7845	<desc>Recommended storage bus type for HD drives.</desc>
7846	</attribute>
7847
7848	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7849	<desc>Recommended firmware type.</desc>
7850	</attribute>
7851
7852	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7853	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7854	</attribute>
7855
7856	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7857	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7858	</attribute>
7859
7860	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7861	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7862	</attribute>
7863
7864	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7865	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7866	</attribute>
7867
7868	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7869	<desc>Recommended chipset type.</desc>
7870	</attribute>
7871
7872	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7873	<desc>Recommended audio type.</desc>
7874	</attribute>
7875
7876	</interface>
7877
7878	<enum
7879	name="AdditionsFacilityType"
7880	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
7881	>
7882	<desc>
7883	Guest Additions facility IDs.
7884	</desc>
7885
7886	<const name="None" value="0">
7887	<desc>No/invalid facility.</desc>
7888	</const>
7889	<const name="VBoxGuestDriver" value="20">
7890	<desc>VirtualBox base driver (VBoxGuest).</desc>
7891	</const>
7892	<const name="VBoxService" value="100">
7893	<desc>VirtualBox system service (VBoxService).</desc>
7894	</const>
7895	<const name="VBoxTrayClient" value="101">
7896	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
7897	</const>
7898	<const name="Seamless" value="1000">
7899	<desc>Seamless guest desktop integration.</desc>
7900	</const>
7901	<const name="Graphics" value="1100">
7902	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
7903	are not immediately acted on and guest display resizes are probably not initiated by
7904	the guest additions.
7905	</desc>
7906	</const>
7907	<const name="All" value="2147483646">
7908	<desc>All facilities selected.</desc>
7909	</const>
7910	</enum>
7911
7912	<enum
7913	name="AdditionsFacilityClass"
7914	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
7915	>
7916	<desc>
7917	Guest Additions facility classes.
7918	</desc>
7919
7920	<const name="None" value="0">
7921	<desc>No/invalid class.</desc>
7922	</const>
7923	<const name="Driver" value="10">
7924	<desc>Driver.</desc>
7925	</const>
7926	<const name="Service" value="30">
7927	<desc>System service.</desc>
7928	</const>
7929	<const name="Program" value="50">
7930	<desc>Program.</desc>
7931	</const>
7932	<const name="Feature" value="100">
7933	<desc>Feature.</desc>
7934	</const>
7935	<const name="ThirdParty" value="999">
7936	<desc>Third party.</desc>
7937	</const>
7938	<const name="All" value="2147483646">
7939	<desc>All facility classes selected.</desc>
7940	</const>
7941	</enum>
7942
7943	<enum
7944	name="AdditionsFacilityStatus"
7945	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
7946	>
7947	<desc>
7948	Guest Additions facility states.
7949	</desc>
7950
7951	<const name="Inactive" value="0">
7952	<desc>Facility is not active.</desc>
7953	</const>
7954	<const name="Paused" value="1">
7955	<desc>Facility has been paused.</desc>
7956	</const>
7957	<const name="PreInit" value="20">
7958	<desc>Facility is preparing to initialize.</desc>
7959	</const>
7960	<const name="Init" value="30">
7961	<desc>Facility is initializing.</desc>
7962	</const>
7963	<const name="Active" value="50">
7964	<desc>Facility is up and running.</desc>
7965	</const>
7966	<const name="Terminating" value="100">
7967	<desc>Facility is shutting down.</desc>
7968	</const>
7969	<const name="Terminated" value="101">
7970	<desc>Facility successfully shut down.</desc>
7971	</const>
7972	<const name="Failed" value="800">
7973	<desc>Facility failed to start.</desc>
7974	</const>
7975	<const name="Unknown" value="999">
7976	<desc>Facility status is unknown.</desc>
7977	</const>
7978	</enum>
7979
7980	<interface
7981	name="IAdditionsFacility" extends="$unknown"
7982	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
7983	wsmap="struct"
7984	>
7985	<desc>
7986	Structure representing a Guest Additions facility.
7987	</desc>
7988
7989	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
7990	<desc>The class this facility is part of.</desc>
7991	</attribute>
7992
7993	<attribute name="lastUpdated" type="long long" readonly="yes">
7994	<desc>
7995	Time stamp of the last status update,
7996	in milliseconds since 1970-01-01 UTC.
7997	</desc>
7998	</attribute>
7999
8000	<attribute name="name" type="wstring" readonly="yes">
8001	<desc>The facility's friendly name.</desc>
8002	</attribute>
8003
8004	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8005	<desc>The current status.</desc>
8006	</attribute>
8007
8008	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8009	<desc>The facility's type ID.</desc>
8010	</attribute>
8011	</interface>
8012
8013	<enum
8014	name="AdditionsRunLevelType"
8015	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8016	>
8017	<desc>
8018	Guest Additions run level type.
8019	</desc>
8020
8021	<const name="None" value="0">
8022	<desc>Guest Additions are not loaded.</desc>
8023	</const>
8024	<const name="System" value="1">
8025	<desc>Guest drivers are loaded.</desc>
8026	</const>
8027	<const name="Userland" value="2">
8028	<desc>Common components (such as application services) are loaded.</desc>
8029	</const>
8030	<const name="Desktop" value="3">
8031	<desc>Per-user desktop components are loaded.</desc>
8032	</const>
8033	</enum>
8034
8035	<enum
8036	name="AdditionsUpdateFlag"
8037	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8038	>
8039	<desc>
8040	Guest Additions update flags.
8041	</desc>
8042
8043	<const name="None" value="0">
8044	<desc>No flag set.</desc>
8045	</const>
8046	<const name="WaitForUpdateStartOnly" value="1">
8047	<desc>Only wait for the update process being started and do not
8048	wait while peforming the actual update.</desc>
8049	</const>
8050	</enum>
8051
8052	<enum
8053	name="ExecuteProcessFlag"
8054	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
8055	>
8056	<desc>
8057	Guest process execution flags.
8058	</desc>
8059
8060	<const name="None" value="0">
8061	<desc>No flag set.</desc>
8062	</const>
8063
8064	<const name="WaitForProcessStartOnly" value="1">
8065	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8066	process itself then uses an infinite timeout.</desc>
8067	</const>
8068
8069	<const name="IgnoreOrphanedProcesses" value="2">
8070	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8071	</const>
8072
8073	<const name="Hidden" value="4">
8074	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8075	</const>
8076	</enum>
8077
8078	<enum
8079	name="ExecuteProcessStatus"
8080	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8081	>
8082	<desc>
8083	Guest process execution status.
8084	</desc>
8085
8086	<const name="Undefined" value="0">
8087	<desc>Process is in an undefined state.</desc>
8088	</const>
8089
8090	<const name="Started" value="1">
8091	<desc>Process has been started.</desc>
8092	</const>
8093
8094	<const name="TerminatedNormally" value="2">
8095	<desc>Process terminated normally.</desc>
8096	</const>
8097
8098	<const name="TerminatedSignal" value="3">
8099	<desc>Process terminated via signal.</desc>
8100	</const>
8101
8102	<const name="TerminatedAbnormally" value="4">
8103	<desc>Process terminated abnormally.</desc>
8104	</const>
8105
8106	<const name="TimedOutKilled" value="5">
8107	<desc>Process timed out and was killed.</desc>
8108	</const>
8109
8110	<const name="TimedOutAbnormally" value="6">
8111	<desc>Process timed out and was not killed successfully.</desc>
8112	</const>
8113
8114	<const name="Down" value="7">
8115	<desc>Service/OS is stopping, process was killed.</desc>
8116	</const>
8117
8118	<const name="Error" value="8">
8119	<desc>Something went wrong (error code in flags).</desc>
8120	</const>
8121	</enum>
8122
8123	<enum
8124	name="ProcessInputFlag"
8125	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8126	>
8127	<desc>
8128	Guest process input flags.
8129	</desc>
8130
8131	<const name="None" value="0">
8132	<desc>No flag set.</desc>
8133	</const>
8134
8135	<const name="EndOfFile" value="1">
8136	<desc>End of file (input) reached.</desc>
8137	</const>
8138	</enum>
8139
8140	<enum
8141	name="CopyFileFlag"
8142	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8143	>
8144	<desc>
8145	Host/Guest copy flags. At the moment none of these flags
8146	are implemented.
8147	</desc>
8148
8149	<const name="None" value="0">
8150	<desc>No flag set.</desc>
8151	</const>
8152
8153	<const name="Recursive" value="1">
8154	<desc>Copy directories recursively.</desc>
8155	</const>
8156
8157	<const name="Update" value="2">
8158	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8159	</const>
8160
8161	<const name="FollowLinks" value="4">
8162	<desc>Follow symbolic links.</desc>
8163	</const>
8164	</enum>
8165
8166	<enum
8167	name="CreateDirectoryFlag"
8168	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
8169	>
8170	<desc>
8171	Directory creation flags.
8172	</desc>
8173
8174	<const name="None" value="0">
8175	<desc>No flag set.</desc>
8176	</const>
8177
8178	<const name="Parents" value="1">
8179	<desc>No error if existing, make parent directories as needed.</desc>
8180	</const>
8181	</enum>
8182
8183	<interface
8184	name="IGuest" extends="$unknown"
8185	uuid="4e78f7dd-8ca1-47e5-a344-5207f793df71"
8186	wsmap="managed"
8187	>
8188	<desc>
8189	The IGuest interface represents information about the operating system
8190	running inside the virtual machine. Used in
8191	<link to="IConsole::guest"/>.
8192
8193	IGuest provides information about the guest operating system, whether
8194	Guest Additions are installed and other OS-specific virtual machine
8195	properties.
8196	</desc>
8197
8198	<attribute name="OSTypeId" type="wstring" readonly="yes">
8199	<desc>
8200	Identifier of the Guest OS type as reported by the Guest
8201	Additions.
8202	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8203	an IGuestOSType object representing details about the given
8204	Guest OS type.
8205	<note>
8206	If Guest Additions are not installed, this value will be
8207	the same as <link to="IMachine::OSTypeId"/>.
8208	</note>
8209	</desc>
8210	</attribute>
8211
8212	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8213	<desc>
8214	Current run level of the Guest Additions.
8215	</desc>
8216	</attribute>
8217
8218	<attribute name="additionsVersion" type="wstring" readonly="yes">
8219	<desc>
8220	Version of the Guest Additions including the revision (3 decimal numbers
8221	separated by dots + revision number) installed on the guest or empty
8222	when the Additions are not installed.
8223	</desc>
8224	</attribute>
8225
8226	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8227	<desc>
8228	Array of current known facilities. Only returns facilities where a status is known,
8229	e.g. facilities with an unknown status will not be returned.
8230	</desc>
8231	</attribute>
8232
8233	<attribute name="memoryBalloonSize" type="unsigned long">
8234	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8235	</attribute>
8236
8237	<attribute name="statisticsUpdateInterval" type="unsigned long">
8238	<desc>Interval to update guest statistics in seconds.</desc>
8239	</attribute>
8240
8241	<method name="internalGetStatistics">
8242	<desc>
8243	Internal method; do not use as it might change at any time.
8244	</desc>
8245	<param name="cpuUser" type="unsigned long" dir="out">
8246	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8247	</param>
8248	<param name="cpuKernel" type="unsigned long" dir="out">
8249	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8250	</param>
8251	<param name="cpuIdle" type="unsigned long" dir="out">
8252	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8253	</param>
8254	<param name="memTotal" type="unsigned long" dir="out">
8255	<desc>Total amount of physical guest RAM.</desc>
8256	</param>
8257	<param name="memFree" type="unsigned long" dir="out">
8258	<desc>Free amount of physical guest RAM.</desc>
8259	</param>
8260	<param name="memBalloon" type="unsigned long" dir="out">
8261	<desc>Amount of ballooned physical guest RAM.</desc>
8262	</param>
8263	<param name="memShared" type="unsigned long" dir="out">
8264	<desc>Amount of shared physical guest RAM.</desc>
8265	</param>
8266	<param name="memCache" type="unsigned long" dir="out">
8267	<desc>Total amount of guest (disk) cache memory.</desc>
8268	</param>
8269	<param name="pagedTotal" type="unsigned long" dir="out">
8270	<desc>Total amount of space in the page file.</desc>
8271	</param>
8272	<param name="memAllocTotal" type="unsigned long" dir="out">
8273	<desc>Total amount of memory allocated by the hypervisor.</desc>
8274	</param>
8275	<param name="memFreeTotal" type="unsigned long" dir="out">
8276	<desc>Total amount of free memory available in the hypervisor.</desc>
8277	</param>
8278	<param name="memBalloonTotal" type="unsigned long" dir="out">
8279	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8280	</param>
8281	<param name="memSharedTotal" type="unsigned long" dir="out">
8282	<desc>Total amount of shared memory in the hypervisor.</desc>
8283	</param>
8284	</method>
8285
8286	<method name="getFacilityStatus">
8287	<desc>
8288	Get the current status of a Guest Additions facility.
8289	</desc>
8290	<param name="facility" type="AdditionsFacilityType" dir="in">
8291	<desc>Facility to check status for.</desc>
8292	</param>
8293	<param name="timestamp" type="long long" dir="out">
8294	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8295	</param>
8296	<param name="status" type="AdditionsFacilityStatus" dir="return">
8297	<desc>The current (latest) facility status.</desc>
8298	</param>
8299	</method>
8300
8301	<method name="getAdditionsStatus">
8302	<desc>
8303	Retrieve the current status of a certain Guest Additions run level.
8304
8305	<result name="VBOX_E_NOT_SUPPORTED">
8306	Wrong status level specified.
8307	</result>
8308
8309	</desc>
8310	<param name="level" type="AdditionsRunLevelType" dir="in">
8311	<desc>Status level to check</desc>
8312	</param>
8313	<param name="active" type="boolean" dir="return">
8314	<desc>Flag whether the status level has been reached or not</desc>
8315	</param>
8316	</method>
8317
8318	<method name="setCredentials">
8319	<desc>
8320	Store login credentials that can be queried by guest operating
8321	systems with Additions installed. The credentials are transient
8322	to the session and the guest may also choose to erase them. Note
8323	that the caller cannot determine whether the guest operating system
8324	has queried or made use of the credentials.
8325
8326	<result name="VBOX_E_VM_ERROR">
8327	VMM device is not available.
8328	</result>
8329
8330	</desc>
8331	<param name="userName" type="wstring" dir="in">
8332	<desc>User name string, can be empty</desc>
8333	</param>
8334	<param name="password" type="wstring" dir="in">
8335	<desc>Password string, can be empty</desc>
8336	</param>
8337	<param name="domain" type="wstring" dir="in">
8338	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8339	</param>
8340	<param name="allowInteractiveLogon" type="boolean" dir="in">
8341	<desc>
8342	Flag whether the guest should alternatively allow the user to
8343	interactively specify different credentials. This flag might
8344	not be supported by all versions of the Additions.
8345	</desc>
8346	</param>
8347	</method>
8348
8349	<method name="executeProcess">
8350	<desc>
8351	Executes an existing program inside the guest VM.
8352
8353	<result name="VBOX_E_IPRT_ERROR">
8354	Could not execute process.
8355	</result>
8356
8357	</desc>
8358	<param name="execName" type="wstring" dir="in">
8359	<desc>
8360	Full path name of the command to execute on the guest; the
8361	commands has to exists in the guest VM in order to be executed.
8362	</desc>
8363	</param>
8364	<param name="flags" type="unsigned long" dir="in">
8365	<desc>
8366	<link to="ExecuteProcessFlag"/> flags.
8367	</desc>
8368	</param>
8369	<param name="arguments" type="wstring" safearray="yes" dir="in">
8370	<desc>
8371	Array of arguments passed to the execution command.
8372	</desc>
8373	</param>
8374	<param name="environment" type="wstring" safearray="yes" dir="in">
8375	<desc>
8376	Environment variables that can be set while the command is being
8377	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8378	variable just set its name ("NAME") without a value.
8379	</desc>
8380	</param>
8381	<param name="userName" type="wstring" dir="in">
8382	<desc>
8383	User name under which the command will be executed; has to exist
8384	and have the appropriate rights to execute programs in the VM.
8385	</desc>
8386	</param>
8387	<param name="password" type="wstring" dir="in">
8388	<desc>
8389	Password of the user account specified.
8390	</desc>
8391	</param>
8392	<param name="timeoutMS" type="unsigned long" dir="in">
8393	<desc>
8394	The maximum timeout value (in msec) to wait for finished program
8395	execution. Pass 0 for an infinite timeout.
8396	</desc>
8397	</param>
8398	<param name="pid" type="unsigned long" dir="out">
8399	<desc>
8400	The PID (process ID) of the started command for later reference.
8401	</desc>
8402	</param>
8403	<param name="progress" type="IProgress" dir="return">
8404	<desc>Progress object to track the operation completion.</desc>
8405	</param>
8406	</method>
8407
8408	<method name="getProcessOutput">
8409	<desc>
8410	Retrieves output of a formerly started process.
8411
8412	<result name="VBOX_E_IPRT_ERROR">
8413	Could not retrieve output.
8414	</result>
8415
8416	</desc>
8417	<param name="pid" type="unsigned long" dir="in">
8418	<desc>
8419	Process id returned by earlier executeProcess() call.
8420	</desc>
8421	</param>
8422	<param name="flags" type="unsigned long" dir="in">
8423	<desc>
8424	Flags describing which output to retrieve.
8425	</desc>
8426	</param>
8427	<param name="timeoutMS" type="unsigned long" dir="in">
8428	<desc>
8429	The maximum timeout value (in msec) to wait for output
8430	data. Pass 0 for an infinite timeout.
8431	</desc>
8432	</param>
8433	<param name="size" type="long long" dir="in">
8434	<desc>
8435	Size in bytes to read in the buffer.
8436	</desc>
8437	</param>
8438	<param name="data" type="octet" dir="return" safearray="yes">
8439	<desc>
8440	Buffer for retrieving the actual output. A data size of 0 means end of file
8441	if the requested size was not 0. This is the unprocessed
8442	output data, i.e. the line ending style depends on the platform of
8443	the system the server is running on.
8444	</desc>
8445	</param>
8446	</method>
8447
8448	<method name="getProcessStatus">
8449	<desc>
8450	Retrieves status, exit code and the exit reason of a formerly started process.
8451
8452	<result name="VBOX_E_IPRT_ERROR">
8453	Process with specified PID was not found.
8454	</result>
8455
8456	</desc>
8457	<param name="pid" type="unsigned long" dir="in">
8458	<desc>
8459	Process id returned by earlier executeProcess() call.
8460	</desc>
8461	</param>
8462	<param name="exitcode" type="unsigned long" dir="out">
8463	<desc>
8464	The exit code (if available).
8465	</desc>
8466	</param>
8467	<param name="flags" type="unsigned long" dir="out">
8468	<desc>
8469	Additional flags of process status. Not used at the moment and
8470	must be set to 0.
8471	</desc>
8472	</param>
8473	<param name="reason" type="ExecuteProcessStatus" dir="return">
8474	<desc>
8475	The current process status.
8476	</desc>
8477	</param>
8478	</method>
8479
8480	<method name="copyToGuest">
8481	<desc>
8482	Copies files/directories from host to the guest.
8483
8484	<result name="VBOX_E_IPRT_ERROR">
8485	Error while copying.
8486	</result>
8487
8488	</desc>
8489	<param name="source" type="wstring" dir="in">
8490	<desc>
8491	Source file on the host to copy.
8492	</desc>
8493	</param>
8494	<param name="dest" type="wstring" dir="in">
8495	<desc>
8496	Destination path on the guest.
8497	</desc>
8498	</param>
8499	<param name="userName" type="wstring" dir="in">
8500	<desc>
8501	User name under which the copy command will be executed; the
8502	user has to exist and have the appropriate rights to write to
8503	the destination path.
8504	</desc>
8505	</param>
8506	<param name="password" type="wstring" dir="in">
8507	<desc>
8508	Password of the user account specified.
8509	</desc>
8510	</param>
8511	<param name="flags" type="unsigned long" dir="in">
8512	<desc>
8513	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8514	</desc>
8515	</param>
8516	<param name="progress" type="IProgress" dir="return">
8517	<desc>Progress object to track the operation completion.</desc>
8518	</param>
8519	</method>
8520
8521	<method name="createDirectory">
8522	<desc>
8523	Creates a directory on the guest.
8524
8525	<result name="VBOX_E_IPRT_ERROR">
8526	Error while creating directory.
8527	</result>
8528
8529	</desc>
8530	<param name="directory" type="wstring" dir="in">
8531	<desc>
8532	Directory to create.
8533	</desc>
8534	</param>
8535	<param name="userName" type="wstring" dir="in">
8536	<desc>
8537	User name under which the directory creation will be executed; the
8538	user has to exist and have the appropriate rights to create the
8539	desired directory.
8540	</desc>
8541	</param>
8542	<param name="password" type="wstring" dir="in">
8543	<desc>
8544	Password of the user account specified.
8545	</desc>
8546	</param>
8547	<param name="mode" type="unsigned long" dir="in">
8548	<desc>
8549	File mode.
8550	</desc>
8551	</param>
8552	<param name="flags" type="unsigned long" dir="in">
8553	<desc>
8554	<link to="CreateDirectoryFlag"/> flags.
8555	</desc>
8556	</param>
8557	<param name="progress" type="IProgress" dir="return">
8558	<desc>Progress object to track the operation completion.</desc>
8559	</param>
8560	</method>
8561
8562	<method name="setProcessInput">
8563	<desc>
8564	Sends input into a formerly started process.
8565
8566	<result name="VBOX_E_IPRT_ERROR">
8567	Could not send input.
8568	</result>
8569
8570	</desc>
8571	<param name="pid" type="unsigned long" dir="in">
8572	<desc>
8573	Process id returned by earlier executeProcess() call.
8574	</desc>
8575	</param>
8576	<param name="flags" type="unsigned long" dir="in">
8577	<desc>
8578	<link to="ProcessInputFlag"/> flags.
8579	</desc>
8580	</param>
8581	<param name="timeoutMS" type="unsigned long" dir="in">
8582	<desc>
8583	The maximum timeout value (in msec) to wait for getting the
8584	data transfered to the guest. Pass 0 for an infinite timeout.
8585	</desc>
8586	</param>
8587	<param name="data" type="octet" dir="in" safearray="yes">
8588	<desc>
8589	Buffer of input data to send to the started process to.
8590	</desc>
8591	</param>
8592	<param name="written" type="unsigned long" dir="return">
8593	<desc>
8594	Number of bytes written.
8595	</desc>
8596	</param>
8597	</method>
8598
8599	<method name="updateGuestAdditions">
8600	<desc>
8601	Updates already installed Guest Additions in a VM
8602	(Windows guests only).
8603
8604	<result name="VBOX_E_IPRT_ERROR">
8605	Error while updating.
8606	</result>
8607
8608	</desc>
8609	<param name="source" type="wstring" dir="in">
8610	<desc>
8611	Path to the Guest Additions .ISO file to use for the upate.
8612	</desc>
8613	</param>
8614	<param name="flags" type="unsigned long" dir="in">
8615	<desc>
8616	<link to="AdditionsUpdateFlag"/> flags.
8617	</desc>
8618	</param>
8619	<param name="progress" type="IProgress" dir="return">
8620	<desc>Progress object to track the operation completion.</desc>
8621	</param>
8622	</method>
8623
8624	</interface>
8625
8626
8627	<!--
8628	// IProgress
8629	/////////////////////////////////////////////////////////////////////////
8630	-->
8631
8632	<interface
8633	name="IProgress" extends="$unknown"
8634	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8635	wsmap="managed"
8636	>
8637	<desc>
8638	The IProgress interface is used to track and control
8639	asynchronous tasks within VirtualBox.
8640
8641	An instance of this is returned every time VirtualBox starts
8642	an asynchronous task (in other words, a separate thread) which
8643	continues to run after a method call returns. For example,
8644	<link to="IConsole::saveState" />, which saves the state of
8645	a running virtual machine, can take a long time to complete.
8646	To be able to display a progress bar, a user interface such as
8647	the VirtualBox graphical user interface can use the IProgress
8648	object returned by that method.
8649
8650	Note that IProgress is a "read-only" interface in the sense
8651	that only the VirtualBox internals behind the Main API can
8652	create and manipulate progress objects, whereas client code
8653	can only use the IProgress object to monitor a task's
8654	progress and, if <link to="#cancelable" /> is @c true,
8655	cancel the task by calling <link to="#cancel" />.
8656
8657	A task represented by IProgress consists of either one or
8658	several sub-operations that run sequentially, one by one (see
8659	<link to="#operation" /> and <link to="#operationCount" />).
8660	Every operation is identified by a number (starting from 0)
8661	and has a separate description.
8662
8663	You can find the individual percentage of completion of the current
8664	operation in <link to="#operationPercent" /> and the
8665	percentage of completion of the task as a whole
8666	in <link to="#percent" />.
8667
8668	Similarly, you can wait for the completion of a particular
8669	operation via <link to="#waitForOperationCompletion" /> or
8670	for the completion of the whole task via
8671	<link to="#waitForCompletion" />.
8672	</desc>
8673
8674	<attribute name="id" type="uuid" mod="string" readonly="yes">
8675	<desc>ID of the task.</desc>
8676	</attribute>
8677
8678	<attribute name="description" type="wstring" readonly="yes">
8679	<desc>Description of the task.</desc>
8680	</attribute>
8681
8682	<attribute name="initiator" type="$unknown" readonly="yes">
8683	<desc>Initiator of the task.</desc>
8684	</attribute>
8685
8686	<attribute name="cancelable" type="boolean" readonly="yes">
8687	<desc>Whether the task can be interrupted.</desc>
8688	</attribute>
8689
8690	<attribute name="percent" type="unsigned long" readonly="yes">
8691	<desc>
8692	Current progress value of the task as a whole, in percent.
8693	This value depends on how many operations are already complete.
8694	Returns 100 if <link to="#completed" /> is @c true.
8695	</desc>
8696	</attribute>
8697
8698	<attribute name="timeRemaining" type="long" readonly="yes">
8699	<desc>
8700	Estimated remaining time until the task completes, in
8701	seconds. Returns 0 once the task has completed; returns -1
8702	if the remaining time cannot be computed, in particular if
8703	the current progress is 0.
8704
8705	Even if a value is returned, the estimate will be unreliable
8706	for low progress values. It will become more reliable as the
8707	task progresses; it is not recommended to display an ETA
8708	before at least 20% of a task have completed.
8709	</desc>
8710	</attribute>
8711
8712	<attribute name="completed" type="boolean" readonly="yes">
8713	<desc>Whether the task has been completed.</desc>
8714	</attribute>
8715
8716	<attribute name="canceled" type="boolean" readonly="yes">
8717	<desc>Whether the task has been canceled.</desc>
8718	</attribute>
8719
8720	<attribute name="resultCode" type="long" readonly="yes">
8721	<desc>
8722	Result code of the progress task.
8723	Valid only if <link to="#completed"/> is @c true.
8724	</desc>
8725	</attribute>
8726
8727	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8728	<desc>
8729	Extended information about the unsuccessful result of the
8730	progress operation. May be @c null if no extended information
8731	is available.
8732	Valid only if <link to="#completed"/> is @c true and
8733	<link to="#resultCode"/> indicates a failure.
8734	</desc>
8735	</attribute>
8736
8737	<attribute name="operationCount" type="unsigned long" readonly="yes">
8738	<desc>
8739	Number of sub-operations this task is divided into.
8740	Every task consists of at least one suboperation.
8741	</desc>
8742	</attribute>
8743
8744	<attribute name="operation" type="unsigned long" readonly="yes">
8745	<desc>Number of the sub-operation being currently executed.</desc>
8746	</attribute>
8747
8748	<attribute name="operationDescription" type="wstring" readonly="yes">
8749	<desc>
8750	Description of the sub-operation being currently executed.
8751	</desc>
8752	</attribute>
8753
8754	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8755	<desc>Progress value of the current sub-operation only, in percent.</desc>
8756	</attribute>
8757
8758	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8759	<desc>Weight value of the current sub-operation only.</desc>
8760	</attribute>
8761
8762	<attribute name="timeout" type="unsigned long">
8763	<desc>
8764	When non-zero, this specifies the number of milliseconds after which
8765	the operation will automatically be canceled. This can only be set on
8766	cancelable objects.
8767	</desc>
8768	</attribute>
8769
8770	<method name="setCurrentOperationProgress">
8771	<desc>Internal method, not to be called externally.</desc>
8772	<param name="percent" type="unsigned long" dir="in" />
8773	</method>
8774	<method name="setNextOperation">
8775	<desc>Internal method, not to be called externally.</desc>
8776	<param name="nextOperationDescription" type="wstring" dir="in" />
8777	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8778	</method>
8779
8780	<method name="waitForCompletion">
8781	<desc>
8782	Waits until the task is done (including all sub-operations)
8783	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8784
8785	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8786	thread are not processed while waiting. Neglecting event queues may
8787	have dire consequences (degrade performance, resource hogs,
8788	deadlocks, etc.), this is specially so for the main thread on
8789	platforms using XPCOM. Callers are adviced wait for short periods
8790	and service their event queues between calls, or to create a worker
8791	thread to do the waiting.
8792
8793	<result name="VBOX_E_IPRT_ERROR">
8794	Failed to wait for task completion.
8795	</result>
8796	</desc>
8797
8798	<param name="timeout" type="long" dir="in">
8799	<desc>
8800	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8801	</desc>
8802	</param>
8803	</method>
8804
8805	<method name="waitForOperationCompletion">
8806	<desc>
8807	Waits until the given operation is done with a given timeout in
8808	milliseconds; specify -1 for an indefinite wait.
8809
8810	See <link to="#waitForCompletion"> for event queue considerations.</link>
8811
8812	<result name="VBOX_E_IPRT_ERROR">
8813	Failed to wait for operation completion.
8814	</result>
8815
8816	</desc>
8817	<param name="operation" type="unsigned long" dir="in">
8818	<desc>
8819	Number of the operation to wait for.
8820	Must be less than <link to="#operationCount"/>.
8821	</desc>
8822	</param>
8823	<param name="timeout" type="long" dir="in">
8824	<desc>
8825	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8826	</desc>
8827	</param>
8828	</method>
8829
8830	<method name="cancel">
8831	<desc>
8832	Cancels the task.
8833	<note>
8834	If <link to="#cancelable"/> is @c false, then this method will fail.
8835	</note>
8836
8837	<result name="VBOX_E_INVALID_OBJECT_STATE">
8838	Operation cannot be canceled.
8839	</result>
8840
8841	</desc>
8842	</method>
8843
8844	</interface>
8845
8846	<!--
8847	// ISnapshot
8848	/////////////////////////////////////////////////////////////////////////
8849	-->
8850
8851	<interface
8852	name="ISnapshot" extends="$unknown"
8853	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8854	wsmap="managed"
8855	>
8856	<desc>
8857	The ISnapshot interface represents a snapshot of the virtual
8858	machine.
8859
8860	Together with the differencing media that are created
8861	when a snapshot is taken, a machine can be brought back to
8862	the exact state it was in when the snapshot was taken.
8863
8864	The ISnapshot interface has no methods, only attributes; snapshots
8865	are controlled through methods of the <link to="IConsole" /> interface
8866	which also manage the media associated with the snapshot.
8867	The following operations exist:
8868
8869	<ul>
8870	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8871	by creating new, empty differencing images for the machine's
8872	media and saving the VM settings and (if the VM is running)
8873	the current VM state in the snapshot.
8874
8875	The differencing images will then receive all data written to
8876	the machine's media, while their parent (base) images
8877	remain unmodified after the snapshot has been taken (see
8878	<link to="IMedium" /> for details about differencing images).
8879	This simplifies restoring a machine to the state of a snapshot:
8880	only the differencing images need to be deleted.
8881
8882	The current machine state is not changed by taking a snapshot
8883	except that <link to="IMachine::currentSnapshot" /> is set to
8884	the newly created snapshot, which is also added to the machine's
8885	snapshots tree.
8886	</li>
8887
8888	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8889	the state of a previous snapshot by deleting the differencing
8890	image of each of the machine's media and setting the machine's
8891	settings and state to the state that was saved in the snapshot (if any).
8892
8893	This destroys the machine's current state. After calling this,
8894	<link to="IMachine::currentSnapshot" /> points to the snapshot
8895	that was restored.
8896	</li>
8897
8898	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8899	without affecting the current machine state.
8900
8901	This does not change the current machine state, but instead frees the
8902	resources allocated when the snapshot was taken: the settings and machine
8903	state file are deleted (if any), and the snapshot's differencing image for
8904	each of the machine's media gets merged with its parent image.
8905
8906	Neither the current machine state nor other snapshots are affected
8907	by this operation, except that parent media will be modified
8908	to contain the disk data associated with the snapshot being deleted.
8909
8910	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8911	attribute is set to the current snapshot's parent or NULL if it
8912	has no parent. Otherwise the attribute is unchanged.
8913	</li>
8914	</ul>
8915
8916	Each snapshot contains a copy of virtual machine's settings (hardware
8917	configuration etc.). This copy is contained in an immutable (read-only)
8918	instance of <link to="IMachine" /> which is available from the snapshot's
8919	<link to="#machine" /> attribute. When restoring the snapshot, these
8920	settings are copied back to the original machine.
8921
8922	In addition, if the machine was running when the
8923	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8924	the current VM state is saved in the snapshot (similarly to what happens
8925	when a VM's state is saved). The snapshot is then said to be <i>online</i>
8926	because when restoring it, the VM will be running.
8927
8928	If the machine was in <link to="MachineState_Saved">saved</link> saved,
8929	the snapshot receives a copy of the execution state file
8930	(<link to="IMachine::stateFilePath"/>).
8931
8932	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8933	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8934	it then contains a so-called "zero execution state", representing a
8935	machine that is powered off.
8936	</desc>
8937
8938	<attribute name="id" type="uuid" mod="string" readonly="yes">
8939	<desc>UUID of the snapshot.</desc>
8940	</attribute>
8941
8942	<attribute name="name" type="wstring">
8943	<desc>Short name of the snapshot.
8944	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8945	be called implicitly.</note>
8946	</desc>
8947	</attribute>
8948
8949	<attribute name="description" type="wstring">
8950	<desc>Optional description of the snapshot.
8951	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8952	be called implicitly.</note>
8953	</desc>
8954	</attribute>
8955
8956	<attribute name="timeStamp" type="long long" readonly="yes">
8957	<desc>
8958	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8959	</desc>
8960	</attribute>
8961
8962	<attribute name="online" type="boolean" readonly="yes">
8963	<desc>
8964	@c true if this snapshot is an online snapshot and @c false otherwise.
8965
8966	When this attribute is @c true, the
8967	<link to="IMachine::stateFilePath"/> attribute of the
8968	<link to="#machine"/> object associated with this snapshot
8969	will point to the saved state file. Otherwise, it will be
8970	an empty string.
8971	</desc>
8972	</attribute>
8973
8974	<attribute name="machine" type="IMachine" readonly="yes">
8975	<desc>
8976	Virtual machine this snapshot is taken on. This object
8977	stores all settings the machine had when taking this snapshot.
8978	<note>
8979	The returned machine object is immutable, i.e. no
8980	any settings can be changed.
8981	</note>
8982	</desc>
8983	</attribute>
8984
8985	<attribute name="parent" type="ISnapshot" readonly="yes">
8986	<desc>
8987	Parent snapshot (a snapshot this one is based on), or
8988	@c null if the snapshot has no parent (i.e. is the first snapshot).
8989	</desc>
8990	</attribute>
8991
8992	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8993	<desc>
8994	Child snapshots (all snapshots having this one as a parent).
8995	By inspecting this attribute starting with a machine's root snapshot
8996	(which can be obtained by calling <link to="IMachine::findSnapshot" />
8997	with a @c null UUID), a machine's snapshots tree can be iterated over.
8998	</desc>
8999	</attribute>
9000
9001	</interface>
9002
9003
9004	<!--
9005	// IMedium
9006	/////////////////////////////////////////////////////////////////////////
9007	-->
9008
9009	<enum
9010	name="MediumState"
9011	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9012	>
9013	<desc>
9014	Virtual medium state.
9015	<see>IMedium</see>
9016	</desc>
9017
9018	<const name="NotCreated" value="0">
9019	<desc>
9020	Associated medium storage does not exist (either was not created yet or
9021	was deleted).
9022	</desc>
9023	</const>
9024	<const name="Created" value="1">
9025	<desc>
9026	Associated storage exists and accessible; this gets set if the
9027	accessibility check performed by <link to="IMedium::refreshState" />
9028	was successful.
9029	</desc>
9030	</const>
9031	<const name="LockedRead" value="2">
9032	<desc>
9033	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
9034	no data modification is possible.
9035	</desc>
9036	</const>
9037	<const name="LockedWrite" value="3">
9038	<desc>
9039	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
9040	no concurrent data reading or modification is possible.
9041	</desc>
9042	</const>
9043	<const name="Inaccessible" value="4">
9044	<desc>
9045	Medium accessibility check (see <link to="IMedium::refreshState" />) has
9046	not yet been performed, or else, associated medium storage is not
9047	accessible. In the first case, <link to="IMedium::lastAccessError"/>
9048	is empty, in the second case, it describes the error that occurred.
9049	</desc>
9050	</const>
9051	<const name="Creating" value="5">
9052	<desc>
9053	Associated medium storage is being created.
9054	</desc>
9055	</const>
9056	<const name="Deleting" value="6">
9057	<desc>
9058	Associated medium storage is being deleted.
9059	</desc>
9060	</const>
9061	</enum>
9062
9063	<enum
9064	name="MediumType"
9065	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
9066	>
9067	<desc>
9068	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
9069	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
9070	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
9071	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
9072	</desc>
9073
9074	<const name="Normal" value="0">
9075	<desc>
9076	Normal medium (attached directly or indirectly, preserved
9077	when taking snapshots).
9078	</desc>
9079	</const>
9080	<const name="Immutable" value="1">
9081	<desc>
9082	Immutable medium (attached indirectly, changes are wiped out
9083	the next time the virtual machine is started).
9084	</desc>
9085	</const>
9086	<const name="Writethrough" value="2">
9087	<desc>
9088	Write through medium (attached directly, ignored when
9089	taking snapshots).
9090	</desc>
9091	</const>
9092	<const name="Shareable" value="3">
9093	<desc>
9094	Allow using this medium concurrently by several machines.
9095	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
9096	</desc>
9097	</const>
9098	<const name="Readonly" value="4">
9099	<desc>
9100	A readonly medium, which can of course be used by several machines.
9101	<note>Present and accepted since VirtualBox 4.0.</note>
9102	</desc>
9103	</const>
9104	<const name="MultiAttach" value="5">
9105	<desc>
9106	A medium which is is indirectly attached, so that one base medium can
9107	be used for several VMs which have their own differencing medium to
9108	store their modifications. In some sense a variant of Immutable
9109	with unset AutoReset flag in each differencing medium.
9110	<note>Present and accepted since VirtualBox 4.0.</note>
9111	</desc>
9112	</const>
9113	</enum>
9114
9115	<enum
9116	name="MediumVariant"
9117	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9118	>
9119	<desc>
9120	Virtual medium image variant. More than one flag may be set.
9121	<see>IMedium</see>
9122	</desc>
9123
9124	<const name="Standard" value="0">
9125	<desc>
9126	No particular variant requested, results in using the backend default.
9127	</desc>
9128	</const>
9129	<const name="VmdkSplit2G" value="0x01">
9130	<desc>
9131	VMDK image split in chunks of less than 2GByte.
9132	</desc>
9133	</const>
9134	<const name="VmdkStreamOptimized" value="0x04">
9135	<desc>
9136	VMDK streamOptimized image. Special import/export format which is
9137	read-only/append-only.
9138	</desc>
9139	</const>
9140	<const name="VmdkESX" value="0x08">
9141	<desc>
9142	VMDK format variant used on ESX products.
9143	</desc>
9144	</const>
9145	<const name="Fixed" value="0x10000">
9146	<desc>
9147	Fixed image. Only allowed for base images.
9148	</desc>
9149	</const>
9150	<const name="Diff" value="0x20000">
9151	<desc>
9152	Differencing image. Only allowed for child images.
9153	</desc>
9154	</const>
9155	</enum>
9156
9157	<interface
9158	name="IMediumAttachment" extends="$unknown"
9159	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
9160	wsmap="struct"
9161	>
9162	<desc>
9163	The IMediumAttachment interface links storage media to virtual machines.
9164	For each medium (<link to="IMedium"/>) which has been attached to a
9165	storage controller (<link to="IStorageController"/>) of a machine
9166	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9167	method, one instance of IMediumAttachment is added to the machine's
9168	<link to="IMachine::mediumAttachments"/> array attribute.
9169
9170	Each medium attachment specifies the storage controller as well as a
9171	port and device number and the IMedium instance representing a virtual
9172	hard disk or floppy or DVD image.
9173
9174	For removable media (DVDs or floppies), there are two additional
9175	options. For one, the IMedium instance can be @c null to represent
9176	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9177	secondly, the medium can be one of the pseudo-media for host drives
9178	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9179
9180	<h3>Attaching Hard Disks</h3>
9181
9182	Hard disks are attached to virtual machines using the
9183	<link to="IMachine::attachDevice"/> method and detached using the
9184	<link to="IMachine::detachDevice"/> method. Depending on a medium's
9185	type (see <link to="IMedium::type" />), hard disks are attached either
9186	<i>directly</i> or <i>indirectly</i>.
9187
9188	When a hard disk is being attached directly, it is associated with the
9189	virtual machine and used for hard disk operations when the machine is
9190	running. When a hard disk is being attached indirectly, a new differencing
9191	hard disk linked to it is implicitly created and this differencing hard
9192	disk is associated with the machine and used for hard disk operations.
9193	This also means that if <link to="IMachine::attachDevice"/> performs
9194	a direct attachment then the same hard disk will be returned in response
9195	to the subsequent <link to="IMachine::getMedium"/> call; however if
9196	an indirect attachment is performed then
9197	<link to="IMachine::getMedium"/> will return the implicitly created
9198	differencing hard disk, not the original one passed to <link
9199	to="IMachine::attachDevice"/>. In detail:
9200
9201	<ul>
9202	<li><b>Normal base</b> hard disks that do not have children (i.e.
9203	differencing hard disks linked to them) and that are not already
9204	attached to virtual machines in snapshots are attached <b>directly</b>.
9205	Otherwise, they are attached <b>indirectly</b> because having
9206	dependent children or being part of the snapshot makes it impossible
9207	to modify hard disk contents without breaking the integrity of the
9208	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
9209	quickly determine the kind of the attachment for the given hard
9210	disk. Note that if a normal base hard disk is to be indirectly
9211	attached to a virtual machine with snapshots then a special
9212	procedure called <i>smart attachment</i> is performed (see below).</li>
9213	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9214	they are attached <b>directly</b> if they do not have children and are
9215	not attached to virtual machines in snapshots, and <b>indirectly</b>
9216	otherwise. Note that the smart attachment procedure is never performed
9217	for differencing hard disks.</li>
9218	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9219	they are designed to be non-writable. If an immutable hard disk is
9220	attached to a virtual machine with snapshots then a special
9221	procedure called smart attachment is performed (see below).</li>
9222	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9223	also as designed. This also means that writethrough hard disks cannot
9224	have other hard disks linked to them at all.</li>
9225	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9226	also as designed. This also means that shareable hard disks cannot
9227	have other hard disks linked to them at all. They behave almost
9228	like writethrough hard disks, except that shareable hard disks can
9229	be attached to several virtual machines which are running, allowing
9230	concurrent accesses. You need special cluster software running in
9231	the virtual machines to make use of such disks.</li>
9232	</ul>
9233
9234	Note that the same hard disk, regardless of its type, may be attached to
9235	more than one virtual machine at a time. In this case, the machine that is
9236	started first gains exclusive access to the hard disk and attempts to
9237	start other machines having this hard disk attached will fail until the
9238	first machine is powered down.
9239
9240	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9241	that the given hard disk remains associated with the given machine after a
9242	successful <link to="IMachine::detachDevice"/> call until
9243	<link to="IMachine::saveSettings"/> is called to save all changes to
9244	machine settings to disk. This deferring is necessary to guarantee that
9245	the hard disk configuration may be restored at any time by a call to
9246	<link to="IMachine::discardSettings"/> before the settings
9247	are saved (committed).
9248
9249	Note that if <link to="IMachine::discardSettings"/> is called after
9250	indirectly attaching some hard disks to the machine but before a call to
9251	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9252	all differencing hard disks implicitly created by
9253	<link to="IMachine::attachDevice"/> for these indirect attachments.
9254	Such implicitly created hard disks will also be immediately deleted when
9255	detached explicitly using the <link to="IMachine::detachDevice"/>
9256	call if it is made before <link to="IMachine::saveSettings"/>. This
9257	implicit deletion is safe because newly created differencing hard
9258	disks do not contain any user data.
9259
9260	However, keep in mind that detaching differencing hard disks that were
9261	implicitly created by <link to="IMachine::attachDevice"/>
9262	before the last <link to="IMachine::saveSettings"/> call will
9263	<b>not</b> implicitly delete them as they may already contain some data
9264	(for example, as a result of virtual machine execution). If these hard
9265	disks are no more necessary, the caller can always delete them explicitly
9266	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
9267	from this machine by the <link to="IMachine::saveSettings"/> call.
9268
9269	<h3>Smart Attachment</h3>
9270
9271	When normal base or immutable hard disks are indirectly attached to a
9272	virtual machine then some additional steps are performed to make sure the
9273	virtual machine will have the most recent "view" of the hard disk being
9274	attached. These steps include walking through the machine's snapshots
9275	starting from the current one and going through ancestors up to the first
9276	snapshot. Hard disks attached to the virtual machine in all
9277	of the encountered snapshots are checked whether they are descendants of
9278	the given normal base or immutable hard disk. The first found child (which
9279	is the differencing hard disk) will be used instead of the normal base or
9280	immutable hard disk as a parent for creating a new differencing hard disk
9281	that will be actually attached to the machine. And only if no descendants
9282	are found or if the virtual machine does not have any snapshots then the
9283	normal base or immutable hard disk will be used itself as a parent for
9284	this differencing hard disk.
9285
9286	It is easier to explain what smart attachment does using the
9287	following example:
9288	<pre>
9289	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9290
9291	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9292	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9293	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9294	Snapshot 4 (none) Snapshot 4 (none)
9295	CurState (none) CurState (D3->D2.vdi)
9296
9297	NOT
9298	...
9299	CurState (D3->B.vdi)
9300	</pre>
9301	The first column is the virtual machine configuration before the base hard
9302	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9303	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9304	mean that the hard disk that is actually attached to the machine is a
9305	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9306	another hard disk, <tt>B.vdi</tt>.
9307
9308	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9309	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9310	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9311	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9312	it cannot be attached directly and needs an indirect attachment (i.e.
9313	implicit creation of a new differencing hard disk). Due to the smart
9314	attachment procedure, the new differencing hard disk
9315	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9316	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9317	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9318	machine.
9319
9320	Note that if there is more than one descendant hard disk of the given base
9321	hard disk found in a snapshot, and there is an exact device, channel and
9322	bus match, then this exact match will be used. Otherwise, the youngest
9323	descendant will be picked up.
9324
9325	There is one more important aspect of the smart attachment procedure which
9326	is not related to snapshots at all. Before walking through the snapshots
9327	as described above, the backup copy of the current list of hard disk
9328	attachment is searched for descendants. This backup copy is created when
9329	the hard disk configuration is changed for the first time after the last
9330	<link to="IMachine::saveSettings"/> call and used by
9331	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9332	changes. When such a descendant is found in this backup copy, it will be
9333	simply re-attached back, without creating a new differencing hard disk for
9334	it. This optimization is necessary to make it possible to re-attach the
9335	base or immutable hard disk to a different bus, channel or device slot
9336	without losing the contents of the differencing hard disk actually
9337	attached to the machine in place of it.
9338
9339	</desc>
9340
9341	<attribute name="medium" type="IMedium" readonly="yes">
9342	<desc>Medium object associated with this attachment; it
9343	can be @c null for removable devices.</desc>
9344	</attribute>
9345
9346	<attribute name="controller" type="wstring" readonly="yes">
9347	<desc>Name of the storage controller of this attachment; this
9348	refers to one of the controllers in <link to="IMachine::storageControllers" />
9349	by name.</desc>
9350	</attribute>
9351
9352	<attribute name="port" type="long" readonly="yes">
9353	<desc>Port number of this attachment.
9354	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9355	</desc>
9356	</attribute>
9357
9358	<attribute name="device" type="long" readonly="yes">
9359	<desc>Device slot number of this attachment.
9360	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9361	</desc>
9362	</attribute>
9363
9364	<attribute name="type" type="DeviceType" readonly="yes">
9365	<desc>Device type of this attachment.</desc>
9366	</attribute>
9367
9368	<attribute name="passthrough" type="boolean" readonly="yes">
9369	<desc>Pass I/O requests through to a device on the host.</desc>
9370	</attribute>
9371
9372	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9373	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9374	</attribute>
9375
9376	</interface>
9377
9378	<interface
9379	name="IMedium" extends="$unknown"
9380	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
9381	wsmap="managed"
9382	>
9383	<desc>
9384	The IMedium interface represents virtual storage for a machine's
9385	hard disks, CD/DVD or floppy drives. It will typically represent
9386	a disk image on the host, for example a VDI or VMDK file representing
9387	a virtual hard disk, or an ISO or RAW file representing virtual
9388	removable media, but can also point to a network location (e.g.
9389	for iSCSI targets).
9390
9391	Instances of IMedium are connected to virtual machines by way of medium
9392	attachments, which link the storage medium to a particular device slot
9393	of a storage controller of the virtual machine.
9394	In the VirtualBox API, virtual storage is therefore always represented
9395	by the following chain of object links:
9396
9397	<ul>
9398	<li><link to="IMachine::storageControllers"/> contains an array of
9399	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9400	these are instances of <link to="IStorageController"/>).</li>
9401	<li><link to="IMachine::mediumAttachments"/> contains an array of
9402	medium attachments (instances of <link to="IMediumAttachment"/>
9403	created by <link to="IMachine::attachDevice" />),
9404	each containing a storage controller from the above array, a
9405	port/device specification, and an instance of IMedium representing
9406	the medium storage (image file).
9407
9408	For removable media, the storage medium is optional; a medium
9409	attachment with no medium represents a CD/DVD or floppy drive
9410	with no medium inserted. By contrast, hard disk attachments
9411	will always have an IMedium object attached.</li>
9412	<li>Each IMedium in turn points to a storage unit (such as a file
9413	on the host computer or a network resource) that holds actual
9414	data. This location is represented by the <link to="#location"/>
9415	attribute.</li>
9416	</ul>
9417
9418	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9419	new hard disk media can be created with the VirtualBox API using the
9420	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
9421	disks (see below) are usually implicitly created by VirtualBox as
9422	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
9423	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
9424	should be created with external tools and then opened from within VirtualBox.
9425
9426	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9427	drive. In that case the <link to="#id" /> attribute contains the UUID of
9428	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9429
9430	<h3>Media registries</h3>
9431
9432	When a medium has been opened or created using one of the aforementioned
9433	APIs, it becomes "known" to VirtualBox. Known media can be attached
9434	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
9435	They also appear in the global
9436	<link to="IVirtualBox::hardDisks" />,
9437	<link to="IVirtualBox::DVDImages" /> and
9438	<link to="IVirtualBox::floppyImages" /> arrays.
9439
9440	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
9441	in the VirtualBox.xml file, which was shared between all machines and made
9442	transporting machines and their media from one host to another difficult.
9443
9444	Starting with VirtualBox 4.0, media are only added to a registry when they are
9445	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
9446	backwards compatibility, which registry a medium is added to depends on which
9447	VirtualBox version created a machine:
9448
9449	<ul>
9450	<li>If the medium has first been attached to a machine which was created by
9451	VirtualBox 4.0 or later, it is added to that machine's media registry in
9452	the machine XML settings file. This way all information about a machine's
9453	media attachments is contained in a single file and can be transported
9454	easily.</li>
9455	<li>For older media attachments (i.e. if the medium was first attached to a
9456	machine which was created with a VirtualBox version before 4.0), media
9457	continue to be registered in the global VirtualBox settings file, for
9458	backwards compatibility.</li>
9459	</ul>
9460
9461	See <link to="IVirtualBox::openMedium" /> for more information.
9462
9463	Media are removed from media registries by the <link to="#close"/>,
9464	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
9465
9466	<h3>Accessibility checks</h3>
9467
9468	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9469	method is called explicitly on a medium. This is done to make the VirtualBox object
9470	ready for serving requests as fast as possible and let the end-user
9471	application decide if it needs to check media accessibility right away or not.
9472
9473	As a result, when VirtualBox starts up (e.g. the VirtualBox
9474	object gets created for the first time), all known media are in the
9475	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9476	attribute is an empty string because no actual accessibility check has
9477	been made yet.
9478
9479	After calling <link to="#refreshState" />, a medium is considered
9480	<i>accessible</i> if its storage unit can be read. In that case, the
9481	<link to="#state"/> attribute has a value of "Created". If the storage
9482	unit cannot be read (for example, because it is located on a disconnected
9483	network resource, or was accidentally deleted outside VirtualBox),
9484	the medium is considered <i>inaccessible</i>, which is indicated by the
9485	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9486	obtained by reading the <link to="#lastAccessError"/> attribute.
9487
9488	<h3>Medium types</h3>
9489
9490	There are five types of medium behavior which are stored in the
9491	<link to="#type"/> attribute (see <link to="MediumType" />) and
9492	which define the medium's behavior with attachments and snapshots.
9493
9494	All media can be also divided in two groups: <i>base</i> media and
9495	<i>differencing</i> media. A base medium contains all sectors of the
9496	medium data in its own storage and therefore can be used independently.
9497	In contrast, a differencing medium is a "delta" to some other medium and
9498	contains only those sectors which differ from that other medium, which is
9499	then called a <i>parent</i>. The differencing medium is said to be
9500	<i>linked to</i> that parent. The parent may be itself a differencing
9501	medium, thus forming a chain of linked media. The last element in that
9502	chain must always be a base medium. Note that several differencing
9503	media may be linked to the same parent medium.
9504
9505	Differencing media can be distinguished from base media by querying the
9506	<link to="#parent"/> attribute: base media do not have parents they would
9507	depend on, so the value of this attribute is always @c null for them.
9508	Using this attribute, it is possible to walk up the medium tree (from the
9509	child medium to its parent). It is also possible to walk down the tree
9510	using the <link to="#children"/> attribute.
9511
9512	Note that the type of all differencing media is "normal"; all other
9513	values are meaningless for them. Base media may be of any type.
9514
9515	<h3>Automatic composition of the file name part</h3>
9516
9517	Another extension to the <link to="IMedium::location"/> attribute is that
9518	there is a possibility to cause VirtualBox to compose a unique value for
9519	the file name part of the location using the UUID of the hard disk. This
9520	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9521	e.g. before the storage unit is created, and works as follows. You set the
9522	value of the <link to="IMedium::location"/> attribute to a location
9523	specification which only contains the path specification but not the file
9524	name part and ends with either a forward slash or a backslash character.
9525	In response, VirtualBox will generate a new UUID for the hard disk and
9526	compose the file name using the following pattern:
9527	<pre>
9528	<path>/{<uuid>}.<ext>
9529	</pre>
9530	where <tt><path></tt> is the supplied path specification,
9531	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9532	is the default extension for the storage format of this hard disk. After
9533	that, you may call any of the methods that create a new hard disk storage
9534	unit and they will use the generated UUID and file name.
9535	</desc>
9536
9537	<attribute name="id" type="uuid" mod="string" readonly="yes">
9538	<desc>
9539	UUID of the medium. For a newly created medium, this value is a randomly
9540	generated UUID.
9541
9542	<note>
9543	For media in one of MediumState_NotCreated, MediumState_Creating or
9544	MediumState_Deleting states, the value of this property is undefined
9545	and will most likely be an empty UUID.
9546	</note>
9547	</desc>
9548	</attribute>
9549
9550	<attribute name="description" type="wstring">
9551	<desc>
9552	Optional description of the medium. For a newly created medium the value
9553	of this attribute is an empty string.
9554
9555	Medium types that don't support this attribute will return E_NOTIMPL in
9556	attempt to get or set this attribute's value.
9557
9558	<note>
9559	For some storage types, reading this attribute may return an outdated
9560	(last known) value when <link to="#state"/> is <link
9561	to="MediumState_Inaccessible"/> or <link
9562	to="MediumState_LockedWrite"/> because the value of this attribute is
9563	stored within the storage unit itself. Also note that changing the
9564	attribute value is not possible in such case, as well as when the
9565	medium is the <link to="MediumState_LockedRead"/> state.
9566	</note>
9567	</desc>
9568	</attribute>
9569
9570	<attribute name="state" type="MediumState" readonly="yes">
9571	<desc>
9572	Returns the current medium state, which is the last state set by
9573	the accessibility check performed by <link to="#refreshState"/>.
9574	If that method has not yet been called on the medium, the state
9575	is "Inaccessible"; as opposed to truly inaccessible media, the
9576	value of <link to="#lastAccessError"/> will be an empty string in
9577	that case.
9578
9579	<note>As of version 3.1, this no longer performs an accessibility check
9580	automatically; call <link to="#refreshState"/> for that.
9581	</note>
9582	</desc>
9583	</attribute>
9584
9585	<attribute name="variant" type="unsigned long" readonly="yes">
9586	<desc>
9587	Returns the storage format variant information for this medium
9588	as a combination of the flags described at <link to="MediumVariant" />.
9589	Before <link to="#refreshState"/> is called this method returns
9590	an undefined value.
9591	</desc>
9592	</attribute>
9593
9594	<attribute name="location" type="wstring">
9595	<desc>
9596	Location of the storage unit holding medium data.
9597
9598	The format of the location string is medium type specific. For medium
9599	types using regular files in a host's file system, the location
9600	string is the full file name.
9601
9602	Some medium types may support changing the storage unit location by
9603	simply changing the value of this property. If this operation is not
9604	supported, the implementation will return E_NOTIMPL in attempt to set
9605	this attribute's value.
9606
9607	When setting a value of the location attribute which is a regular file
9608	in the host's file system, the given file name may be either relative to
9609	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9610	absolute. Note that if the given location specification does not contain
9611	the file extension part then a proper default extension will be
9612	automatically appended by the implementation depending on the medium type.
9613	</desc>
9614	</attribute>
9615
9616	<attribute name="name" type="wstring" readonly="yes">
9617	<desc>
9618	Name of the storage unit holding medium data.
9619
9620	The returned string is a short version of the <link to="#location"/>
9621	attribute that is suitable for representing the medium in situations
9622	where the full location specification is too long (such as lists
9623	and comboboxes in GUI frontends). This string is also used by frontends
9624	to sort the media list alphabetically when needed.
9625
9626	For example, for locations that are regular files in the host's file
9627	system, the value of this attribute is just the file name (+ extension),
9628	without the path specification.
9629
9630	Note that as opposed to the <link to="#location"/> attribute, the name
9631	attribute will not necessary be unique for a list of media of the
9632	given type and format.
9633	</desc>
9634	</attribute>
9635
9636	<attribute name="deviceType" type="DeviceType" readonly="yes">
9637	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9638	medium.</desc>
9639	</attribute>
9640
9641	<attribute name="hostDrive" type="boolean" readonly="yes">
9642	<desc>True if this corresponds to a drive on the host.</desc>
9643	</attribute>
9644
9645	<attribute name="size" type="long long" readonly="yes">
9646	<desc>
9647	Physical size of the storage unit used to hold medium data (in bytes).
9648
9649	<note>
9650	For media whose <link to="#state"/> is <link
9651	to="MediumState_Inaccessible"/>, the value of this property is the
9652	last known size. For <link to="MediumState_NotCreated"/> media,
9653	the returned value is zero.
9654	</note>
9655	</desc>
9656	</attribute>
9657
9658	<attribute name="format" type="wstring" readonly="yes">
9659	<desc>
9660	Storage format of this medium.
9661
9662	The value of this attribute is a string that specifies a backend used
9663	to store medium data. The storage format is defined when you create a
9664	new medium or automatically detected when you open an existing medium,
9665	and cannot be changed later.
9666
9667	The list of all storage formats supported by this VirtualBox
9668	installation can be obtained using
9669	<link to="ISystemProperties::mediumFormats"/>.
9670	</desc>
9671	</attribute>
9672
9673	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9674	<desc>
9675	Storage medium format object corresponding to this medium.
9676
9677	The value of this attribute is a reference to the medium format object
9678	that specifies the backend properties used to store medium data. The
9679	storage format is defined when you create a new medium or automatically
9680	detected when you open an existing medium, and cannot be changed later.
9681
9682	<note>@c null is returned if there is no associated medium format
9683	object. This can e.g. happen for medium objects representing host
9684	drives and other special medium objects.</note>
9685	</desc>
9686	</attribute>
9687
9688	<attribute name="type" type="MediumType">
9689	<desc>
9690	Type (role) of this medium.
9691
9692	The following constraints apply when changing the value of this
9693	attribute:
9694	<ul>
9695	<li>If a medium is attached to a virtual machine (either in the
9696	current state or in one of the snapshots), its type cannot be
9697	changed.
9698	</li>
9699	<li>As long as the medium has children, its type cannot be set
9700	to <link to="MediumType_Writethrough"/>.
9701	</li>
9702	<li>The type of all differencing media is
9703	<link to="MediumType_Normal"/> and cannot be changed.
9704	</li>
9705	</ul>
9706
9707	The type of a newly created or opened medium is set to
9708	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9709	which have a type of <link to="MediumType_Writethrough"/>.
9710	</desc>
9711	</attribute>
9712
9713	<attribute name="parent" type="IMedium" readonly="yes">
9714	<desc>
9715	Parent of this medium (the medium this medium is directly based
9716	on).
9717
9718	Only differencing media have parents. For base (non-differencing)
9719	media, @c null is returned.
9720	</desc>
9721	</attribute>
9722
9723	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9724	<desc>
9725	Children of this medium (all differencing media directly based
9726	on this medium). A @c null array is returned if this medium
9727	does not have any children.
9728	</desc>
9729	</attribute>
9730
9731	<attribute name="base" type="IMedium" readonly="yes">
9732	<desc>
9733	Base medium of this medium.
9734
9735	If this is a differencing medium, its base medium is the medium
9736	the given medium branch starts from. For all other types of media, this
9737	property returns the medium object itself (i.e. the same object this
9738	property is read on).
9739	</desc>
9740	</attribute>
9741
9742	<attribute name="readOnly" type="boolean" readonly="yes">
9743	<desc>
9744	Returns @c true if this medium is read-only and @c false otherwise.
9745
9746	A medium is considered to be read-only when its contents cannot be
9747	modified without breaking the integrity of other parties that depend on
9748	this medium such as its child media or snapshots of virtual machines
9749	where this medium is attached to these machines. If there are no
9750	children and no such snapshots then there is no dependency and the
9751	medium is not read-only.
9752
9753	The value of this attribute can be used to determine the kind of the
9754	attachment that will take place when attaching this medium to a
9755	virtual machine. If the value is @c false then the medium will
9756	be attached directly. If the value is @c true then the medium
9757	will be attached indirectly by creating a new differencing child
9758	medium for that. See the interface description for more information.
9759
9760	Note that all <link to="MediumType_Immutable">Immutable</link> media
9761	are always read-only while all
9762	<link to="MediumType_Writethrough">Writethrough</link> media are
9763	always not.
9764
9765	<note>
9766	The read-only condition represented by this attribute is related to
9767	the medium type and usage, not to the current
9768	<link to="IMedium::state">medium state</link> and not to the read-only
9769	state of the storage unit.
9770	</note>
9771	</desc>
9772	</attribute>
9773
9774	<attribute name="logicalSize" type="long long" readonly="yes">
9775	<desc>
9776	Logical size of this medium (in bytes), as reported to the
9777	guest OS running inside the virtual machine this medium is
9778	attached to. The logical size is defined when the medium is created
9779	and cannot be changed later.
9780
9781	<note>
9782	Reading this property on a differencing medium will return the size
9783	of its <link to="#base"/> medium.
9784	</note>
9785	<note>
9786	For media whose state is <link to="#state"/> is <link
9787	to="MediumState_Inaccessible"/>, the value of this property is the
9788	last known logical size. For <link to="MediumState_NotCreated"/>
9789	media, the returned value is zero.
9790	</note>
9791	</desc>
9792	</attribute>
9793
9794	<attribute name="autoReset" type="boolean">
9795	<desc>
9796	Whether this differencing medium will be automatically reset each
9797	time a virtual machine it is attached to is powered up. This
9798	attribute is automatically set to @c true for the last
9799	differencing image of an "immutable" medium (see
9800	<link to="MediumType" />).
9801
9802	See <link to="#reset"/> for more information about resetting
9803	differencing media.
9804
9805	<note>
9806	Reading this property on a base (non-differencing) medium will
9807	always @c false. Changing the value of this property in this
9808	case is not supported.
9809	</note>
9810
9811	<result name="VBOX_E_NOT_SUPPORTED">
9812	This is not a differencing medium (when changing the attribute
9813	value).
9814	</result>
9815	</desc>
9816	</attribute>
9817
9818	<attribute name="lastAccessError" type="wstring" readonly="yes">
9819	<desc>
9820	Text message that represents the result of the last accessibility
9821	check performed by <link to="#refreshState"/>.
9822
9823	An empty string is returned if the last accessibility check
9824	was successful or has not yet been called. As a result, if
9825	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9826	then <link to="#refreshState"/> has yet to be called; this is the
9827	default value of media after VirtualBox initialization.
9828	A non-empty string indicates a failure and should normally describe
9829	a reason of the failure (for example, a file read error).
9830	</desc>
9831	</attribute>
9832
9833	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9834	<desc>
9835	Array of UUIDs of all machines this medium is attached to.
9836
9837	A @c null array is returned if this medium is not attached to any
9838	machine or to any machine's snapshot.
9839
9840	<note>
9841	The returned array will include a machine even if this medium is not
9842	attached to that machine in the current state but attached to it in
9843	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9844	details.
9845	</note>
9846	</desc>
9847	</attribute>
9848
9849	<method name="setIDs">
9850	<desc>
9851	Changes the UUID and parent UUID for a hard disk medium.
9852	</desc>
9853	<param name="setImageId" type="boolean" dir="in">
9854	<desc>
9855	Select whether a new image UUID is set or not.
9856	</desc>
9857	</param>
9858	<param name="imageId" type="uuid" mod="string" dir="in">
9859	<desc>
9860	New UUID for the image. If an empty string is passed, then a new
9861	UUID is automatically created, provided that @a setImageId is @c true.
9862	Specifying a zero UUID is not allowed.
9863	</desc>
9864	</param>
9865	<param name="setParentId" type="boolean" dir="in">
9866	<desc>
9867	Select whether a new parent UUID is set or not.
9868	</desc>
9869	</param>
9870	<param name="parentId" type="uuid" mod="string" dir="in">
9871	<desc>
9872	New parent UUID for the image. If an empty string is passed, then a
9873	new UUID is automatically created, provided @a setParentId is
9874	@c true. A zero UUID is valid.
9875	</desc>
9876	</param>
9877	<result name="E_INVALIDARG">
9878	Invalid parameter combination.
9879	</result>
9880	<result name="VBOX_E_NOT_SUPPORTED">
9881	Medium is not a hard disk medium.
9882	</result>
9883	</method>
9884
9885	<method name="refreshState">
9886	<desc>
9887	If the current medium state (see <link to="MediumState"/>) is one of
9888	"Created", "Inaccessible" or "LockedRead", then this performs an
9889	accessibility check on the medium and sets the value of the <link to="#state"/>
9890	attribute accordingly; that value is also returned for convenience.
9891
9892	For all other state values, this does not perform a refresh but returns
9893	the state only.
9894
9895	The refresh, if performed, may take a long time (several seconds or even
9896	minutes, depending on the storage unit location and format) because it performs an
9897	accessibility check of the storage unit. This check may cause a significant
9898	delay if the storage unit of the given medium is, for example, a file located
9899	on a network share which is not currently accessible due to connectivity
9900	problems. In that case, the call will not return until a timeout
9901	interval defined by the host OS for this operation expires. For this reason,
9902	it is recommended to never read this attribute on the main UI thread to avoid
9903	making the UI unresponsive.
9904
9905	If the last known state of the medium is "Created" and the accessibility
9906	check fails, then the state would be set to "Inaccessible", and
9907	<link to="#lastAccessError"/> may be used to get more details about the
9908	failure. If the state of the medium is "LockedRead", then it remains the
9909	same, and a non-empty value of <link to="#lastAccessError"/> will
9910	indicate a failed accessibility check in this case.
9911
9912	Note that not all medium states are applicable to all medium types.
9913	</desc>
9914	<param name="state" type="MediumState" dir="return">
9915	<desc>
9916	New medium state.
9917	</desc>
9918	</param>
9919	</method>
9920
9921	<method name="getSnapshotIds">
9922	<desc>
9923	Returns an array of UUIDs of all snapshots of the given machine where
9924	this medium is attached to.
9925
9926	If the medium is attached to the machine in the current state, then the
9927	first element in the array will always be the ID of the queried machine
9928	(i.e. the value equal to the @c machineId argument), followed by
9929	snapshot IDs (if any).
9930
9931	If the medium is not attached to the machine in the current state, then
9932	the array will contain only snapshot IDs.
9933
9934	The returned array may be @c null if this medium is not attached
9935	to the given machine at all, neither in the current state nor in one of
9936	the snapshots.
9937	</desc>
9938	<param name="machineId" type="uuid" mod="string" dir="in">
9939	<desc>
9940	UUID of the machine to query.
9941	</desc>
9942	</param>
9943	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9944	<desc>
9945	Array of snapshot UUIDs of the given machine using this medium.
9946	</desc>
9947	</param>
9948	</method>
9949
9950	<method name="lockRead">
9951	<desc>
9952	Locks this medium for reading.
9953
9954	A read lock is shared: many clients can simultaneously lock the
9955	same medium for reading unless it is already locked for writing (see
9956	<link to="#lockWrite"/>) in which case an error is returned.
9957
9958	When the medium is locked for reading, it cannot be modified
9959	from within VirtualBox. This means that any method that changes
9960	the properties of this medium or contents of the storage unit
9961	will return an error (unless explicitly stated otherwise). That
9962	includes an attempt to start a virtual machine that wants to
9963	write to the the medium.
9964
9965	When the virtual machine is started up, it locks for reading all
9966	media it uses in read-only mode. If some medium cannot be locked
9967	for reading, the startup procedure will fail.
9968	A medium is typically locked for reading while it is used by a running
9969	virtual machine but has a depending differencing image that receives
9970	the actual write operations. This way one base medium can have
9971	multiple child differencing images which can be written to
9972	simultaneously. Read-only media such as DVD and floppy images are
9973	also locked for reading only (so they can be in use by multiple
9974	machines simultaneously).
9975
9976	A medium is also locked for reading when it is the source of a
9977	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9978
9979	The medium locked for reading must be unlocked using the <link
9980	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9981	can be nested and must be followed by the same number of paired
9982	<link to="#unlockRead"/> calls.
9983
9984	This method sets the medium state (see <link to="#state"/>) to
9985	"LockedRead" on success. The medium's previous state must be
9986	one of "Created", "Inaccessible" or "LockedRead".
9987
9988	Locking an inaccessible medium is not an error; this method performs
9989	a logical lock that prevents modifications of this medium through
9990	the VirtualBox API, not a physical file-system lock of the underlying
9991	storage unit.
9992
9993	This method returns the current state of the medium
9994	<i>before</i> the operation.
9995
9996	<result name="VBOX_E_INVALID_OBJECT_STATE">
9997	Invalid medium state (e.g. not created, locked, inaccessible,
9998	creating, deleting).
9999	</result>
10000
10001	</desc>
10002	<param name="state" type="MediumState" dir="return">
10003	<desc>
10004	State of the medium after the operation.
10005	</desc>
10006	</param>
10007	</method>
10008
10009	<method name="unlockRead">
10010	<desc>
10011	Cancels the read lock previously set by <link to="#lockRead"/>.
10012
10013	For both success and failure, this method returns the current state
10014	of the medium <i>after</i> the operation.
10015
10016	See <link to="#lockRead"/> for more details.
10017
10018	<result name="VBOX_E_INVALID_OBJECT_STATE">
10019	Medium not locked for reading.
10020	</result>
10021
10022	</desc>
10023	<param name="state" type="MediumState" dir="return">
10024	<desc>
10025	State of the medium after the operation.
10026	</desc>
10027	</param>
10028	</method>
10029
10030	<method name="lockWrite">
10031	<desc>
10032	Locks this medium for writing.
10033
10034	A write lock, as opposed to <link to="#lockRead"/>, is
10035	exclusive: there may be only one client holding a write lock,
10036	and there may be no read locks while the write lock is held.
10037	As a result, read-locking fails if a write lock is held, and
10038	write-locking fails if either a read or another write lock is held.
10039
10040	When a medium is locked for writing, it cannot be modified
10041	from within VirtualBox, and it is not guaranteed that the values
10042	of its properties are up-to-date. Any method that changes the
10043	properties of this medium or contents of the storage unit will
10044	return an error (unless explicitly stated otherwise).
10045
10046	When a virtual machine is started up, it locks for writing all
10047	media it uses to write data to. If any medium could not be locked
10048	for writing, the startup procedure will fail. If a medium has
10049	differencing images, then while the machine is running, only
10050	the last ("leaf") differencing image is locked for writing,
10051	whereas its parents are locked for reading only.
10052
10053	A medium is also locked for writing when it is the target of a
10054	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10055
10056	The medium locked for writing must be unlocked using the <link
10057	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10058
10059	This method sets the medium state (see <link to="#state"/>) to
10060	"LockedWrite" on success. The medium's previous state must be
10061	either "Created" or "Inaccessible".
10062
10063	Locking an inaccessible medium is not an error; this method performs
10064	a logical lock that prevents modifications of this medium through
10065	the VirtualBox API, not a physical file-system lock of the underlying
10066	storage unit.
10067
10068	For both, success and failure, this method returns the current
10069	state of the medium <i>before</i> the operation.
10070
10071	<result name="VBOX_E_INVALID_OBJECT_STATE">
10072	Invalid medium state (e.g. not created, locked, inaccessible,
10073	creating, deleting).
10074	</result>
10075
10076	</desc>
10077	<param name="state" type="MediumState" dir="return">
10078	<desc>
10079	State of the medium after the operation.
10080	</desc>
10081	</param>
10082	</method>
10083
10084	<method name="unlockWrite">
10085	<desc>
10086	Cancels the write lock previously set by <link to="#lockWrite"/>.
10087
10088	For both success and failure, this method returns the current
10089	state of the medium <i>after</i> the operation.
10090
10091	See <link to="#lockWrite"/> for more details.
10092
10093	<result name="VBOX_E_INVALID_OBJECT_STATE">
10094	Medium not locked for writing.
10095	</result>
10096
10097	</desc>
10098	<param name="state" type="MediumState" dir="return">
10099	<desc>
10100	State of the medium after the operation.
10101	</desc>
10102	</param>
10103	</method>
10104
10105	<method name="close">
10106	<desc>
10107	Closes this medium.
10108
10109	The medium must not be attached to any known virtual machine
10110	and must not have any known child media, otherwise the
10111	operation will fail.
10112
10113	When the medium is successfully closed, it is removed from
10114	the list of registered media, but its storage unit is not
10115	deleted. In particular, this means that this medium can
10116	later be opened again using the <link to="IVirtualBox::openMedium"/>
10117	call.
10118
10119	Note that after this method successfully returns, the given medium
10120	object becomes uninitialized. This means that any attempt
10121	to call any of its methods or attributes will fail with the
10122	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10123
10124	<result name="VBOX_E_INVALID_OBJECT_STATE">
10125	Invalid medium state (other than not created, created or
10126	inaccessible).
10127	</result>
10128	<result name="VBOX_E_OBJECT_IN_USE">
10129	Medium attached to virtual machine.
10130	</result>
10131	<result name="VBOX_E_FILE_ERROR">
10132	Settings file not accessible.
10133	</result>
10134	<result name="VBOX_E_XML_ERROR">
10135	Could not parse the settings file.
10136	</result>
10137
10138	</desc>
10139	</method>
10140
10141	<!-- storage methods -->
10142
10143	<method name="getProperty">
10144	<desc>
10145	Returns the value of the custom medium property with the given name.
10146
10147	The list of all properties supported by the given medium format can
10148	be obtained with <link to="IMediumFormat::describeProperties"/>.
10149
10150	Note that if this method returns an empty string in @a value, the
10151	requested property is supported but currently not assigned any value.
10152
10153	<result name="VBOX_E_OBJECT_NOT_FOUND">
10154	Requested property does not exist (not supported by the format).
10155	</result>
10156	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10157	</desc>
10158	<param name="name" type="wstring" dir="in">
10159	<desc>Name of the property to get.</desc>
10160	</param>
10161	<param name="value" type="wstring" dir="return">
10162	<desc>Current property value.</desc>
10163	</param>
10164	</method>
10165
10166	<method name="setProperty">
10167	<desc>
10168	Sets the value of the custom medium property with the given name.
10169
10170	The list of all properties supported by the given medium format can
10171	be obtained with <link to="IMediumFormat::describeProperties"/>.
10172
10173	Note that setting the property value to @c null or an empty string is
10174	equivalent to deleting the existing value. A default value (if it is
10175	defined for this property) will be used by the format backend in this
10176	case.
10177
10178	<result name="VBOX_E_OBJECT_NOT_FOUND">
10179	Requested property does not exist (not supported by the format).
10180	</result>
10181	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10182	</desc>
10183	<param name="name" type="wstring" dir="in">
10184	<desc>Name of the property to set.</desc>
10185	</param>
10186	<param name="value" type="wstring" dir="in">
10187	<desc>Property value to set.</desc>
10188	</param>
10189	</method>
10190
10191	<method name="getProperties">
10192	<desc>
10193	Returns values for a group of properties in one call.
10194
10195	The names of the properties to get are specified using the @a names
10196	argument which is a list of comma-separated property names or
10197	an empty string if all properties are to be returned. Note that currently
10198	the value of this argument is ignored and the method always returns all
10199	existing properties.
10200
10201	The list of all properties supported by the given medium format can
10202	be obtained with <link to="IMediumFormat::describeProperties"/>.
10203
10204	The method returns two arrays, the array of property names corresponding
10205	to the @a names argument and the current values of these properties.
10206	Both arrays have the same number of elements with each elemend at the
10207	given index in the first array corresponds to an element at the same
10208	index in the second array.
10209
10210	Note that for properties that do not have assigned values,
10211	an empty string is returned at the appropriate index in the
10212	@a returnValues array.
10213
10214	</desc>
10215	<param name="names" type="wstring" dir="in">
10216	<desc>
10217	Names of properties to get.
10218	</desc>
10219	</param>
10220	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10221	<desc>Names of returned properties.</desc>
10222	</param>
10223	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10224	<desc>Values of returned properties.</desc>
10225	</param>
10226	</method>
10227
10228	<method name="setProperties">
10229	<desc>
10230	Sets values for a group of properties in one call.
10231
10232	The names of the properties to set are passed in the @a names
10233	array along with the new values for them in the @a values array. Both
10234	arrays have the same number of elements with each elemend at the given
10235	index in the first array corresponding to an element at the same index
10236	in the second array.
10237
10238	If there is at least one property name in @a names that is not valid,
10239	the method will fail before changing the values of any other properties
10240	from the @a names array.
10241
10242	Using this method over <link to="#setProperty"/> is preferred if you
10243	need to set several properties at once since it will result into less
10244	IPC calls.
10245
10246	The list of all properties supported by the given medium format can
10247	be obtained with <link to="IMediumFormat::describeProperties"/>.
10248
10249	Note that setting the property value to @c null or an empty string is
10250	equivalent to deleting the existing value. A default value (if it is
10251	defined for this property) will be used by the format backend in this
10252	case.
10253	</desc>
10254	<param name="names" type="wstring" safearray="yes" dir="in">
10255	<desc>Names of properties to set.</desc>
10256	</param>
10257	<param name="values" type="wstring" safearray="yes" dir="in">
10258	<desc>Values of properties to set.</desc>
10259	</param>
10260	</method>
10261
10262	<!-- storage methods -->
10263
10264	<method name="createBaseStorage">
10265	<desc>
10266	Starts creating a hard disk storage unit (fixed/dynamic, according
10267	to the variant flags) in in the background. The previous storage unit
10268	created for this object, if any, must first be deleted using
10269	<link to="#deleteStorage"/>, otherwise the operation will fail.
10270
10271	Before the operation starts, the medium is placed in
10272	<link to="MediumState_Creating"/> state. If the create operation
10273	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10274	state.
10275
10276	After the returned progress object reports that the operation has
10277	successfully completed, the medium state will be set to <link
10278	to="MediumState_Created"/>, the medium will be remembered by this
10279	VirtualBox installation and may be attached to virtual machines.
10280
10281	<result name="VBOX_E_NOT_SUPPORTED">
10282	The variant of storage creation operation is not supported. See <link
10283	to="IMediumFormat::capabilities"/>.
10284	</result>
10285	</desc>
10286	<param name="logicalSize" type="long long" dir="in">
10287	<desc>Maximum logical size of the medium in bytes.</desc>
10288	</param>
10289	<param name="variant" type="unsigned long" dir="in">
10290	<desc>Exact image variant which should be created (as a combination of
10291	<link to="MediumVariant" /> flags).</desc>
10292	</param>
10293	<param name="progress" type="IProgress" dir="return">
10294	<desc>Progress object to track the operation completion.</desc>
10295	</param>
10296	</method>
10297
10298	<method name="deleteStorage">
10299	<desc>
10300	Starts deleting the storage unit of this medium.
10301
10302	The medium must not be attached to any known virtual machine and must
10303	not have any known child media, otherwise the operation will fail.
10304	It will also fail if there is no storage unit to delete or if deletion
10305	is already in progress, or if the medium is being in use (locked for
10306	read or for write) or inaccessible. Therefore, the only valid state for
10307	this operation to succeed is <link to="MediumState_Created"/>.
10308
10309	Before the operation starts, the medium is placed in
10310	<link to="MediumState_Deleting"/> state and gets removed from the list
10311	of remembered hard disks (media registry). If the delete operation
10312	fails, the medium will be remembered again and placed back to
10313	<link to="MediumState_Created"/> state.
10314
10315	After the returned progress object reports that the operation is
10316	complete, the medium state will be set to
10317	<link to="MediumState_NotCreated"/> and you will be able to use one of
10318	the storage creation methods to create it again.
10319
10320	<see>#close()</see>
10321
10322	<result name="VBOX_E_OBJECT_IN_USE">
10323	Medium is attached to a virtual machine.
10324	</result>
10325	<result name="VBOX_E_NOT_SUPPORTED">
10326	Storage deletion is not allowed because neither of storage creation
10327	operations are supported. See
10328	<link to="IMediumFormat::capabilities"/>.
10329	</result>
10330
10331	<note>
10332	If the deletion operation fails, it is not guaranteed that the storage
10333	unit still exists. You may check the <link to="IMedium::state"/> value
10334	to answer this question.
10335	</note>
10336	</desc>
10337	<param name="progress" type="IProgress" dir="return">
10338	<desc>Progress object to track the operation completion.</desc>
10339	</param>
10340	</method>
10341
10342	<!-- diff methods -->
10343
10344	<method name="createDiffStorage">
10345	<desc>
10346	Starts creating an empty differencing storage unit based on this
10347	medium in the format and at the location defined by the @a target
10348	argument.
10349
10350	The target medium must be in <link to="MediumState_NotCreated"/>
10351	state (i.e. must not have an existing storage unit). Upon successful
10352	completion, this operation will set the type of the target medium to
10353	<link to="MediumType_Normal"/> and create a storage unit necessary to
10354	represent the differencing medium data in the given format (according
10355	to the storage format of the target object).
10356
10357	After the returned progress object reports that the operation is
10358	successfully complete, the target medium gets remembered by this
10359	VirtualBox installation and may be attached to virtual machines.
10360
10361	<note>
10362	The medium will be set to <link to="MediumState_LockedRead"/>
10363	state for the duration of this operation.
10364	</note>
10365	<result name="VBOX_E_OBJECT_IN_USE">
10366	Medium not in @c NotCreated state.
10367	</result>
10368	</desc>
10369	<param name="target" type="IMedium" dir="in">
10370	<desc>Target medium.</desc>
10371	</param>
10372	<param name="variant" type="unsigned long" dir="in">
10373	<desc>Exact image variant which should be created (as a combination of
10374	<link to="MediumVariant" /> flags).</desc>
10375	</param>
10376	<param name="progress" type="IProgress" dir="return">
10377	<desc>Progress object to track the operation completion.</desc>
10378	</param>
10379	</method>
10380
10381	<method name="mergeTo">
10382	<desc>
10383	Starts merging the contents of this medium and all intermediate
10384	differencing media in the chain to the given target medium.
10385
10386	The target medium must be either a descendant of this medium or
10387	its ancestor (otherwise this method will immediately return a failure).
10388	It follows that there are two logical directions of the merge operation:
10389	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10390	ancestor (<i>backward merge</i>). Let us consider the following medium
10391	chain:
10392
10393	<pre>Base <- Diff_1 <- Diff_2</pre>
10394
10395	Here, calling this method on the <tt>Base</tt> medium object with
10396	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10397	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10398	merge. Note that in both cases the contents of the resulting medium
10399	will be the same, the only difference is the medium object that takes
10400	the result of the merge operation. In case of the forward merge in the
10401	above example, the result will be written to <tt>Diff_2</tt>; in case of
10402	the backward merge, the result will be written to <tt>Base</tt>. In
10403	other words, the result of the operation is always stored in the target
10404	medium.
10405
10406	Upon successful operation completion, the storage units of all media in
10407	the chain between this (source) medium and the target medium, including
10408	the source medium itself, will be automatically deleted and the
10409	relevant medium objects (including this medium) will become
10410	uninitialized. This means that any attempt to call any of
10411	their methods or attributes will fail with the
10412	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10413	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10414	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10415	Note that <tt>Diff_2</tt> in this case will become a base medium
10416	itself since it will no longer be based on any other medium.
10417
10418	Considering the above, all of the following conditions must be met in
10419	order for the merge operation to succeed:
10420	<ul>
10421	<li>
10422	Neither this (source) medium nor any intermediate
10423	differencing medium in the chain between it and the target
10424	medium is attached to any virtual machine.
10425	</li>
10426	<li>
10427	Neither the source medium nor the target medium is an
10428	<link to="MediumType_Immutable"/> medium.
10429	</li>
10430	<li>
10431	The part of the medium tree from the source medium to the
10432	target medium is a linear chain, i.e. all medium in this
10433	chain have exactly one child which is the next medium in this
10434	chain. The only exception from this rule is the target medium in
10435	the forward merge operation; it is allowed to have any number of
10436	child media because the merge operation will not change its
10437	logical contents (as it is seen by the guest OS or by children).
10438	</li>
10439	<li>
10440	None of the involved media are in
10441	<link to="MediumState_LockedRead"/> or
10442	<link to="MediumState_LockedWrite"/> state.
10443	</li>
10444	</ul>
10445
10446	<note>
10447	This (source) medium and all intermediates will be placed to <link
10448	to="MediumState_Deleting"/> state and the target medium will be
10449	placed to <link to="MediumState_LockedWrite"/> state and for the
10450	duration of this operation.
10451	</note>
10452	</desc>
10453	<param name="target" type="IMedium" dir="in">
10454	<desc>Target medium.</desc>
10455	</param>
10456	<param name="progress" type="IProgress" dir="return">
10457	<desc>Progress object to track the operation completion.</desc>
10458	</param>
10459	</method>
10460
10461	<!-- clone method -->
10462
10463	<method name="cloneTo">
10464	<desc>
10465	Starts creating a clone of this medium in the format and at the
10466	location defined by the @a target argument.
10467
10468	The target medium must be either in <link to="MediumState_NotCreated"/>
10469	state (i.e. must not have an existing storage unit) or in
10470	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10471	big enough to hold the data or else the copy will be partial). Upon
10472	successful completion, the cloned medium will contain exactly the
10473	same sector data as the medium being cloned, except that in the
10474	first case a new UUID for the clone will be randomly generated, and in
10475	the second case the UUID will remain unchanged.
10476
10477	The @a parent argument defines which medium will be the parent
10478	of the clone. Passing a @c null reference indicates that the clone will
10479	be a base image, i.e. completely independent. It is possible to specify
10480	an arbitrary medium for this parameter, including the parent of the
10481	medium which is being cloned. Even cloning to a child of the source
10482	medium is possible. Note that when cloning to an existing image, the
10483	@a parent irgument is ignored.
10484
10485	After the returned progress object reports that the operation is
10486	successfully complete, the target medium gets remembered by this
10487	VirtualBox installation and may be attached to virtual machines.
10488
10489	<note>
10490	This medium will be placed to <link to="MediumState_LockedRead"/>
10491	state for the duration of this operation.
10492	</note>
10493	<result name="E_NOTIMPL">
10494	The specified cloning variant is not supported at the moment.
10495	</result>
10496	</desc>
10497	<param name="target" type="IMedium" dir="in">
10498	<desc>Target medium.</desc>
10499	</param>
10500	<param name="variant" type="unsigned long" dir="in">
10501	<desc>Exact image variant which should be created (as a combination of
10502	<link to="MediumVariant" /> flags).</desc>
10503	</param>
10504	<param name="parent" type="IMedium" dir="in">
10505	<desc>Parent of the cloned medium.</desc>
10506	</param>
10507	<param name="progress" type="IProgress" dir="return">
10508	<desc>Progress object to track the operation completion.</desc>
10509	</param>
10510	</method>
10511
10512	<!-- other methods -->
10513
10514	<method name="compact">
10515	<desc>
10516	Starts compacting of this medium. This means that the medium is
10517	transformed into a possibly more compact storage representation.
10518	This potentially creates temporary images, which can require a
10519	substantial amount of additional disk space.
10520
10521	This medium will be placed to <link to="MediumState_LockedWrite"/>
10522	state and all its parent media (if any) will be placed to
10523	<link to="MediumState_LockedRead"/> state for the duration of this
10524	operation.
10525
10526	Please note that the results can be either returned straight away,
10527	or later as the result of the background operation via the object
10528	returned via the @a progress parameter.
10529
10530	<result name="VBOX_E_NOT_SUPPORTED">
10531	Medium format does not support compacting (but potentially
10532	needs it).
10533	</result>
10534	</desc>
10535	<param name="progress" type="IProgress" dir="return">
10536	<desc>Progress object to track the operation completion.</desc>
10537	</param>
10538	</method>
10539
10540	<method name="resize">
10541	<desc>
10542	Starts resizing this medium. This means that the nominal size of the
10543	medium is set to the new value. Both increasing and decreasing the
10544	size is possible, and there are no safety checks, since VirtualBox
10545	does not make any assumptions about the medium contents.
10546
10547	Resizing usually needs additional disk space, and possibly also
10548	some temporary disk space. Note that resize does not create a full
10549	temporary copy of the medium, so the additional disk space requirement
10550	is usually much lower than using the clone operation.
10551
10552	This medium will be placed to <link to="MediumState_LockedWrite"/>
10553	state for the duration of this operation.
10554
10555	Please note that the results can be either returned straight away,
10556	or later as the result of the background operation via the object
10557	returned via the @a progress parameter.
10558
10559	<result name="VBOX_E_NOT_SUPPORTED">
10560	Medium format does not support resizing.
10561	</result>
10562	</desc>
10563	<param name="logicalSize" type="long long" dir="in">
10564	<desc>New nominal capacity of the medium in bytes.</desc>
10565	</param>
10566	<param name="progress" type="IProgress" dir="return">
10567	<desc>Progress object to track the operation completion.</desc>
10568	</param>
10569	</method>
10570
10571	<method name="reset">
10572	<desc>
10573	Starts erasing the contents of this differencing medium.
10574
10575	This operation will reset the differencing medium to its initial
10576	state when it does not contain any sector data and any read operation is
10577	redirected to its parent medium. This automatically gets called
10578	during VM power-up for every medium whose <link to="#autoReset" />
10579	attribute is @c true.
10580
10581	The medium will be write-locked for the duration of this operation (see
10582	<link to="#lockWrite" />).
10583
10584	<result name="VBOX_E_NOT_SUPPORTED">
10585	This is not a differencing medium.
10586	</result>
10587	<result name="VBOX_E_INVALID_OBJECT_STATE">
10588	Medium is not in <link to="MediumState_Created"/> or
10589	<link to="MediumState_Inaccessible"/> state.
10590	</result>
10591	</desc>
10592	<param name="progress" type="IProgress" dir="return">
10593	<desc>Progress object to track the operation completion.</desc>
10594	</param>
10595	</method>
10596
10597	</interface>
10598
10599
10600	<!--
10601	// IMediumFormat
10602	/////////////////////////////////////////////////////////////////////////
10603	-->
10604
10605	<enum
10606	name="DataType"
10607	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10608	>
10609	<const name="Int32" value="0"/>
10610	<const name="Int8" value="1"/>
10611	<const name="String" value="2"/>
10612	</enum>
10613
10614	<enum
10615	name="DataFlags"
10616	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10617	>
10618	<const name="None" value="0x00"/>
10619	<const name="Mandatory" value="0x01"/>
10620	<const name="Expert" value="0x02"/>
10621	<const name="Array" value="0x04"/>
10622	<const name="FlagMask" value="0x07"/>
10623	</enum>
10624
10625	<enum
10626	name="MediumFormatCapabilities"
10627	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10628	>
10629	<desc>
10630	Medium format capability flags.
10631	</desc>
10632
10633	<const name="Uuid" value="0x01">
10634	<desc>
10635	Supports UUIDs as expected by VirtualBox code.
10636	</desc>
10637	</const>
10638
10639	<const name="CreateFixed" value="0x02">
10640	<desc>
10641	Supports creating fixed size images, allocating all space instantly.
10642	</desc>
10643	</const>
10644
10645	<const name="CreateDynamic" value="0x04">
10646	<desc>
10647	Supports creating dynamically growing images, allocating space on
10648	demand.
10649	</desc>
10650	</const>
10651
10652	<const name="CreateSplit2G" value="0x08">
10653	<desc>
10654	Supports creating images split in chunks of a bit less than 2 GBytes.
10655	</desc>
10656	</const>
10657
10658	<const name="Differencing" value="0x10">
10659	<desc>
10660	Supports being used as a format for differencing media (see <link
10661	to="IMedium::createDiffStorage"/>).
10662	</desc>
10663	</const>
10664
10665	<const name="Asynchronous" value="0x20">
10666	<desc>
10667	Supports asynchronous I/O operations for at least some configurations.
10668	</desc>
10669	</const>
10670
10671	<const name="File" value="0x40">
10672	<desc>
10673	The format backend operates on files (the <link to="IMedium::location"/>
10674	attribute of the medium specifies a file used to store medium
10675	data; for a list of supported file extensions see
10676	<link to="IMediumFormat::describeFileExtensions"/>).
10677	</desc>
10678	</const>
10679
10680	<const name="Properties" value="0x80">
10681	<desc>
10682	The format backend uses the property interface to configure the storage
10683	location and properties (the <link to="IMediumFormat::describeProperties"/>
10684	method is used to get access to properties supported by the given medium format).
10685	</desc>
10686	</const>
10687
10688	<const name="TcpNetworking" value="0x100">
10689	<desc>
10690	The format backend uses the TCP networking interface for network access.
10691	</desc>
10692	</const>
10693
10694	<const name="VFS" value="0x200">
10695	<desc>
10696	The format backend supports virtual filesystem functionality.
10697	</desc>
10698	</const>
10699
10700	<const name="CapabilityMask" value="0x3FF"/>
10701	</enum>
10702
10703	<interface
10704	name="IMediumFormat" extends="$unknown"
10705	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10706	wsmap="managed"
10707	>
10708	<desc>
10709	The IMediumFormat interface represents a medium format.
10710
10711	Each medium format has an associated backend which is used to handle
10712	media stored in this format. This interface provides information
10713	about the properties of the associated backend.
10714
10715	Each medium format is identified by a string represented by the
10716	<link to="#id"/> attribute. This string is used in calls like
10717	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10718	format.
10719
10720	The list of all supported medium formats can be obtained using
10721	<link to="ISystemProperties::mediumFormats"/>.
10722
10723	<see>IMedium</see>
10724	</desc>
10725
10726	<attribute name="id" type="wstring" readonly="yes">
10727	<desc>
10728	Identifier of this format.
10729
10730	The format identifier is a non-@c null non-empty ASCII string. Note that
10731	this string is case-insensitive. This means that, for example, all of
10732	the following strings:
10733	<pre>
10734	"VDI"
10735	"vdi"
10736	"VdI"</pre>
10737	refer to the same medium format.
10738
10739	This string is used in methods of other interfaces where it is necessary
10740	to specify a medium format, such as
10741	<link to="IVirtualBox::createHardDisk"/>.
10742	</desc>
10743	</attribute>
10744
10745	<attribute name="name" type="wstring" readonly="yes">
10746	<desc>
10747	Human readable description of this format.
10748
10749	Mainly for use in file open dialogs.
10750	</desc>
10751	</attribute>
10752
10753	<attribute name="capabilities" type="unsigned long" readonly="yes">
10754	<desc>
10755	Capabilities of the format as a set of bit flags.
10756
10757	For the meaning of individual capability flags see
10758	<link to="MediumFormatCapabilities"/>.
10759	</desc>
10760	</attribute>
10761
10762	<method name="describeFileExtensions">
10763	<desc>
10764	Returns two arrays describing the supported file extensions.
10765
10766	The first array contains the supported extensions and the seconds one
10767	the type each extension supports. Both have the same size.
10768
10769	Note that some backends do not work on files, so this array may be
10770	empty.
10771
10772	<see>IMediumFormat::capabilities</see>
10773	</desc>
10774	<param name="extensions" type="wstring" safearray="yes" dir="out">
10775	<desc>The array of supported extensions.</desc>
10776	</param>
10777	<param name="type" type="DeviceType" safearray="yes" dir="out">
10778	<desc>The array which indicates the device type for every given extension.</desc>
10779	</param>
10780	</method>
10781
10782	<method name="describeProperties">
10783	<desc>
10784	Returns several arrays describing the properties supported by this
10785	format.
10786
10787	An element with the given index in each array describes one
10788	property. Thus, the number of elements in each returned array is the
10789	same and corresponds to the number of supported properties.
10790
10791	The returned arrays are filled in only if the
10792	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10793	All arguments must be non-@c null.
10794
10795	<see>DataType</see>
10796	<see>DataFlags</see>
10797	</desc>
10798
10799	<param name="names" type="wstring" safearray="yes" dir="out">
10800	<desc>Array of property names.</desc>
10801	</param>
10802	<param name="description" type="wstring" safearray="yes" dir="out">
10803	<desc>Array of property descriptions.</desc>
10804	</param>
10805	<param name="types" type="DataType" safearray="yes" dir="out">
10806	<desc>Array of property types.</desc>
10807	</param>
10808	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10809	<desc>Array of property flags.</desc>
10810	</param>
10811	<param name="defaults" type="wstring" safearray="yes" dir="out">
10812	<desc>Array of default property values.</desc>
10813	</param>
10814	</method>
10815
10816	</interface>
10817
10818
10819	<!--
10820	// IKeyboard
10821	/////////////////////////////////////////////////////////////////////////
10822	-->
10823
10824	<interface
10825	name="IKeyboard" extends="$unknown"
10826	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10827	wsmap="managed"
10828	>
10829	<desc>
10830	The IKeyboard interface represents the virtual machine's keyboard. Used
10831	in <link to="IConsole::keyboard"/>.
10832
10833	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10834	to the virtual machine.
10835
10836	</desc>
10837	<method name="putScancode">
10838	<desc>Sends a scancode to the keyboard.
10839
10840	<result name="VBOX_E_IPRT_ERROR">
10841	Could not send scan code to virtual keyboard.
10842	</result>
10843
10844	</desc>
10845	<param name="scancode" type="long" dir="in"/>
10846	</method>
10847
10848	<method name="putScancodes">
10849	<desc>Sends an array of scancodes to the keyboard.
10850
10851	<result name="VBOX_E_IPRT_ERROR">
10852	Could not send all scan codes to virtual keyboard.
10853	</result>
10854
10855	</desc>
10856	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10857	<param name="codesStored" type="unsigned long" dir="return"/>
10858	</method>
10859
10860	<method name="putCAD">
10861	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10862	function is nothing special, it is just a convenience function
10863	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10864
10865	<result name="VBOX_E_IPRT_ERROR">
10866	Could not send all scan codes to virtual keyboard.
10867	</result>
10868
10869	</desc>
10870	</method>
10871
10872	<attribute name="eventSource" type="IEventSource" readonly="yes">
10873	<desc>
10874	Event source for keyboard events.
10875	</desc>
10876	</attribute>
10877
10878	</interface>
10879
10880
10881	<!--
10882	// IMouse
10883	/////////////////////////////////////////////////////////////////////////
10884	-->
10885
10886	<enum
10887	name="MouseButtonState"
10888	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10889	>
10890	<desc>
10891	Mouse button state.
10892	</desc>
10893
10894	<const name="LeftButton" value="0x01"/>
10895	<const name="RightButton" value="0x02"/>
10896	<const name="MiddleButton" value="0x04"/>
10897	<const name="WheelUp" value="0x08"/>
10898	<const name="WheelDown" value="0x10"/>
10899	<const name="XButton1" value="0x20"/>
10900	<const name="XButton2" value="0x40"/>
10901	<const name="MouseStateMask" value="0x7F"/>
10902	</enum>
10903
10904	<interface
10905	name="IMouse" extends="$unknown"
10906	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10907	wsmap="managed"
10908	>
10909	<desc>
10910	The IMouse interface represents the virtual machine's mouse. Used in
10911	<link to="IConsole::mouse"/>.
10912
10913	Through this interface, the virtual machine's virtual mouse can be
10914	controlled.
10915	</desc>
10916
10917	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10918	<desc>
10919	Whether the guest OS supports absolute mouse pointer positioning
10920	or not.
10921	<note>
10922	You can use the <link to="IMouseCapabilityChangedEvent"/>
10923	event to be instantly informed about changes of this attribute
10924	during virtual machine execution.
10925	</note>
10926	<see><link to="#putMouseEventAbsolute"/></see>
10927	</desc>
10928	</attribute>
10929
10930	<attribute name="relativeSupported" type="boolean" readonly="yes">
10931	<desc>
10932	Whether the guest OS supports relative mouse pointer positioning
10933	or not.
10934	<note>
10935	You can use the <link to="IMouseCapabilityChangedEvent"/>
10936	event to be instantly informed about changes of this attribute
10937	during virtual machine execution.
10938	</note>
10939	<see><link to="#putMouseEvent"/></see>
10940	</desc>
10941	</attribute>
10942
10943	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10944	<desc>
10945	Whether the guest OS can currently switch to drawing it's own mouse
10946	cursor on demand.
10947	<note>
10948	You can use the <link to="IMouseCapabilityChangedEvent"/>
10949	event to be instantly informed about changes of this attribute
10950	during virtual machine execution.
10951	</note>
10952	<see><link to="#putMouseEvent"/></see>
10953	</desc>
10954	</attribute>
10955
10956	<method name="putMouseEvent">
10957	<desc>
10958	Initiates a mouse event using relative pointer movements
10959	along x and y axis.
10960
10961	<result name="E_ACCESSDENIED">
10962	Console not powered up.
10963	</result>
10964	<result name="VBOX_E_IPRT_ERROR">
10965	Could not send mouse event to virtual mouse.
10966	</result>
10967
10968	</desc>
10969
10970	<param name="dx" type="long" dir="in">
10971	<desc>
10972	Amount of pixels the mouse should move to the right.
10973	Negative values move the mouse to the left.
10974	</desc>
10975	</param>
10976	<param name="dy" type="long" dir="in">
10977	<desc>
10978	Amount of pixels the mouse should move downwards.
10979	Negative values move the mouse upwards.
10980	</desc>
10981	</param>
10982	<param name="dz" type="long" dir="in">
10983	<desc>
10984	Amount of mouse wheel moves.
10985	Positive values describe clockwise wheel rotations,
10986	negative values describe counterclockwise rotations.
10987	</desc>
10988	</param>
10989	<param name="dw" type="long" dir="in">
10990	<desc>
10991	Amount of horizontal mouse wheel moves.
10992	Positive values describe a movement to the left,
10993	negative values describe a movement to the right.
10994	</desc>
10995	</param>
10996	<param name="buttonState" type="long" dir="in">
10997	<desc>
10998	The current state of mouse buttons. Every bit represents
10999	a mouse button as follows:
11000	<table>
11001	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11002	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11003	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11004	</table>
11005	A value of <tt>1</tt> means the corresponding button is pressed.
11006	otherwise it is released.
11007	</desc>
11008	</param>
11009	</method>
11010
11011	<method name="putMouseEventAbsolute">
11012	<desc>
11013	Positions the mouse pointer using absolute x and y coordinates.
11014	These coordinates are expressed in pixels and
11015	start from <tt>[1,1]</tt> which corresponds to the top left
11016	corner of the virtual display.
11017
11018	<result name="E_ACCESSDENIED">
11019	Console not powered up.
11020	</result>
11021	<result name="VBOX_E_IPRT_ERROR">
11022	Could not send mouse event to virtual mouse.
11023	</result>
11024
11025	<note>
11026	This method will have effect only if absolute mouse
11027	positioning is supported by the guest OS.
11028	</note>
11029
11030	<see><link to="#absoluteSupported"/></see>
11031	</desc>
11032
11033	<param name="x" type="long" dir="in">
11034	<desc>
11035	X coordinate of the pointer in pixels, starting from @c 1.
11036	</desc>
11037	</param>
11038	<param name="y" type="long" dir="in">
11039	<desc>
11040	Y coordinate of the pointer in pixels, starting from @c 1.
11041	</desc>
11042	</param>
11043	<param name="dz" type="long" dir="in">
11044	<desc>
11045	Amount of mouse wheel moves.
11046	Positive values describe clockwise wheel rotations,
11047	negative values describe counterclockwise rotations.
11048	</desc>
11049	</param>
11050	<param name="dw" type="long" dir="in">
11051	<desc>
11052	Amount of horizontal mouse wheel moves.
11053	Positive values describe a movement to the left,
11054	negative values describe a movement to the right.
11055	</desc>
11056	</param>
11057	<param name="buttonState" type="long" dir="in">
11058	<desc>
11059	The current state of mouse buttons. Every bit represents
11060	a mouse button as follows:
11061	<table>
11062	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11063	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11064	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11065	</table>
11066	A value of @c 1 means the corresponding button is pressed.
11067	otherwise it is released.
11068	</desc>
11069	</param>
11070	</method>
11071
11072	<attribute name="eventSource" type="IEventSource" readonly="yes">
11073	<desc>
11074	Event source for mouse events.
11075	</desc>
11076	</attribute>
11077
11078	</interface>
11079
11080	<!--
11081	// IDisplay
11082	/////////////////////////////////////////////////////////////////////////
11083	-->
11084
11085	<enum
11086	name="FramebufferPixelFormat"
11087	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11088	>
11089	<desc>
11090	Format of the video memory buffer. Constants represented by this enum can
11091	be used to test for particular values of <link
11092	to="IFramebuffer::pixelFormat"/>. See also <link
11093	to="IFramebuffer::requestResize"/>.
11094
11095	See also www.fourcc.org for more information about FOURCC pixel formats.
11096	</desc>
11097
11098	<const name="Opaque" value="0">
11099	<desc>
11100	Unknown buffer format (the user may not assume any particular format of
11101	the buffer).
11102	</desc>
11103	</const>
11104	<const name="FOURCC_RGB" value="0x32424752">
11105	<desc>
11106	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11107	bit layout).
11108	</desc>
11109	</const>
11110	</enum>
11111
11112	<interface
11113	name="IFramebuffer" extends="$unknown"
11114	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11115	wsmap="suppress"
11116	>
11117	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11118	<desc>Address of the start byte of the frame buffer.</desc>
11119	</attribute>
11120
11121	<attribute name="width" type="unsigned long" readonly="yes">
11122	<desc>Frame buffer width, in pixels.</desc>
11123	</attribute>
11124
11125	<attribute name="height" type="unsigned long" readonly="yes">
11126	<desc>Frame buffer height, in pixels.</desc>
11127	</attribute>
11128
11129	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11130	<desc>
11131	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11132	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11133	are: 8, 15, 16, 24 and 32.
11134	</desc>
11135	</attribute>
11136
11137	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11138	<desc>
11139	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11140	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11141	size of the scan line must be aligned to 32 bits.
11142	</desc>
11143	</attribute>
11144
11145	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11146	<desc>
11147	Frame buffer pixel format. It's either one of the values defined by <link
11148	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11149	<note>
11150	This attribute must never return <link
11151	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11152	<link to="#address"/> points to must be always known.
11153	</note>
11154	</desc>
11155	</attribute>
11156
11157	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11158	<desc>
11159	Defines whether this frame buffer uses the virtual video card's memory
11160	buffer (guest VRAM) directly or not. See <link
11161	to="IFramebuffer::requestResize"/> for more information.
11162	</desc>
11163	</attribute>
11164
11165	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11166	<desc>
11167	Hint from the frame buffer about how much of the standard
11168	screen height it wants to use for itself. This information is
11169	exposed to the guest through the VESA BIOS and VMMDev interface
11170	so that it can use it for determining its video mode table. It
11171	is not guaranteed that the guest respects the value.
11172	</desc>
11173	</attribute>
11174
11175	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11176	<desc>
11177	An alpha-blended overlay which is superposed over the frame buffer.
11178	The initial purpose is to allow the display of icons providing
11179	information about the VM state, including disk activity, in front
11180	ends which do not have other means of doing that. The overlay is
11181	designed to controlled exclusively by IDisplay. It has no locking
11182	of its own, and any changes made to it are not guaranteed to be
11183	visible until the affected portion of IFramebuffer is updated. The
11184	overlay can be created lazily the first time it is requested. This
11185	attribute can also return @c null to signal that the overlay is not
11186	implemented.
11187	</desc>
11188	</attribute>
11189
11190	<attribute name="winId" type="long long" readonly="yes">
11191	<desc>
11192	Platform-dependent identifier of the window where context of this
11193	frame buffer is drawn, or zero if there's no such window.
11194	</desc>
11195	</attribute>
11196
11197	<method name="lock">
11198	<desc>
11199	Locks the frame buffer.
11200	Gets called by the IDisplay object where this frame buffer is
11201	bound to.
11202	</desc>
11203	</method>
11204
11205	<method name="unlock">
11206	<desc>
11207	Unlocks the frame buffer.
11208	Gets called by the IDisplay object where this frame buffer is
11209	bound to.
11210	</desc>
11211	</method>
11212
11213	<method name="notifyUpdate">
11214	<desc>
11215	Informs about an update.
11216	Gets called by the display object where this buffer is
11217	registered.
11218	</desc>
11219	<param name="x" type="unsigned long" dir="in"/>
11220	<param name="y" type="unsigned long" dir="in"/>
11221	<param name="width" type="unsigned long" dir="in"/>
11222	<param name="height" type="unsigned long" dir="in"/>
11223	</method>
11224
11225	<method name="requestResize">
11226	<desc>
11227	Requests a size and pixel format change.
11228
11229	There are two modes of working with the video buffer of the virtual
11230	machine. The <i>indirect</i> mode implies that the IFramebuffer
11231	implementation allocates a memory buffer for the requested display mode
11232	and provides it to the virtual machine. In <i>direct</i> mode, the
11233	IFramebuffer implementation uses the memory buffer allocated and owned
11234	by the virtual machine. This buffer represents the video memory of the
11235	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11236	usually faster because the implementation gets a raw pointer to the
11237	guest VRAM buffer which it can directly use for visualizing the contents
11238	of the virtual display, as opposed to the indirect mode where the
11239	contents of guest VRAM are copied to the memory buffer provided by
11240	the implementation every time a display update occurs.
11241
11242	It is important to note that the direct mode is really fast only when
11243	the implementation uses the given guest VRAM buffer directly, for
11244	example, by blitting it to the window representing the virtual machine's
11245	display, which saves at least one copy operation comparing to the
11246	indirect mode. However, using the guest VRAM buffer directly is not
11247	always possible: the format and the color depth of this buffer may be
11248	not supported by the target window, or it may be unknown (opaque) as in
11249	case of text or non-linear multi-plane VGA video modes. In this case,
11250	the indirect mode (that is always available) should be used as a
11251	fallback: when the guest VRAM contents are copied to the
11252	implementation-provided memory buffer, color and format conversion is
11253	done automatically by the underlying code.
11254
11255	The @a pixelFormat parameter defines whether the direct mode is
11256	available or not. If @a pixelFormat is <link
11257	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11258	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11259	@a bytesPerLine parameters must be ignored and the implementation must use
11260	the indirect mode (where it provides its own buffer in one of the
11261	supported formats). In all other cases, @a pixelFormat together with
11262	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11263	buffer pointed to by the @a VRAM parameter and the implementation is
11264	free to choose which mode to use. To indicate that this frame buffer uses
11265	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11266	attribute must return @c true and <link to="#address"/> must
11267	return exactly the same address that is passed in the @a VRAM parameter
11268	of this method; otherwise it is assumed that the indirect strategy is
11269	chosen.
11270
11271	The @a width and @a height parameters represent the size of the
11272	requested display mode in both modes. In case of indirect mode, the
11273	provided memory buffer should be big enough to store data of the given
11274	display mode. In case of direct mode, it is guaranteed that the given
11275	@a VRAM buffer contains enough space to represent the display mode of the
11276	given size. Note that this frame buffer's <link to="#width"/> and <link
11277	to="#height"/> attributes must return exactly the same values as
11278	passed to this method after the resize is completed (see below).
11279
11280	The @a finished output parameter determines if the implementation has
11281	finished resizing the frame buffer or not. If, for some reason, the
11282	resize cannot be finished immediately during this call, @a finished
11283	must be set to @c false, and the implementation must call
11284	<link to="IDisplay::resizeCompleted"/> after it has returned from
11285	this method as soon as possible. If @a finished is @c false, the
11286	machine will not call any frame buffer methods until
11287	<link to="IDisplay::resizeCompleted"/> is called.
11288
11289	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11290	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11291	this frame buffer must return exactly the same values as specified in the
11292	parameters of this method, after the resize is completed. If the
11293	indirect mode is chosen, these attributes must return values describing
11294	the format of the implementation's own memory buffer <link
11295	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11296	value must always correlate with <link to="#pixelFormat"/>. Note that
11297	the <link to="#pixelFormat"/> attribute must never return <link
11298	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11299
11300	<note>
11301	This method is called by the IDisplay object under the
11302	<link to="#lock"/> provided by this IFramebuffer
11303	implementation. If this method returns @c false in @a finished, then
11304	this lock is not released until
11305	<link to="IDisplay::resizeCompleted"/> is called.
11306	</note>
11307	</desc>
11308	<param name="screenId" type="unsigned long" dir="in">
11309	<desc>
11310	Logical screen number. Must be used in the corresponding call to
11311	<link to="IDisplay::resizeCompleted"/> if this call is made.
11312	</desc>
11313	</param>
11314	<param name="pixelFormat" type="unsigned long" dir="in">
11315	<desc>
11316	Pixel format of the memory buffer pointed to by @a VRAM.
11317	See also <link to="FramebufferPixelFormat"/>.
11318	</desc>
11319	</param>
11320	<param name="VRAM" type="octet" mod="ptr" dir="in">
11321	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11322	</param>
11323	<param name="bitsPerPixel" type="unsigned long" dir="in">
11324	<desc>Color depth, bits per pixel.</desc>
11325	</param>
11326	<param name="bytesPerLine" type="unsigned long" dir="in">
11327	<desc>Size of one scan line, in bytes.</desc>
11328	</param>
11329	<param name="width" type="unsigned long" dir="in">
11330	<desc>Width of the guest display, in pixels.</desc>
11331	</param>
11332	<param name="height" type="unsigned long" dir="in">
11333	<desc>Height of the guest display, in pixels.</desc>
11334	</param>
11335	<param name="finished" type="boolean" dir="return">
11336	<desc>
11337	Can the VM start using the new frame buffer immediately
11338	after this method returns or it should wait for
11339	<link to="IDisplay::resizeCompleted"/>.
11340	</desc>
11341	</param>
11342	</method>
11343
11344	<method name="videoModeSupported">
11345	<desc>
11346	Returns whether the frame buffer implementation is willing to
11347	support a given video mode. In case it is not able to render
11348	the video mode (or for some reason not willing), it should
11349	return @c false. Usually this method is called when the guest
11350	asks the VMM device whether a given video mode is supported
11351	so the information returned is directly exposed to the guest.
11352	It is important that this method returns very quickly.
11353	</desc>
11354	<param name="width" type="unsigned long" dir="in"/>
11355	<param name="height" type="unsigned long" dir="in"/>
11356	<param name="bpp" type="unsigned long" dir="in"/>
11357	<param name="supported" type="boolean" dir="return"/>
11358	</method>
11359
11360	<method name="getVisibleRegion">
11361	<desc>
11362	Returns the visible region of this frame buffer.
11363
11364	If the @a rectangles parameter is @c null then the value of the
11365	@a count parameter is ignored and the number of elements necessary to
11366	describe the current visible region is returned in @a countCopied.
11367
11368	If @a rectangles is not @c null but @a count is less
11369	than the required number of elements to store region data, the method
11370	will report a failure. If @a count is equal or greater than the
11371	required number of elements, then the actual number of elements copied
11372	to the provided array will be returned in @a countCopied.
11373
11374	<note>
11375	The address of the provided array must be in the process space of
11376	this IFramebuffer object.
11377	</note>
11378	<note>
11379	Method not yet implemented.
11380	</note>
11381	</desc>
11382	<param name="rectangles" type="octet" mod="ptr" dir="in">
11383	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11384	</param>
11385	<param name="count" type="unsigned long" dir="in">
11386	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11387	</param>
11388	<param name="countCopied" type="unsigned long" dir="return">
11389	<desc>Number of elements copied to the @a rectangles array.</desc>
11390	</param>
11391	</method>
11392
11393	<method name="setVisibleRegion">
11394	<desc>
11395	Suggests a new visible region to this frame buffer. This region
11396	represents the area of the VM display which is a union of regions of
11397	all top-level windows of the guest operating system running inside the
11398	VM (if the Guest Additions for this system support this
11399	functionality). This information may be used by the frontends to
11400	implement the seamless desktop integration feature.
11401
11402	<note>
11403	The address of the provided array must be in the process space of
11404	this IFramebuffer object.
11405	</note>
11406	<note>
11407	The IFramebuffer implementation must make a copy of the provided
11408	array of rectangles.
11409	</note>
11410	<note>
11411	Method not yet implemented.
11412	</note>
11413	</desc>
11414	<param name="rectangles" type="octet" mod="ptr" dir="in">
11415	<desc>Pointer to the @c RTRECT array.</desc>
11416	</param>
11417	<param name="count" type="unsigned long" dir="in">
11418	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11419	</param>
11420	</method>
11421
11422	<method name="processVHWACommand">
11423	<desc>
11424	Posts a Video HW Acceleration Command to the frame buffer for processing.
11425	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11426	are posted from quest to the host to be processed by the host hardware.
11427
11428	<note>
11429	The address of the provided command must be in the process space of
11430	this IFramebuffer object.
11431	</note>
11432	</desc>
11433
11434	<param name="command" type="octet" mod="ptr" dir="in">
11435	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11436	</param>
11437	</method>
11438
11439	</interface>
11440
11441	<interface
11442	name="IFramebufferOverlay" extends="IFramebuffer"
11443	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11444	wsmap="suppress"
11445	>
11446	<desc>
11447	The IFramebufferOverlay interface represents an alpha blended overlay
11448	for displaying status icons above an IFramebuffer. It is always created
11449	not visible, so that it must be explicitly shown. It only covers a
11450	portion of the IFramebuffer, determined by its width, height and
11451	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11452	that order) format, and may be written to directly. Do re-read the
11453	width though, after setting it, as it may be adjusted (increased) to
11454	make it more suitable for the front end.
11455	</desc>
11456	<attribute name="x" type="unsigned long" readonly="yes">
11457	<desc>X position of the overlay, relative to the frame buffer.</desc>
11458	</attribute>
11459
11460	<attribute name="y" type="unsigned long" readonly="yes">
11461	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11462	</attribute>
11463
11464	<attribute name="visible" type="boolean" readonly="no">
11465	<desc>
11466	Whether the overlay is currently visible.
11467	</desc>
11468	</attribute>
11469
11470	<attribute name="alpha" type="unsigned long" readonly="no">
11471	<desc>
11472	The global alpha value for the overlay. This may or may not be
11473	supported by a given front end.
11474	</desc>
11475	</attribute>
11476
11477	<method name="move">
11478	<desc>
11479	Changes the overlay's position relative to the IFramebuffer.
11480	</desc>
11481	<param name="x" type="unsigned long" dir="in"/>
11482	<param name="y" type="unsigned long" dir="in"/>
11483	</method>
11484
11485	</interface>
11486
11487	<interface
11488	name="IDisplay" extends="$unknown"
11489	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11490	wsmap="managed"
11491	>
11492	<desc>
11493	The IDisplay interface represents the virtual machine's display.
11494
11495	The object implementing this interface is contained in each
11496	<link to="IConsole::display"/> attribute and represents the visual
11497	output of the virtual machine.
11498
11499	The virtual display supports pluggable output targets represented by the
11500	IFramebuffer interface. Examples of the output target are a window on
11501	the host computer or an RDP session's display on a remote computer.
11502	</desc>
11503	<method name="getScreenResolution">
11504	<desc>Queries display width, height and color depth for given screen.</desc>
11505	<param name="screenId" type="unsigned long" dir="in"/>
11506	<param name="width" type="unsigned long" dir="out"/>
11507	<param name="height" type="unsigned long" dir="out"/>
11508	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11509	</method>
11510
11511	<method name="setFramebuffer">
11512	<desc>
11513	Sets the framebuffer for given screen.
11514	</desc>
11515	<param name="screenId" type="unsigned long" dir="in"/>
11516	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11517	</method>
11518
11519	<method name="getFramebuffer">
11520	<desc>
11521	Queries the framebuffer for given screen.
11522	</desc>
11523	<param name="screenId" type="unsigned long" dir="in"/>
11524	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11525	<param name="xOrigin" type="long" dir="out"/>
11526	<param name="yOrigin" type="long" dir="out"/>
11527	</method>
11528
11529	<method name="setVideoModeHint">
11530	<desc>
11531	Asks VirtualBox to request the given video mode from
11532	the guest. This is just a hint and it cannot be guaranteed
11533	that the requested resolution will be used. Guest Additions
11534	are required for the request to be seen by guests. The caller
11535	should issue the request and wait for a resolution change and
11536	after a timeout retry.
11537
11538	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11539	parameters means that the corresponding values should be taken from the
11540	current video mode (i.e. left unchanged).
11541
11542	If the guest OS supports multi-monitor configuration then the @a display
11543	parameter specifies the number of the guest display to send the hint to:
11544	@c 0 is the primary display, @c 1 is the first secondary and
11545	so on. If the multi-monitor configuration is not supported, @a display
11546	must be @c 0.
11547
11548	<result name="E_INVALIDARG">
11549	The @a display is not associated with any monitor.
11550	</result>
11551
11552	</desc>
11553	<param name="width" type="unsigned long" dir="in"/>
11554	<param name="height" type="unsigned long" dir="in"/>
11555	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11556	<param name="display" type="unsigned long" dir="in"/>
11557	</method>
11558
11559	<method name="setSeamlessMode">
11560	<desc>
11561	Enables or disables seamless guest display rendering (seamless desktop
11562	integration) mode.
11563	<note>
11564	Calling this method has no effect if <link
11565	to="IGuest::getFacilityStatus"/> with facility <link to="AdditionsFacilityType::Seamless"/>
11566	does not return <link to="AdditionsFacilityStatus::Active"/>.
11567	</note>
11568	</desc>
11569	<param name="enabled" type="boolean" dir="in"/>
11570	</method>
11571
11572	<method name="takeScreenShot">
11573	<desc>
11574	Takes a screen shot of the requested size and copies it to the
11575	32-bpp buffer allocated by the caller and pointed to by @a address.
11576	A pixel consists of 4 bytes in order: B, G, R, 0.
11577
11578	<note>This API can be used only by the COM/XPCOM C++ API as it
11579	requires pointer support. Use <link to="#takeScreenShotToArray" />
11580	with other language bindings.
11581	</note>
11582
11583	<result name="E_NOTIMPL">
11584	Feature not implemented.
11585	</result>
11586	<result name="VBOX_E_IPRT_ERROR">
11587	Could not take a screenshot.
11588	</result>
11589
11590	</desc>
11591	<param name="screenId" type="unsigned long" dir="in"/>
11592	<param name="address" type="octet" mod="ptr" dir="in"/>
11593	<param name="width" type="unsigned long" dir="in"/>
11594	<param name="height" type="unsigned long" dir="in"/>
11595	</method>
11596
11597	<method name="takeScreenShotToArray">
11598	<desc>
11599	Takes a guest screen shot of the requested size and returns it as
11600	an array of bytes in uncompressed 32-bit RGBA format.
11601	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11602
11603	This API is slow, but could be the only option to get guest screenshot
11604	for scriptable languages not allowed to manipulate with addresses
11605	directly.
11606
11607	<result name="E_NOTIMPL">
11608	Feature not implemented.
11609	</result>
11610	<result name="VBOX_E_IPRT_ERROR">
11611	Could not take a screenshot.
11612	</result>
11613	</desc>
11614	<param name="screenId" type="unsigned long" dir="in">
11615	<desc>
11616	Monitor to take screenshot from.
11617	</desc>
11618	</param>
11619	<param name="width" type="unsigned long" dir="in">
11620	<desc>
11621	Desired image width.
11622	</desc>
11623	</param>
11624	<param name="height" type="unsigned long" dir="in">
11625	<desc>
11626	Desired image height.
11627	</desc>
11628	</param>
11629	<param name="screenData" type="octet" dir="return" safearray="yes">
11630	<desc>
11631	Array with resulting screen data.
11632	</desc>
11633	</param>
11634	</method>
11635
11636	<method name="takeScreenShotPNGToArray">
11637	<desc>
11638	Takes a guest screen shot of the requested size and returns it as
11639	PNG image in array.
11640
11641	<result name="E_NOTIMPL">
11642	Feature not implemented.
11643	</result>
11644	<result name="VBOX_E_IPRT_ERROR">
11645	Could not take a screenshot.
11646	</result>
11647	</desc>
11648	<param name="screenId" type="unsigned long" dir="in">
11649	<desc>
11650	Monitor to take the screenshot from.
11651	</desc>
11652	</param>
11653	<param name="width" type="unsigned long" dir="in">
11654	<desc>
11655	Desired image width.
11656	</desc>
11657	</param>
11658	<param name="height" type="unsigned long" dir="in">
11659	<desc>
11660	Desired image height.
11661	</desc>
11662	</param>
11663	<param name="screenData" type="octet" dir="return" safearray="yes">
11664	<desc>
11665	Array with resulting screen data.
11666	</desc>
11667	</param>
11668	</method>
11669
11670	<method name="drawToScreen">
11671	<desc>
11672	Draws a 32-bpp image of the specified size from the given buffer
11673	to the given point on the VM display.
11674
11675	<result name="E_NOTIMPL">
11676	Feature not implemented.
11677	</result>
11678	<result name="VBOX_E_IPRT_ERROR">
11679	Could not draw to screen.
11680	</result>
11681
11682	</desc>
11683	<param name="screenId" type="unsigned long" dir="in">
11684	<desc>
11685	Monitor to take the screenshot from.
11686	</desc>
11687	</param>
11688	<param name="address" type="octet" mod="ptr" dir="in">
11689	<desc>
11690	Address to store the screenshot to
11691	</desc>
11692	</param>
11693	<param name="x" type="unsigned long" dir="in">
11694	<desc>
11695	Relative to the screen top left corner.
11696	</desc>
11697	</param>
11698	<param name="y" type="unsigned long" dir="in">
11699	<desc>
11700	Relative to the screen top left corner.
11701	</desc>
11702	</param>
11703	<param name="width" type="unsigned long" dir="in">
11704	<desc>
11705	Desired image width.
11706	</desc>
11707	</param>
11708	<param name="height" type="unsigned long" dir="in">
11709	<desc>
11710	Desired image height.
11711	</desc>
11712	</param>
11713	</method>
11714
11715	<method name="invalidateAndUpdate">
11716	<desc>
11717	Does a full invalidation of the VM display and instructs the VM
11718	to update it.
11719
11720	<result name="VBOX_E_IPRT_ERROR">
11721	Could not invalidate and update screen.
11722	</result>
11723
11724	</desc>
11725	</method>
11726
11727	<method name="resizeCompleted">
11728	<desc>
11729	Signals that a framebuffer has completed the resize operation.
11730
11731	<result name="VBOX_E_NOT_SUPPORTED">
11732	Operation only valid for external frame buffers.
11733	</result>
11734
11735	</desc>
11736	<param name="screenId" type="unsigned long" dir="in"/>
11737	</method>
11738
11739	<method name="completeVHWACommand">
11740	<desc>
11741	Signals that the Video HW Acceleration command has completed.
11742	</desc>
11743
11744	<param name="command" type="octet" mod="ptr" dir="in">
11745	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11746	</param>
11747	</method>
11748
11749	</interface>
11750
11751	<!--
11752	// INetworkAdapter
11753	/////////////////////////////////////////////////////////////////////////
11754	-->
11755
11756	<enum
11757	name="NetworkAttachmentType"
11758	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11759	>
11760	<desc>
11761	Network attachment type.
11762	</desc>
11763
11764	<const name="Null" value="0">
11765	<desc>Null value, also means "not attached".</desc>
11766	</const>
11767	<const name="NAT" value="1"/>
11768	<const name="Bridged" value="2"/>
11769	<const name="Internal" value="3"/>
11770	<const name="HostOnly" value="4"/>
11771	<const name="VDE" value="5"/>
11772	</enum>
11773
11774	<enum
11775	name="NetworkAdapterType"
11776	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11777	>
11778	<desc>
11779	Network adapter type.
11780	</desc>
11781
11782	<const name="Null" value="0">
11783	<desc>Null value (never used by the API).</desc>
11784	</const>
11785	<const name="Am79C970A" value="1">
11786	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11787	</const>
11788	<const name="Am79C973" value="2">
11789	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11790	</const>
11791	<const name="I82540EM" value="3">
11792	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11793	</const>
11794	<const name="I82543GC" value="4">
11795	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11796	</const>
11797	<const name="I82545EM" value="5">
11798	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11799	</const>
11800	<const name="Virtio" value="6">
11801	<desc>Virtio network device.</desc>
11802	</const>
11803	</enum>
11804
11805	<enum
11806	name="NetworkAdapterPromiscModePolicy"
11807	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
11808	>
11809	<desc>
11810	The promiscuous mode policy of an interface.
11811	</desc>
11812
11813	<const name="Deny" value="1">
11814	<desc>Deny promiscuous mode requests.</desc>
11815	</const>
11816	<const name="AllowNetwork" value="2">
11817	<desc>
11818	Allow promicuous mode, but restrict the scope it to the internal
11819	network so that it only applies to other VMs.
11820	</desc>
11821	</const>
11822	<const name="AllowAll" value="3">
11823	<desc>
11824	Allow promicuous mode, include unrelated traffic going over the wire
11825	and internally on the host.
11826	</desc>
11827	</const>
11828	</enum>
11829
11830	<interface
11831	name="INetworkAdapter" extends="$unknown"
11832	uuid="6aa240a1-dd58-478e-92e8-aac001ce5547"
11833	wsmap="managed"
11834	>
11835	<desc>
11836	Represents a virtual network adapter that is attached to a virtual machine.
11837	Each virtual machine has a fixed number of network adapter slots with one
11838	instance of this attached to each of them. Call
11839	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11840	is attached to a given slot in a given machine.
11841
11842	Each network adapter can be in one of five attachment modes, which are
11843	represented by the <link to="NetworkAttachmentType" /> enumeration;
11844	see the <link to="#attachmentType" /> attribute.
11845	</desc>
11846
11847	<attribute name="adapterType" type="NetworkAdapterType">
11848	<desc>
11849	Type of the virtual network adapter. Depending on this value,
11850	VirtualBox will provide a different virtual network hardware
11851	to the guest.
11852	</desc>
11853	</attribute>
11854
11855	<attribute name="slot" type="unsigned long" readonly="yes">
11856	<desc>
11857	Slot number this adapter is plugged into. Corresponds to
11858	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11859	to obtain this instance.
11860	</desc>
11861	</attribute>
11862
11863	<attribute name="enabled" type="boolean">
11864	<desc>
11865	Flag whether the network adapter is present in the
11866	guest system. If disabled, the virtual guest hardware will
11867	not contain this network adapter. Can only be changed when
11868	the VM is not running.
11869	</desc>
11870	</attribute>
11871
11872	<attribute name="MACAddress" type="wstring">
11873	<desc>
11874	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11875	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11876	</desc>
11877	</attribute>
11878
11879	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11880
11881	<attribute name="hostInterface" type="wstring">
11882	<desc>
11883	Name of the host network interface the VM is attached to.
11884	</desc>
11885	</attribute>
11886
11887	<attribute name="internalNetwork" type="wstring">
11888	<desc>
11889	Name of the internal network the VM is attached to.
11890	</desc>
11891	</attribute>
11892
11893	<attribute name="NATNetwork" type="wstring">
11894	<desc>
11895	Name of the NAT network the VM is attached to.
11896	</desc>
11897	</attribute>
11898
11899	<attribute name="VDENetwork" type="wstring">
11900	<desc>
11901	Name of the VDE switch the VM is attached to.
11902	</desc>
11903	</attribute>
11904
11905	<attribute name="cableConnected" type="boolean">
11906	<desc>
11907	Flag whether the adapter reports the cable as connected or not.
11908	It can be used to report offline situations to a VM.
11909	</desc>
11910	</attribute>
11911
11912	<attribute name="lineSpeed" type="unsigned long">
11913	<desc>
11914	Line speed reported by custom drivers, in units of 1 kbps.
11915	</desc>
11916	</attribute>
11917
11918	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
11919	<desc>
11920	The promiscuous mode policy of the network adapter when attached to an
11921	internal network, host only network or a bridge.
11922	</desc>
11923	</attribute>
11924
11925	<attribute name="traceEnabled" type="boolean">
11926	<desc>
11927	Flag whether network traffic from/to the network card should be traced.
11928	Can only be toggled when the VM is turned off.
11929	</desc>
11930	</attribute>
11931
11932	<attribute name="traceFile" type="wstring">
11933	<desc>
11934	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11935	will be used.
11936	</desc>
11937	</attribute>
11938
11939	<attribute name="natDriver" type="INATEngine" readonly="yes">
11940	<desc>
11941	Points to the NAT engine which handles the network address translation
11942	for this interface. This is active only when the interface actually uses
11943	NAT (see <link to="#attachToNAT" />).
11944	</desc>
11945	</attribute>
11946
11947	<attribute name="bootPriority" type="unsigned long">
11948	<desc>
11949	Network boot priority of the adapter. Priority 1 is highest. If not set,
11950	the priority is considered to be at the lowest possible setting.
11951	</desc>
11952	</attribute>
11953
11954	<attribute name="bandwidthGroup" type="IBandwidthGroup">
11955	<desc>The bandwidth group this network adapter is assigned to.</desc>
11956	</attribute>
11957
11958	<method name="attachToNAT">
11959	<desc>
11960	Attach the network adapter to the Network Address Translation (NAT) interface.
11961	</desc>
11962	</method>
11963
11964	<method name="attachToBridgedInterface">
11965	<desc>
11966	Attach the network adapter to a bridged host interface.
11967	</desc>
11968	</method>
11969
11970	<method name="attachToInternalNetwork">
11971	<desc>
11972	Attach the network adapter to an internal network.
11973	</desc>
11974	</method>
11975
11976	<method name="attachToHostOnlyInterface">
11977	<desc>
11978	Attach the network adapter to the host-only network.
11979	</desc>
11980	</method>
11981
11982	<method name="attachToVDE">
11983	<desc>
11984	Attach the network adapter to a VDE network.
11985	</desc>
11986	</method>
11987
11988	<method name="detach">
11989	<desc>
11990	Detach the network adapter
11991	</desc>
11992	</method>
11993	</interface>
11994
11995
11996	<!--
11997	// ISerialPort
11998	/////////////////////////////////////////////////////////////////////////
11999	-->
12000
12001	<enum
12002	name="PortMode"
12003	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
12004	>
12005	<desc>
12006	The PortMode enumeration represents possible communication modes for
12007	the virtual serial port device.
12008	</desc>
12009
12010	<const name="Disconnected" value="0">
12011	<desc>Virtual device is not attached to any real host device.</desc>
12012	</const>
12013	<const name="HostPipe" value="1">
12014	<desc>Virtual device is attached to a host pipe.</desc>
12015	</const>
12016	<const name="HostDevice" value="2">
12017	<desc>Virtual device is attached to a host device.</desc>
12018	</const>
12019	<const name="RawFile" value="3">
12020	<desc>Virtual device is attached to a raw file.</desc>
12021	</const>
12022	</enum>
12023
12024	<interface
12025	name="ISerialPort" extends="$unknown"
12026	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
12027	wsmap="managed"
12028	>
12029
12030	<desc>
12031	The ISerialPort interface represents the virtual serial port device.
12032
12033	The virtual serial port device acts like an ordinary serial port
12034	inside the virtual machine. This device communicates to the real
12035	serial port hardware in one of two modes: host pipe or host device.
12036
12037	In host pipe mode, the #path attribute specifies the path to the pipe on
12038	the host computer that represents a serial port. The #server attribute
12039	determines if this pipe is created by the virtual machine process at
12040	machine startup or it must already exist before starting machine
12041	execution.
12042
12043	In host device mode, the #path attribute specifies the name of the
12044	serial port device on the host computer.
12045
12046	There is also a third communication mode: the disconnected mode. In this
12047	mode, the guest OS running inside the virtual machine will be able to
12048	detect the serial port, but all port write operations will be discarded
12049	and all port read operations will return no data.
12050
12051	<see>IMachine::getSerialPort</see>
12052	</desc>
12053
12054	<attribute name="slot" type="unsigned long" readonly="yes">
12055	<desc>
12056	Slot number this serial port is plugged into. Corresponds to
12057	the value you pass to <link to="IMachine::getSerialPort"/>
12058	to obtain this instance.
12059	</desc>
12060	</attribute>
12061
12062	<attribute name="enabled" type="boolean">
12063	<desc>
12064	Flag whether the serial port is enabled. If disabled,
12065	the serial port will not be reported to the guest OS.
12066	</desc>
12067	</attribute>
12068
12069	<attribute name="IOBase" type="unsigned long">
12070	<desc>Base I/O address of the serial port.</desc>
12071	</attribute>
12072
12073	<attribute name="IRQ" type="unsigned long">
12074	<desc>IRQ number of the serial port.</desc>
12075	</attribute>
12076
12077	<attribute name="hostMode" type="PortMode">
12078	<desc>
12079	How is this port connected to the host.
12080	<note>
12081	Changing this attribute may fail if the conditions for
12082	<link to="#path"/> are not met.
12083	</note>
12084	</desc>
12085	</attribute>
12086
12087	<attribute name="server" type="boolean">
12088	<desc>
12089	Flag whether this serial port acts as a server (creates a new pipe on
12090	the host) or as a client (uses the existing pipe). This attribute is
12091	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12092	</desc>
12093	</attribute>
12094
12095	<attribute name="path" type="wstring">
12096	<desc>
12097	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12098	PortMode_HostPipe, or the host serial device name when
12099	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12100	cases, setting a @c null or empty string as the attribute's value
12101	is an error. Otherwise, the value of this property is ignored.
12102	</desc>
12103	</attribute>
12104
12105	</interface>
12106
12107	<!--
12108	// IParallelPort
12109	/////////////////////////////////////////////////////////////////////////
12110	-->
12111
12112	<interface
12113	name="IParallelPort" extends="$unknown"
12114	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12115	wsmap="managed"
12116	>
12117
12118	<desc>
12119	The IParallelPort interface represents the virtual parallel port device.
12120
12121	The virtual parallel port device acts like an ordinary parallel port
12122	inside the virtual machine. This device communicates to the real
12123	parallel port hardware using the name of the parallel device on the host
12124	computer specified in the #path attribute.
12125
12126	Each virtual parallel port device is assigned a base I/O address and an
12127	IRQ number that will be reported to the guest operating system and used
12128	to operate the given parallel port from within the virtual machine.
12129
12130	<see>IMachine::getParallelPort</see>
12131	</desc>
12132
12133	<attribute name="slot" type="unsigned long" readonly="yes">
12134	<desc>
12135	Slot number this parallel port is plugged into. Corresponds to
12136	the value you pass to <link to="IMachine::getParallelPort"/>
12137	to obtain this instance.
12138	</desc>
12139	</attribute>
12140
12141	<attribute name="enabled" type="boolean">
12142	<desc>
12143	Flag whether the parallel port is enabled. If disabled,
12144	the parallel port will not be reported to the guest OS.
12145	</desc>
12146	</attribute>
12147
12148	<attribute name="IOBase" type="unsigned long">
12149	<desc>Base I/O address of the parallel port.</desc>
12150	</attribute>
12151
12152	<attribute name="IRQ" type="unsigned long">
12153	<desc>IRQ number of the parallel port.</desc>
12154	</attribute>
12155
12156	<attribute name="path" type="wstring">
12157	<desc>
12158	Host parallel device name. If this parallel port is enabled, setting a
12159	@c null or an empty string as this attribute's value will result into
12160	an error.
12161	</desc>
12162	</attribute>
12163
12164	</interface>
12165
12166
12167	<!--
12168	// IMachineDebugger
12169	/////////////////////////////////////////////////////////////////////////
12170	-->
12171
12172	<interface
12173	name="IMachineDebugger" extends="$unknown"
12174	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12175	wsmap="suppress"
12176	>
12177	<method name="dumpGuestCore">
12178	<desc>
12179	Takes a core dump of the guest.
12180
12181	See include/VBox/dbgfcorefmt.h for details on the file format.
12182	</desc>
12183	<param name="filename" type="wstring" dir="in">
12184	<desc>
12185	The name of the output file. The file must not exist.
12186	</desc>
12187	</param>
12188	<param name="compression" type="wstring" dir="in">
12189	<desc>
12190	Reserved for future compression method indicator.
12191	</desc>
12192	</param>
12193	</method>
12194
12195	<method name="dumpHostProcessCore">
12196	<desc>
12197	Takes a core dump of the VM process on the host.
12198
12199	This feature is not implemented in the 4.0.0 release but it may show up
12200	in a dot release.
12201	</desc>
12202	<param name="filename" type="wstring" dir="in">
12203	<desc>
12204	The name of the output file. The file must not exist.
12205	</desc>
12206	</param>
12207	<param name="compression" type="wstring" dir="in">
12208	<desc>
12209	Reserved for future compression method indicator.
12210	</desc>
12211	</param>
12212	</method>
12213
12214	<method name="info">
12215	<desc>
12216	Interfaces with the info dumpers (DBGFInfo).
12217
12218	This feature is not implemented in the 4.0.0 release but it may show up
12219	in a dot release.
12220	</desc>
12221	<param name="name" type="wstring" dir="in">
12222	<desc>
12223	The name of the info item.
12224	</desc>
12225	</param>
12226	<param name="args" type="wstring" dir="in">
12227	<desc>
12228	Arguments to the info dumper.
12229	</desc>
12230	</param>
12231	<param name="info" type="wstring" dir="return">
12232	<desc>
12233	The into string.
12234	</desc>
12235	</param>
12236	</method>
12237
12238	<method name="injectNMI">
12239	<desc>
12240	Inject an NMI into a running VT-x/AMD-V VM.
12241	</desc>
12242	</method>
12243
12244	<method name="modifyLogGroups">
12245	<desc>
12246	Modifies the group settings of the debug logger.
12247
12248	This feature is not implemented in the 4.0.0 release but may show up
12249	in a dot release.
12250	</desc>
12251	<param name="settings" type="wstring" dir="in">
12252	<desc>The group settings string. See iprt/log.h for details.</desc>
12253	</param>
12254	</method>
12255
12256	<method name="modifyLogFlags">
12257	<desc>
12258	Modifies the debug logger flags.
12259
12260	This feature is not implemented in the 4.0.0 release but may show up
12261	in a dot release.
12262	</desc>
12263	<param name="settings" type="wstring" dir="in">
12264	<desc>The flags settings string. See iprt/log.h for details.</desc>
12265	</param>
12266	</method>
12267
12268	<method name="modifyLogDestinations">
12269	<desc>
12270	Modifies the debug logger destinations.
12271
12272	This feature is not implemented in the 4.0.0 release but may show up
12273	in a dot release.
12274	</desc>
12275	<param name="settings" type="wstring" dir="in">
12276	<desc>The destination settings string. See iprt/log.h for details.</desc>
12277	</param>
12278	</method>
12279
12280	<method name="readPhysicalMemory">
12281	<desc>
12282	Reads guest physical memory, no side effects (MMIO++).
12283
12284	This feature is not implemented in the 4.0.0 release but may show up
12285	in a dot release.
12286	</desc>
12287	<param name="address" type="long long" dir="in">
12288	<desc>The guest physical address.</desc>
12289	</param>
12290	<param name="size" type="unsigned long" dir="in">
12291	<desc>The number of bytes to read.</desc>
12292	</param>
12293	<param name="bytes" type="octet" safearray="yes" dir="return">
12294	<desc>The bytes read.</desc>
12295	</param>
12296	</method>
12297
12298	<method name="writePhysicalMemory">
12299	<desc>
12300	Writes guest physical memory, access handles (MMIO++) are ignored.
12301
12302	This feature is not implemented in the 4.0.0 release but may show up
12303	in a dot release.
12304	</desc>
12305	<param name="address" type="long long" dir="in">
12306	<desc>The guest physical address.</desc>
12307	</param>
12308	<param name="size" type="unsigned long" dir="in">
12309	<desc>The number of bytes to read.</desc>
12310	</param>
12311	<param name="bytes" type="octet" safearray="yes" dir="in">
12312	<desc>The bytes to write.</desc>
12313	</param>
12314	</method>
12315
12316	<method name="readVirtualMemory">
12317	<desc>
12318	Reads guest virtual memory, no side effects (MMIO++).
12319
12320	This feature is not implemented in the 4.0.0 release but may show up
12321	in a dot release.
12322	</desc>
12323	<param name="cpuId" type="unsigned long" dir="in">
12324	<desc>The identifier of the Virtual CPU.</desc>
12325	</param>
12326	<param name="address" type="long long" dir="in">
12327	<desc>The guest virtual address.</desc>
12328	</param>
12329	<param name="size" type="unsigned long" dir="in">
12330	<desc>The number of bytes to read.</desc>
12331	</param>
12332	<param name="bytes" type="octet" safearray="yes" dir="return">
12333	<desc>The bytes read.</desc>
12334	</param>
12335	</method>
12336
12337	<method name="writeVirtualMemory">
12338	<desc>
12339	Writes guest virtual memory, access handles (MMIO++) are ignored.
12340
12341	This feature is not implemented in the 4.0.0 release but may show up
12342	in a dot release.
12343	</desc>
12344	<param name="cpuId" type="unsigned long" dir="in">
12345	<desc>The identifier of the Virtual CPU.</desc>
12346	</param>
12347	<param name="address" type="long long" dir="in">
12348	<desc>The guest virtual address.</desc>
12349	</param>
12350	<param name="size" type="unsigned long" dir="in">
12351	<desc>The number of bytes to read.</desc>
12352	</param>
12353	<param name="bytes" type="octet" safearray="yes" dir="in">
12354	<desc>The bytes to write.</desc>
12355	</param>
12356	</method>
12357
12358	<method name="detectOS">
12359	<desc>
12360	Tries to (re-)detect the guest OS kernel.
12361
12362	This feature is not implemented in the 4.0.0 release but may show up
12363	in a dot release.
12364	</desc>
12365	<param name="os" type="wstring" dir="return">
12366	<desc>
12367	The detected OS kernel on success.
12368	</desc>
12369	</param>
12370	</method>
12371
12372	<method name="getRegister">
12373	<desc>
12374	Gets one register.
12375
12376	This feature is not implemented in the 4.0.0 release but may show up
12377	in a dot release.
12378	</desc>
12379	<param name="cpuId" type="unsigned long" dir="in">
12380	<desc>The identifier of the Virtual CPU.</desc>
12381	</param>
12382	<param name="name" type="wstring" dir="in">
12383	<desc>The register name, case is ignored.</desc>
12384	</param>
12385	<param name="value" type="wstring" dir="return">
12386	<desc>
12387	The register value. This is usually a hex value (always 0x prefixed)
12388	but other format may be used for floating point registers (TBD).
12389	</desc>
12390	</param>
12391	</method>
12392
12393	<method name="getRegisters">
12394	<desc>
12395	Gets all the registers for the given CPU.
12396
12397	This feature is not implemented in the 4.0.0 release but may show up
12398	in a dot release.
12399	</desc>
12400	<param name="cpuId" type="unsigned long" dir="in">
12401	<desc>The identifier of the Virtual CPU.</desc>
12402	</param>
12403	<param name="names" type="wstring" dir="out" safearray="yes">
12404	<desc>Array containing the lowercase register names.</desc>
12405	</param>
12406	<param name="values" type="wstring" dir="out" safearray="yes">
12407	<desc>
12408	Array paralell to the names holding the register values as if the
12409	register was returned by <link to="IMachineDebugger::getRegister"/>.
12410	</desc>
12411	</param>
12412	</method>
12413
12414	<method name="setRegister">
12415	<desc>
12416	Gets one register.
12417
12418	This feature is not implemented in the 4.0.0 release but may show up
12419	in a dot release.
12420	</desc>
12421	<param name="cpuId" type="unsigned long" dir="in">
12422	<desc>The identifier of the Virtual CPU.</desc>
12423	</param>
12424	<param name="name" type="wstring" dir="in">
12425	<desc>The register name, case is ignored.</desc>
12426	</param>
12427	<param name="value" type="wstring" dir="in">
12428	<desc>
12429	The new register value. Hexadecimal, decimal and octal formattings
12430	are supported in addition to any special formattings returned by
12431	the getters.
12432	</desc>
12433	</param>
12434	</method>
12435
12436	<method name="setRegisters">
12437	<desc>
12438	Sets zero or more registers atomically.
12439
12440	This feature is not implemented in the 4.0.0 release but may show up
12441	in a dot release.
12442	</desc>
12443	<param name="cpuId" type="unsigned long" dir="in">
12444	<desc>The identifier of the Virtual CPU.</desc>
12445	</param>
12446	<param name="names" type="wstring" dir="in" safearray="yes">
12447	<desc>Array containing the register names, case ignored.</desc>
12448	</param>
12449	<param name="values" type="wstring" dir="in" safearray="yes">
12450	<desc>
12451	Array paralell to the names holding the register values. See
12452	<link to="IMachineDebugger::setRegister"/> for formatting
12453	guidelines.
12454	</desc>
12455	</param>
12456	</method>
12457
12458	<method name="dumpGuestStack">
12459	<desc>
12460	Produce a simple stack dump using the current guest state.
12461
12462	This feature is not implemented in the 4.0.0 release but may show up
12463	in a dot release.
12464	</desc>
12465	<param name="cpuId" type="unsigned long" dir="in">
12466	<desc>The identifier of the Virtual CPU.</desc>
12467	</param>
12468	<param name="stack" type="wstring" dir="return">
12469	<desc>String containing the formatted stack dump.</desc>
12470	</param>
12471	</method>
12472
12473	<method name="resetStats">
12474	<desc>
12475	Reset VM statistics.
12476	</desc>
12477	<param name="pattern" type="wstring" dir="in">
12478	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12479	</param>
12480	</method>
12481
12482	<method name="dumpStats">
12483	<desc>
12484	Dumps VM statistics.
12485	</desc>
12486	<param name="pattern" type="wstring" dir="in">
12487	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12488	</param>
12489	</method>
12490
12491	<method name="getStats">
12492	<desc>
12493	Get the VM statistics in a XMLish format.
12494	</desc>
12495	<param name="pattern" type="wstring" dir="in">
12496	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12497	</param>
12498	<param name="withDescriptions" type="boolean" dir="in">
12499	<desc>Whether to include the descriptions.</desc>
12500	</param>
12501	<param name="stats" type="wstring" dir="out">
12502	<desc>The XML document containing the statistics.</desc>
12503	</param>
12504	</method>
12505
12506	<attribute name="singlestep" type="boolean">
12507	<desc>Switch for enabling singlestepping.</desc>
12508	</attribute>
12509
12510	<attribute name="recompileUser" type="boolean">
12511	<desc>Switch for forcing code recompilation for user mode code.</desc>
12512	</attribute>
12513
12514	<attribute name="recompileSupervisor" type="boolean">
12515	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12516	</attribute>
12517
12518	<attribute name="PATMEnabled" type="boolean">
12519	<desc>Switch for enabling and disabling the PATM component.</desc>
12520	</attribute>
12521
12522	<attribute name="CSAMEnabled" type="boolean">
12523	<desc>Switch for enabling and disabling the CSAM component.</desc>
12524	</attribute>
12525
12526	<attribute name="logEnabled" type="boolean">
12527	<desc>Switch for enabling and disabling the debug logger.</desc>
12528	</attribute>
12529
12530	<attribute name="logFlags" type="wstring" readonly="yes">
12531	<desc>The debug logger flags.</desc>
12532	</attribute>
12533
12534	<attribute name="logGroups" type="wstring" readonly="yes">
12535	<desc>The debug logger's group settings.</desc>
12536	</attribute>
12537
12538	<attribute name="logDestinations" type="wstring" readonly="yes">
12539	<desc>The debug logger's destination settings.</desc>
12540	</attribute>
12541
12542	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12543	<desc>
12544	Flag indicating whether the VM is currently making use of CPU hardware
12545	virtualization extensions.
12546	</desc>
12547	</attribute>
12548
12549	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12550	<desc>
12551	Flag indicating whether the VM is currently making use of the nested paging
12552	CPU hardware virtualization extension.
12553	</desc>
12554	</attribute>
12555
12556	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12557	<desc>
12558	Flag indicating whether the VM is currently making use of the VPID
12559	VT-x extension.
12560	</desc>
12561	</attribute>
12562
12563	<attribute name="OSName" type="wstring" readonly="yes">
12564	<desc>
12565	Query the guest OS kernel name as detected by the DBGF.
12566
12567	This feature is not implemented in the 4.0.0 release but may show up
12568	in a dot release.
12569	</desc>
12570	</attribute>
12571
12572	<attribute name="OSVersion" type="wstring" readonly="yes">
12573	<desc>
12574	Query the guest OS kernel version string as detected by the DBGF.
12575
12576	This feature is not implemented in the 4.0.0 release but may show up
12577	in a dot release.
12578	</desc>
12579	</attribute>
12580
12581	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12582	<desc>
12583	Flag indicating whether the VM is currently making use of the Physical
12584	Address Extension CPU feature.
12585	</desc>
12586	</attribute>
12587
12588	<attribute name="virtualTimeRate" type="unsigned long">
12589	<desc>
12590	The rate at which the virtual time runs expressed as a percentage.
12591	The accepted range is 2% to 20000%.
12592	</desc>
12593	</attribute>
12594
12595	<attribute name="VM" type="long long" readonly="yes">
12596	<desc>
12597	Gets the VM handle. This is only for internal use while
12598	we carve the details of this interface.
12599	</desc>
12600	</attribute>
12601
12602	</interface>
12603
12604	<!--
12605	// IUSBController
12606	/////////////////////////////////////////////////////////////////////////
12607	-->
12608
12609	<interface
12610	name="IUSBController" extends="$unknown"
12611	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12612	wsmap="managed"
12613	>
12614	<attribute name="enabled" type="boolean">
12615	<desc>
12616	Flag whether the USB controller is present in the
12617	guest system. If disabled, the virtual guest hardware will
12618	not contain any USB controller. Can only be changed when
12619	the VM is powered off.
12620	</desc>
12621	</attribute>
12622
12623	<attribute name="enabledEhci" type="boolean">
12624	<desc>
12625	Flag whether the USB EHCI controller is present in the
12626	guest system. If disabled, the virtual guest hardware will
12627	not contain a USB EHCI controller. Can only be changed when
12628	the VM is powered off.
12629	</desc>
12630	</attribute>
12631
12632	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12633	<desc>
12634	Flag whether there is an USB proxy available.
12635	</desc>
12636	</attribute>
12637
12638	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12639	<desc>
12640	USB standard version which the controller implements.
12641	This is a BCD which means that the major version is in the
12642	high byte and minor version is in the low byte.
12643	</desc>
12644	</attribute>
12645
12646	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12647	<desc>
12648	List of USB device filters associated with the machine.
12649
12650	If the machine is currently running, these filters are activated
12651	every time a new (supported) USB device is attached to the host
12652	computer that was not ignored by global filters
12653	(<link to="IHost::USBDeviceFilters"/>).
12654
12655	These filters are also activated when the machine is powered up.
12656	They are run against a list of all currently available USB
12657	devices (in states
12658	<link to="USBDeviceState_Available"/>,
12659	<link to="USBDeviceState_Busy"/>,
12660	<link to="USBDeviceState_Held"/>) that were not previously
12661	ignored by global filters.
12662
12663	If at least one filter matches the USB device in question, this
12664	device is automatically captured (attached to) the virtual USB
12665	controller of this machine.
12666
12667	<see>IUSBDeviceFilter, ::IUSBController</see>
12668	</desc>
12669	</attribute>
12670
12671	<method name="createDeviceFilter">
12672	<desc>
12673	Creates a new USB device filter. All attributes except
12674	the filter name are set to empty (any match),
12675	<i>active</i> is @c false (the filter is not active).
12676
12677	The created filter can then be added to the list of filters using
12678	<link to="#insertDeviceFilter"/>.
12679
12680	<result name="VBOX_E_INVALID_VM_STATE">
12681	The virtual machine is not mutable.
12682	</result>
12683
12684	<see>#deviceFilters</see>
12685	</desc>
12686	<param name="name" type="wstring" dir="in">
12687	<desc>
12688	Filter name. See <link to="IUSBDeviceFilter::name"/>
12689	for more info.
12690	</desc>
12691	</param>
12692	<param name="filter" type="IUSBDeviceFilter" dir="return">
12693	<desc>Created filter object.</desc>
12694	</param>
12695	</method>
12696
12697	<method name="insertDeviceFilter">
12698	<desc>
12699	Inserts the given USB device to the specified position
12700	in the list of filters.
12701
12702	Positions are numbered starting from <tt>0</tt>. If the specified
12703	position is equal to or greater than the number of elements in
12704	the list, the filter is added to the end of the collection.
12705
12706	<note>
12707	Duplicates are not allowed, so an attempt to insert a
12708	filter that is already in the collection, will return an
12709	error.
12710	</note>
12711
12712	<result name="VBOX_E_INVALID_VM_STATE">
12713	Virtual machine is not mutable.
12714	</result>
12715	<result name="E_INVALIDARG">
12716	USB device filter not created within this VirtualBox instance.
12717	</result>
12718	<result name="VBOX_E_INVALID_OBJECT_STATE">
12719	USB device filter already in list.
12720	</result>
12721
12722	<see>#deviceFilters</see>
12723	</desc>
12724	<param name="position" type="unsigned long" dir="in">
12725	<desc>Position to insert the filter to.</desc>
12726	</param>
12727	<param name="filter" type="IUSBDeviceFilter" dir="in">
12728	<desc>USB device filter to insert.</desc>
12729	</param>
12730	</method>
12731
12732	<method name="removeDeviceFilter">
12733	<desc>
12734	Removes a USB device filter from the specified position in the
12735	list of filters.
12736
12737	Positions are numbered starting from <tt>0</tt>. Specifying a
12738	position equal to or greater than the number of elements in
12739	the list will produce an error.
12740
12741	<see>#deviceFilters</see>
12742
12743	<result name="VBOX_E_INVALID_VM_STATE">
12744	Virtual machine is not mutable.
12745	</result>
12746	<result name="E_INVALIDARG">
12747	USB device filter list empty or invalid @a position.
12748	</result>
12749
12750	</desc>
12751	<param name="position" type="unsigned long" dir="in">
12752	<desc>Position to remove the filter from.</desc>
12753	</param>
12754	<param name="filter" type="IUSBDeviceFilter" dir="return">
12755	<desc>Removed USB device filter.</desc>
12756	</param>
12757	</method>
12758
12759	</interface>
12760
12761
12762	<!--
12763	// IUSBDevice
12764	/////////////////////////////////////////////////////////////////////////
12765	-->
12766
12767	<interface
12768	name="IUSBDevice" extends="$unknown"
12769	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12770	wsmap="managed"
12771	>
12772	<desc>
12773	The IUSBDevice interface represents a virtual USB device attached to the
12774	virtual machine.
12775
12776	A collection of objects implementing this interface is stored in the
12777	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12778	attached to a running virtual machine's USB controller.
12779	</desc>
12780
12781	<attribute name="id" type="uuid" mod="string" readonly="yes">
12782	<desc>
12783	Unique USB device ID. This ID is built from #vendorId,
12784	#productId, #revision and #serialNumber.
12785	</desc>
12786	</attribute>
12787
12788	<attribute name="vendorId" type="unsigned short" readonly="yes">
12789	<desc>Vendor ID.</desc>
12790	</attribute>
12791
12792	<attribute name="productId" type="unsigned short" readonly="yes">
12793	<desc>Product ID.</desc>
12794	</attribute>
12795
12796	<attribute name="revision" type="unsigned short" readonly="yes">
12797	<desc>
12798	Product revision number. This is a packed BCD represented as
12799	unsigned short. The high byte is the integer part and the low
12800	byte is the decimal.
12801	</desc>
12802	</attribute>
12803
12804	<attribute name="manufacturer" type="wstring" readonly="yes">
12805	<desc>Manufacturer string.</desc>
12806	</attribute>
12807
12808	<attribute name="product" type="wstring" readonly="yes">
12809	<desc>Product string.</desc>
12810	</attribute>
12811
12812	<attribute name="serialNumber" type="wstring" readonly="yes">
12813	<desc>Serial number string.</desc>
12814	</attribute>
12815
12816	<attribute name="address" type="wstring" readonly="yes">
12817	<desc>Host specific address of the device.</desc>
12818	</attribute>
12819
12820	<attribute name="port" type="unsigned short" readonly="yes">
12821	<desc>
12822	Host USB port number the device is physically
12823	connected to.
12824	</desc>
12825	</attribute>
12826
12827	<attribute name="version" type="unsigned short" readonly="yes">
12828	<desc>
12829	The major USB version of the device - 1 or 2.
12830	</desc>
12831	</attribute>
12832
12833	<attribute name="portVersion" type="unsigned short" readonly="yes">
12834	<desc>
12835	The major USB version of the host USB port the device is
12836	physically connected to - 1 or 2. For devices not connected to
12837	anything this will have the same value as the version attribute.
12838	</desc>
12839	</attribute>
12840
12841	<attribute name="remote" type="boolean" readonly="yes">
12842	<desc>
12843	Whether the device is physically connected to a remote VRDE
12844	client or to a local host machine.
12845	</desc>
12846	</attribute>
12847
12848	</interface>
12849
12850
12851	<!--
12852	// IUSBDeviceFilter
12853	/////////////////////////////////////////////////////////////////////////
12854	-->
12855
12856	<interface
12857	name="IUSBDeviceFilter" extends="$unknown"
12858	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12859	wsmap="managed"
12860	>
12861	<desc>
12862	The IUSBDeviceFilter interface represents an USB device filter used
12863	to perform actions on a group of USB devices.
12864
12865	This type of filters is used by running virtual machines to
12866	automatically capture selected USB devices once they are physically
12867	attached to the host computer.
12868
12869	A USB device is matched to the given device filter if and only if all
12870	attributes of the device match the corresponding attributes of the
12871	filter (that is, attributes are joined together using the logical AND
12872	operation). On the other hand, all together, filters in the list of
12873	filters carry the semantics of the logical OR operation. So if it is
12874	desirable to create a match like "this vendor id OR this product id",
12875	one needs to create two filters and specify "any match" (see below)
12876	for unused attributes.
12877
12878	All filter attributes used for matching are strings. Each string
12879	is an expression representing a set of values of the corresponding
12880	device attribute, that will match the given filter. Currently, the
12881	following filtering expressions are supported:
12882
12883	<ul>
12884	<li><i>Interval filters</i>. Used to specify valid intervals for
12885	integer device attributes (Vendor ID, Product ID and Revision).
12886	The format of the string is:
12887
12888	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12889
12890	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12891	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12892	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12893	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12894	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12895	possible integer is assumed.
12896	</li>
12897	<li><i>Boolean filters</i>. Used to specify acceptable values for
12898	boolean device attributes. The format of the string is:
12899
12900	<tt>true\|false\|yes\|no\|0\|1</tt>
12901
12902	</li>
12903	<li><i>Exact match</i>. Used to specify a single value for the given
12904	device attribute. Any string that doesn't start with <tt>int:</tt>
12905	represents the exact match. String device attributes are compared to
12906	this string including case of symbols. Integer attributes are first
12907	converted to a string (see individual filter attributes) and then
12908	compared ignoring case.
12909
12910	</li>
12911	<li><i>Any match</i>. Any value of the corresponding device attribute
12912	will match the given filter. An empty or @c null string is
12913	used to construct this type of filtering expressions.
12914
12915	</li>
12916	</ul>
12917
12918	<note>
12919	On the Windows host platform, interval filters are not currently
12920	available. Also all string filter attributes
12921	(<link to="#manufacturer"/>, <link to="#product"/>,
12922	<link to="#serialNumber"/>) are ignored, so they behave as
12923	<i>any match</i> no matter what string expression is specified.
12924	</note>
12925
12926	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12927	</desc>
12928
12929	<attribute name="name" type="wstring">
12930	<desc>
12931	Visible name for this filter.
12932	This name is used to visually distinguish one filter from another,
12933	so it can neither be @c null nor an empty string.
12934	</desc>
12935	</attribute>
12936
12937	<attribute name="active" type="boolean">
12938	<desc>Whether this filter active or has been temporarily disabled.</desc>
12939	</attribute>
12940
12941	<attribute name="vendorId" type="wstring">
12942	<desc>
12943	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12944	The string representation for the <i>exact matching</i>
12945	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12946	(including leading zeroes).
12947	</desc>
12948	</attribute>
12949
12950	<attribute name="productId" type="wstring">
12951	<desc>
12952	<link to="IUSBDevice::productId">Product ID</link> filter.
12953	The string representation for the <i>exact matching</i>
12954	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12955	(including leading zeroes).
12956	</desc>
12957	</attribute>
12958
12959	<attribute name="revision" type="wstring">
12960	<desc>
12961	<link to="IUSBDevice::productId">Product revision number</link>
12962	filter. The string representation for the <i>exact matching</i>
12963	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12964	of the integer part of the revision, and <tt>F</tt> is the
12965	decimal digit of its fractional part (including leading and
12966	trailing zeros).
12967	Note that for interval filters, it's best to use the hexadecimal
12968	form, because the revision is stored as a 16 bit packed BCD value;
12969	so the expression <tt>int:0x0100-0x0199</tt> will match any
12970	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12971	</desc>
12972	</attribute>
12973
12974	<attribute name="manufacturer" type="wstring">
12975	<desc>
12976	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12977	</desc>
12978	</attribute>
12979
12980	<attribute name="product" type="wstring">
12981	<desc>
12982	<link to="IUSBDevice::product">Product</link> filter.
12983	</desc>
12984	</attribute>
12985
12986	<attribute name="serialNumber" type="wstring">
12987	<desc>
12988	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12989	</desc>
12990	</attribute>
12991
12992	<attribute name="port" type="wstring">
12993	<desc>
12994	<link to="IUSBDevice::port">Host USB port</link> filter.
12995	</desc>
12996	</attribute>
12997
12998	<attribute name="remote" type="wstring">
12999	<desc>
13000	<link to="IUSBDevice::remote">Remote state</link> filter.
13001	<note>
13002	This filter makes sense only for machine USB filters,
13003	i.e. it is ignored by IHostUSBDeviceFilter objects.
13004	</note>
13005	</desc>
13006	</attribute>
13007
13008	<attribute name="maskedInterfaces" type="unsigned long">
13009	<desc>
13010	This is an advanced option for hiding one or more USB interfaces
13011	from the guest. The value is a bit mask where the bits that are set
13012	means the corresponding USB interface should be hidden, masked off
13013	if you like.
13014	This feature only works on Linux hosts.
13015	</desc>
13016	</attribute>
13017
13018	</interface>
13019
13020
13021	<!--
13022	// IHostUSBDevice
13023	/////////////////////////////////////////////////////////////////////////
13024	-->
13025
13026	<enum
13027	name="USBDeviceState"
13028	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
13029	>
13030	<desc>
13031	USB device state. This enumeration represents all possible states
13032	of the USB device physically attached to the host computer regarding
13033	its state on the host computer and availability to guest computers
13034	(all currently running virtual machines).
13035
13036	Once a supported USB device is attached to the host, global USB
13037	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
13038	either ignore the device, or put it to USBDeviceState_Held state, or do
13039	nothing. Unless the device is ignored by global filters, filters of all
13040	currently running guests (<link to="IUSBController::deviceFilters"/>) are
13041	activated that can put it to USBDeviceState_Captured state.
13042
13043	If the device was ignored by global filters, or didn't match
13044	any filters at all (including guest ones), it is handled by the host
13045	in a normal way. In this case, the device state is determined by
13046	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
13047	or USBDeviceState_Available, depending on the current device usage.
13048
13049	Besides auto-capturing based on filters, the device can be manually
13050	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
13051	state is USBDeviceState_Busy, USBDeviceState_Available or
13052	USBDeviceState_Held.
13053
13054	<note>
13055	Due to differences in USB stack implementations in Linux and Win32,
13056	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
13057	only to the Linux version of the product. This also means that (<link
13058	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
13059	device state is USBDeviceState_Held.
13060	</note>
13061
13062	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
13063	</desc>
13064
13065	<const name="NotSupported" value="0">
13066	<desc>
13067	Not supported by the VirtualBox server, not available to guests.
13068	</desc>
13069	</const>
13070	<const name="Unavailable" value="1">
13071	<desc>
13072	Being used by the host computer exclusively,
13073	not available to guests.
13074	</desc>
13075	</const>
13076	<const name="Busy" value="2">
13077	<desc>
13078	Being used by the host computer, potentially available to guests.
13079	</desc>
13080	</const>
13081	<const name="Available" value="3">
13082	<desc>
13083	Not used by the host computer, available to guests (the host computer
13084	can also start using the device at any time).
13085	</desc>
13086	</const>
13087	<const name="Held" value="4">
13088	<desc>
13089	Held by the VirtualBox server (ignored by the host computer),
13090	available to guests.
13091	</desc>
13092	</const>
13093	<const name="Captured" value="5">
13094	<desc>
13095	Captured by one of the guest computers, not available
13096	to anybody else.
13097	</desc>
13098	</const>
13099	</enum>
13100
13101	<interface
13102	name="IHostUSBDevice" extends="IUSBDevice"
13103	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
13104	wsmap="managed"
13105	>
13106	<desc>
13107	The IHostUSBDevice interface represents a physical USB device attached
13108	to the host computer.
13109
13110	Besides properties inherited from IUSBDevice, this interface adds the
13111	<link to="#state"/> property that holds the current state of the USB
13112	device.
13113
13114	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
13115	</desc>
13116
13117	<attribute name="state" type="USBDeviceState" readonly="yes">
13118	<desc>
13119	Current state of the device.
13120	</desc>
13121	</attribute>
13122
13123	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13124
13125	</interface>
13126
13127
13128	<!--
13129	// IHostUSBDeviceFilter
13130	/////////////////////////////////////////////////////////////////////////
13131	-->
13132
13133	<enum
13134	name="USBDeviceFilterAction"
13135	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13136	>
13137	<desc>
13138	Actions for host USB device filters.
13139	<see>IHostUSBDeviceFilter, USBDeviceState</see>
13140	</desc>
13141
13142	<const name="Null" value="0">
13143	<desc>Null value (never used by the API).</desc>
13144	</const>
13145	<const name="Ignore" value="1">
13146	<desc>Ignore the matched USB device.</desc>
13147	</const>
13148	<const name="Hold" value="2">
13149	<desc>Hold the matched USB device.</desc>
13150	</const>
13151	</enum>
13152
13153	<interface
13154	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13155	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13156	wsmap="managed"
13157	>
13158	<desc>
13159	The IHostUSBDeviceFilter interface represents a global filter for a
13160	physical USB device used by the host computer. Used indirectly in
13161	<link to="IHost::USBDeviceFilters"/>.
13162
13163	Using filters of this type, the host computer determines the initial
13164	state of the USB device after it is physically attached to the
13165	host's USB controller.
13166
13167	<note>
13168	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13169	filters, because it makes sense only for
13170	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13171	</note>
13172
13173	<see>IHost::USBDeviceFilters</see>
13174	</desc>
13175
13176	<attribute name="action" type="USBDeviceFilterAction">
13177	<desc>
13178	Action performed by the host when an attached USB device
13179	matches this filter.
13180	</desc>
13181	</attribute>
13182
13183	</interface>
13184
13185	<!--
13186	// IAudioAdapter
13187	/////////////////////////////////////////////////////////////////////////
13188	-->
13189
13190	<enum
13191	name="AudioDriverType"
13192	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13193	>
13194	<desc>
13195	Host audio driver type.
13196	</desc>
13197
13198	<const name="Null" value="0">
13199	<desc>Null value, also means "dummy audio driver".</desc>
13200	</const>
13201	<const name="WinMM" value="1">
13202	<desc>Windows multimedia (Windows hosts only).</desc>
13203	</const>
13204	<const name="OSS" value="2">
13205	<desc>Open Sound System (Linux hosts only).</desc>
13206	</const>
13207	<const name="ALSA" value="3">
13208	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13209	</const>
13210	<const name="DirectSound" value="4">
13211	<desc>DirectSound (Windows hosts only).</desc>
13212	</const>
13213	<const name="CoreAudio" value="5">
13214	<desc>CoreAudio (Mac hosts only).</desc>
13215	</const>
13216	<const name="MMPM" value="6">
13217	<desc>Reserved for historical reasons.</desc>
13218	</const>
13219	<const name="Pulse" value="7">
13220	<desc>PulseAudio (Linux hosts only).</desc>
13221	</const>
13222	<const name="SolAudio" value="8">
13223	<desc>Solaris audio (Solaris hosts only).</desc>
13224	</const>
13225	</enum>
13226
13227	<enum
13228	name="AudioControllerType"
13229	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13230	>
13231	<desc>
13232	Virtual audio controller type.
13233	</desc>
13234
13235	<const name="AC97" value="0"/>
13236	<const name="SB16" value="1"/>
13237	<const name="HDA" value="2"/>
13238	</enum>
13239
13240	<interface
13241	name="IAudioAdapter" extends="$unknown"
13242	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13243	wsmap="managed"
13244	>
13245	<desc>
13246	The IAudioAdapter interface represents the virtual audio adapter of
13247	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13248	</desc>
13249	<attribute name="enabled" type="boolean">
13250	<desc>
13251	Flag whether the audio adapter is present in the
13252	guest system. If disabled, the virtual guest hardware will
13253	not contain any audio adapter. Can only be changed when
13254	the VM is not running.
13255	</desc>
13256	</attribute>
13257	<attribute name="audioController" type="AudioControllerType">
13258	<desc>
13259	The audio hardware we emulate.
13260	</desc>
13261	</attribute>
13262	<attribute name="audioDriver" type="AudioDriverType">
13263	<desc>
13264	Audio driver the adapter is connected to. This setting
13265	can only be changed when the VM is not running.
13266	</desc>
13267	</attribute>
13268	</interface>
13269
13270	<enum
13271	name="AuthType"
13272	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13273	>
13274	<desc>
13275	VirtualBox authentication type.
13276	</desc>
13277
13278	<const name="Null" value="0">
13279	<desc>Null value, also means "no authentication".</desc>
13280	</const>
13281	<const name="External" value="1"/>
13282	<const name="Guest" value="2"/>
13283	</enum>
13284
13285	<!--
13286	// IVRDEServer
13287	/////////////////////////////////////////////////////////////////////////
13288	-->
13289
13290	<interface
13291	name="IVRDEServer" extends="$unknown"
13292	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13293	wsmap="managed"
13294	>
13295	<attribute name="enabled" type="boolean">
13296	<desc>VRDE server status.</desc>
13297	</attribute>
13298
13299	<attribute name="authType" type="AuthType">
13300	<desc>VRDE authentication method.</desc>
13301	</attribute>
13302
13303	<attribute name="authTimeout" type="unsigned long">
13304	<desc>Timeout for guest authentication. Milliseconds.</desc>
13305	</attribute>
13306
13307	<attribute name="allowMultiConnection" type="boolean">
13308	<desc>
13309	Flag whether multiple simultaneous connections to the VM are permitted.
13310	Note that this will be replaced by a more powerful mechanism in the future.
13311	</desc>
13312	</attribute>
13313
13314	<attribute name="reuseSingleConnection" type="boolean">
13315	<desc>
13316	Flag whether the existing connection must be dropped and a new connection
13317	must be established by the VRDE server, when a new client connects in single
13318	connection mode.
13319	</desc>
13320	</attribute>
13321
13322	<attribute name="VRDEExtPack" type="wstring">
13323	<desc>
13324	The name of Extension Pack providing VRDE for this VM. Overrides
13325	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13326	</desc>
13327	</attribute>
13328
13329	<attribute name="AuthLibrary" type="wstring">
13330	<desc>
13331	Library used for authentication of RDP clients by this VM. Overrides
13332	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13333	</desc>
13334	</attribute>
13335
13336	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13337	<desc>
13338	Array of names of properties, which are supported by this VRDE server.
13339	</desc>
13340	</attribute>
13341
13342	<method name="setVRDEProperty">
13343	<desc>
13344	Sets a VRDE specific property string.
13345
13346	If you pass @c null or empty string as a key @a value, the given @a key
13347	will be deleted.
13348
13349	</desc>
13350	<param name="key" type="wstring" dir="in">
13351	<desc>Name of the key to set.</desc>
13352	</param>
13353	<param name="value" type="wstring" dir="in">
13354	<desc>Value to assign to the key.</desc>
13355	</param>
13356	</method>
13357
13358	<method name="getVRDEProperty">
13359	<desc>
13360	Returns a VRDE specific property string.
13361
13362	If the requested data @a key does not exist, this function will
13363	succeed and return an empty string in the @a value argument.
13364
13365	</desc>
13366	<param name="key" type="wstring" dir="in">
13367	<desc>Name of the key to get.</desc>
13368	</param>
13369	<param name="value" type="wstring" dir="return">
13370	<desc>Value of the requested key.</desc>
13371	</param>
13372	</method>
13373
13374	</interface>
13375
13376
13377	<!--
13378	// ISharedFolder
13379	/////////////////////////////////////////////////////////////////////////
13380	-->
13381
13382	<interface
13383	name="ISharedFolder" extends="$unknown"
13384	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13385	wsmap="struct"
13386	>
13387	<desc>
13388	The ISharedFolder interface represents a folder in the host computer's
13389	file system accessible from the guest OS running inside a virtual
13390	machine using an associated logical name.
13391
13392	There are three types of shared folders:
13393	<ul>
13394	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13395	folders available to all virtual machines.</li>
13396	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13397	VM-specific shared folders available to the given virtual machine at
13398	startup.</li>
13399	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13400	VM-specific shared folders created in the session context (for
13401	example, when the virtual machine is running) and automatically
13402	discarded when the session is closed (the VM is powered off).</li>
13403	</ul>
13404
13405	Logical names of shared folders must be unique within the given scope
13406	(global, permanent or transient). However, they do not need to be unique
13407	across scopes. In this case, the definition of the shared folder in a
13408	more specific scope takes precedence over definitions in all other
13409	scopes. The order of precedence is (more specific to more general):
13410	<ol>
13411	<li>Transient definitions</li>
13412	<li>Permanent definitions</li>
13413	<li>Global definitions</li>
13414	</ol>
13415
13416	For example, if MyMachine has a shared folder named
13417	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13418	transient shared folder named <tt>C_DRIVE</tt> (that points
13419	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13420	of <tt>C_DRIVE</tt> in the guest OS so
13421	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13422	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13423	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13424	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13425	to <tt>C:\\</tt> if it still exists.
13426
13427	Note that permanent and transient shared folders of different machines
13428	are in different name spaces, so they don't overlap and don't need to
13429	have unique logical names.
13430
13431	<note>
13432	Global shared folders are not implemented in the current version of the
13433	product.
13434	</note>
13435	</desc>
13436
13437	<attribute name="name" type="wstring" readonly="yes">
13438	<desc>Logical name of the shared folder.</desc>
13439	</attribute>
13440
13441	<attribute name="hostPath" type="wstring" readonly="yes">
13442	<desc>Full path to the shared folder in the host file system.</desc>
13443	</attribute>
13444
13445	<attribute name="accessible" type="boolean" readonly="yes">
13446	<desc>
13447	Whether the folder defined by the host path is currently
13448	accessible or not.
13449	For example, the folder can be inaccessible if it is placed
13450	on the network share that is not available by the time
13451	this property is read.
13452	</desc>
13453	</attribute>
13454
13455	<attribute name="writable" type="boolean" readonly="yes">
13456	<desc>
13457	Whether the folder defined by the host path is writable or
13458	not.
13459	</desc>
13460	</attribute>
13461
13462	<attribute name="autoMount" type="boolean" readonly="yes">
13463	<desc>
13464	Whether the folder gets automatically mounted by the guest or not.
13465	</desc>
13466	</attribute>
13467
13468	<attribute name="lastAccessError" type="wstring" readonly="yes">
13469	<desc>
13470	Text message that represents the result of the last accessibility
13471	check.
13472
13473	Accessibility checks are performed each time the <link to="#accessible"/>
13474	attribute is read. An empty string is returned if the last
13475	accessibility check was successful. A non-empty string indicates a
13476	failure and should normally describe a reason of the failure (for
13477	example, a file read error).
13478	</desc>
13479	</attribute>
13480
13481	</interface>
13482
13483	<!--
13484	// ISession
13485	/////////////////////////////////////////////////////////////////////////
13486	-->
13487
13488	<interface
13489	name="IInternalSessionControl" extends="$unknown"
13490	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
13491	internal="yes"
13492	wsmap="suppress"
13493	>
13494	<method name="getPID">
13495	<desc>PID of the process that has created this Session object.
13496	</desc>
13497	<param name="pid" type="unsigned long" dir="return"/>
13498	</method>
13499
13500	<method name="getRemoteConsole">
13501	<desc>
13502	Returns the console object suitable for remote control.
13503
13504	<result name="VBOX_E_INVALID_VM_STATE">
13505	Session state prevents operation.
13506	</result>
13507	<result name="VBOX_E_INVALID_OBJECT_STATE">
13508	Session type prevents operation.
13509	</result>
13510
13511	</desc>
13512	<param name="console" type="IConsole" dir="return"/>
13513	</method>
13514
13515	<method name="assignMachine">
13516	<desc>
13517	Assigns the machine object associated with this direct-type
13518	session or informs the session that it will be a remote one
13519	(if @a machine == @c null).
13520
13521	<result name="VBOX_E_INVALID_VM_STATE">
13522	Session state prevents operation.
13523	</result>
13524	<result name="VBOX_E_INVALID_OBJECT_STATE">
13525	Session type prevents operation.
13526	</result>
13527
13528	</desc>
13529	<param name="machine" type="IMachine" dir="in"/>
13530	</method>
13531
13532	<method name="assignRemoteMachine">
13533	<desc>
13534	Assigns the machine and the (remote) console object associated with
13535	this remote-type session.
13536
13537	<result name="VBOX_E_INVALID_VM_STATE">
13538	Session state prevents operation.
13539	</result>
13540
13541	</desc>
13542	<param name="machine" type="IMachine" dir="in"/>
13543	<param name="console" type="IConsole" dir="in"/>
13544	</method>
13545
13546	<method name="updateMachineState">
13547	<desc>
13548	Updates the machine state in the VM process.
13549	Must be called only in certain cases
13550	(see the method implementation).
13551
13552	<result name="VBOX_E_INVALID_VM_STATE">
13553	Session state prevents operation.
13554	</result>
13555	<result name="VBOX_E_INVALID_OBJECT_STATE">
13556	Session type prevents operation.
13557	</result>
13558
13559	</desc>
13560	<param name="aMachineState" type="MachineState" dir="in"/>
13561	</method>
13562
13563	<method name="uninitialize">
13564	<desc>
13565	Uninitializes (closes) this session. Used by VirtualBox to close
13566	the corresponding remote session when the direct session dies
13567	or gets closed.
13568
13569	<result name="VBOX_E_INVALID_VM_STATE">
13570	Session state prevents operation.
13571	</result>
13572
13573	</desc>
13574	</method>
13575
13576	<method name="onNetworkAdapterChange">
13577	<desc>
13578	Triggered when settings of a network adapter of the
13579	associated virtual machine have changed.
13580
13581	<result name="VBOX_E_INVALID_VM_STATE">
13582	Session state prevents operation.
13583	</result>
13584	<result name="VBOX_E_INVALID_OBJECT_STATE">
13585	Session type prevents operation.
13586	</result>
13587
13588	</desc>
13589	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13590	<param name="changeAdapter" type="boolean" dir="in"/>
13591	</method>
13592
13593	<method name="onSerialPortChange">
13594	<desc>
13595	Triggered when settings of a serial port of the
13596	associated virtual machine have changed.
13597
13598	<result name="VBOX_E_INVALID_VM_STATE">
13599	Session state prevents operation.
13600	</result>
13601	<result name="VBOX_E_INVALID_OBJECT_STATE">
13602	Session type prevents operation.
13603	</result>
13604
13605	</desc>
13606	<param name="serialPort" type="ISerialPort" dir="in"/>
13607	</method>
13608
13609	<method name="onParallelPortChange">
13610	<desc>
13611	Triggered when settings of a parallel port of the
13612	associated virtual machine have changed.
13613
13614	<result name="VBOX_E_INVALID_VM_STATE">
13615	Session state prevents operation.
13616	</result>
13617	<result name="VBOX_E_INVALID_OBJECT_STATE">
13618	Session type prevents operation.
13619	</result>
13620
13621	</desc>
13622	<param name="parallelPort" type="IParallelPort" dir="in"/>
13623	</method>
13624
13625	<method name="onStorageControllerChange">
13626	<desc>
13627	Triggered when settings of a storage controller of the
13628	associated virtual machine have changed.
13629
13630	<result name="VBOX_E_INVALID_VM_STATE">
13631	Session state prevents operation.
13632	</result>
13633	<result name="VBOX_E_INVALID_OBJECT_STATE">
13634	Session type prevents operation.
13635	</result>
13636
13637	</desc>
13638	</method>
13639
13640	<method name="onMediumChange">
13641	<desc>
13642	Triggered when attached media of the
13643	associated virtual machine have changed.
13644
13645	<result name="VBOX_E_INVALID_VM_STATE">
13646	Session state prevents operation.
13647	</result>
13648	<result name="VBOX_E_INVALID_OBJECT_STATE">
13649	Session type prevents operation.
13650	</result>
13651
13652	</desc>
13653
13654	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13655	<param name="force" type="boolean" dir="in"/>
13656	</method>
13657
13658	<method name="onCPUChange">
13659	<desc>
13660	Notification when a CPU changes.
13661	</desc>
13662	<param name="cpu" type="unsigned long" dir="in">
13663	<desc>The CPU which changed</desc>
13664	</param>
13665	<param name="add" type="boolean" dir="in">
13666	<desc>Flag whether the CPU was added or removed</desc>
13667	</param>
13668	</method>
13669
13670	<method name="onCPUExecutionCapChange">
13671	<desc>
13672	Notification when the CPU execution cap changes.
13673	</desc>
13674	<param name="executionCap" type="unsigned long" dir="in">
13675	<desc>The new CPU execution cap value. (1-100)</desc>
13676	</param>
13677	</method>
13678
13679	<method name="onVRDEServerChange">
13680	<desc>
13681	Triggered when settings of the VRDE server object of the
13682	associated virtual machine have changed.
13683
13684	<result name="VBOX_E_INVALID_VM_STATE">
13685	Session state prevents operation.
13686	</result>
13687	<result name="VBOX_E_INVALID_OBJECT_STATE">
13688	Session type prevents operation.
13689	</result>
13690
13691	</desc>
13692	<param name="restart" type="boolean" dir="in">
13693	<desc>Flag whether the server must be restarted</desc>
13694	</param>
13695	</method>
13696
13697	<method name="onUSBControllerChange">
13698	<desc>
13699	Triggered when settings of the USB controller object of the
13700	associated virtual machine have changed.
13701
13702	<result name="VBOX_E_INVALID_VM_STATE">
13703	Session state prevents operation.
13704	</result>
13705	<result name="VBOX_E_INVALID_OBJECT_STATE">
13706	Session type prevents operation.
13707	</result>
13708
13709	</desc>
13710	</method>
13711
13712	<method name="onSharedFolderChange">
13713	<desc>
13714	Triggered when a permanent (global or machine) shared folder has been
13715	created or removed.
13716	<note>
13717	We don't pass shared folder parameters in this notification because
13718	the order in which parallel notifications are delivered is not defined,
13719	therefore it could happen that these parameters were outdated by the
13720	time of processing this notification.
13721	</note>
13722
13723	<result name="VBOX_E_INVALID_VM_STATE">
13724	Session state prevents operation.
13725	</result>
13726	<result name="VBOX_E_INVALID_OBJECT_STATE">
13727	Session type prevents operation.
13728	</result>
13729
13730	</desc>
13731	<param name="global" type="boolean" dir="in"/>
13732	</method>
13733
13734	<method name="onUSBDeviceAttach">
13735	<desc>
13736	Triggered when a request to capture a USB device (as a result
13737	of matched USB filters or direct call to
13738	<link to="IConsole::attachUSBDevice"/>) has completed.
13739	A @c null @a error object means success, otherwise it
13740	describes a failure.
13741
13742	<result name="VBOX_E_INVALID_VM_STATE">
13743	Session state prevents operation.
13744	</result>
13745	<result name="VBOX_E_INVALID_OBJECT_STATE">
13746	Session type prevents operation.
13747	</result>
13748
13749	</desc>
13750	<param name="device" type="IUSBDevice" dir="in"/>
13751	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13752	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13753	</method>
13754
13755	<method name="onUSBDeviceDetach">
13756	<desc>
13757	Triggered when a request to release the USB device (as a result
13758	of machine termination or direct call to
13759	<link to="IConsole::detachUSBDevice"/>) has completed.
13760	A @c null @a error object means success, otherwise it
13761	describes a failure.
13762
13763	<result name="VBOX_E_INVALID_VM_STATE">
13764	Session state prevents operation.
13765	</result>
13766	<result name="VBOX_E_INVALID_OBJECT_STATE">
13767	Session type prevents operation.
13768	</result>
13769
13770	</desc>
13771	<param name="id" type="uuid" mod="string" dir="in"/>
13772	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13773	</method>
13774
13775	<method name="onShowWindow">
13776	<desc>
13777	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13778	<link to="IMachine::showConsoleWindow"/> in order to notify
13779	console listeners
13780	<link to="ICanShowWindowEvent"/>
13781	and <link to="IShowWindowEvent"/>.
13782
13783	<result name="VBOX_E_INVALID_OBJECT_STATE">
13784	Session type prevents operation.
13785	</result>
13786
13787	</desc>
13788	<param name="check" type="boolean" dir="in"/>
13789	<param name="canShow" type="boolean" dir="out"/>
13790	<param name="winId" type="long long" dir="out"/>
13791	</method>
13792
13793	<method name="onBandwidthGroupChange">
13794	<desc>
13795	Notification when one of the bandwidth groups change.
13796	</desc>
13797	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13798	<desc>The bandwidth group which changed.</desc>
13799	</param>
13800	</method>
13801
13802	<method name="accessGuestProperty">
13803	<desc>
13804	Called by <link to="IMachine::getGuestProperty"/> and by
13805	<link to="IMachine::setGuestProperty"/> in order to read and
13806	modify guest properties.
13807
13808	<result name="VBOX_E_INVALID_VM_STATE">
13809	Machine session is not open.
13810	</result>
13811	<result name="VBOX_E_INVALID_OBJECT_STATE">
13812	Session type is not direct.
13813	</result>
13814
13815	</desc>
13816	<param name="name" type="wstring" dir="in"/>
13817	<param name="value" type="wstring" dir="in"/>
13818	<param name="flags" type="wstring" dir="in"/>
13819	<param name="isSetter" type="boolean" dir="in"/>
13820	<param name="retValue" type="wstring" dir="out"/>
13821	<param name="retTimestamp" type="long long" dir="out"/>
13822	<param name="retFlags" type="wstring" dir="out"/>
13823	</method>
13824
13825	<method name="enumerateGuestProperties">
13826	<desc>
13827	Return a list of the guest properties matching a set of patterns along
13828	with their values, time stamps and flags.
13829
13830	<result name="VBOX_E_INVALID_VM_STATE">
13831	Machine session is not open.
13832	</result>
13833	<result name="VBOX_E_INVALID_OBJECT_STATE">
13834	Session type is not direct.
13835	</result>
13836
13837	</desc>
13838	<param name="patterns" type="wstring" dir="in">
13839	<desc>
13840	The patterns to match the properties against as a comma-separated
13841	string. If this is empty, all properties currently set will be
13842	returned.
13843	</desc>
13844	</param>
13845	<param name="key" type="wstring" dir="out" safearray="yes">
13846	<desc>
13847	The key names of the properties returned.
13848	</desc>
13849	</param>
13850	<param name="value" type="wstring" dir="out" safearray="yes">
13851	<desc>
13852	The values of the properties returned. The array entries match the
13853	corresponding entries in the @a key array.
13854	</desc>
13855	</param>
13856	<param name="timestamp" type="long long" dir="out" safearray="yes">
13857	<desc>
13858	The time stamps of the properties returned. The array entries match
13859	the corresponding entries in the @a key array.
13860	</desc>
13861	</param>
13862	<param name="flags" type="wstring" dir="out" safearray="yes">
13863	<desc>
13864	The flags of the properties returned. The array entries match the
13865	corresponding entries in the @a key array.
13866	</desc>
13867	</param>
13868	</method>
13869
13870	<method name="onlineMergeMedium">
13871	<desc>
13872	Triggers online merging of a hard disk. Used internally when deleting
13873	a snapshot while a VM referring to the same hard disk chain is running.
13874
13875	<result name="VBOX_E_INVALID_VM_STATE">
13876	Machine session is not open.
13877	</result>
13878	<result name="VBOX_E_INVALID_OBJECT_STATE">
13879	Session type is not direct.
13880	</result>
13881
13882	</desc>
13883	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13884	<desc>The medium attachment to identify the medium chain.</desc>
13885	</param>
13886	<param name="sourceIdx" type="unsigned long" dir="in">
13887	<desc>The index of the source image in the chain.
13888	Redundant, but drastically reduces IPC.</desc>
13889	</param>
13890	<param name="targetIdx" type="unsigned long" dir="in">
13891	<desc>The index of the target image in the chain.
13892	Redundant, but drastically reduces IPC.</desc>
13893	</param>
13894	<param name="source" type="IMedium" dir="in">
13895	<desc>Merge source medium.</desc>
13896	</param>
13897	<param name="target" type="IMedium" dir="in">
13898	<desc>Merge target medium.</desc>
13899	</param>
13900	<param name="mergeForward" type="boolean" dir="in">
13901	<desc>Merge direction.</desc>
13902	</param>
13903	<param name="parentForTarget" type="IMedium" dir="in">
13904	<desc>For forward merges: new parent for target medium.</desc>
13905	</param>
13906	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13907	<desc>For backward merges: list of media which need their parent UUID
13908	updated.</desc>
13909	</param>
13910	<param name="progress" type="IProgress" dir="in">
13911	<desc>
13912	Progress object for this operation.
13913	</desc>
13914	</param>
13915	</method>
13916
13917	</interface>
13918
13919	<interface
13920	name="ISession" extends="$unknown"
13921	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13922	wsmap="managed"
13923	>
13924	<desc>
13925	The ISession interface represents a client process and allows for locking
13926	virtual machines (represented by IMachine objects) to prevent conflicting
13927	changes to the machine.
13928
13929	Any caller wishing to manipulate a virtual machine needs to create a session
13930	object first, which lives in its own process space. Such session objects are
13931	then associated with <link to="IMachine" /> objects living in the VirtualBox
13932	server process to coordinate such changes.
13933
13934	There are two typical scenarios in which sessions are used:
13935
13936	<ul>
13937	<li>To alter machine settings or control a running virtual machine, one
13938	needs to lock a machine for a given session (client process) by calling
13939	<link to="IMachine::lockMachine"/>.
13940
13941	Whereas multiple sessions may control a running virtual machine, only
13942	one process can obtain a write lock on the machine to prevent conflicting
13943	changes. A write lock is also needed if a process wants to actually run a
13944	virtual machine in its own context, such as the VirtualBox GUI or
13945	VBoxHeadless front-ends. They must also lock a machine for their own
13946	sessions before they are allowed to power up the virtual machine.
13947
13948	As a result, no machine settings can be altered while another process is
13949	already using it, either because that process is modifying machine settings
13950	or because the machine is running.
13951	</li>
13952	<li>
13953	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13954	VirtualBox GUI or VBoxHeadless), one would use
13955	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13956	as its first parameter. This session then identifies the caller and lets the
13957	caller control the started machine (for example, pause machine execution or
13958	power it down) as well as be notified about machine execution state changes.
13959	</li>
13960	</ul>
13961
13962	How sessions objects are created in a client process depends on whether you use
13963	the Main API via COM or via the webservice:
13964
13965	<ul>
13966	<li>When using the COM API directly, an object of the Session class from the
13967	VirtualBox type library needs to be created. In regular COM C++ client code,
13968	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13969	This object will then act as a local session object in further calls to open
13970	a session.
13971	</li>
13972
13973	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13974	a session object automatically whenever <link to="IWebsessionManager::logon" />
13975	is called. A managed object reference to that session object can be retrieved by
13976	calling <link to="IWebsessionManager::getSessionObject" />.
13977	</li>
13978	</ul>
13979	</desc>
13980
13981	<attribute name="state" type="SessionState" readonly="yes">
13982	<desc>Current state of this session.</desc>
13983	</attribute>
13984
13985	<attribute name="type" type="SessionType" readonly="yes">
13986	<desc>
13987	Type of this session. The value of this attribute is valid only
13988	if the session currently has a machine locked (i.e. its
13989	<link to="#state" /> is Locked), otherwise an error will be returned.
13990	</desc>
13991	</attribute>
13992
13993	<attribute name="machine" type="IMachine" readonly="yes">
13994	<desc>Machine object associated with this session.</desc>
13995	</attribute>
13996
13997	<attribute name="console" type="IConsole" readonly="yes">
13998	<desc>Console object associated with this session.</desc>
13999	</attribute>
14000
14001	<method name="unlockMachine">
14002	<desc>
14003	Unlocks a machine that was previously locked for the current session.
14004
14005	Calling this method is required every time a machine has been locked
14006	for a particular session using the <link to="IMachine::launchVMProcess" />
14007	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
14008	the machine will be set to <link to="MachineState_Aborted" /> on the
14009	server, and changes made to the machine settings will be lost.
14010
14011	Generally, it is recommended to unlock all machines explicitly
14012	before terminating the application (regardless of the reason for
14013	the termination).
14014
14015	<note>
14016	Do not expect the session state (<link to="ISession::state" />
14017	to return to "Unlocked" immediately after you invoke this method,
14018	particularly if you have started a new VM process. The session
14019	state will automatically return to "Unlocked" once the VM is no
14020	longer executing, which can of course take a very long time.
14021	</note>
14022
14023	<result name="E_UNEXPECTED">
14024	Session is not locked.
14025	</result>
14026
14027	</desc>
14028	</method>
14029
14030	</interface>
14031
14032	<!--
14033	// IStorageController
14034	/////////////////////////////////////////////////////////////////////////
14035	-->
14036
14037	<enum
14038	name="StorageBus"
14039	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
14040	>
14041	<desc>
14042	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
14043	see <link to="IStorageController::bus" />.
14044	</desc>
14045	<const name="Null" value="0">
14046	<desc>@c null value. Never used by the API.</desc>
14047	</const>
14048	<const name="IDE" value="1"/>
14049	<const name="SATA" value="2"/>
14050	<const name="SCSI" value="3"/>
14051	<const name="Floppy" value="4"/>
14052	<const name="SAS" value="5"/>
14053	</enum>
14054
14055	<enum
14056	name="StorageControllerType"
14057	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
14058	>
14059	<desc>
14060	The exact variant of storage controller hardware presented
14061	to the guest; see <link to="IStorageController::controllerType" />.
14062	</desc>
14063
14064	<const name="Null" value="0">
14065	<desc>@c null value. Never used by the API.</desc>
14066	</const>
14067	<const name="LsiLogic" value="1">
14068	<desc>A SCSI controller of the LsiLogic variant.</desc>
14069	</const>
14070	<const name="BusLogic" value="2">
14071	<desc>A SCSI controller of the BusLogic variant.</desc>
14072	</const>
14073	<const name="IntelAhci" value="3">
14074	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
14075	</const>
14076	<const name="PIIX3" value="4">
14077	<desc>An IDE controller of the PIIX3 variant.</desc>
14078	</const>
14079	<const name="PIIX4" value="5">
14080	<desc>An IDE controller of the PIIX4 variant.</desc>
14081	</const>
14082	<const name="ICH6" value="6">
14083	<desc>An IDE controller of the ICH6 variant.</desc>
14084	</const>
14085	<const name="I82078" value="7">
14086	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
14087	</const>
14088	<const name="LsiLogicSas" value="8">
14089	<desc>A variant of the LsiLogic controller using SAS.</desc>
14090	</const>
14091	</enum>
14092
14093	<enum
14094	name="ChipsetType"
14095	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
14096	>
14097	<desc>
14098	Type of emulated chipset (mostly southbridge).
14099	</desc>
14100
14101	<const name="Null" value="0">
14102	<desc>@c null value. Never used by the API.</desc>
14103	</const>
14104	<const name="PIIX3" value="1">
14105	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
14106	</const>
14107	<const name="ICH9" value="2">
14108	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
14109	</const>
14110	</enum>
14111
14112	<interface
14113	name="IStorageController" extends="$unknown"
14114	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
14115	wsmap="managed"
14116	>
14117	<desc>
14118	Represents a storage controller that is attached to a virtual machine
14119	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14120	attached to storage controllers in a real computer, virtual drives
14121	(represented by <link to="IMediumAttachment" />) are attached to virtual
14122	storage controllers, represented by this interface.
14123
14124	As opposed to physical hardware, VirtualBox has a very generic concept
14125	of a storage controller, and for purposes of the Main API, all virtual
14126	storage is attached to virtual machines via instances of this interface.
14127	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14128	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14129	is used, certain sub-types may be available and can be selected in
14130	<link to="#controllerType" />.
14131
14132	Depending on these settings, the guest operating system might see
14133	significantly different virtual hardware.
14134	</desc>
14135
14136	<attribute name="name" type="wstring" readonly="yes">
14137	<desc>
14138	Name of the storage controller, as originally specified with
14139	<link to="IMachine::addStorageController" />. This then uniquely
14140	identifies this controller with other method calls such as
14141	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14142	</desc>
14143	</attribute>
14144
14145	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14146	<desc>
14147	Maximum number of devices which can be attached to one port.
14148	</desc>
14149	</attribute>
14150
14151	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14152	<desc>
14153	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14154	</desc>
14155	</attribute>
14156
14157	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14158	<desc>
14159	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14160	</desc>
14161	</attribute>
14162
14163	<attribute name="instance" type="unsigned long">
14164	<desc>
14165	The instance number of the device in the running VM.
14166	</desc>
14167	</attribute>
14168
14169	<attribute name="portCount" type="unsigned long">
14170	<desc>
14171	The number of currently usable ports on the controller.
14172	The minimum and maximum number of ports for one controller are
14173	stored in <link to="IStorageController::minPortCount"/>
14174	and <link to="IStorageController::maxPortCount"/>.
14175	</desc>
14176	</attribute>
14177
14178	<attribute name="bus" type="StorageBus" readonly="yes">
14179	<desc>
14180	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14181	</desc>
14182	</attribute>
14183
14184	<attribute name="controllerType" type="StorageControllerType">
14185	<desc>
14186	The exact variant of storage controller hardware presented
14187	to the guest.
14188	Depending on this value, VirtualBox will provide a different
14189	virtual storage controller hardware to the guest.
14190	For SATA, SAS and floppy controllers, only one variant is
14191	available, but for IDE and SCSI, there are several.
14192
14193	For SCSI controllers, the default type is LsiLogic.
14194	</desc>
14195	</attribute>
14196
14197	<attribute name="useHostIOCache" type="boolean">
14198	<desc>
14199	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14200	caches and use synchronous file APIs on the host. This was the only option in the API before
14201	VirtualBox 3.2 and is still the default for IDE controllers.
14202
14203	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14204	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14205	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14206	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14207	virtual machines are running at the same time to prevent I/O cache related hangs.
14208	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14209	</desc>
14210	</attribute>
14211
14212	<attribute name="bootable" type="boolean" readonly="yes">
14213	<desc>
14214	Returns whether it is possible to boot from disks attached to this controller.
14215	</desc>
14216	</attribute>
14217
14218	<method name="getIDEEmulationPort">
14219	<desc>
14220	Gets the corresponding port number which is emulated as an IDE device.
14221	Works only with SATA controllers.
14222
14223	<result name="E_INVALIDARG">
14224	The @a devicePosition is not in the range 0 to 3.
14225	</result>
14226	<result name="E_NOTIMPL">
14227	The storage controller type is not SATAIntelAhci.
14228	</result>
14229
14230	</desc>
14231	<param name="devicePosition" type="long" dir="in"/>
14232	<param name="portNumber" type="long" dir="return"/>
14233	</method>
14234
14235	<method name="setIDEEmulationPort">
14236	<desc>
14237	Sets the port number which is emulated as an IDE device.
14238	Works only with SATA controllers.
14239
14240	<result name="E_INVALIDARG">
14241	The @a devicePosition is not in the range 0 to 3 or the
14242	@a portNumber is not in the range 0 to 29.
14243	</result>
14244	<result name="E_NOTIMPL">
14245	The storage controller type is not SATAIntelAhci.
14246	</result>
14247
14248	</desc>
14249	<param name="devicePosition" type="long" dir="in"/>
14250	<param name="portNumber" type="long" dir="in"/>
14251	</method>
14252
14253	</interface>
14254
14255	<if target="wsdl">
14256
14257	<!--
14258	// IManagedObjectRef
14259	/////////////////////////////////////////////////////////////////////////
14260	-->
14261
14262	<interface
14263	name="IManagedObjectRef" extends="$unknown"
14264	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14265	internal="yes"
14266	wsmap="managed"
14267	wscpp="hardcoded"
14268	>
14269	<desc>
14270	Managed object reference.
14271
14272	Only within the webservice, a managed object reference (which is really
14273	an opaque number) allows a webservice client to address an object
14274	that lives in the address space of the webservice server.
14275
14276	Behind each managed object reference, there is a COM object that lives
14277	in the webservice server's address space. The COM object is not freed
14278	until the managed object reference is released, either by an explicit
14279	call to <link to="IManagedObjectRef::release" /> or by logging off from
14280	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14281	all objects created during the webservice session.
14282
14283	Whenever a method call of the VirtualBox API returns a COM object, the
14284	webservice representation of that method will instead return a
14285	managed object reference, which can then be used to invoke methods
14286	on that object.
14287	</desc>
14288
14289	<method name="getInterfaceName">
14290	<desc>
14291	Returns the name of the interface that this managed object represents,
14292	for example, "IMachine", as a string.
14293	</desc>
14294	<param name="return" type="wstring" dir="return"/>
14295	</method>
14296
14297	<method name="release">
14298	<desc>
14299	Releases this managed object reference and frees the resources that
14300	were allocated for it in the webservice server process. After calling
14301	this method, the identifier of the reference can no longer be used.
14302	</desc>
14303	</method>
14304
14305	</interface>
14306
14307	<!--
14308	// IWebsessionManager
14309	/////////////////////////////////////////////////////////////////////////
14310	-->
14311
14312	<interface
14313	name="IWebsessionManager" extends="$unknown"
14314	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14315	internal="yes"
14316	wsmap="global"
14317	wscpp="hardcoded"
14318	>
14319	<desc>
14320	Websession manager. This provides essential services
14321	to webservice clients.
14322	</desc>
14323	<method name="logon">
14324	<desc>
14325	Logs a new client onto the webservice and returns a managed object reference to
14326	the IVirtualBox instance, which the client can then use as a basis to further
14327	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14328	interface, in one way or the other.
14329	</desc>
14330	<param name="username" type="wstring" dir="in"/>
14331	<param name="password" type="wstring" dir="in"/>
14332	<param name="return" type="IVirtualBox" dir="return"/>
14333	</method>
14334
14335	<method name="getSessionObject">
14336	<desc>
14337	Returns a managed object reference to the internal ISession object that was created
14338	for this web service session when the client logged on.
14339
14340	<see>ISession</see>
14341	</desc>
14342	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14343	<param name="return" type="ISession" dir="return"/>
14344	</method>
14345
14346	<method name="logoff">
14347	<desc>
14348	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14349	and destroys all resources associated with the session (most importantly, all
14350	managed objects created in the server while the session was active).
14351	</desc>
14352	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14353	</method>
14354
14355	</interface>
14356
14357	</if>
14358
14359	<!--
14360	// IPerformanceCollector & friends
14361	/////////////////////////////////////////////////////////////////////////
14362	-->
14363
14364	<interface
14365	name="IPerformanceMetric" extends="$unknown"
14366	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14367	>
14368	<desc>
14369	The IPerformanceMetric interface represents parameters of the given
14370	performance metric.
14371	</desc>
14372
14373	<attribute name="metricName" type="wstring" readonly="yes">
14374	<desc>
14375	Name of the metric.
14376	</desc>
14377	</attribute>
14378
14379	<attribute name="object" type="$unknown" readonly="yes">
14380	<desc>
14381	Object this metric belongs to.
14382	</desc>
14383	</attribute>
14384
14385	<attribute name="description" type="wstring" readonly="yes">
14386	<desc>
14387	Textual description of the metric.
14388	</desc>
14389	</attribute>
14390
14391	<attribute name="period" type="unsigned long" readonly="yes">
14392	<desc>
14393	Time interval between samples, measured in seconds.
14394	</desc>
14395	</attribute>
14396
14397	<attribute name="count" type="unsigned long" readonly="yes">
14398	<desc>
14399	Number of recent samples retained by the performance collector for this
14400	metric.
14401
14402	When the collected sample count exceeds this number, older samples
14403	are discarded.
14404	</desc>
14405	</attribute>
14406
14407	<attribute name="unit" type="wstring" readonly="yes">
14408	<desc>
14409	Unit of measurement.
14410	</desc>
14411	</attribute>
14412
14413	<attribute name="minimumValue" type="long" readonly="yes">
14414	<desc>
14415	Minimum possible value of this metric.
14416	</desc>
14417	</attribute>
14418
14419	<attribute name="maximumValue" type="long" readonly="yes">
14420	<desc>
14421	Maximum possible value of this metric.
14422	</desc>
14423	</attribute>
14424	</interface>
14425
14426	<interface
14427	name="IPerformanceCollector" extends="$unknown"
14428	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14429	wsmap="managed"
14430	>
14431	<desc>
14432	The IPerformanceCollector interface represents a service that collects
14433	and stores performance metrics data.
14434
14435	Performance metrics are associated with objects of interfaces like IHost
14436	and IMachine. Each object has a distinct set of performance metrics. The
14437	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14438
14439	Metric data is collected at the specified intervals and is retained
14440	internally. The interval and the number of retained samples can be set
14441	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14442	and collection settings are not persistent, they are discarded as soon as
14443	VBoxSVC process terminates. Moreover, metric settings and data associated
14444	with a particular VM only exist while VM is running. They disappear as
14445	soon as VM shuts down. It is not possible to set up metrics for machines
14446	that are powered off. One needs to start VM first, then set up metric
14447	collection parameters.
14448
14449	Metrics are organized hierarchically, with each level separated by a
14450	slash (/) character. Generally, the scheme for metric names is like this:
14451
14452	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14453
14454	"Category/Metric" together form the base metric name. A base metric is
14455	the smallest unit for which a sampling interval and the number of
14456	retained samples can be set. Only base metrics can be enabled and
14457	disabled. All sub-metrics are collected when their base metric is
14458	collected. Collected values for any set of sub-metrics can be queried
14459	with <link to="IPerformanceCollector::queryMetricsData" />.
14460
14461	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14462	category, "Load" metric, "User" submetric, "average" aggregate. An
14463	aggregate function is computed over all retained data. Valid aggregate
14464	functions are:
14465
14466	<ul>
14467	<li>avg -- average</li>
14468	<li>min -- minimum</li>
14469	<li>max -- maximum</li>
14470	</ul>
14471
14472	When setting up metric parameters, querying metric data, enabling or
14473	disabling metrics wildcards can be used in metric names to specify a
14474	subset of metrics. For example, to select all CPU-related metrics
14475	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14476	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14477
14478	The valid names for base metrics are:
14479
14480	<ul>
14481	<li>CPU/Load</li>
14482	<li>CPU/MHz</li>
14483	<li>RAM/Usage</li>
14484	<li>RAM/VMM</li>
14485	</ul>
14486
14487	The general sequence for collecting and retrieving the metrics is:
14488	<ul>
14489	<li>
14490	Obtain an instance of IPerformanceCollector with
14491	<link to="IVirtualBox::performanceCollector" />
14492	</li>
14493	<li>
14494	Allocate and populate an array with references to objects the metrics
14495	will be collected for. Use references to IHost and IMachine objects.
14496	</li>
14497	<li>
14498	Allocate and populate an array with base metric names the data will
14499	be collected for.
14500	</li>
14501	<li>
14502	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14503	the metric data will be collected and stored.
14504	</li>
14505	<li>
14506	Wait for the data to get collected.
14507	</li>
14508	<li>
14509	Allocate and populate an array with references to objects the metric
14510	values will be queried for. You can re-use the object array used for
14511	setting base metrics.
14512	</li>
14513	<li>
14514	Allocate and populate an array with metric names the data will be
14515	collected for. Note that metric names differ from base metric names.
14516	</li>
14517	<li>
14518	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14519	that have been collected so far are returned. Note that the values
14520	are still retained internally and data collection continues.
14521	</li>
14522	</ul>
14523
14524	For an example of usage refer to the following files in VirtualBox SDK:
14525	<ul>
14526	<li>
14527	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14528	</li>
14529	<li>
14530	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14531	</li>
14532	</ul>
14533	</desc>
14534
14535	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14536	<desc>
14537	Array of unique names of metrics.
14538
14539	This array represents all metrics supported by the performance
14540	collector. Individual objects do not necessarily support all of them.
14541	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14542	list of supported metrics for a particular object.
14543	</desc>
14544	</attribute>
14545
14546	<method name="getMetrics">
14547	<desc>
14548	Returns parameters of specified metrics for a set of objects.
14549	<note>
14550	@c Null metrics array means all metrics. @c Null object array means
14551	all existing objects.
14552	</note>
14553	</desc>
14554	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14555	<desc>
14556	Metric name filter. Currently, only a comma-separated list of metrics
14557	is supported.
14558	</desc>
14559	</param>
14560	<param name="objects" type="$unknown" dir="in" safearray="yes">
14561	<desc>
14562	Set of objects to return metric parameters for.
14563	</desc>
14564	</param>
14565	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14566	<desc>
14567	Array of returned metric parameters.
14568	</desc>
14569	</param>
14570	</method>
14571
14572	<method name="setupMetrics">
14573	<desc>
14574	Sets parameters of specified base metrics for a set of objects. Returns
14575	an array of <link to="IPerformanceMetric" /> describing the metrics
14576	have been affected.
14577	<note>
14578	@c Null or empty metric name array means all metrics. @c Null or
14579	empty object array means all existing objects. If metric name array
14580	contains a single element and object array contains many, the single
14581	metric name array element is applied to each object array element to
14582	form metric/object pairs.
14583	</note>
14584	</desc>
14585	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14586	<desc>
14587	Metric name filter. Comma-separated list of metrics with wildcard
14588	support.
14589	</desc>
14590	</param>
14591	<param name="objects" type="$unknown" dir="in" safearray="yes">
14592	<desc>
14593	Set of objects to setup metric parameters for.
14594	</desc>
14595	</param>
14596	<param name="period" type="unsigned long" dir="in">
14597	<desc>
14598	Time interval in seconds between two consecutive samples of
14599	performance data.
14600	</desc>
14601	</param>
14602	<param name="count" type="unsigned long" dir="in">
14603	<desc>
14604	Number of samples to retain in performance data history. Older
14605	samples get discarded.
14606	</desc>
14607	</param>
14608	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14609	<desc>
14610	Array of metrics that have been modified by the call to this method.
14611	</desc>
14612	</param>
14613	</method>
14614
14615	<method name="enableMetrics">
14616	<desc>
14617	Turns on collecting specified base metrics. Returns an array of
14618	<link to="IPerformanceMetric" /> describing the metrics have been
14619	affected.
14620	<note>
14621	@c Null or empty metric name array means all metrics. @c Null or
14622	empty object array means all existing objects. If metric name array
14623	contains a single element and object array contains many, the single
14624	metric name array element is applied to each object array element to
14625	form metric/object pairs.
14626	</note>
14627	</desc>
14628	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14629	<desc>
14630	Metric name filter. Comma-separated list of metrics with wildcard
14631	support.
14632	</desc>
14633	</param>
14634	<param name="objects" type="$unknown" dir="in" safearray="yes">
14635	<desc>
14636	Set of objects to enable metrics for.
14637	</desc>
14638	</param>
14639	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14640	<desc>
14641	Array of metrics that have been modified by the call to this method.
14642	</desc>
14643	</param>
14644	</method>
14645
14646	<method name="disableMetrics">
14647	<desc>
14648	Turns off collecting specified base metrics. Returns an array of
14649	<link to="IPerformanceMetric" /> describing the metrics have been
14650	affected.
14651	<note>
14652	@c Null or empty metric name array means all metrics. @c Null or
14653	empty object array means all existing objects. If metric name array
14654	contains a single element and object array contains many, the single
14655	metric name array element is applied to each object array element to
14656	form metric/object pairs.
14657	</note>
14658	</desc>
14659	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14660	<desc>
14661	Metric name filter. Comma-separated list of metrics with wildcard
14662	support.
14663	</desc>
14664	</param>
14665	<param name="objects" type="$unknown" dir="in" safearray="yes">
14666	<desc>
14667	Set of objects to disable metrics for.
14668	</desc>
14669	</param>
14670	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14671	<desc>
14672	Array of metrics that have been modified by the call to this method.
14673	</desc>
14674	</param>
14675	</method>
14676
14677	<method name="queryMetricsData">
14678	<desc>
14679	Queries collected metrics data for a set of objects.
14680
14681	The data itself and related metric information are returned in seven
14682	parallel and one flattened array of arrays. Elements of
14683	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14684	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14685	the same index describe one set of values corresponding to a single
14686	metric.
14687
14688	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14689	start and length of a sub-array is indicated by
14690	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14691	value for metric <tt>metricNames[i]</tt> is at
14692	<tt>returnData[returnIndices[i]]</tt>.
14693
14694	<note>
14695	@c Null or empty metric name array means all metrics. @c Null or
14696	empty object array means all existing objects. If metric name array
14697	contains a single element and object array contains many, the single
14698	metric name array element is applied to each object array element to
14699	form metric/object pairs.
14700	</note>
14701	<note>
14702	Data collection continues behind the scenes after call to @c
14703	queryMetricsData. The return data can be seen as the snapshot of the
14704	current state at the time of @c queryMetricsData call. The internally
14705	kept metric values are not cleared by the call. This makes possible
14706	querying different subsets of metrics or aggregates with subsequent
14707	calls. If periodic querying is needed it is highly suggested to query
14708	the values with @c interval*count period to avoid confusion. This way
14709	a completely new set of data values will be provided by each query.
14710	</note>
14711	</desc>
14712	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14713	<desc>
14714	Metric name filter. Comma-separated list of metrics with wildcard
14715	support.
14716	</desc>
14717	</param>
14718	<param name="objects" type="$unknown" dir="in" safearray="yes">
14719	<desc>
14720	Set of objects to query metrics for.
14721	</desc>
14722	</param>
14723	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14724	<desc>
14725	Names of metrics returned in @c returnData.
14726	</desc>
14727	</param>
14728	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14729	<desc>
14730	Objects associated with metrics returned in @c returnData.
14731	</desc>
14732	</param>
14733	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14734	<desc>
14735	Units of measurement for each returned metric.
14736	</desc>
14737	</param>
14738	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14739	<desc>
14740	Divisor that should be applied to return values in order to get
14741	floating point values. For example:
14742	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14743	will retrieve the floating point value of i-th sample of the first
14744	metric.
14745	</desc>
14746	</param>
14747	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14748	<desc>
14749	Sequence numbers of the first elements of value sequences of
14750	particular metrics returned in @c returnData. For aggregate metrics
14751	it is the sequence number of the sample the aggregate started
14752	calculation from.
14753	</desc>
14754	</param>
14755	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14756	<desc>
14757	Indices of the first elements of value sequences of particular
14758	metrics returned in @c returnData.
14759	</desc>
14760	</param>
14761	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14762	<desc>
14763	Lengths of value sequences of particular metrics.
14764	</desc>
14765	</param>
14766	<param name="returnData" type="long" dir="return" safearray="yes">
14767	<desc>
14768	Flattened array of all metric data containing sequences of values for
14769	each metric.
14770	</desc>
14771	</param>
14772	</method>
14773
14774	</interface>
14775
14776	<enum
14777	name="NATAliasMode"
14778	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14779	>
14780	<desc></desc>
14781	<const name="AliasLog" value="0x1">
14782	<desc></desc>
14783	</const>
14784	<const name="AliasProxyOnly" value="0x02">
14785	<desc></desc>
14786	</const>
14787	<const name="AliasUseSamePorts" value="0x04">
14788	<desc></desc>
14789	</const>
14790	</enum>
14791
14792	<enum
14793	name="NATProtocol"
14794	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14795	>
14796	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14797	<const name="UDP" value="0">
14798	<desc>Port-forwarding uses UDP protocol.</desc>
14799	</const>
14800	<const name="TCP" value="1">
14801	<desc>Port-forwarding uses TCP protocol.</desc>
14802	</const>
14803	</enum>
14804
14805	<interface
14806	name="INATEngine" extends="$unknown"
14807	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14808	wsmap="managed"
14809	>
14810	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14811	allows for changing NAT behavior such as port-forwarding rules. This interface is
14812	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14813	<attribute name="network" type="wstring">
14814	<desc>The network attribute of the NAT engine (the same value is used with built-in
14815	DHCP server to fill corresponding fields of DHCP leases).</desc>
14816	</attribute>
14817	<attribute name="hostIP" type="wstring">
14818	<desc>IP of host interface to bind all opened sockets to.
14819	<note>Changing this does not change binding of port forwarding.</note>
14820	</desc>
14821	</attribute>
14822	<attribute name="tftpPrefix" type="wstring">
14823	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14824	the corresponding fields of DHCP leases.</desc>
14825	</attribute>
14826	<attribute name="tftpBootFile" type="wstring">
14827	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14828	the corresponding fields of DHCP leases.</desc>
14829	</attribute>
14830	<attribute name="tftpNextServer" type="wstring">
14831	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14832	the corresponding fields of DHCP leases.
14833	<note>The preferred form is IPv4 addresses.</note>
14834	</desc>
14835	</attribute>
14836	<attribute name="aliasMode" type="unsigned long">
14837	<desc></desc>
14838	</attribute>
14839	<attribute name="dnsPassDomain" type="boolean">
14840	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14841	</attribute>
14842	<attribute name="dnsProxy" type="boolean">
14843	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14844	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14845	</attribute>
14846	<attribute name="dnsUseHostResolver" type="boolean">
14847	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14848	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14849	</attribute>
14850	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14851	<desc>Array of NAT port-forwarding rules in string representation, in the following
14852	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14853	</attribute>
14854	<method name="setNetworkSettings">
14855	<desc>Sets network configuration of the NAT engine.</desc>
14856	<param name="mtu" type="unsigned long" dir="in">
14857	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14858	</param>
14859	<param name="sockSnd" type="unsigned long" dir="in">
14860	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14861	</param>
14862	<param name="sockRcv" type="unsigned long" dir="in">
14863	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14864	</param>
14865	<param name="TcpWndSnd" type="unsigned long" dir="in">
14866	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14867	establishing a new TCP connection.</desc>
14868	</param>
14869	<param name="TcpWndRcv" type="unsigned long" dir="in">
14870	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14871	establishing a new TCP connection.</desc>
14872	</param>
14873	</method>
14874	<method name="getNetworkSettings">
14875	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14876	for parameter descriptions.</desc>
14877	<param name="mtu" type="unsigned long" dir="out" />
14878	<param name="sockSnd" type="unsigned long" dir="out" />
14879	<param name="sockRcv" type="unsigned long" dir="out" />
14880	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14881	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14882	</method>
14883	<method name="addRedirect">
14884	<desc>Adds a new NAT port-forwarding rule.</desc>
14885	<param name="name" type="wstring" dir="in">
14886	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14887	auto-generates one using the other parameters.</desc>
14888	</param>
14889	<param name="proto" type="NATProtocol" dir="in">
14890	<desc>Protocol handled with the rule.</desc>
14891	</param>
14892	<param name="hostIp" type="wstring" dir="in">
14893	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14894	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14895	</param>
14896	<param name="hostPort" type="unsigned short" dir="in">
14897	<desc>The port number to listen on.</desc>
14898	</param>
14899	<param name="guestIp" type="wstring" dir="in">
14900	<desc>The IP address of the guest which the NAT engine will forward matching packets
14901	to. An empty IP address is acceptable, in which case the NAT engine will forward
14902	packets to the first DHCP lease (x.x.x.15).</desc>
14903	</param>
14904	<param name="guestPort" type="unsigned short" dir="in">
14905	<desc>The port number to forward.</desc>
14906	</param>
14907	</method>
14908	<method name="removeRedirect">
14909	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14910	<param name="name" type="wstring" dir="in">
14911	<desc>The name of the rule to delete.</desc>
14912	</param>
14913	</method>
14914	</interface>
14915
14916	<!--
14917	// IExtPackManager
14918	/////////////////////////////////////////////////////////////////////////
14919	-->
14920
14921	<interface
14922	name="IExtPackPlugIn" extends="$unknown"
14923	uuid="58000040-e718-4746-bbce-4b86d96da461"
14924	wsmap="suppress"
14925	>
14926	<desc>
14927	Interface for keeping information about a plug-in that ships with an
14928	extension pack.
14929	</desc>
14930	<attribute name="name" type="wstring" readonly="yes">
14931	<desc>The plug-in name.</desc>
14932	</attribute>
14933	<attribute name="description" type="wstring" readonly="yes">
14934	<desc>The plug-in description.</desc>
14935	</attribute>
14936	<attribute name="frontend" type="wstring" readonly="yes">
14937	<desc>
14938	The name of the frontend or component name this plug-in plugs into.
14939	</desc>
14940	</attribute>
14941	<attribute name="modulePath" type="wstring" readonly="yes">
14942	<desc> The module path. </desc>
14943	</attribute>
14944	</interface>
14945
14946	<interface
14947	name="IExtPackBase" extends="$unknown"
14948	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
14949	wsmap="suppress"
14950	>
14951	<desc>
14952	Interface for querying information about an extension pack as well as
14953	accessing COM objects within it.
14954	</desc>
14955	<attribute name="name" type="wstring" readonly="yes">
14956	<desc>The extension pack name. This is unique.</desc>
14957	</attribute>
14958	<attribute name="description" type="wstring" readonly="yes">
14959	<desc>The extension pack description.</desc>
14960	</attribute>
14961	<attribute name="version" type="wstring" readonly="yes">
14962	<desc>
14963	The extension pack version string. This is on the same form as
14964	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14965	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14966	or "1.2.3_BETA1-r45678-OSE"
14967	</desc>
14968	</attribute>
14969	<attribute name="revision" type="unsigned long" readonly="yes">
14970	<desc>The extension pack internal revision number.</desc>
14971	</attribute>
14972	<attribute name="VRDEModule" type="wstring" readonly="yes">
14973	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14974	</attribute>
14975	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14976	<desc>Plug-ins provided by this extension pack.</desc>
14977	</attribute>
14978	<attribute name="usable" type="boolean" readonly="yes">
14979	<desc>
14980	Indicates whether the extension pack is usable or not.
14981
14982	There are a number of reasons why an extension pack might be unusable,
14983	typical examples would be broken installation/file or that it is
14984	incompatible with the current VirtualBox version.
14985	</desc>
14986	</attribute>
14987	<attribute name="whyUnusable" type="wstring" readonly="yes">
14988	<desc>
14989	String indicating why the extension pack is not usable. This is an
14990	empty string if usable and always a non-empty string if not usable.
14991	</desc>
14992	</attribute>
14993	<attribute name="showLicense" type="boolean" readonly="yes">
14994	<desc>Whether to show the license before installation</desc>
14995	</attribute>
14996	<attribute name="license" type="wstring" readonly="yes">
14997	<desc>
14998	The default HTML license text for the extension pack. Same as
14999	calling <link to="#queryLicense">queryLicense</link> with
15000	preferredLocale and preferredLanguage as empty strings and format set
15001	to html.
15002	</desc>
15003	</attribute>
15004
15005	<method name="queryLicense">
15006	<desc>
15007	Full feature version of the license attribute.
15008	</desc>
15009	<param name="preferredLocale" type="wstring" dir="in">
15010	<desc>
15011	The preferred license locale. Pass an empty string to get the default
15012	license.
15013	</desc>
15014	</param>
15015	<param name="preferredLanguage" type="wstring" dir="in">
15016	<desc>
15017	The preferred license language. Pass an empty string to get the
15018	default language for the locale.
15019	</desc>
15020	</param>
15021	<param name="format" type="wstring" dir="in">
15022	<desc>
15023	The license format: html, rtf or txt. If a license is present there
15024	will always be an HTML of it, the rich text format (RTF) and plain
15025	text (txt) versions are optional. If
15026	</desc>
15027	</param>
15028	<param name="licenseText" type="wstring" dir="return">
15029	<desc>The license text.</desc>
15030	</param>
15031	</method>
15032
15033	</interface>
15034
15035	<interface
15036	name="IExtPack" extends="IExtPackBase"
15037	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
15038	wsmap="suppress"
15039	>
15040	<desc>
15041	Interface for querying information about an extension pack as well as
15042	accessing COM objects within it.
15043	</desc>
15044	<method name="queryObject">
15045	<desc>
15046	Queries the IUnknown interface to an object in the extension pack
15047	main module. This allows plug-ins and others to talk directly to an
15048	extension pack.
15049	</desc>
15050	<param name="objUuid" type="wstring" dir="in">
15051	<desc>The object ID. What exactly this is </desc>
15052	</param>
15053	<param name="returnInterface" type="$unknown" dir="return">
15054	<desc>The queried interface.</desc>
15055	</param>
15056	</method>
15057	</interface>
15058
15059	<interface
15060	name="IExtPackFile" extends="IExtPackBase"
15061	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
15062	wsmap="suppress"
15063	>
15064	<desc>
15065	Extension pack file (aka tarball, .vbox-extpack) representation returned
15066	by IExtPackManager::openExtPackFile. This provides the base extension
15067	pack information with the addition of the file name. It also provides an
15068	alternative to IExtPackManager::install.
15069	</desc>
15070	<attribute name="filePath" type="wstring" readonly="yes">
15071	<desc>
15072	The path to the extension pack file.
15073	</desc>
15074	</attribute>
15075
15076	<method name="install">
15077	<desc>
15078	Install the extension pack.
15079	</desc>
15080	<param name="replace" type="boolean" dir="in">
15081	<desc>
15082	Set this to automatically uninstall any existing extension pack with
15083	the same name as the one being installed.
15084	</desc>
15085	</param>
15086	<param name="displayInfo" type="wstring" dir="in">
15087	<desc>
15088	Platform specific display information. Reserved for future hacks.
15089	</desc>
15090	</param>
15091	<param name="progess" type="IProgress" dir="return">
15092	<desc>
15093	Progress object for the operation.
15094	</desc>
15095	</param>
15096	</method>
15097	</interface>
15098
15099	<interface
15100	name="IExtPackManager" extends="$unknown"
15101	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
15102	wsmap="suppress"
15103	>
15104	<desc>
15105	Interface for managing VirtualBox Extension Packs.
15106
15107	TODO: Describe extension packs, how they are managed and how to create
15108	one.
15109	</desc>
15110
15111	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
15112	<desc>
15113	List of the installed extension packs.
15114	</desc>
15115	</attribute>
15116
15117	<method name="find">
15118	<desc>
15119	Returns the extension pack with the specified name if found.
15120
15121	<result name="VBOX_E_OBJECT_NOT_FOUND">
15122	No extension pack matching @a name was found.
15123	</result>
15124	</desc>
15125	<param name="name" type="wstring" dir="in">
15126	<desc>The name of the extension pack to locate.</desc>
15127	</param>
15128	<param name="returnData" type="IExtPack" dir="return">
15129	<desc>The extension pack if found.</desc>
15130	</param>
15131	</method>
15132
15133	<method name="openExtPackFile">
15134	<desc>
15135	Attempts to open an extension pack file in preparation for
15136	installation.
15137	</desc>
15138	<param name="path" type="wstring" dir="in">
15139	<desc>The path of the extension pack tarball.</desc>
15140	</param>
15141	<param name="file" type="IExtPackFile" dir="return">
15142	<desc>The interface of the extension pack file object.</desc>
15143	</param>
15144	</method>
15145
15146	<method name="uninstall">
15147	<desc>Uninstalls an extension pack, removing all related files.</desc>
15148	<param name="name" type="wstring" dir="in">
15149	<desc>The name of the extension pack to uninstall.</desc>
15150	</param>
15151	<param name="forcedRemoval" type="boolean" dir="in">
15152	<desc>
15153	Forced removal of the extension pack. This means that the uninstall
15154	hook will not be called.
15155	</desc>
15156	</param>
15157	<param name="displayInfo" type="wstring" dir="in">
15158	<desc>
15159	Platform specific display information. Reserved for future hacks.
15160	</desc>
15161	</param>
15162	<param name="progess" type="IProgress" dir="return">
15163	<desc>
15164	Progress object for the operation.
15165	</desc>
15166	</param>
15167	</method>
15168
15169	<method name="cleanup">
15170	<desc>Cleans up failed installs and uninstalls</desc>
15171	</method>
15172
15173	<method name="QueryAllPlugInsForFrontend">
15174	<desc>
15175	Gets the path to all the plug-in modules for a given frontend.
15176
15177	This is a convenience method that is intended to simplify the plug-in
15178	loading process for a frontend.
15179	</desc>
15180	<param name="frontendName" type="wstring" dir="in">
15181	<desc>The name of the frontend or component.</desc>
15182	</param>
15183	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15184	<desc>Array containing the plug-in modules (full paths).</desc>
15185	</param>
15186	</method>
15187
15188	<method name="IsExtPackUsable">
15189	<desc>Check if the given extension pack is loaded and usable.</desc>
15190	<param name="name" type="wstring" dir="in">
15191	<desc>The name of the extension pack to check for.</desc>
15192	</param>
15193	<param name="usable" type="boolean" dir="return">
15194	<desc>Is the given extension pack loaded and usable.</desc>
15195	</param>
15196	</method>
15197
15198	</interface>
15199
15200	<!--
15201	// BandwidthGroupType
15202	/////////////////////////////////////////////////////////////////////////
15203	-->
15204	<enum
15205	name="BandwidthGroupType"
15206	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15207
15208	<desc>
15209	Type of a bandwidth control group.
15210	</desc>
15211
15212	<const name="Null" value="0">
15213	<desc>
15214	Null type, must be first.
15215	</desc>
15216	</const>
15217
15218	<const name="Disk" value="1">
15219	<desc>
15220	The bandwidth group controls disk I/O.
15221	</desc>
15222	</const>
15223
15224	<const name="Network" value="2">
15225	<desc>
15226	The bandwidth group controls network I/O.
15227	</desc>
15228	</const>
15229
15230	</enum>
15231
15232	<!--
15233	// IBandwidthGroup
15234	/////////////////////////////////////////////////////////////////////////
15235	-->
15236	<interface
15237	name="IBandwidthGroup" extends="$unknown"
15238	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15239	wsmap="managed"
15240	>
15241	<desc>Represents one bandwidth group.</desc>
15242
15243	<attribute name="name" type="wstring" readonly="yes">
15244	<desc>Name of the group.</desc>
15245	</attribute>
15246
15247	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15248	<desc>Type of the group.</desc>
15249	</attribute>
15250
15251	<attribute name="reference" type="unsigned long" readonly="yes">
15252	<desc>How many devices/medium attachements use this group.</desc>
15253	</attribute>
15254
15255	<attribute name="maxMbPerSec" type="unsigned long">
15256	<desc>The maximum number of MBytes which can be transfered by all
15257	entities attached to this group during one second.</desc>
15258	</attribute>
15259
15260	</interface>
15261
15262	<!--
15263	// IBandwidthControl
15264	/////////////////////////////////////////////////////////////////////////
15265	-->
15266	<interface
15267	name="IBandwidthControl" extends="$unknown"
15268	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15269	wsmap="managed"
15270	>
15271	<desc>
15272	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15273	This includes network and disk I/O.
15274	</desc>
15275
15276	<attribute name="numGroups" type="unsigned long" readonly="yes">
15277	<desc>
15278	The current number of existing bandwidth groups managed.
15279	</desc>
15280	</attribute>
15281
15282	<method name="CreateBandwidthGroup">
15283	<desc>
15284	Creates a new bandwidth group.
15285	</desc>
15286
15287	<param name="name" type="wstring" dir="in">
15288	<desc>Name of the bandwidth group.</desc>
15289	</param>
15290	<param name="type" type="BandwidthGroupType" dir="in">
15291	<desc>The type of the bandwidth group (network or disk).</desc>
15292	</param>
15293	<param name="maxMbPerSec" type="unsigned long" dir="in">
15294	<desc>The maximum number of MBytes which can be transfered by all
15295	entities attached to this group during one second.</desc>
15296	</param>
15297	</method>
15298
15299	<method name="DeleteBandwidthGroup">
15300	<desc>
15301	Deletes a new bandwidth group.
15302	</desc>
15303
15304	<param name="name" type="wstring" dir="in">
15305	<desc>Name of the bandwidth group to delete.</desc>
15306	</param>
15307	</method>
15308
15309	<method name="GetBandwidthGroup" const="yes">
15310	<desc>
15311	Get a bandwidth group by name.
15312	</desc>
15313
15314	<param name="name" type="wstring" dir="in">
15315	<desc>Name of the bandwidth group to get.</desc>
15316	</param>
15317	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15318	<desc>Where to store the bandwidth group on success.</desc>
15319	</param>
15320	</method>
15321
15322	<method name="GetAllBandwidthGroups" const="yes">
15323	<desc>
15324	Get all managed bandwidth groups.
15325	</desc>
15326
15327	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15328	<desc>The array of managed bandwidth groups.</desc>
15329	</param>
15330	</method>
15331	</interface>
15332
15333	<!--
15334	// IVirtualBoxClient
15335	/////////////////////////////////////////////////////////////////////////
15336	-->
15337
15338	<interface
15339	name="IVirtualBoxClient" extends="$unknown"
15340	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15341	wsmap="suppress"
15342	>
15343	<desc>
15344	Convenience interface for client applications. Treat this as a
15345	singleton, i.e. never create more than one instance of this interface.
15346
15347	At the moment only available for clients of the local API (not usable
15348	via the webservice). Once the session logic is redesigned this might
15349	change.
15350	</desc>
15351
15352	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15353	<desc>
15354	Reference to the server-side API root object.
15355	</desc>
15356	</attribute>
15357
15358	<attribute name="session" type="ISession" readonly="yes">
15359	<desc>
15360	Create a new session object and return the reference to it.
15361	</desc>
15362	</attribute>
15363
15364	<attribute name="eventSource" type="IEventSource" readonly="yes">
15365	<desc>
15366	Event source for VirtualBoxClient events.
15367	</desc>
15368	</attribute>
15369
15370	</interface>
15371
15372	<!--
15373	// Events
15374	/////////////////////////////////////////////////////////////////////////
15375	-->
15376	<enum
15377	name="VBoxEventType"
15378	uuid="e71c487f-755e-46e9-a476-dd6a5d134597"
15379	>
15380
15381	<desc>
15382	Type of an event.
15383	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15384	</desc>
15385
15386	<const name="Invalid" value="0">
15387	<desc>
15388	Invalid event, must be first.
15389	</desc>
15390	</const>
15391
15392	<const name="Any" value="1">
15393	<desc>
15394	Wildcard for all events.
15395	Events of this type are never delivered, and only used in
15396	registerListener() call to simplify registration.
15397	</desc>
15398	</const>
15399
15400	<const name="Vetoable" value="2">
15401	<desc>
15402	Wildcard for all vetoable events. Events of this type are never delivered, and only
15403	used in registerListener() call to simplify registration.
15404	</desc>
15405	</const>
15406
15407	<const name="MachineEvent" value="3">
15408	<desc>
15409	Wildcard for all machine events. Events of this type are never delivered, and only used in
15410	registerListener() call to simplify registration.
15411	</desc>
15412	</const>
15413
15414	<const name="SnapshotEvent" value="4">
15415	<desc>
15416	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15417	registerListener() call to simplify registration.
15418	</desc>
15419	</const>
15420
15421	<const name="InputEvent" value="5">
15422	<desc>
15423	Wildcard for all input device (keyboard, mouse) events.
15424	Events of this type are never delivered, and only used in
15425	registerListener() call to simplify registration.
15426	</desc>
15427	</const>
15428
15429	<const name="LastWildcard" value="31">
15430	<desc>
15431	Last wildcard.
15432	</desc>
15433	</const>
15434
15435	<const name="OnMachineStateChanged" value="32">
15436	<desc>
15437	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15438	</desc>
15439	</const>
15440	<const name="OnMachineDataChanged" value="33">
15441	<desc>
15442	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15443	</desc>
15444	</const>
15445	<const name="OnExtraDataChanged" value="34">
15446	<desc>
15447	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15448	</desc>
15449	</const>
15450	<const name="OnExtraDataCanChange" value="35">
15451	<desc>
15452	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15453	</desc>
15454	</const>
15455	<const name="OnMediumRegistered" value="36">
15456	<desc>
15457	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15458	</desc>
15459	</const>
15460	<const name="OnMachineRegistered" value="37">
15461	<desc>
15462	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15463	</desc>
15464	</const>
15465	<const name="OnSessionStateChanged" value="38">
15466	<desc>
15467	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15468	</desc>
15469	</const>
15470	<const name="OnSnapshotTaken" value="39">
15471	<desc>
15472	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15473	</desc>
15474	</const>
15475	<const name="OnSnapshotDeleted" value="40">
15476	<desc>
15477	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15478	</desc>
15479	</const>
15480	<const name="OnSnapshotChanged" value="41">
15481	<desc>
15482	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15483	</desc>
15484	</const>
15485	<const name="OnGuestPropertyChanged" value="42">
15486	<desc>
15487	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15488	</desc>
15489	</const>
15490	<!-- Console events -->
15491	<const name="OnMousePointerShapeChanged" value="43">
15492	<desc>
15493	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15494	</desc>
15495	</const>
15496	<const name="OnMouseCapabilityChanged" value="44">
15497	<desc>
15498	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15499	</desc>
15500	</const>
15501	<const name="OnKeyboardLedsChanged" value="45">
15502	<desc>
15503	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15504	</desc>
15505	</const>
15506	<const name="OnStateChanged" value="46">
15507	<desc>
15508	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15509	</desc>
15510	</const>
15511	<const name="OnAdditionsStateChanged" value="47">
15512	<desc>
15513	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15514	</desc>
15515	</const>
15516	<const name="OnNetworkAdapterChanged" value="48">
15517	<desc>
15518	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15519	</desc>
15520	</const>
15521	<const name="OnSerialPortChanged" value="49">
15522	<desc>
15523	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15524	</desc>
15525	</const>
15526	<const name="OnParallelPortChanged" value="50">
15527	<desc>
15528	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15529	</desc>
15530	</const>
15531	<const name="OnStorageControllerChanged" value="51">
15532	<desc>
15533	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15534	</desc>
15535	</const>
15536	<const name="OnMediumChanged" value="52">
15537	<desc>
15538	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15539	</desc>
15540	</const>
15541	<const name="OnVRDEServerChanged" value="53">
15542	<desc>
15543	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15544	</desc>
15545	</const>
15546	<const name="OnUSBControllerChanged" value="54">
15547	<desc>
15548	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15549	</desc>
15550	</const>
15551	<const name="OnUSBDeviceStateChanged" value="55">
15552	<desc>
15553	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15554	</desc>
15555	</const>
15556	<const name="OnSharedFolderChanged" value="56">
15557	<desc>
15558	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15559	</desc>
15560	</const>
15561	<const name="OnRuntimeError" value="57">
15562	<desc>
15563	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15564	</desc>
15565	</const>
15566	<const name="OnCanShowWindow" value="58">
15567	<desc>
15568	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15569	</desc>
15570	</const>
15571	<const name="OnShowWindow" value="59">
15572	<desc>
15573	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15574	</desc>
15575	</const>
15576	<const name="OnCPUChanged" value="60">
15577	<desc>
15578	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15579	</desc>
15580	</const>
15581	<const name="OnVRDEServerInfoChanged" value="61">
15582	<desc>
15583	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15584	</desc>
15585	</const>
15586	<const name="OnEventSourceChanged" value="62">
15587	<desc>
15588	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15589	</desc>
15590	</const>
15591	<const name="OnCPUExecutionCapChanged" value="63">
15592	<desc>
15593	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15594	</desc>
15595	</const>
15596	<const name="OnGuestKeyboard" value="64">
15597	<desc>
15598	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15599	</desc>
15600	</const>
15601	<const name="OnGuestMouse" value="65">
15602	<desc>
15603	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15604	</desc>
15605	</const>
15606	<const name="OnNATRedirect" value="66">
15607	<desc>
15608	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15609	</desc>
15610	</const>
15611	<const name="OnHostPciDevicePlug" value="67">
15612	<desc>
15613	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15614	</desc>
15615	</const>
15616	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15617	<desc>
15618	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15619	</desc>
15620	</const>
15621	<const name="OnBandwidthGroupChanged" value="69">
15622	<desc>
15623	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15624	</desc>
15625	</const>
15626	<const name="OnGuestMonitorChanged" value="70">
15627	<desc>
15628	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15629	</desc>
15630	</const>
15631
15632	<!-- Last event marker -->
15633	<const name="Last" value="71">
15634	<desc>
15635	Must be last event, used for iterations and structures relying on numerical event values.
15636	</desc>
15637	</const>
15638
15639	</enum>
15640
15641	<interface
15642	name="IEventSource" extends="$unknown"
15643	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15644	wsmap="managed"
15645	>
15646	<desc>
15647	Event source. Generally, any object which could generate events can be an event source,
15648	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15649	an event source can work with listeners in either active or passive mode. In active mode it is up to
15650	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15651	event source keeps track of pending events for each listener and returns available events on demand.
15652
15653	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15654	</desc>
15655
15656	<method name="createListener">
15657	<desc>
15658	Creates a new listener object, useful for passive mode.
15659	</desc>
15660	<param name="listener" type="IEventListener" dir="return"/>
15661	</method>
15662
15663	<method name="createAggregator">
15664	<desc>
15665	Creates an aggregator event source, collecting events from multiple sources.
15666	This way a single listener can listen for events coming from multiple sources,
15667	using a single blocking getEvent() on the returned aggregator.
15668	</desc>
15669	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15670	<desc>
15671	Subordinate event source this one aggregatres.
15672	</desc>
15673	</param>
15674	<param name="result" type="IEventSource" dir="return">
15675	<desc>
15676	Event source aggregating passed sources.
15677	</desc>
15678	</param>
15679	</method>
15680
15681	<method name="registerListener">
15682	<desc>
15683	Register an event listener.
15684
15685	<note>
15686	To avoid system overload, the VirtualBox server process checks if passive event
15687	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15688	current implementation, if more than 500 pending events are detected for a passive
15689	event listener, it is forcefully unregistered by the system, and further
15690	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15691	</note>
15692	</desc>
15693	<param name="listener" type="IEventListener" dir="in">
15694	<desc>Listener to register.</desc>
15695	</param>
15696	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15697	<desc>
15698	Event types listener is interested in. One can use wildcards like -
15699	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15700	than one event.
15701	</desc>
15702	</param>
15703	<param name="active" type="boolean" dir="in">
15704	<desc>
15705	Which mode this listener is operating in.
15706	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15707	In passive mode, an internal event queue is created for this this IEventListener.
15708	For each event coming in, it is added to queues for all interested registered passive
15709	listeners. It is then up to the external code to call the listener's
15710	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15711	external code must call <link to="#eventProcessed" />.
15712	</desc>
15713	</param>
15714	</method>
15715
15716	<method name="unregisterListener">
15717	<desc>
15718	Unregister an event listener. If listener is passive, and some waitable events are still
15719	in queue they are marked as processed automatically.
15720	</desc>
15721	<param name="listener" type="IEventListener" dir="in">
15722	<desc>Listener to unregister.</desc>
15723	</param>
15724	</method>
15725
15726	<method name="fireEvent">
15727	<desc>
15728	Fire an event for this source.
15729	</desc>
15730	<param name="event" type="IEvent" dir="in">
15731	<desc>Event to deliver.</desc>
15732	</param>
15733	<param name="timeout" type="long" dir="in">
15734	<desc>
15735	Maximum time to wait for event processing (if event is waitable), in ms;
15736	0 = no wait, -1 = indefinite wait.
15737	</desc>
15738	</param>
15739	<param name="result" type="boolean" dir="return">
15740	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15741	</param>
15742	</method>
15743
15744	<method name="getEvent">
15745	<desc>
15746	Get events from this peer's event queue (for passive mode). Calling this method
15747	regularly is required for passive event listeners to avoid system overload;
15748	see <link to="IEventSource::registerListener" /> for details.
15749
15750	<result name="VBOX_E_OBJECT_NOT_FOUND">
15751	Listener is not registered, or autounregistered.
15752	</result>
15753	</desc>
15754	<param name="listener" type="IEventListener" dir="in">
15755	<desc>Which listener to get data for.</desc>
15756	</param>
15757	<param name="timeout" type="long" dir="in">
15758	<desc>
15759	Maximum time to wait for events, in ms;
15760	0 = no wait, -1 = indefinite wait.
15761	</desc>
15762	</param>
15763	<param name="event" type="IEvent" dir="return">
15764	<desc>Event retrieved, or null if none available.</desc>
15765	</param>
15766	</method>
15767
15768	<method name="eventProcessed">
15769	<desc>
15770	Must be called for waitable events after a particular listener finished its
15771	event processing. When all listeners of a particular event have called this
15772	method, the system will then call <link to="IEvent::setProcessed" />.
15773	</desc>
15774	<param name="listener" type="IEventListener" dir="in">
15775	<desc>Which listener processed event.</desc>
15776	</param>
15777	<param name="event" type="IEvent" dir="in">
15778	<desc>Which event.</desc>
15779	</param>
15780	</method>
15781
15782	</interface>
15783
15784	<interface
15785	name="IEventListener" extends="$unknown"
15786	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15787	wsmap="managed"
15788	>
15789	<desc>
15790	Event listener. An event listener can work in either active or passive mode, depending on the way
15791	it was registered.
15792	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15793	</desc>
15794
15795	<method name="handleEvent">
15796	<desc>
15797	Handle event callback for active listeners. It is not called for passive listeners. After
15798	calling handleEvent() on all active listeners and having received acknowledgement from all
15799	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15800	IEvent::waitProcessed() will return immediately.
15801	</desc>
15802	<param name="event" type="IEvent" dir="in">
15803	<desc>Event available.</desc>
15804	</param>
15805	</method>
15806
15807	</interface>
15808
15809	<interface
15810	name="IEvent" extends="$unknown"
15811	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15812	wsmap="managed"
15813	>
15814	<desc>
15815	Abstract parent interface for VirtualBox events. Actual events will typically implement
15816	a more specific interface which derives from this (see below).
15817
15818	<b>Introduction to VirtualBox events</b>
15819
15820	Generally speaking, an event (represented by this interface) signals that something
15821	happened, while an event listener (see <link to="IEventListener" />) represents an
15822	entity that is interested in certain events. In order for this to work with
15823	unidirectional protocols (i.e. web services), the concepts of passive and active
15824	listener are used.
15825
15826	Event consumers can register themselves as listeners, providing an array of
15827	events they are interested in (see <link to="IEventSource::registerListener" />).
15828	When an event triggers, the listener is notified about the event. The exact
15829	mechanism of the notification depends on whether the listener was registered as
15830	an active or passive listener:
15831
15832	<ul>
15833	<li>An active listener is very similar to a callback: it is a function invoked
15834	by the API. As opposed to the callbacks that were used in the API before
15835	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15836	</li>
15837
15838	<li>Passive listeners are somewhat trickier to implement, but do not require
15839	a client function to be callable, which is not an option with scripting
15840	languages or web service clients. Internally the <link to="IEventSource" />
15841	implementation maintains an event queue for each passive listener, and
15842	newly arrived events are put in this queue. When the listener calls
15843	<link to="IEventSource::getEvent"/>, first element from its internal event
15844	queue is returned. When the client completes processing of an event,
15845	the <link to="IEventSource::eventProcessed" /> function must be called,
15846	acknowledging that the event was processed. It supports implementing
15847	waitable events. On passive listener unregistration, all events from its
15848	queue are auto-acknowledged.
15849	</li>
15850	</ul>
15851
15852	Waitable events are useful in situations where the event generator wants to track
15853	delivery or a party wants to wait until all listeners have completed the event. A
15854	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15855	listeners might veto a certain action, and thus the event producer has to make
15856	sure that all listeners have processed the event and not vetoed before taking
15857	the action.
15858
15859	A given event may have both passive and active listeners at the same time.
15860
15861	<b>Using events</b>
15862
15863	Any VirtualBox object capable of producing externally visible events provides an
15864	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15865	This event source object is notified by VirtualBox once something has happened, so
15866	consumers may register event listeners with this event source. To register a listener,
15867	an object implementing the <link to="IEventListener" /> interface must be provided.
15868	For active listeners, such an object is typically created by the consumer, while for
15869	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15870	note that a listener created with @c createListener() must not be used as an active listener.
15871
15872	Once created, the listener must be registered to listen for the desired events
15873	(see <link to="IEventSource::registerListener" />), providing an array of
15874	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15875	event IDs or wildcards matching multiple event IDs.
15876
15877	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15878	called automatically when the event is triggered, while passive listeners have to call
15879	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15880	an event processing loop.
15881
15882	The IEvent interface is an abstract parent interface for all such VirtualBox events
15883	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15884	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15885	then cast to the appropriate specific interface using @c QueryInterface().
15886	</desc>
15887
15888	<attribute name="type" readonly="yes" type="VBoxEventType">
15889	<desc>
15890	Event type.
15891	</desc>
15892	</attribute>
15893
15894	<attribute name="source" readonly="yes" type="IEventSource">
15895	<desc>
15896	Source of this event.
15897	</desc>
15898	</attribute>
15899
15900	<attribute name="waitable" readonly="yes" type="boolean">
15901	<desc>
15902	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15903	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15904	as no additional overhead associated with waitability imposed.
15905	Waitable events are needed when one need to be able to wait for particular event processed,
15906	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15907	until all consumers confirmed events.
15908	</desc>
15909	</attribute>
15910
15911	<method name="setProcessed">
15912	<desc>
15913	Internal method called by the system when all listeners of a particular event have called
15914	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15915	</desc>
15916	</method>
15917
15918	<method name="waitProcessed">
15919	<desc>
15920	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15921	described semantics, for non-waitable returns true immediately.
15922	</desc>
15923	<param name="timeout" type="long" dir="in">
15924	<desc>
15925	Maximum time to wait for event processeing, in ms;
15926	0 = no wait, -1 = indefinite wait.
15927	</desc>
15928	</param>
15929	<param name="result" type="boolean" dir="return">
15930	<desc>If this event was processed before timeout.</desc>
15931	</param>
15932	</method>
15933	</interface>
15934
15935
15936	<interface
15937	name="IReusableEvent" extends="IEvent"
15938	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15939	wsmap="managed"
15940	>
15941	<desc>Base abstract interface for all reusable events.</desc>
15942
15943	<attribute name="generation" readonly="yes" type="unsigned long">
15944	<desc>Current generation of event, incremented on reuse.</desc>
15945	</attribute>
15946
15947	<method name="reuse">
15948	<desc>
15949	Marks an event as reused, increments 'generation', fields shall no
15950	longer be considered valid.
15951	</desc>
15952	</method>
15953	</interface>
15954
15955	<interface
15956	name="IMachineEvent" extends="IEvent"
15957	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15958	wsmap="managed" id="MachineEvent"
15959	>
15960	<desc>Base abstract interface for all machine events.</desc>
15961
15962	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15963	<desc>ID of the machine this event relates to.</desc>
15964	</attribute>
15965
15966	</interface>
15967
15968	<interface
15969	name="IMachineStateChangedEvent" extends="IMachineEvent"
15970	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15971	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15972	>
15973	<desc>Machine state change event.</desc>
15974
15975	<attribute name="state" readonly="yes" type="MachineState">
15976	<desc>New execution state.</desc>
15977	</attribute>
15978	</interface>
15979
15980	<interface
15981	name="IMachineDataChangedEvent" extends="IMachineEvent"
15982	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15983	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15984	>
15985	<desc>
15986	Any of the settings of the given machine has changed.
15987	</desc>
15988	</interface>
15989
15990	<interface
15991	name="IMediumRegisteredEvent" extends="IEvent"
15992	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15993	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15994	>
15995	<desc>
15996	The given medium was registered or unregistered
15997	within this VirtualBox installation.
15998	</desc>
15999
16000	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
16001	<desc>ID of the medium this event relates to.</desc>
16002	</attribute>
16003
16004	<attribute name="mediumType" readonly="yes" type="DeviceType">
16005	<desc>Type of the medium this event relates to.</desc>
16006	</attribute>
16007
16008	<attribute name="registered" type="boolean" readonly="yes">
16009	<desc>
16010	If @c true, the medium was registered, otherwise it was
16011	unregistered.
16012	</desc>
16013	</attribute>
16014	</interface>
16015
16016	<interface
16017	name="IMachineRegisteredEvent" extends="IMachineEvent"
16018	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
16019	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
16020	>
16021	<desc>
16022	The given machine was registered or unregistered
16023	within this VirtualBox installation.
16024	</desc>
16025
16026	<attribute name="registered" type="boolean" readonly="yes">
16027	<desc>
16028	If @c true, the machine was registered, otherwise it was
16029	unregistered.
16030	</desc>
16031	</attribute>
16032	</interface>
16033
16034	<interface
16035	name="ISessionStateChangedEvent" extends="IMachineEvent"
16036	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
16037	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
16038	>
16039	<desc>
16040	The state of the session for the given machine was changed.
16041	<see>IMachine::sessionState</see>
16042	</desc>
16043
16044	<attribute name="state" type="SessionState" readonly="yes">
16045	<desc>
16046	New session state.
16047	</desc>
16048	</attribute>
16049	</interface>
16050
16051	<interface
16052	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
16053	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
16054	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
16055	>
16056	<desc>
16057	Notification when a guest property has changed.
16058	</desc>
16059
16060	<attribute name="name" readonly="yes" type="wstring">
16061	<desc>
16062	The name of the property that has changed.
16063	</desc>
16064	</attribute>
16065
16066	<attribute name="value" readonly="yes" type="wstring">
16067	<desc>
16068	The new property value.
16069	</desc>
16070	</attribute>
16071
16072	<attribute name="flags" readonly="yes" type="wstring">
16073	<desc>
16074	The new property flags.
16075	</desc>
16076	</attribute>
16077
16078	</interface>
16079
16080	<interface
16081	name="ISnapshotEvent" extends="IMachineEvent"
16082	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
16083	wsmap="managed" id="SnapshotEvent"
16084	>
16085	<desc>Base interface for all snapshot events.</desc>
16086
16087	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
16088	<desc>ID of the snapshot this event relates to.</desc>
16089	</attribute>
16090
16091	</interface>
16092
16093	<interface
16094	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
16095	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
16096	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
16097	>
16098	<desc>
16099	A new snapshot of the machine has been taken.
16100	<see>ISnapshot</see>
16101	</desc>
16102	</interface>
16103
16104	<interface
16105	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
16106	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
16107	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
16108	>
16109	<desc>
16110	Snapshot of the given machine has been deleted.
16111
16112	<note>
16113	This notification is delivered <b>after</b> the snapshot
16114	object has been uninitialized on the server (so that any
16115	attempt to call its methods will return an error).
16116	</note>
16117
16118	<see>ISnapshot</see>
16119	</desc>
16120	</interface>
16121
16122	<interface
16123	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16124	uuid="07541941-8079-447a-a33e-47a69c7980db"
16125	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16126	>
16127	<desc>
16128	Snapshot properties (name and/or description) have been changed.
16129	<see>ISnapshot</see>
16130	</desc>
16131	</interface>
16132
16133	<interface
16134	name="IMousePointerShapeChangedEvent" extends="IEvent"
16135	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16136	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16137	>
16138	<desc>
16139	Notification when the guest mouse pointer shape has
16140	changed. The new shape data is given.
16141	</desc>
16142
16143	<attribute name="visible" type="boolean" readonly="yes">
16144	<desc>
16145	Flag whether the pointer is visible.
16146	</desc>
16147	</attribute>
16148	<attribute name="alpha" type="boolean" readonly="yes">
16149	<desc>
16150	Flag whether the pointer has an alpha channel.
16151	</desc>
16152	</attribute>
16153	<attribute name="xhot" type="unsigned long" readonly="yes">
16154	<desc>
16155	The pointer hot spot X coordinate.
16156	</desc>
16157	</attribute>
16158	<attribute name="yhot" type="unsigned long" readonly="yes">
16159	<desc>
16160	The pointer hot spot Y coordinate.
16161	</desc>
16162	</attribute>
16163	<attribute name="width" type="unsigned long" readonly="yes">
16164	<desc>
16165	Width of the pointer shape in pixels.
16166	</desc>
16167	</attribute>
16168	<attribute name="height" type="unsigned long" readonly="yes">
16169	<desc>
16170	Height of the pointer shape in pixels.
16171	</desc>
16172	</attribute>
16173	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16174	<desc>
16175	Shape buffer arrays.
16176
16177	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16178	followed by a 32-bpp XOR (color) mask.
16179
16180	For pointers without alpha channel the XOR mask pixels are 32
16181	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16182	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16183
16184	An AND mask is used for pointers with alpha channel, so if the
16185	callback does not support alpha, the pointer could be
16186	displayed as a normal color pointer.
16187
16188	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16189	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16190	height</tt>. The padding bits at the end of each scanline are
16191	undefined.
16192
16193	The XOR mask follows the AND mask on the next 4-byte aligned
16194	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16195	Bytes in the gap between the AND and the XOR mask are undefined.
16196	The XOR mask scanlines have no gap between them and the size of
16197	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16198
16199	<note>
16200	If @a shape is 0, only the pointer visibility is changed.
16201	</note>
16202	</desc>
16203	</attribute>
16204	</interface>
16205
16206	<interface
16207	name="IMouseCapabilityChangedEvent" extends="IEvent"
16208	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
16209	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
16210	>
16211	<desc>
16212	Notification when the mouse capabilities reported by the
16213	guest have changed. The new capabilities are passed.
16214	</desc>
16215	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16216	<desc>
16217	Supports absolute coordinates.
16218	</desc>
16219	</attribute>
16220	<attribute name="supportsRelative" type="boolean" readonly="yes">
16221	<desc>
16222	Supports relative coordinates.
16223	</desc>
16224	</attribute>
16225	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16226	<desc>
16227	If host cursor is needed.
16228	</desc>
16229	</attribute>
16230	</interface>
16231
16232	<interface
16233	name="IKeyboardLedsChangedEvent" extends="IEvent"
16234	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16235	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16236	>
16237	<desc>
16238	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16239	to alter the state of the keyboard LEDs.
16240	</desc>
16241	<attribute name="numLock" type="boolean" readonly="yes">
16242	<desc>
16243	NumLock status.
16244	</desc>
16245	</attribute>
16246	<attribute name="capsLock" type="boolean" readonly="yes">
16247	<desc>
16248	CapsLock status.
16249	</desc>
16250	</attribute>
16251	<attribute name="scrollLock" type="boolean" readonly="yes">
16252	<desc>
16253	ScrollLock status.
16254	</desc>
16255	</attribute>
16256	</interface>
16257
16258	<interface
16259	name="IStateChangedEvent" extends="IEvent"
16260	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16261	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16262	>
16263	<desc>
16264	Notification when the execution state of the machine has changed.
16265	The new state is given.
16266	</desc>
16267	<attribute name="state" type="MachineState" readonly="yes">
16268	<desc>
16269	New machine state.
16270	</desc>
16271	</attribute>
16272	</interface>
16273
16274	<interface
16275	name="IAdditionsStateChangedEvent" extends="IEvent"
16276	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16277	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16278	>
16279	<desc>
16280	Notification when a Guest Additions property changes.
16281	Interested callees should query IGuest attributes to
16282	find out what has changed.
16283	</desc>
16284	</interface>
16285
16286	<interface
16287	name="INetworkAdapterChangedEvent" extends="IEvent"
16288	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16289	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16290	>
16291	<desc>
16292	Notification when a property of one of the
16293	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16294	changes. Interested callees should use INetworkAdapter methods and
16295	attributes to find out what has changed.
16296	</desc>
16297	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16298	<desc>
16299	Network adapter that is subject to change.
16300	</desc>
16301	</attribute>
16302	</interface>
16303
16304	<interface
16305	name="ISerialPortChangedEvent" extends="IEvent"
16306	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16307	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16308	>
16309	<desc>
16310	Notification when a property of one of the
16311	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16312	Interested callees should use ISerialPort methods and attributes
16313	to find out what has changed.
16314	</desc>
16315	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16316	<desc>
16317	Serial port that is subject to change.
16318	</desc>
16319	</attribute>
16320	</interface>
16321
16322	<interface
16323	name="IParallelPortChangedEvent" extends="IEvent"
16324	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16325	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16326	>
16327	<desc>
16328	Notification when a property of one of the
16329	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16330	changes. Interested callees should use ISerialPort methods and
16331	attributes to find out what has changed.
16332	</desc>
16333	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16334	<desc>
16335	Parallel port that is subject to change.
16336	</desc>
16337	</attribute>
16338	</interface>
16339
16340	<interface
16341	name="IStorageControllerChangedEvent" extends="IEvent"
16342	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16343	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16344	>
16345	<desc>
16346	Notification when a
16347	<link to="IMachine::mediumAttachments">medium attachment</link>
16348	changes.
16349	</desc>
16350	</interface>
16351
16352	<interface
16353	name="IMediumChangedEvent" extends="IEvent"
16354	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16355	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16356	>
16357	<desc>
16358	Notification when a
16359	<link to="IMachine::mediumAttachments">medium attachment</link>
16360	changes.
16361	</desc>
16362	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16363	<desc>
16364	Medium attachment that is subject to change.
16365	</desc>
16366	</attribute>
16367	</interface>
16368
16369	<interface
16370	name="ICPUChangedEvent" extends="IEvent"
16371	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16372	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16373	>
16374	<desc>
16375	Notification when a CPU changes.
16376	</desc>
16377	<attribute name="cpu" type="unsigned long" readonly="yes">
16378	<desc>
16379	The CPU which changed.
16380	</desc>
16381	</attribute>
16382	<attribute name="add" type="boolean" readonly="yes">
16383	<desc>
16384	Flag whether the CPU was added or removed.
16385	</desc>
16386	</attribute>
16387	</interface>
16388
16389	<interface
16390	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16391	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16392	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16393	>
16394	<desc>
16395	Notification when the CPU execution cap changes.
16396	</desc>
16397	<attribute name="executionCap" type="unsigned long" readonly="yes">
16398	<desc>
16399	The new CPU execution cap value. (1-100)
16400	</desc>
16401	</attribute>
16402	</interface>
16403
16404	<interface
16405	name="IGuestKeyboardEvent" extends="IEvent"
16406	uuid="88394258-7006-40d4-b339-472ee3801844"
16407	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16408	>
16409	<desc>
16410	Notification when guest keyboard event happens.
16411	</desc>
16412	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16413	<desc>
16414	Array of scancodes.
16415	</desc>
16416	</attribute>
16417	</interface>
16418
16419	<interface
16420	name="IGuestMouseEvent" extends="IReusableEvent"
16421	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16422	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16423	>
16424	<desc>
16425	Notification when guest mouse event happens.
16426	</desc>
16427
16428	<attribute name="absolute" type="boolean" readonly="yes">
16429	<desc>
16430	If this event is relative or absolute.
16431	</desc>
16432	</attribute>
16433
16434	<attribute name="x" type="long" readonly="yes">
16435	<desc>
16436	New X position, or X delta.
16437	</desc>
16438	</attribute>
16439
16440	<attribute name="y" type="long" readonly="yes">
16441	<desc>
16442	New Y position, or Y delta.
16443	</desc>
16444	</attribute>
16445
16446	<attribute name="z" type="long" readonly="yes">
16447	<desc>
16448	Z delta.
16449	</desc>
16450	</attribute>
16451
16452	<attribute name="w" type="long" readonly="yes">
16453	<desc>
16454	W delta.
16455	</desc>
16456	</attribute>
16457
16458	<attribute name="buttons" type="long" readonly="yes">
16459	<desc>
16460	Button state bitmask.
16461	</desc>
16462	</attribute>
16463
16464	</interface>
16465
16466
16467	<interface
16468	name="IVRDEServerChangedEvent" extends="IEvent"
16469	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16470	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16471	>
16472	<desc>
16473	Notification when a property of the
16474	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16475	Interested callees should use IVRDEServer methods and attributes to
16476	find out what has changed.
16477	</desc>
16478	</interface>
16479
16480	<interface
16481	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16482	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16483	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16484	>
16485	<desc>
16486	Notification when the status of the VRDE server changes. Interested callees
16487	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16488	attributes to find out what is the current status.
16489	</desc>
16490	</interface>
16491
16492	<interface
16493	name="IUSBControllerChangedEvent" extends="IEvent"
16494	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16495	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16496	>
16497	<desc>
16498	Notification when a property of the virtual
16499	<link to="IMachine::USBController">USB controller</link> changes.
16500	Interested callees should use IUSBController methods and attributes to
16501	find out what has changed.
16502	</desc>
16503	</interface>
16504
16505	<interface
16506	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16507	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16508	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16509	>
16510	<desc>
16511	Notification when a USB device is attached to or detached from
16512	the virtual USB controller.
16513
16514	This notification is sent as a result of the indirect
16515	request to attach the device because it matches one of the
16516	machine USB filters, or as a result of the direct request
16517	issued by <link to="IConsole::attachUSBDevice"/> or
16518	<link to="IConsole::detachUSBDevice"/>.
16519
16520	This notification is sent in case of both a succeeded and a
16521	failed request completion. When the request succeeds, the
16522	@a error parameter is @c null, and the given device has been
16523	already added to (when @a attached is @c true) or removed from
16524	(when @a attached is @c false) the collection represented by
16525	<link to="IConsole::USBDevices"/>. On failure, the collection
16526	doesn't change and the @a error parameter represents the error
16527	message describing the failure.
16528	</desc>
16529	<attribute name="device" type="IUSBDevice" readonly="yes">
16530	<desc>
16531	Device that is subject to state change.
16532	</desc>
16533	</attribute>
16534	<attribute name="attached" type="boolean" readonly="yes">
16535	<desc>
16536	@c true if the device was attached and @c false otherwise.
16537	</desc>
16538	</attribute>
16539	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16540	<desc>
16541	@c null on success or an error message object on failure.
16542	</desc>
16543	</attribute>
16544	</interface>
16545
16546	<interface
16547	name="ISharedFolderChangedEvent" extends="IEvent"
16548	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16549	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16550	>
16551	<desc>
16552	Notification when a shared folder is added or removed.
16553	The @a scope argument defines one of three scopes:
16554	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16555	(<link to="Scope_Global">Global</link>),
16556	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16557	the machine (<link to="Scope_Machine">Machine</link>) or <link
16558	to="IConsole::sharedFolders">transient shared folders</link> of the
16559	machine (<link to="Scope_Session">Session</link>). Interested callees
16560	should use query the corresponding collections to find out what has
16561	changed.
16562	</desc>
16563	<attribute name="scope" type="Scope" readonly="yes">
16564	<desc>
16565	Scope of the notification.
16566	</desc>
16567	</attribute>
16568	</interface>
16569
16570	<interface
16571	name="IRuntimeErrorEvent" extends="IEvent"
16572	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16573	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16574	>
16575	<desc>
16576	Notification when an error happens during the virtual
16577	machine execution.
16578
16579	There are three kinds of runtime errors:
16580	<ul>
16581	<li><i>fatal</i></li>
16582	<li><i>non-fatal with retry</i></li>
16583	<li><i>non-fatal warnings</i></li>
16584	</ul>
16585
16586	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16587	to @c true. In case of fatal errors, the virtual machine
16588	execution is always paused before calling this notification, and
16589	the notification handler is supposed either to immediately save
16590	the virtual machine state using <link to="IConsole::saveState"/>
16591	or power it off using <link to="IConsole::powerDown"/>.
16592	Resuming the execution can lead to unpredictable results.
16593
16594	<b>Non-fatal</b> errors and warnings are indicated by the
16595	@a fatal parameter set to @c false. If the virtual machine
16596	is in the Paused state by the time the error notification is
16597	received, it means that the user can <i>try to resume</i> the machine
16598	execution after attempting to solve the problem that caused the
16599	error. In this case, the notification handler is supposed
16600	to show an appropriate message to the user (depending on the
16601	value of the @a id parameter) that offers several actions such
16602	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16603	wants to retry, the notification handler should continue
16604	the machine execution using the <link to="IConsole::resume"/>
16605	call. If the machine execution is not Paused during this
16606	notification, then it means this notification is a <i>warning</i>
16607	(for example, about a fatal condition that can happen very soon);
16608	no immediate action is required from the user, the machine
16609	continues its normal execution.
16610
16611	Note that in either case the notification handler
16612	<b>must not</b> perform any action directly on a thread
16613	where this notification is called. Everything it is allowed to
16614	do is to post a message to another thread that will then talk
16615	to the user and take the corresponding action.
16616
16617	Currently, the following error identifiers are known:
16618	<ul>
16619	<li><tt>"HostMemoryLow"</tt></li>
16620	<li><tt>"HostAudioNotResponding"</tt></li>
16621	<li><tt>"VDIStorageFull"</tt></li>
16622	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16623	</ul>
16624	</desc>
16625	<attribute name="fatal" type="boolean" readonly="yes">
16626	<desc>
16627	Whether the error is fatal or not.
16628	</desc>
16629	</attribute>
16630	<attribute name="id" type="wstring" readonly="yes">
16631	<desc>
16632	Error identifier.
16633	</desc>
16634	</attribute>
16635	<attribute name="message" type="wstring" readonly="yes">
16636	<desc>
16637	Optional error message.
16638	</desc>
16639	</attribute>
16640	</interface>
16641
16642
16643	<interface
16644	name="IEventSourceChangedEvent" extends="IEvent"
16645	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16646	waitable="yes"
16647	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16648	>
16649	<desc>
16650	Notification when an event source state changes (listener added or removed).
16651	</desc>
16652
16653	<attribute name="listener" type="IEventListener" readonly="yes">
16654	<desc>
16655	Event listener which has changed.
16656	</desc>
16657	</attribute>
16658
16659	<attribute name="add" type="boolean" readonly="yes">
16660	<desc>
16661	Flag whether listener was added or removed.
16662	</desc>
16663	</attribute>
16664	</interface>
16665
16666	<interface
16667	name="IExtraDataChangedEvent" extends="IEvent"
16668	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16669	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16670	>
16671	<desc>
16672	Notification when machine specific or global extra data
16673	has changed.
16674	</desc>
16675	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16676	<desc>
16677	ID of the machine this event relates to.
16678	Null for global extra data changes.
16679	</desc>
16680	</attribute>
16681	<attribute name="key" type="wstring" readonly="yes">
16682	<desc>
16683	Extra data key that has changed.
16684	</desc>
16685	</attribute>
16686	<attribute name="value" type="wstring" readonly="yes">
16687	<desc>
16688	Extra data value for the given key.
16689	</desc>
16690	</attribute>
16691	</interface>
16692
16693	<interface
16694	name="IVetoEvent" extends="IEvent"
16695	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16696	wsmap="managed"
16697	>
16698	<desc>Base abstract interface for veto events.</desc>
16699
16700	<method name="addVeto">
16701	<desc>
16702	Adds a veto on this event.
16703	</desc>
16704	<param name="reason" type="wstring" dir="in">
16705	<desc>
16706	Reason for veto, could be null or empty string.
16707	</desc>
16708	</param>
16709	</method>
16710
16711	<method name="isVetoed">
16712	<desc>
16713	If this event was vetoed.
16714	</desc>
16715	<param name="result" type="boolean" dir="return">
16716	<desc>
16717	Reason for veto.
16718	</desc>
16719	</param>
16720	</method>
16721
16722	<method name="getVetos">
16723	<desc>
16724	Current veto reason list, if size is 0 - no veto.
16725	</desc>
16726	<param name="result" type="wstring" dir="return" safearray="yes">
16727	<desc>
16728	Array of reasons for veto provided by different event handlers.
16729	</desc>
16730	</param>
16731	</method>
16732
16733	</interface>
16734
16735	<interface
16736	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16737	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16738	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16739	waitable="true"
16740	>
16741	<desc>
16742	Notification when someone tries to change extra data for
16743	either the given machine or (if @c null) global extra data.
16744	This gives the chance to veto against changes.
16745	</desc>
16746	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16747	<desc>
16748	ID of the machine this event relates to.
16749	Null for global extra data changes.
16750	</desc>
16751	</attribute>
16752	<attribute name="key" type="wstring" readonly="yes">
16753	<desc>
16754	Extra data key that has changed.
16755	</desc>
16756	</attribute>
16757	<attribute name="value" type="wstring" readonly="yes">
16758	<desc>
16759	Extra data value for the given key.
16760	</desc>
16761	</attribute>
16762	</interface>
16763
16764	<interface
16765	name="ICanShowWindowEvent" extends="IVetoEvent"
16766	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16767	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16768	waitable="true"
16769	>
16770	<desc>
16771	Notification when a call to
16772	<link to="IMachine::canShowConsoleWindow"/> is made by a
16773	front-end to check if a subsequent call to
16774	<link to="IMachine::showConsoleWindow"/> can succeed.
16775
16776	The callee should give an answer appropriate to the current
16777	machine state using event veto. This answer must
16778	remain valid at least until the next
16779	<link to="IConsole::state">machine state</link> change.
16780	</desc>
16781	</interface>
16782
16783	<interface
16784	name="IShowWindowEvent" extends="IEvent"
16785	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16786	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16787	waitable="true"
16788	>
16789	<desc>
16790	Notification when a call to
16791	<link to="IMachine::showConsoleWindow"/>
16792	requests the console window to be activated and brought to
16793	foreground on the desktop of the host PC.
16794
16795	This notification should cause the VM console process to
16796	perform the requested action as described above. If it is
16797	impossible to do it at a time of this notification, this
16798	method should return a failure.
16799
16800	Note that many modern window managers on many platforms
16801	implement some sort of focus stealing prevention logic, so
16802	that it may be impossible to activate a window without the
16803	help of the currently active application (which is supposedly
16804	an initiator of this notification). In this case, this method
16805	must return a non-zero identifier that represents the
16806	top-level window of the VM console process. The caller, if it
16807	represents a currently active process, is responsible to use
16808	this identifier (in a platform-dependent manner) to perform
16809	actual window activation.
16810
16811	This method must set @a winId to zero if it has performed all
16812	actions necessary to complete the request and the console
16813	window is now active and in foreground, to indicate that no
16814	further action is required on the caller's side.
16815	</desc>
16816	<attribute name="winId" type="long long">
16817	<desc>
16818	Platform-dependent identifier of the top-level VM console
16819	window, or zero if this method has performed all actions
16820	necessary to implement the <i>show window</i> semantics for
16821	the given platform and/or this VirtualBox front-end.
16822	</desc>
16823	</attribute>
16824	</interface>
16825
16826	<interface
16827	name="INATRedirectEvent" extends="IMachineEvent"
16828	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16829	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16830	>
16831	<desc>
16832	Notification when NAT redirect rule added or removed.
16833	</desc>
16834	<attribute name="slot" type="unsigned long" readonly="yes">
16835	<desc>
16836	Adapter which NAT attached to.
16837	</desc>
16838	</attribute>
16839	<attribute name="remove" type="boolean" readonly="yes">
16840	<desc>
16841	Whether rule remove or add.
16842	</desc>
16843	</attribute>
16844	<attribute name="name" type="wstring" readonly="yes">
16845	<desc>
16846	Name of the rule.
16847	</desc>
16848	</attribute>
16849	<attribute name="proto" type="NATProtocol" readonly="yes">
16850	<desc>
16851	Protocol (TCP or UDP) of the redirect rule.
16852	</desc>
16853	</attribute>
16854	<attribute name="hostIp" type="wstring" readonly="yes">
16855	<desc>
16856	Host ip address to bind socket on.
16857	</desc>
16858	</attribute>
16859	<attribute name="hostPort" type="long" readonly="yes">
16860	<desc>
16861	Host port to bind socket on.
16862	</desc>
16863	</attribute>
16864	<attribute name="guestIp" type="wstring" readonly="yes">
16865	<desc>
16866	Guest ip address to redirect to.
16867	</desc>
16868	</attribute>
16869	<attribute name="guestPort" type="long" readonly="yes">
16870	<desc>
16871	Guest port to redirect to.
16872	</desc>
16873	</attribute>
16874	</interface>
16875
16876	<interface
16877	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16878	waitable="yes"
16879	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
16880	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16881	>
16882	<desc>
16883	Notification when host PCI device is plugged/unplugged. Plugging
16884	usually takes place on VM startup, unplug - when
16885	IMachine::DetachHostPciDevice is called.
16886
16887	<see>IMachine::DetachHostPciDevice</see>
16888
16889	</desc>
16890
16891	<attribute name="plugged" type="boolean" readonly="yes">
16892	<desc>
16893	If device successfully plugged or unplugged.
16894	</desc>
16895	</attribute>
16896
16897	<attribute name="success" type="boolean" readonly="yes">
16898	<desc>
16899	If operation was successful, if false - 'message' attribute
16900	may be of interest.
16901	</desc>
16902	</attribute>
16903
16904	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16905	<desc>
16906	Attachment info for this device.
16907	</desc>
16908	</attribute>
16909
16910	<attribute name="message" type="wstring" readonly="yes">
16911	<desc>
16912	Optional error message.
16913	</desc>
16914	</attribute>
16915
16916	</interface>
16917
16918	<interface
16919	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
16920	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
16921	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
16922	>
16923	<desc>
16924	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16925	unexpected circumstances) or available again.
16926	</desc>
16927
16928	<attribute name="available" type="boolean" readonly="yes">
16929	<desc>
16930	Whether VBoxSVC is available now.
16931	</desc>
16932	</attribute>
16933	</interface>
16934
16935	<interface
16936	name="IBandwidthGroupChangedEvent" extends="IEvent"
16937	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16938	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16939	>
16940	<desc>
16941	Notification when one of the bandwidth groups changed
16942	</desc>
16943	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16944	<desc>
16945	The changed bandwidth group.
16946	</desc>
16947	</attribute>
16948	</interface>
16949
16950	<enum
16951	name="GuestMonitorChangedEventType"
16952	uuid="ef172985-7e36-4297-95be-e46396968d66"
16953	>
16954
16955	<desc>
16956	How the guest monitor has been changed.
16957	</desc>
16958
16959	<const name="Enabled" value="0">
16960	<desc>
16961	The guest monitor has been enabled by the guest.
16962	</desc>
16963	</const>
16964
16965	<const name="Disabled" value="1">
16966	<desc>
16967	The guest monitor has been disabled by the guest.
16968	</desc>
16969	</const>
16970
16971	<const name="NewOrigin" value="2">
16972	<desc>
16973	The guest monitor origin has changed in the guest.
16974	</desc>
16975	</const>
16976	</enum>
16977
16978	<interface
16979	name="IGuestMonitorChangedEvent" extends="IEvent"
16980	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
16981	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
16982	>
16983	<desc>
16984	Notification when the guest enables one of its monitors.
16985	</desc>
16986
16987	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
16988	<desc>
16989	What was changed for this guest monitor.
16990	</desc>
16991	</attribute>
16992
16993	<attribute name="screenId" type="unsigned long" readonly="yes">
16994	<desc>
16995	The monitor which was changed.
16996	</desc>
16997	</attribute>
16998
16999	<attribute name="originX" type="unsigned long" readonly="yes">
17000	<desc>
17001	Physical X origin relative to the primary screen.
17002	Valid for Enabled and NewOrigin.
17003	</desc>
17004	</attribute>
17005
17006	<attribute name="originY" type="unsigned long" readonly="yes">
17007	<desc>
17008	Physical Y origin relative to the primary screen.
17009	Valid for Enabled and NewOrigin.
17010	</desc>
17011	</attribute>
17012
17013	<attribute name="width" type="unsigned long" readonly="yes">
17014	<desc>
17015	Width of the screen.
17016	Valid for Enabled.
17017	</desc>
17018	</attribute>
17019
17020	<attribute name="height" type="unsigned long" readonly="yes">
17021	<desc>
17022	Height of the screen.
17023	Valid for Enabled.
17024	</desc>
17025	</attribute>
17026
17027	</interface>
17028
17029	<module name="VBoxSVC" context="LocalServer">
17030	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
17031	namespace="virtualbox.org">
17032	<interface name="IVirtualBox" default="yes"/>
17033	</class>
17034	</module>
17035
17036	<module name="VBoxC" context="InprocServer" threadingModel="Free">
17037	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
17038	namespace="virtualbox.org">
17039	<interface name="IVirtualBoxClient" default="yes"/>
17040	</class>
17041
17042	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
17043	namespace="virtualbox.org">
17044	<interface name="ISession" default="yes"/>
17045	</class>
17046	</module>
17047
17048	</library>
17049
17050	</idl>
17051
17052	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format