VirtualBox.xidl@ 35903

Last change on this file since 35903 was 35903, checked in by vboxsync, 14 years ago
Main: before unregistering a machine, move media shared with another machine to that machine's media registry to prevent that machine from becoming inaccessible
Property svn:eol-style set to `native`
File size: 613.2 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	-->
488	</const>
489
490	<const name="Future" value="99999">
491	<desc>Settings version greater than "1.11", written by a future VirtualBox version.</desc>
492	</const>
493	</enum>
494
495	<enum
496	name="AccessMode"
497	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
498	>
499	<desc>
500	Access mode for opening files.
501	</desc>
502
503	<const name="ReadOnly" value="1"/>
504	<const name="ReadWrite" value="2"/>
505	</enum>
506
507	<enum
508	name="MachineState"
509	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
510	>
511	<desc>
512	Virtual machine execution state.
513
514	This enumeration represents possible values of the <link
515	to="IMachine::state"/> attribute.
516
517	Below is the basic virtual machine state diagram. It shows how the state
518	changes during virtual machine execution. The text in square braces shows
519	a method of the IConsole interface that performs the given state
520	transition.
521
522	<pre>
523	+---------[powerDown()] <- Stuck <--[failure]-+
524	V \|
525	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
526	\| \| \| \| V \|
527	\| Aborted -----+ +--> Running --[pause()]--> Paused
528	\| \| ^ \| ^ \|
529	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
530	\| ^ \| \| \| \|
531	\| \| +-----------------------------------------+-\|-------------------+ +
532	\| \| \| \| \|
533	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
534	\| \| \| \|
535	\| +-------- Saving <--------[saveState()]<----------+---------------------+
536	\| \| \|
537	+-------------- Stopping -------[powerDown()]<----------+---------------------+
538	</pre>
539
540	Note that states to the right from PoweredOff, Aborted and Saved in the
541	above diagram are called <i>online VM states</i>. These states
542	represent the virtual machine which is being executed in a dedicated
543	process (usually with a GUI window attached to it where you can see the
544	activity of the virtual machine and interact with it). There are two
545	special pseudo-states, FirstOnline and LastOnline, that can be used in
546	relational expressions to detect if the given machine state is online or
547	not:
548
549	<pre>
550	if (machine.GetState() >= MachineState_FirstOnline &&
551	machine.GetState() <= MachineState_LastOnline)
552	{
553	...the machine is being executed...
554	}
555	</pre>
556
557	When the virtual machine is in one of the online VM states (that is, being
558	executed), only a few machine settings can be modified. Methods working
559	with such settings contain an explicit note about that. An attempt to
560	change any oter setting or perform a modifying operation during this time
561	will result in the <link to="VBOX_E_INVALID_VM_STATE"/> error.
562
563	All online states except Running, Paused and Stuck are transitional: they
564	represent temporary conditions of the virtual machine that will last as
565	long as the operation that initiated such a condition.
566
567	The Stuck state is a special case. It means that execution of the machine
568	has reached the "Guru Meditation" condition. This condition indicates an
569	internal VMM (virtual machine manager) failure which may happen as a
570	result of either an unhandled low-level virtual hardware exception or one
571	of the recompiler exceptions (such as the <i>too-many-traps</i>
572	condition).
573
574	Note also that any online VM state may transit to the Aborted state. This
575	happens if the process that is executing the virtual machine terminates
576	unexpectedly (for example, crashes). Other than that, the Aborted state is
577	equivalent to PoweredOff.
578
579	There are also a few additional state diagrams that do not deal with
580	virtual machine execution and therefore are shown separately. The states
581	shown on these diagrams are called <i>offline VM states</i> (this includes
582	PoweredOff, Aborted and Saved too).
583
584	The first diagram shows what happens when a lengthy setup operation is
585	being executed (such as <link to="IMachine::attachDevice"/>).
586
587	<pre>
588	+----------------------------------(same state as before the call)------+
589	\| \|
590	+-> PoweredOff --+ \|
591	\| \| \|
592	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
593	\| \|
594	+-> Saved -------+
595	</pre>
596
597	The next two diagrams demonstrate the process of taking a snapshot of a
598	powered off virtual machine, restoring the state to that as of a snapshot
599	or deleting a snapshot, respectively.
600
601	<pre>
602	+----------------------------------(same state as before the call)------+
603	\| \|
604	+-> PoweredOff --+ \|
605	\| +-->[takeSnapshot()] -------------------> Saving ------+
606	+-> Aborted -----+
607
608	+-> PoweredOff --+
609	\| \|
610	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
611	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
612	+-> Saved -------+ \|
613	\| \|
614	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
615	</pre>
616
617	Note that the Saving state is present in both the offline state group and
618	online state group. Currently, the only way to determine what group is
619	assumed in a particular case is to remember the previous machine state: if
620	it was Running or Paused, then Saving is an online state, otherwise it is
621	an offline state. This inconsistency may be removed in one of the future
622	versions of VirtualBox by adding a new state.
623
624	<note internal="yes">
625	For whoever decides to touch this enum: In order to keep the
626	comparisons involving FirstOnline and LastOnline pseudo-states valid,
627	the numeric values of these states must be correspondingly updated if
628	needed: for any online VM state, the condition
629	<tt>FirstOnline <= state <= LastOnline</tt> must be
630	@c true. The same relates to transient states for which
631	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
632	@c true.
633	</note>
634	</desc>
635
636	<const name="Null" value="0">
637	<desc>Null value (never used by the API).</desc>
638	</const>
639	<const name="PoweredOff" value="1">
640	<desc>
641	The machine is not running and has no saved execution state; it has
642	either never been started or been shut down successfully.
643	</desc>
644	</const>
645	<const name="Saved" value="2">
646	<desc>
647	The machine is not currently running, but the execution state of the machine
648	has been saved to an external file when it was running, from where
649	it can be resumed.
650	</desc>
651	</const>
652	<const name="Teleported" value="3">
653	<desc>
654	The machine was teleported to a different host (or process) and then
655	powered off. Take care when powering it on again may corrupt resources
656	it shares with the teleportation target (e.g. disk and network).
657	</desc>
658	</const>
659	<const name="Aborted" value="4">
660	<desc>
661	The process running the machine has terminated abnormally. This may
662	indicate a crash of the VM process in host execution context, or
663	the VM process has been terminated externally.
664	</desc>
665	</const>
666	<const name="Running" value="5">
667	<desc>
668	The machine is currently being executed.
669	<note internal="yes">
670	For whoever decides to touch this enum: In order to keep the
671	comparisons in the old source code valid, this state must immediately
672	precede the Paused state.
673	TODO: Lift this spectacularly wonderful restriction.
674	</note>
675	</desc>
676	</const>
677	<const name="Paused" value="6">
678	<desc>
679	Execution of the machine has been paused.
680	<note internal="yes">
681	For whoever decides to touch this enum: In order to keep the
682	comparisons in the old source code valid, this state must immediately
683	follow the Running state.
684	TODO: Lift this spectacularly wonderful restriction.
685	</note>
686	</desc>
687	</const>
688	<const name="Stuck" value="7">
689	<desc>
690	Execution of the machine has reached the "Guru Meditation"
691	condition. This indicates a severe error in the hypervisor itself.
692	<note internal="yes">
693	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
694	"Guru", perhaps? Or are there some other VMM states that are
695	intended to be lumped in here as well?
696	</note>
697	</desc>
698	</const>
699	<const name="Teleporting" value="8">
700	<desc>
701	The machine is about to be teleported to a different host or process.
702	It is possible to pause a machine in this state, but it will go to the
703	@c TeleportingPausedVM state and it will not be
704	possible to resume it again unless the teleportation fails.
705	</desc>
706	</const>
707	<const name="LiveSnapshotting" value="9">
708	<desc>
709	A live snapshot is being taken. The machine is running normally, but
710	some of the runtime configuration options are inaccessible. Also, if
711	paused while in this state it will transition to
712	@c Saving and it will not be resume the
713	execution until the snapshot operation has completed.
714	</desc>
715	</const>
716	<const name="Starting" value="10">
717	<desc>
718	Machine is being started after powering it on from a
719	zero execution state.
720	</desc>
721	</const>
722	<const name="Stopping" value="11">
723	<desc>
724	Machine is being normally stopped powering it off, or after the guest OS
725	has initiated a shutdown sequence.
726	</desc>
727	</const>
728	<const name="Saving" value="12">
729	<desc>
730	Machine is saving its execution state to a file, or an online
731	snapshot of the machine is being taken.
732	</desc>
733	</const>
734	<const name="Restoring" value="13">
735	<desc>
736	Execution state of the machine is being restored from a file
737	after powering it on from the saved execution state.
738	</desc>
739	</const>
740	<const name="TeleportingPausedVM" value="14">
741	<desc>
742	The machine is being teleported to another host or process, but it is
743	not running. This is the paused variant of the
744	@c state.
745	</desc>
746	</const>
747	<const name="TeleportingIn" value="15">
748	<desc>
749	Teleporting the machine state in from another host or process.
750	</desc>
751	</const>
752	<const name="FaultTolerantSyncing" value="16">
753	<desc>
754	The machine is being synced with a fault tolerant VM running elsewhere.
755	</desc>
756	</const>
757	<const name="DeletingSnapshotOnline" value="17">
758	<desc>
759	Like @c DeletingSnapshot, but the merging of media is ongoing in
760	the background while the machine is running.
761	</desc>
762	</const>
763	<const name="DeletingSnapshotPaused" value="18">
764	<desc>
765	Like @c DeletingSnapshotOnline, but the machine was paused when the
766	merging of differencing media was started.
767	</desc>
768	</const>
769	<const name="RestoringSnapshot" value="19">
770	<desc>
771	A machine snapshot is being restored; this typically does not take long.
772	</desc>
773	</const>
774	<const name="DeletingSnapshot" value="20">
775	<desc>
776	A machine snapshot is being deleted; this can take a long time since this
777	may require merging differencing media. This value indicates that the
778	machine is not running while the snapshot is being deleted.
779	</desc>
780	</const>
781	<const name="SettingUp" value="21">
782	<desc>
783	Lengthy setup operation is in progress.
784	</desc>
785	</const>
786
787	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
788	<desc>
789	Pseudo-state: first online state (for use in relational expressions).
790	</desc>
791	</const>
792	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
793	<desc>
794	Pseudo-state: last online state (for use in relational expressions).
795	</desc>
796	</const>
797
798	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
799	<desc>
800	Pseudo-state: first transient state (for use in relational expressions).
801	</desc>
802	</const>
803	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
804	<desc>
805	Pseudo-state: last transient state (for use in relational expressions).
806	</desc>
807	</const>
808
809	</enum>
810
811	<enum
812	name="SessionState"
813	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
814	>
815	<desc>
816	Session state. This enumeration represents possible values of
817	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
818	attributes.
819	</desc>
820
821	<const name="Null" value="0">
822	<desc>Null value (never used by the API).</desc>
823	</const>
824	<const name="Unlocked" value="1">
825	<desc>
826	In <link to="IMachine::sessionState"/>, this means that the machine
827	is not locked for any sessions.
828
829	In <link to="ISession::state"/>, this means that no machine is
830	currently locked for this session.
831	</desc>
832	</const>
833	<const name="Locked" value="2">
834	<desc>
835	In <link to="IMachine::sessionState"/>, this means that the machine
836	is currently locked for a session, whose process identifier can
837	then be found in the <link to="IMachine::sessionPid" /> attribute.
838
839	In <link to="ISession::state"/>, this means that a machine is
840	currently locked for this session, and the mutable machine object
841	can be found in the <link to="ISession::machine"/> attribute
842	(see <link to="IMachine::lockMachine" /> for details).
843	</desc>
844	</const>
845	<const name="Spawning" value="3">
846	<desc>
847	A new process is being spawned for the machine as a result of
848	<link to="IMachine::launchVMProcess"/> call. This state also occurs
849	as a short transient state during an <link to="IMachine::lockMachine"/>
850	call.
851	</desc>
852	</const>
853	<const name="Unlocking" value="4">
854	<desc>
855	The session is being unlocked.
856	</desc>
857	</const>
858	</enum>
859
860	<enum
861	name="CPUPropertyType"
862	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
863	>
864	<desc>
865	Virtual CPU property type. This enumeration represents possible values of the
866	IMachine get- and setCPUProperty methods.
867	</desc>
868	<const name="Null" value="0">
869	<desc>Null value (never used by the API).</desc>
870	</const>
871	<const name="PAE" value="1">
872	<desc>
873	This setting determines whether VirtualBox will expose the Physical Address
874	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
875	is not available, it will not be reported.
876	</desc>
877	</const>
878	<const name="Synthetic" value="2">
879	<desc>
880	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
881	teleporting between host systems that differ significantly.
882	</desc>
883	</const>
884	</enum>
885
886
887	<enum
888	name="HWVirtExPropertyType"
889	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
890	>
891	<desc>
892	Hardware virtualization property type. This enumeration represents possible values
893	for the <link to="IMachine::getHWVirtExProperty"/> and
894	<link to="IMachine::setHWVirtExProperty"/> methods.
895	</desc>
896	<const name="Null" value="0">
897	<desc>Null value (never used by the API).</desc>
898	</const>
899	<const name="Enabled" value="1">
900	<desc>
901	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
902	such extensions are not available, they will not be used.
903	</desc>
904	</const>
905	<const name="Exclusive" value="2">
906	<desc>
907	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
908	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
909	feature of the host. To share these with other hypervisors, you must disable this property.
910	</desc>
911	</const>
912	<const name="VPID" value="3">
913	<desc>
914	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
915	</desc>
916	</const>
917	<const name="NestedPaging" value="4">
918	<desc>
919	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
920	</desc>
921	</const>
922	<const name="LargePages" value="5">
923	<desc>
924	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
925	</desc>
926	</const>
927	<const name="Force" value="6">
928	<desc>
929	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
930	not set, there will be an automatic fallback to software virtualization.
931	</desc>
932	</const>
933	</enum>
934
935	<enum
936	name="FaultToleranceState"
937	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
938	>
939	<desc>
940	Used with <link to="IMachine::faultToleranceState" />.
941	</desc>
942	<const name="Inactive" value="1">
943	<desc>No fault tolerance enabled.</desc>
944	</const>
945	<const name="Master" value="2">
946	<desc>Fault tolerant master VM.</desc>
947	</const>
948	<const name="Standby" value="3">
949	<desc>Fault tolerant standby VM.</desc>
950	</const>
951	</enum>
952
953	<enum
954	name="LockType"
955	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
956	>
957	<desc>
958	Used with <link to="IMachine::lockMachine" />.
959	</desc>
960	<const name="Write" value="2">
961	<desc>Lock the machine for writing.</desc>
962	</const>
963	<const name="Shared" value="1">
964	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
965	</const>
966	</enum>
967
968	<enum
969	name="SessionType"
970	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
971	>
972	<desc>
973	Session type. This enumeration represents possible values of the
974	<link to="ISession::type"/> attribute.
975	</desc>
976
977	<const name="Null" value="0">
978	<desc>Null value (never used by the API).</desc>
979	</const>
980	<const name="WriteLock" value="1">
981	<desc>
982	Session has acquired an exclusive write lock on a machine
983	using <link to="IMachine::lockMachine"/>.
984	</desc>
985	</const>
986	<const name="Remote" value="2">
987	<desc>
988	Session has launched a VM process using
989	<link to="IMachine::launchVMProcess"/>
990	</desc>
991	</const>
992	<const name="Shared" value="3">
993	<desc>
994	Session has obtained a link to another session using
995	<link to="IMachine::lockMachine"/>
996	</desc>
997	</const>
998	</enum>
999
1000	<enum
1001	name="DeviceType"
1002	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1003	>
1004	<desc>
1005	Device type.
1006	</desc>
1007	<const name="Null" value="0">
1008	<desc>
1009	Null value, may also mean "no device" (not allowed for
1010	<link to="IConsole::getDeviceActivity"/>).
1011	</desc>
1012	</const>
1013	<const name="Floppy" value="1">
1014	<desc>Floppy device.</desc>
1015	</const>
1016	<const name="DVD" value="2">
1017	<desc>CD/DVD-ROM device.</desc>
1018	</const>
1019	<const name="HardDisk" value="3">
1020	<desc>Hard disk device.</desc>
1021	</const>
1022	<const name="Network" value="4">
1023	<desc>Network device.</desc>
1024	</const>
1025	<const name="USB" value="5">
1026	<desc>USB device.</desc>
1027	</const>
1028	<const name="SharedFolder" value="6">
1029	<desc>Shared folder device.</desc>
1030	</const>
1031	</enum>
1032
1033	<enum
1034	name="DeviceActivity"
1035	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1036	>
1037	<desc>
1038	Device activity for <link to="IConsole::getDeviceActivity"/>.
1039	</desc>
1040
1041	<const name="Null" value="0"/>
1042	<const name="Idle" value="1"/>
1043	<const name="Reading" value="2"/>
1044	<const name="Writing" value="3"/>
1045	</enum>
1046
1047	<enum
1048	name="ClipboardMode"
1049	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1050	>
1051	<desc>
1052	Host-Guest clipboard interchange mode.
1053	</desc>
1054
1055	<const name="Disabled" value="0"/>
1056	<const name="HostToGuest" value="1"/>
1057	<const name="GuestToHost" value="2"/>
1058	<const name="Bidirectional" value="3"/>
1059	</enum>
1060
1061	<enum
1062	name="Scope"
1063	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1064	>
1065	<desc>
1066	Scope of the operation.
1067
1068	A generic enumeration used in various methods to define the action or
1069	argument scope.
1070	</desc>
1071
1072	<const name="Global" value="0"/>
1073	<const name="Machine" value="1"/>
1074	<const name="Session" value="2"/>
1075	</enum>
1076
1077	<enum
1078	name="BIOSBootMenuMode"
1079	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1080	>
1081	<desc>
1082	BIOS boot menu mode.
1083	</desc>
1084
1085	<const name="Disabled" value="0"/>
1086	<const name="MenuOnly" value="1"/>
1087	<const name="MessageAndMenu" value="2"/>
1088	</enum>
1089
1090	<enum
1091	name="ProcessorFeature"
1092	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1093	>
1094	<desc>
1095	CPU features.
1096	</desc>
1097
1098	<const name="HWVirtEx" value="0"/>
1099	<const name="PAE" value="1"/>
1100	<const name="LongMode" value="2"/>
1101	<const name="NestedPaging" value="3"/>
1102	</enum>
1103
1104	<enum
1105	name="FirmwareType"
1106	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1107	>
1108	<desc>
1109	Firmware type.
1110	</desc>
1111	<const name="BIOS" value="1">
1112	<desc>BIOS Firmware.</desc>
1113	</const>
1114	<const name="EFI" value="2">
1115	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1116	</const>
1117	<const name="EFI32" value="3">
1118	<desc>Efi firmware, 32-bit.</desc>
1119	</const>
1120	<const name="EFI64" value="4">
1121	<desc>Efi firmware, 64-bit.</desc>
1122	</const>
1123	<const name="EFIDUAL" value="5">
1124	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1125	</const>
1126	</enum>
1127
1128	<enum
1129	name="PointingHidType"
1130	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1131	>
1132	<desc>
1133	Type of pointing device used in a virtual machine.
1134	</desc>
1135	<const name="None" value="1">
1136	<desc>No mouse.</desc>
1137	</const>
1138	<const name="PS2Mouse" value="2">
1139	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1140	</const>
1141	<const name="USBMouse" value="3">
1142	<desc>USB mouse (relative pointer).</desc>
1143	</const>
1144	<const name="USBTablet" value="4">
1145	<desc>USB tablet (absolute pointer).</desc>
1146	</const>
1147	<const name="ComboMouse" value="5">
1148	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1149	Using of such device can have negative performance implications. </desc>
1150	</const>
1151	</enum>
1152
1153	<enum
1154	name="KeyboardHidType"
1155	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1156	>
1157	<desc>
1158	Type of keyboard device used in a virtual machine.
1159	</desc>
1160	<const name="None" value="1">
1161	<desc>No keyboard.</desc>
1162	</const>
1163	<const name="PS2Keyboard" value="2">
1164	<desc>PS/2 keyboard.</desc>
1165	</const>
1166	<const name="USBKeyboard" value="3">
1167	<desc>USB keyboard.</desc>
1168	</const>
1169	<const name="ComboKeyboard" value="4">
1170	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1171	Using of such device can have negative performance implications. </desc>
1172	</const>
1173	</enum>
1174
1175	<!--
1176	// IVirtualBoxErrorInfo
1177	/////////////////////////////////////////////////////////////////////////
1178	-->
1179
1180	<interface
1181	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1182	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1183	supportsErrorInfo="no"
1184	wsmap="managed"
1185	>
1186	<desc>
1187	The IVirtualBoxErrorInfo interface represents extended error information.
1188
1189	Extended error information can be set by VirtualBox components after
1190	unsuccessful or partially successful method invocation. This information
1191	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1192	and then shown to the client in addition to the plain 32-bit result code.
1193
1194	In MS COM, this interface extends the IErrorInfo interface,
1195	in XPCOM, it extends the nsIException interface. In both cases,
1196	it provides a set of common attributes to retrieve error
1197	information.
1198
1199	Sometimes invocation of some component's method may involve methods of
1200	other components that may also fail (independently of this method's
1201	failure), or a series of non-fatal errors may precede a fatal error that
1202	causes method failure. In cases like that, it may be desirable to preserve
1203	information about all errors happened during method invocation and deliver
1204	it to the caller. The <link to="#next"/> attribute is intended
1205	specifically for this purpose and allows to represent a chain of errors
1206	through a single IVirtualBoxErrorInfo object set after method invocation.
1207
1208	Note that errors are stored to a chain in the reverse order, i.e. the
1209	initial error object you query right after method invocation is the last
1210	error set by the callee, the object it points to in the @a next attribute
1211	is the previous error and so on, up to the first error (which is the last
1212	in the chain).
1213	</desc>
1214
1215	<attribute name="resultCode" type="long" readonly="yes">
1216	<desc>
1217	Result code of the error.
1218	Usually, it will be the same as the result code returned
1219	by the method that provided this error information, but not
1220	always. For example, on Win32, CoCreateInstance() will most
1221	likely return E_NOINTERFACE upon unsuccessful component
1222	instantiation attempt, but not the value the component factory
1223	returned. Value is typed 'long', not 'result',
1224	to make interface usable from scripting languages.
1225	<note>
1226	In MS COM, there is no equivalent.
1227	In XPCOM, it is the same as nsIException::result.
1228	</note>
1229	</desc>
1230	</attribute>
1231
1232	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1233	<desc>
1234	UUID of the interface that defined the error.
1235	<note>
1236	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1237	data type.
1238	In XPCOM, there is no equivalent.
1239	</note>
1240	</desc>
1241	</attribute>
1242
1243	<attribute name="component" type="wstring" readonly="yes">
1244	<desc>
1245	Name of the component that generated the error.
1246	<note>
1247	In MS COM, it is the same as IErrorInfo::GetSource.
1248	In XPCOM, there is no equivalent.
1249	</note>
1250	</desc>
1251	</attribute>
1252
1253	<attribute name="text" type="wstring" readonly="yes">
1254	<desc>
1255	Text description of the error.
1256	<note>
1257	In MS COM, it is the same as IErrorInfo::GetDescription.
1258	In XPCOM, it is the same as nsIException::message.
1259	</note>
1260	</desc>
1261	</attribute>
1262
1263	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1264	<desc>
1265	Next error object if there is any, or @c null otherwise.
1266	<note>
1267	In MS COM, there is no equivalent.
1268	In XPCOM, it is the same as nsIException::inner.
1269	</note>
1270	</desc>
1271	</attribute>
1272
1273	</interface>
1274
1275	<!--
1276	// IVirtualBox
1277	/////////////////////////////////////////////////////////////////////////
1278	-->
1279
1280	<interface
1281	name="IDHCPServer" extends="$unknown"
1282	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1283	wsmap="managed"
1284	>
1285	<desc>
1286	The IDHCPServer interface represents the vbox dhcp server configuration.
1287
1288	To enumerate all the dhcp servers on the host, use the
1289	<link to="IVirtualBox::DHCPServers"/> attribute.
1290	</desc>
1291
1292	<attribute name="enabled" type="boolean">
1293	<desc>
1294	specifies if the dhcp server is enabled
1295	</desc>
1296	</attribute>
1297
1298	<attribute name="IPAddress" type="wstring" readonly="yes">
1299	<desc>
1300	specifies server IP
1301	</desc>
1302	</attribute>
1303
1304	<attribute name="networkMask" type="wstring" readonly="yes">
1305	<desc>
1306	specifies server network mask
1307	</desc>
1308	</attribute>
1309
1310	<attribute name="networkName" type="wstring" readonly="yes">
1311	<desc>
1312	specifies internal network name the server is used for
1313	</desc>
1314	</attribute>
1315
1316	<attribute name="lowerIP" type="wstring" readonly="yes">
1317	<desc>
1318	specifies from IP address in server address range
1319	</desc>
1320	</attribute>
1321
1322	<attribute name="upperIP" type="wstring" readonly="yes">
1323	<desc>
1324	specifies to IP address in server address range
1325	</desc>
1326	</attribute>
1327
1328	<method name="setConfiguration">
1329	<desc>
1330	configures the server
1331	<result name="E_INVALIDARG">
1332	invalid configuration supplied
1333	</result>
1334	</desc>
1335	<param name="IPAddress" type="wstring" dir="in">
1336	<desc>
1337	server IP address
1338	</desc>
1339	</param>
1340	<param name="networkMask" type="wstring" dir="in">
1341	<desc>
1342	server network mask
1343	</desc>
1344	</param>
1345	<param name="FromIPAddress" type="wstring" dir="in">
1346	<desc>
1347	server From IP address for address range
1348	</desc>
1349	</param>
1350	<param name="ToIPAddress" type="wstring" dir="in">
1351	<desc>
1352	server To IP address for address range
1353	</desc>
1354	</param>
1355	</method>
1356
1357	<method name="start">
1358	<desc>
1359	Starts DHCP server process.
1360	<result name="E_FAIL">
1361	Failed to start the process.
1362	</result>
1363	</desc>
1364	<param name="networkName" type="wstring" dir="in">
1365	<desc>
1366	Name of internal network DHCP server should attach to.
1367	</desc>
1368	</param>
1369	<param name="trunkName" type="wstring" dir="in">
1370	<desc>
1371	Name of internal network trunk.
1372	</desc>
1373	</param>
1374	<param name="trunkType" type="wstring" dir="in">
1375	<desc>
1376	Type of internal network trunk.
1377	</desc>
1378	</param>
1379	</method>
1380
1381	<method name="stop">
1382	<desc>
1383	Stops DHCP server process.
1384	<result name="E_FAIL">
1385	Failed to stop the process.
1386	</result>
1387	</desc>
1388	</method>
1389	</interface>
1390
1391	<interface
1392	name="IVirtualBox" extends="$unknown"
1393	uuid="d2de270c-1d4b-4c9e-843f-bbb9b47269ff"
1394	wsmap="managed"
1395	>
1396	<desc>
1397	The IVirtualBox interface represents the main interface exposed by the
1398	product that provides virtual machine management.
1399
1400	An instance of IVirtualBox is required for the product to do anything
1401	useful. Even though the interface does not expose this, internally,
1402	IVirtualBox is implemented as a singleton and actually lives in the
1403	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1404	IVirtualBox can track the state of all virtual machines on a particular
1405	host, regardless of which frontend started them.
1406
1407	To enumerate all the virtual machines on the host, use the
1408	<link to="IVirtualBox::machines"/> attribute.
1409	</desc>
1410
1411	<attribute name="version" type="wstring" readonly="yes">
1412	<desc>
1413	A string representing the version number of the product. The
1414	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1415	last number represents the build number and will frequently change.
1416	</desc>
1417	</attribute>
1418
1419	<attribute name="revision" type="unsigned long" readonly="yes">
1420	<desc>
1421	The internal build revision number of the product.
1422	</desc>
1423	</attribute>
1424
1425	<attribute name="packageType" type="wstring" readonly="yes">
1426	<desc>
1427	A string representing the package type of this product. The
1428	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1429	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1430	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1431	this.
1432	</desc>
1433	</attribute>
1434
1435	<attribute name="homeFolder" type="wstring" readonly="yes">
1436	<desc>
1437	Full path to the directory where the global settings file,
1438	<tt>VirtualBox.xml</tt>, is stored.
1439
1440	In this version of VirtualBox, the value of this property is
1441	always <tt><user_dir>/.VirtualBox</tt> (where
1442	<tt><user_dir></tt> is the path to the user directory,
1443	as determined by the host OS), and cannot be changed.
1444
1445	This path is also used as the base to resolve relative paths in
1446	places where relative paths are allowed (unless otherwise
1447	expressly indicated).
1448	</desc>
1449	</attribute>
1450
1451	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1452	<desc>
1453	Full name of the global settings file.
1454	The value of this property corresponds to the value of
1455	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1456	</desc>
1457	</attribute>
1458
1459	<attribute name="host" type="IHost" readonly="yes">
1460	<desc>Associated host object.</desc>
1461	</attribute>
1462
1463	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1464	<desc>Associated system information object.</desc>
1465	</attribute>
1466
1467	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1468	<desc>
1469	Array of machine objects registered within this VirtualBox instance.
1470	</desc>
1471	</attribute>
1472
1473	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1474	<desc>
1475	Array of medium objects known to this VirtualBox installation.
1476
1477	This array contains only base media. All differencing
1478	media of the given base medium can be enumerated using
1479	<link to="IMedium::children"/>.
1480	</desc>
1481	</attribute>
1482
1483	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1484	<desc>
1485	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1486	</desc>
1487	</attribute>
1488
1489	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1490	<desc>
1491	Array of floppy image objects currently in use by this VirtualBox instance.
1492	</desc>
1493	</attribute>
1494
1495	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1496
1497	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1498
1499	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1500	<desc>
1501	Collection of global shared folders. Global shared folders are
1502	available to all virtual machines.
1503
1504	New shared folders are added to the collection using
1505	<link to="#createSharedFolder"/>. Existing shared folders can be
1506	removed using <link to="#removeSharedFolder"/>.
1507
1508	<note>
1509	In the current version of the product, global shared folders are not
1510	implemented and therefore this collection is always empty.
1511	</note>
1512	</desc>
1513	</attribute>
1514
1515	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1516	<desc>
1517	Associated performance collector object.
1518	</desc>
1519	</attribute>
1520
1521	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1522	<desc>
1523	DHCP servers.
1524	</desc>
1525	</attribute>
1526
1527	<attribute name="eventSource" type="IEventSource" readonly="yes">
1528	<desc>
1529	Event source for VirtualBox events.
1530	</desc>
1531	</attribute>
1532
1533	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1534	<desc>
1535	The extension pack manager.
1536	</desc>
1537	</attribute>
1538
1539
1540	<method name="composeMachineFilename">
1541	<desc>
1542	Returns a recommended full path of the settings file name for a new virtual
1543	machine.
1544
1545	This API serves two purposes:
1546
1547	<ul>
1548	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1549	for the @a settingsFile argument there, which means that API should use
1550	a recommended default file name.</li>
1551
1552	<li>It can be called manually by a client software before creating a machine,
1553	e.g. if that client wants to pre-create the machine directory to create
1554	virtual hard disks in that directory together with the new machine
1555	settings file. In that case, the file name should be stripped from the
1556	full settings file path returned by this function to obtain the
1557	machine directory.</li>
1558	</ul>
1559
1560	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1561	details about the machine name.
1562
1563	If @a baseFolder is a @c null or empty string (which is recommended), the
1564	default machine settings folder
1565	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1566	a base folder for the created machine, resulting in a file name like
1567	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1568	will be used.
1569
1570	This method does not access the host disks. In particular, it does not check
1571	for whether a machine of this name already exists.
1572	</desc>
1573	<param name="name" type="wstring" dir="in">
1574	<desc>Suggested machine name.</desc>
1575	</param>
1576	<param name="baseFolder" type="wstring" dir="in">
1577	<desc>Base machine folder (optional).</desc>
1578	</param>
1579	<param name="file" type="wstring" dir="return">
1580	<desc>Fully qualified path where the machine would be created.</desc>
1581	</param>
1582	</method>
1583
1584	<method name="createMachine">
1585	<desc>
1586	Creates a new virtual machine by creating a machine settings file at
1587	the given location.
1588
1589	VirtualBox machine settings files use a custom XML dialect. Starting
1590	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1591	and machine files can be created at arbitrary locations.
1592
1593	However, it is is recommended that machines be created in the default
1594	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1595	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1596	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1597	is called automatically to have such a recommended name composed based
1598	on the machine name given in the @a name argument.
1599
1600	If the resulting settings file already exists, this method will fail,
1601	unless @a forceOverwrite is set.
1602
1603	The new machine is created unregistered, with the initial configuration
1604	set according to the specified guest OS type. A typical sequence of
1605	actions to create a new virtual machine is as follows:
1606
1607	<ol>
1608	<li>
1609	Call this method to have a new machine created. The returned machine
1610	object will be "mutable" allowing to change any machine property.
1611	</li>
1612
1613	<li>
1614	Configure the machine using the appropriate attributes and methods.
1615	</li>
1616
1617	<li>
1618	Call <link to="IMachine::saveSettings" /> to write the settings
1619	to the machine's XML settings file. The configuration of the newly
1620	created machine will not be saved to disk until this method is
1621	called.
1622	</li>
1623
1624	<li>
1625	Call <link to="#registerMachine" /> to add the machine to the list
1626	of machines known to VirtualBox.
1627	</li>
1628	</ol>
1629
1630	The specified guest OS type identifier must match an ID of one of known
1631	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1632	array.
1633
1634	Optionally, you may specify an UUID of to assign to the created machine.
1635	However, this is not recommended and you should normally pass an empty
1636	(@c null) UUID to this method so that a new UUID will be automatically
1637	generated for every created machine. You can use UUID
1638	00000000-0000-0000-0000-000000000000 as @c null value.
1639
1640	<note>
1641	There is no way to change the name of the settings file or
1642	subfolder of the created machine directly.
1643	</note>
1644
1645	<result name="VBOX_E_OBJECT_NOT_FOUND">
1646	@a osTypeId is invalid.
1647	</result>
1648	<result name="VBOX_E_FILE_ERROR">
1649	Resulting settings file name is invalid or the settings file already
1650	exists or could not be created due to an I/O error.
1651	</result>
1652	<result name="E_INVALIDARG">
1653	@a name is empty or @c null.
1654	</result>
1655	</desc>
1656
1657	<param name="settingsFile" type="wstring" dir="in">
1658	<desc>Fully qualified path where the settings file should be created,
1659	or NULL for a default folder and file based on the @a name argument
1660	(see <link to="#composeMachineFilename" />).</desc>
1661	</param>
1662	<param name="name" type="wstring" dir="in">
1663	<desc>Machine name.</desc>
1664	</param>
1665	<param name="osTypeId" type="wstring" dir="in">
1666	<desc>Guest OS Type ID.</desc>
1667	</param>
1668	<param name="id" type="uuid" mod="string" dir="in">
1669	<desc>Machine UUID (optional).</desc>
1670	</param>
1671	<param name="forceOverwrite" type="boolean" dir="in">
1672	<desc>If true, an existing machine settings file will be overwritten.</desc>
1673	</param>
1674	<param name="machine" type="IMachine" dir="return">
1675	<desc>Created machine object.</desc>
1676	</param>
1677	</method>
1678
1679	<method name="openMachine">
1680	<desc>
1681	Opens a virtual machine from the existing settings file.
1682	The opened machine remains unregistered until you call
1683	<link to="#registerMachine"/>.
1684
1685	The specified settings file name must be fully qualified.
1686	The file must exist and be a valid machine XML settings file
1687	whose contents will be used to construct the machine object.
1688
1689	<result name="VBOX_E_FILE_ERROR">
1690	Settings file name invalid, not found or sharing violation.
1691	</result>
1692	</desc>
1693	<param name="settingsFile" type="wstring" dir="in">
1694	<desc>
1695	Name of the machine settings file.
1696	</desc>
1697	</param>
1698	<param name="machine" type="IMachine" dir="return">
1699	<desc>Opened machine object.</desc>
1700	</param>
1701	<note>
1702	<link to="IMachine::settingsModified"/> will return
1703	@c false for the created machine, until any of machine settings
1704	are changed.
1705	</note>
1706	</method>
1707
1708	<method name="registerMachine">
1709	<desc>
1710
1711	Registers the machine previously created using
1712	<link to="#createMachine"/> or opened using
1713	<link to="#openMachine"/> within this VirtualBox installation. After
1714	successful method invocation, the
1715	<link to="IMachineRegisteredEvent"/> event is fired.
1716
1717	<note>
1718	This method implicitly calls <link to="IMachine::saveSettings"/>
1719	to save all current machine settings before registering it.
1720	</note>
1721
1722	<result name="VBOX_E_OBJECT_NOT_FOUND">
1723	No matching virtual machine found.
1724	</result>
1725	<result name="VBOX_E_INVALID_OBJECT_STATE">
1726	Virtual machine was not created within this VirtualBox instance.
1727	</result>
1728
1729	</desc>
1730	<param name="machine" type="IMachine" dir="in"/>
1731	</method>
1732
1733	<method name="findMachine">
1734	<desc>
1735	Attempts to find a virtual machine given its name or UUID.
1736
1737	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1738	cannot safely be determined.</note>
1739
1740	<result name="VBOX_E_OBJECT_NOT_FOUND">
1741	Could not find registered machine matching @a nameOrId.
1742	</result>
1743
1744	</desc>
1745	<param name="nameOrId" type="wstring" dir="in">
1746	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1747	</param>
1748	<param name="machine" type="IMachine" dir="return">
1749	<desc>Machine object, if found.</desc>
1750	</param>
1751	</method>
1752
1753	<method name="createAppliance">
1754	<desc>
1755	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1756	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1757	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1758	</desc>
1759	<param name="appliance" type="IAppliance" dir="return">
1760	<desc>New appliance.</desc>
1761	</param>
1762	</method>
1763
1764	<method name="createHardDisk">
1765	<desc>
1766	Creates a new base medium object that will use the given storage
1767	format and location for medium data.
1768
1769	Note that the actual storage unit is not created by this method. In
1770	order to do it, and before you are able to attach the created medium
1771	to virtual machines, you must call one of the following methods to
1772	allocate a format-specific storage unit at the specified location:
1773	<ul>
1774	<li><link to="IMedium::createBaseStorage"/></li>
1775	<li><link to="IMedium::createDiffStorage"/></li>
1776	</ul>
1777
1778	Some medium attributes, such as <link to="IMedium::id"/>, may
1779	remain uninitialized until the medium storage unit is successfully
1780	created by one of the above methods.
1781
1782	After the storage unit is successfully created, it will be
1783	accessible through the <link to="#findMedium"/> method and can
1784	be found in the <link to="#hardDisks"/> array.
1785
1786	The list of all storage formats supported by this VirtualBox
1787	installation can be obtained using
1788	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1789	attribute is empty or @c null then the default storage format
1790	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1791	be used for creating a storage unit of the medium.
1792
1793	Note that the format of the location string is storage format specific.
1794	See <link to="IMedium::location"/> and IMedium for more details.
1795
1796	<result name="VBOX_E_OBJECT_NOT_FOUND">
1797	@a format identifier is invalid. See
1798	<link to="ISystemProperties::mediumFormats"/>.
1799	</result>
1800	<result name="VBOX_E_FILE_ERROR">
1801	@a location is a not valid file name (for file-based formats only).
1802	</result>
1803	</desc>
1804	<param name="format" type="wstring" dir="in">
1805	<desc>
1806	Identifier of the storage format to use for the new medium.
1807	</desc>
1808	</param>
1809	<param name="location" type="wstring" dir="in">
1810	<desc>
1811	Location of the storage unit for the new medium.
1812	</desc>
1813	</param>
1814	<param name="medium" type="IMedium" dir="return">
1815	<desc>Created medium object.</desc>
1816	</param>
1817	</method>
1818
1819	<method name="openMedium">
1820	<desc>
1821	Opens a medium from an existing storage location.
1822
1823	Once a medium has been opened, it can be passed to other VirtualBox
1824	methods, in particular to <link to="IMachine::attachDevice" />.
1825
1826	Depending on the given device type, the file at the storage location
1827	must be in one of the media formats understood by VirtualBox:
1828
1829	<ul>
1830	<li>With a "HardDisk" device type, the file must be a hard disk image
1831	in one of the formats supported by VirtualBox (see
1832	<link to="ISystemProperties::mediumFormats" />).
1833	After this method succeeds, if the medium is a base medium, it
1834	will be added to the <link to="#hardDisks"/> array attribute. </li>
1835	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1836	After this method succeeds, the medium will be added to the
1837	<link to="#DVDImages"/> array attribute.</li>
1838	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1839	After this method succeeds, the medium will be added to the
1840	<link to="#floppyImages"/> array attribute.</li>
1841	</ul>
1842
1843	After having been opened, the medium can be found by the <link to="#findMedium"/>
1844	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1845
1846	The UUID of the newly opened medium will either be retrieved from the
1847	storage location, if the format supports it (e.g. for hard disk images),
1848	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1849	If for some reason you need to change the medium's UUID, use
1850	<link to="IMedium::setIDs" />.
1851
1852	If a differencing hard disk medium is to be opened by this method, the
1853	operation will succeed only if its parent medium and all ancestors,
1854	if any, are already known to this VirtualBox installation (for example,
1855	were opened by this method before).
1856
1857	This method attempts to guess the storage format of the specified medium
1858	by reading medium data at the specified location.
1859
1860	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1861	the image is opened for read/write access and must have according permissions,
1862	as VirtualBox may actually write status information into the disk's metadata
1863	sections.
1864
1865	Note that write access is required for all typical hard disk usage in VirtualBox,
1866	since VirtualBox may need to write metadata such as a UUID into the image.
1867	The only exception is opening a source image temporarily for copying and
1868	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1869	again soon.
1870
1871	The format of the location string is storage format specific. See
1872	<link to="IMedium::location"/> and IMedium for more details.
1873
1874	Prior to VirtualBox 4.0, opening a medium added it to a global media
1875	registry in the VirtualBox.xml file, which was shared between all machines
1876	and made transporting machines and their media from one host to another
1877	difficult.
1878
1879	Starting with VirtualBox 4.0, media are only added to a registry when
1880	they are attached to a machine. Machines created with VirtualBox 4.0
1881	or later can have their own media registry. As a result, a medium attached
1882	to such a machine will be remembered in that machine's XML settings file.
1883	Media attached to older machines will continue to be added to the global
1884	registry.
1885
1886	<result name="VBOX_E_FILE_ERROR">
1887	Invalid medium storage file location or could not find the medium
1888	at the specified location.
1889	</result>
1890	<result name="VBOX_E_IPRT_ERROR">
1891	Could not get medium storage format.
1892	</result>
1893	<result name="E_INVALIDARG">
1894	Invalid medium storage format.
1895	</result>
1896	<result name="VBOX_E_INVALID_OBJECT_STATE">
1897	Medium has already been added to a media registry.
1898	</result>
1899	</desc>
1900	<param name="location" type="wstring" dir="in">
1901	<desc>
1902	Location of the storage unit that contains medium data in one of
1903	the supported storage formats.
1904	</desc>
1905	</param>
1906	<param name="deviceType" type="DeviceType" dir="in">
1907	<desc>
1908	Must be one of "HardDisk", "DVD" or "Floppy".
1909	</desc>
1910	</param>
1911	<param name="accessMode" type="AccessMode" dir="in">
1912	<desc>Whether to open the image in read/write or read-only mode. For
1913	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1914	</param>
1915	<param name="medium" type="IMedium" dir="return">
1916	<desc>Opened medium object.</desc>
1917	</param>
1918	</method>
1919
1920	<method name="findMedium">
1921	<desc>
1922	Returns a medium of the given type that uses the given fully qualified
1923	location or UUID to store medium data.
1924
1925	The given medium must be known to this VirtualBox installation, i.e.
1926	it must be previously created by <link to="#createHardDisk"/> or opened
1927	by <link to="#openMedium"/>.
1928
1929	The search is done by comparing the value of the @a location argument to
1930	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1931	attributes of each known medium.
1932
1933	On case sensitive file systems, a case sensitive comparison is performed,
1934	otherwise the case of symbols in the file path is ignored.
1935
1936	<result name="VBOX_E_OBJECT_NOT_FOUND">
1937	No medium object matching @a location found.
1938	</result>
1939	</desc>
1940	<param name="location" type="wstring" dir="in">
1941	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1942	</param>
1943	<param name="type" type="DeviceType" dir="in">
1944	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1945	</param>
1946	<param name="medium" type="IMedium" dir="return">
1947	<desc>Medium object, if found.</desc>
1948	</param>
1949	</method>
1950
1951	<method name="getGuestOSType">
1952	<desc>
1953	Returns an object describing the specified guest OS type.
1954
1955	The requested guest OS type is specified using a string which is a
1956	mnemonic identifier of the guest operating system, such as
1957	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1958	particular virtual machine can be read or set using the
1959	<link to="IMachine::OSTypeId"/> attribute.
1960
1961	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1962	available guest OS type objects. Each object has an
1963	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1964	the guest OS this object describes.
1965
1966	<result name="E_INVALIDARG">
1967	@a id is not a valid Guest OS type.
1968	</result>
1969
1970	</desc>
1971	<param name="id" type="uuid" mod="string" dir="in">
1972	<desc>Guest OS type ID string.</desc>
1973	</param>
1974	<param name="type" type="IGuestOSType" dir="return">
1975	<desc>Guest OS type object.</desc>
1976	</param>
1977	</method>
1978
1979	<method name="createSharedFolder">
1980	<desc>
1981	Creates a new global shared folder by associating the given logical
1982	name with the given host path, adds it to the collection of shared
1983	folders and starts sharing it. Refer to the description of
1984	<link to="ISharedFolder"/> to read more about logical names.
1985	<note>
1986	In the current implementation, this operation is not
1987	implemented.
1988	</note>
1989	</desc>
1990	<param name="name" type="wstring" dir="in">
1991	<desc>Unique logical name of the shared folder.</desc>
1992	</param>
1993	<param name="hostPath" type="wstring" dir="in">
1994	<desc>Full path to the shared folder in the host file system.</desc>
1995	</param>
1996	<param name="writable" type="boolean" dir="in">
1997	<desc>Whether the share is writable or readonly</desc>
1998	</param>
1999	<param name="automount" type="boolean" dir="in">
2000	<desc>Whether the share gets automatically mounted by the guest
2001	or not.</desc>
2002	</param>
2003	</method>
2004
2005	<method name="removeSharedFolder">
2006	<desc>
2007	Removes the global shared folder with the given name previously
2008	created by <link to="#createSharedFolder"/> from the collection of
2009	shared folders and stops sharing it.
2010	<note>
2011	In the current implementation, this operation is not
2012	implemented.
2013	</note>
2014	</desc>
2015	<param name="name" type="wstring" dir="in">
2016	<desc>Logical name of the shared folder to remove.</desc>
2017	</param>
2018	</method>
2019
2020	<method name="getExtraDataKeys">
2021	<desc>
2022	Returns an array representing the global extra data keys which currently
2023	have values defined.
2024	</desc>
2025	<param name="value" type="wstring" dir="return" safearray="yes">
2026	<desc>Array of extra data keys.</desc>
2027	</param>
2028	</method>
2029
2030	<method name="getExtraData">
2031	<desc>
2032	Returns associated global extra data.
2033
2034	If the requested data @a key does not exist, this function will
2035	succeed and return an empty string in the @a value argument.
2036
2037	<result name="VBOX_E_FILE_ERROR">
2038	Settings file not accessible.
2039	</result>
2040	<result name="VBOX_E_XML_ERROR">
2041	Could not parse the settings file.
2042	</result>
2043
2044	</desc>
2045	<param name="key" type="wstring" dir="in">
2046	<desc>Name of the data key to get.</desc>
2047	</param>
2048	<param name="value" type="wstring" dir="return">
2049	<desc>Value of the requested data key.</desc>
2050	</param>
2051	</method>
2052
2053	<method name="setExtraData">
2054	<desc>
2055	Sets associated global extra data.
2056
2057	If you pass @c null or empty string as a key @a value, the given @a key
2058	will be deleted.
2059
2060	<note>
2061	Before performing the actual data change, this method will ask all
2062	registered event listener using the
2063	<link to="IExtraDataCanChangeEvent"/>
2064	notification for a permission. If one of the listeners refuses the
2065	new value, the change will not be performed.
2066	</note>
2067	<note>
2068	On success, the
2069	<link to="IExtraDataChangedEvent"/> notification
2070	is called to inform all registered listeners about a successful data
2071	change.
2072	</note>
2073
2074	<result name="VBOX_E_FILE_ERROR">
2075	Settings file not accessible.
2076	</result>
2077	<result name="VBOX_E_XML_ERROR">
2078	Could not parse the settings file.
2079	</result>
2080	<result name="E_ACCESSDENIED">
2081	Modification request refused.
2082	</result>
2083
2084	</desc>
2085	<param name="key" type="wstring" dir="in">
2086	<desc>Name of the data key to set.</desc>
2087	</param>
2088	<param name="value" type="wstring" dir="in">
2089	<desc>Value to assign to the key.</desc>
2090	</param>
2091	</method>
2092
2093	<!--method name="createDHCPServerForInterface">
2094	<desc>
2095	Creates a dhcp server settings to be used for the given interface
2096	<result name="E_INVALIDARG">
2097	Host network interface @a name already exists.
2098	</result>
2099	</desc>
2100	<param name="interface" type="IHostNetworkInterface" dir="in">
2101	<desc>Network Interface</desc>
2102	</param>
2103	<param name="server" type="IDHCPServer" dir="out">
2104	<desc>Dhcp server settings</desc>
2105	</param>
2106	</method-->
2107
2108	<method name="createDHCPServer">
2109	<desc>
2110	Creates a dhcp server settings to be used for the given internal network name
2111	<result name="E_INVALIDARG">
2112	Host network interface @a name already exists.
2113	</result>
2114	</desc>
2115	<param name="name" type="wstring" dir="in">
2116	<desc>server name</desc>
2117	</param>
2118	<param name="server" type="IDHCPServer" dir="return">
2119	<desc>Dhcp server settings</desc>
2120	</param>
2121	</method>
2122
2123	<method name="findDHCPServerByNetworkName">
2124	<desc>
2125	Searches a dhcp server settings to be used for the given internal network name
2126	<result name="E_INVALIDARG">
2127	Host network interface @a name already exists.
2128	</result>
2129
2130	</desc>
2131	<param name="name" type="wstring" dir="in">
2132	<desc>server name</desc>
2133	</param>
2134	<param name="server" type="IDHCPServer" dir="return">
2135	<desc>Dhcp server settings</desc>
2136	</param>
2137	</method>
2138
2139	<!--method name="findDHCPServerForInterface">
2140	<desc>
2141	Searches a dhcp server settings to be used for the given interface
2142	<result name="E_INVALIDARG">
2143	Host network interface @a name already exists.
2144	</result>
2145	</desc>
2146	<param name="interface" type="IHostNetworkInterface" dir="in">
2147	<desc>Network Interface</desc>
2148	</param>
2149	<param name="server" type="IDHCPServer" dir="out">
2150	<desc>Dhcp server settings</desc>
2151	</param>
2152	</method-->
2153
2154	<method name="removeDHCPServer">
2155	<desc>
2156	Removes the dhcp server settings
2157	<result name="E_INVALIDARG">
2158	Host network interface @a name already exists.
2159	</result>
2160	</desc>
2161	<param name="server" type="IDHCPServer" dir="in">
2162	<desc>Dhcp server settings to be removed</desc>
2163	</param>
2164	</method>
2165
2166
2167	<method name="checkFirmwarePresent">
2168	<desc>
2169	Check if this VirtualBox installation has a firmware
2170	of the given type available, either system-wide or per-user.
2171	Optionally, this may return a hint where this firmware can be
2172	downloaded from.
2173	</desc>
2174	<param name="firmwareType" type="FirmwareType" dir="in">
2175	<desc>
2176	Type of firmware to check.
2177	</desc>
2178	</param>
2179	<param name="version" type="wstring" dir="in">
2180	<desc>Expected version number, usually empty string (presently ignored).</desc>
2181	</param>
2182
2183	<param name="url" type="wstring" dir="out">
2184	<desc>
2185	Suggested URL to download this firmware from.
2186	</desc>
2187	</param>
2188
2189	<param name="file" type="wstring" dir="out">
2190	<desc>
2191	Filename of firmware, only valid if result == TRUE.
2192	</desc>
2193	</param>
2194
2195	<param name="result" type="boolean" dir="return">
2196	<desc>If firmware of this type and version is available.</desc>
2197	</param>
2198	</method>
2199
2200	</interface>
2201
2202	<!--
2203	// IVFSExplorer
2204	/////////////////////////////////////////////////////////////////////////
2205	-->
2206
2207	<enum
2208	name="VFSType"
2209	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2210	>
2211	<desc>
2212	Virtual file systems supported by VFSExplorer.
2213	</desc>
2214
2215	<const name="File" value="1" />
2216	<const name="Cloud" value="2" />
2217	<const name="S3" value="3" />
2218	<const name="WebDav" value="4" />
2219	</enum>
2220
2221	<enum
2222	name="VFSFileType"
2223	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2224	>
2225	<desc>
2226	File types known by VFSExplorer.
2227	</desc>
2228
2229	<const name="Unknown" value="1" />
2230	<const name="Fifo" value="2" />
2231	<const name="DevChar" value="3" />
2232	<const name="Directory" value="4" />
2233	<const name="DevBlock" value="5" />
2234	<const name="File" value="6" />
2235	<const name="SymLink" value="7" />
2236	<const name="Socket" value="8" />
2237	<const name="WhiteOut" value="9" />
2238	</enum>
2239
2240	<interface
2241	name="IVFSExplorer" extends="$unknown"
2242	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2243	wsmap="managed"
2244	>
2245	<desc>
2246	The VFSExplorer interface unifies access to different file system
2247	types. This includes local file systems as well remote file systems like
2248	S3. For a list of supported types see <link to="VFSType" />.
2249	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2250	</desc>
2251
2252	<attribute name="path" type="wstring" readonly="yes">
2253	<desc>Returns the current path in the virtual file system.</desc>
2254	</attribute>
2255
2256	<attribute name="type" type="VFSType" readonly="yes">
2257	<desc>Returns the file system type which is currently in use.</desc>
2258	</attribute>
2259
2260	<method name="update">
2261	<desc>Updates the internal list of files/directories from the
2262	current directory level. Use <link to="#entryList" /> to get the full list
2263	after a call to this method.</desc>
2264
2265	<param name="aProgress" type="IProgress" dir="return">
2266	<desc>Progress object to track the operation completion.</desc>
2267	</param>
2268	</method>
2269
2270	<method name="cd">
2271	<desc>Change the current directory level.</desc>
2272
2273	<param name="aDir" type="wstring" dir="in">
2274	<desc>The name of the directory to go in.</desc>
2275	</param>
2276
2277	<param name="aProgress" type="IProgress" dir="return">
2278	<desc>Progress object to track the operation completion.</desc>
2279	</param>
2280	</method>
2281
2282	<method name="cdUp">
2283	<desc>Go one directory upwards from the current directory level.</desc>
2284
2285	<param name="aProgress" type="IProgress" dir="return">
2286	<desc>Progress object to track the operation completion.</desc>
2287	</param>
2288	</method>
2289
2290	<method name="entryList">
2291	<desc>Returns a list of files/directories after a call to <link
2292	to="#update" />. The user is responsible for keeping this internal
2293	list up do date.</desc>
2294
2295	<param name="aNames" type="wstring" safearray="yes" dir="out">
2296	<desc>The list of names for the entries.</desc>
2297	</param>
2298
2299	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2300	<desc>The list of types for the entries.</desc>
2301	</param>
2302
2303	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2304	<desc>The list of sizes (in bytes) for the entries.</desc>
2305	</param>
2306
2307	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2308	<desc>The list of file modes (in octal form) for the entries.</desc>
2309	</param>
2310	</method>
2311
2312	<method name="exists">
2313	<desc>Checks if the given file list exists in the current directory
2314	level.</desc>
2315
2316	<param name="aNames" type="wstring" safearray="yes" dir="in">
2317	<desc>The names to check.</desc>
2318	</param>
2319
2320	<param name="aExists" type="wstring" safearray="yes" dir="return">
2321	<desc>The names which exist.</desc>
2322	</param>
2323	</method>
2324
2325	<method name="remove">
2326	<desc>Deletes the given files in the current directory level.</desc>
2327
2328	<param name="aNames" type="wstring" safearray="yes" dir="in">
2329	<desc>The names to remove.</desc>
2330	</param>
2331
2332	<param name="aProgress" type="IProgress" dir="return">
2333	<desc>Progress object to track the operation completion.</desc>
2334	</param>
2335	</method>
2336
2337	</interface>
2338
2339	<!--
2340	// IAppliance
2341	/////////////////////////////////////////////////////////////////////////
2342	-->
2343
2344	<interface
2345	name="IAppliance" extends="$unknown"
2346	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2347	wsmap="managed"
2348	>
2349	<desc>
2350	Represents a platform-independent appliance in OVF format. An instance of this is returned
2351	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2352	virtual machines within an appliance with VirtualBox.
2353
2354	The OVF standard suggests two different physical file formats:
2355
2356	<ol>
2357	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2358	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2359	this descriptor file references other files such as disk images, as OVF appliances typically
2360	do, those additional files must be in the same directory as the descriptor file.</li>
2361
2362	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2363	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2364	files and optionally other files.
2365
2366	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2367	be added with a later version.</li>
2368	</ol>
2369
2370	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2371	<link to="IMachine" /> involves the following sequence of API calls:
2372
2373	<ol>
2374	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2375	</li>
2376
2377	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2378	would like to import. So long as this file is syntactically valid, this will succeed
2379	and fill the appliance object with the parsed data from the OVF file.
2380	</li>
2381
2382	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2383	contents of the IAppliance attributes accordingly. These can be inspected by a
2384	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2385	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2386	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2387	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2388	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2389	The GUI can then give the user the option to confirm and/or change these suggestions.
2390	</li>
2391
2392	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2393	virtual system (machine) to override the suggestions made by the interpret() routine.
2394	</li>
2395
2396	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2397	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2398	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2399	can be found in the <link to="#machines" /> array attribute.
2400	</li>
2401	</ol>
2402
2403	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2404
2405	<ol>
2406	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2407	an empty IAppliance object.
2408	</li>
2409
2410	<li>For each machine you would like to export, call <link to="IMachine::export" />
2411	with the IAppliance object you just created. Each such call creates one instance of
2412	<link to="IVirtualSystemDescription" /> inside the appliance.
2413	</li>
2414
2415	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2416	virtual system (machine) to override the suggestions made by the export() routine.
2417	</li>
2418
2419	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2420	file written.</li>
2421	</ol>
2422
2423	</desc>
2424
2425	<attribute name="path" type="wstring" readonly="yes">
2426	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2427	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2428	<link to="#write" /> (for export).
2429	This attribute is empty until one of these methods has been called.
2430	</desc>
2431	</attribute>
2432
2433	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2434	<desc>
2435	Array of virtual disk definitions. One such description exists for each
2436	disk definition in the OVF; each string array item represents one such piece of
2437	disk information, with the information fields separated by tab (\\t) characters.
2438
2439	The caller should be prepared for additional fields being appended to
2440	this string in future versions of VirtualBox and therefore check for
2441	the number of tabs in the strings returned.
2442
2443	In the current version, the following eight fields are returned per string
2444	in the array:
2445
2446	<ol>
2447	<li>Disk ID (unique string identifier given to disk)</li>
2448
2449	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2450
2451	<li>Populated size (optional unsigned integer indicating the current size of the
2452	disk; can be approximate; -1 if unspecified)</li>
2453
2454	<li>Format (string identifying the disk format, typically
2455	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2456
2457	<li>Reference (where to find the disk image, typically a file name; if empty,
2458	then the disk should be created on import)</li>
2459
2460	<li>Image size (optional unsigned integer indicating the size of the image,
2461	which need not necessarily be the same as the values specified above, since
2462	the image may be compressed or sparse; -1 if not specified)</li>
2463
2464	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2465	presently unsupported and always -1)</li>
2466
2467	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2468	</ol>
2469	</desc>
2470	</attribute>
2471
2472	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2473	<desc> Array of virtual system descriptions. One such description is created
2474	for each virtual system (machine) found in the OVF.
2475	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2476	(for export) has been called.
2477	</desc>
2478	</attribute>
2479
2480	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2481	<desc>
2482	Contains the UUIDs of the machines created from the information in this appliances. This is only
2483	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2484	succeeded.
2485	</desc>
2486	</attribute>
2487
2488	<method name="read">
2489	<desc>
2490	Reads an OVF file into the appliance object.
2491
2492	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2493	mere fact that this method returns successfully does not mean that VirtualBox supports all
2494	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2495	</desc>
2496	<param name="file" type="wstring" dir="in">
2497	<desc>
2498	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2499	on whether the appliance is distributed as a set of files or as a single file, respectively).
2500	</desc>
2501	</param>
2502	<param name="aProgress" type="IProgress" dir="return">
2503	<desc>Progress object to track the operation completion.</desc>
2504	</param>
2505	</method>
2506
2507	<method name="interpret">
2508	<desc>
2509	Interprets the OVF data that was read when the appliance was constructed. After
2510	calling this method, one can inspect the
2511	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2512	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2513	the appliance.
2514
2515	Calling this method is the second step of importing an appliance into VirtualBox;
2516	see <link to="IAppliance" /> for an overview.
2517
2518	After calling this method, one should call <link to="#getWarnings" /> to find out
2519	if problems were encountered during the processing which might later lead to
2520	errors.
2521	</desc>
2522	</method>
2523
2524	<method name="importMachines">
2525	<desc>
2526	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2527	and other interfaces that match the information contained in the appliance as
2528	closely as possible, as represented by the import instructions in the
2529	<link to="#virtualSystemDescriptions" /> array.
2530
2531	Calling this method is the final step of importing an appliance into VirtualBox;
2532	see <link to="IAppliance" /> for an overview.
2533
2534	Since importing the appliance will most probably involve copying and converting
2535	disk images, which can take a long time, this method operates asynchronously and
2536	returns an IProgress object to allow the caller to monitor the progress.
2537
2538	After the import succeeded, the UUIDs of the IMachine instances created can be
2539	retrieved from the <link to="#machines" /> array attribute.
2540	</desc>
2541
2542	<param name="aProgress" type="IProgress" dir="return">
2543	<desc>Progress object to track the operation completion.</desc>
2544	</param>
2545	</method>
2546
2547	<method name="createVFSExplorer">
2548	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2549
2550	<param name="aUri" type="wstring" dir="in">
2551	<desc>The URI describing the file system to use.</desc>
2552	</param>
2553
2554	<param name="aExplorer" type="IVFSExplorer" dir="return">
2555	<desc></desc>
2556	</param>
2557	</method>
2558
2559	<method name="write">
2560	<desc>
2561	Writes the contents of the appliance exports into a new OVF file.
2562
2563	Calling this method is the final step of exporting an appliance from VirtualBox;
2564	see <link to="IAppliance" /> for an overview.
2565
2566	Since exporting the appliance will most probably involve copying and converting
2567	disk images, which can take a long time, this method operates asynchronously and
2568	returns an IProgress object to allow the caller to monitor the progress.
2569	</desc>
2570	<param name="format" type="wstring" dir="in">
2571	<desc>
2572	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2573	future versions of VirtualBox may support additional formats.
2574	</desc>
2575	</param>
2576	<param name="manifest" type="boolean" dir="in">
2577	<desc>
2578	Indicate if the optional manifest file (.mf) should be written. The manifest file
2579	is used for integrity checks prior import.
2580	</desc>
2581	</param>
2582	<param name="path" type="wstring" dir="in">
2583	<desc>
2584	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2585	on whether the appliance is distributed as a set of files or as a single file, respectively).
2586	</desc>
2587	</param>
2588	<param name="progress" type="IProgress" dir="return">
2589	<desc>Progress object to track the operation completion.</desc>
2590	</param>
2591	</method>
2592
2593	<method name="getWarnings">
2594	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2595
2596	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2597	<desc></desc>
2598	</param>
2599	</method>
2600
2601	</interface>
2602
2603	<enum
2604	name="VirtualSystemDescriptionType"
2605	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2606	>
2607	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2608	a configuration value.</desc>
2609
2610	<const name="Ignore" value="1" />
2611	<const name="OS" value="2" />
2612	<const name="Name" value="3" />
2613	<const name="Product" value="4" />
2614	<const name="Vendor" value="5" />
2615	<const name="Version" value="6" />
2616	<const name="ProductUrl" value="7" />
2617	<const name="VendorUrl" value="8" />
2618	<const name="Description" value="9" />
2619	<const name="License" value="10" />
2620	<const name="Miscellaneous" value="11" />
2621	<const name="CPU" value="12" />
2622	<const name="Memory" value="13" />
2623	<const name="HardDiskControllerIDE" value="14" />
2624	<const name="HardDiskControllerSATA" value="15" />
2625	<const name="HardDiskControllerSCSI" value="16" />
2626	<const name="HardDiskControllerSAS" value="17" />
2627	<const name="HardDiskImage" value="18" />
2628	<const name="Floppy" value="19" />
2629	<const name="CDROM" value="20" />
2630	<const name="NetworkAdapter" value="21" />
2631	<const name="USBController" value="22" />
2632	<const name="SoundCard" value="23" />
2633
2634	</enum>
2635
2636	<enum
2637	name="VirtualSystemDescriptionValueType"
2638	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2639	>
2640	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2641	type to fetch.</desc>
2642
2643	<const name="Reference" value="1" />
2644	<const name="Original" value="2" />
2645	<const name="Auto" value="3" />
2646	<const name="ExtraConfig" value="4" />
2647
2648	</enum>
2649
2650	<interface
2651	name="IVirtualSystemDescription" extends="$unknown"
2652	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2653	wsmap="managed"
2654	>
2655
2656	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2657	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2658	<link to="IAppliance::interpret" /> has been called, that array contains information
2659	about how the virtual systems described in the OVF should best be imported into
2660	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2661	import an OVF into VirtualBox.
2662	</desc>
2663
2664	<attribute name="count" type="unsigned long" readonly="yes">
2665	<desc>Return the number of virtual system description entries.</desc>
2666	</attribute>
2667
2668	<method name="getDescription">
2669	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2670	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2671
2672	The list below identifies the value sets that are possible depending on the
2673	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2674	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2675	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2676	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2677	the @a aExtraConfigValues[] array item may also be used.
2678
2679	<ul>
2680	<li>
2681	"OS": the guest operating system type. There must be exactly one such array item on import. The
2682	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2683	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2684	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2685	</li>
2686	<li>
2687	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2688	if none is present on import, then an automatic name will be created from the operating system
2689	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2690	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2691	<link to="IMachine" /> name that does not exist yet.
2692	</li>
2693	<li>
2694	"Description": an arbitrary description.
2695	</li>
2696	<li>
2697	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2698	code to display such a license for agreement; the Main API does not enforce any such policy.
2699	</li>
2700	<li>
2701	Miscellaneous: reserved for future use.
2702	</li>
2703	<li>
2704	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2705	</li>
2706	<li>
2707	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2708	is present on import, then VirtualBox will set a meaningful default based on the operating system
2709	type.
2710	</li>
2711	<li>
2712	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2713	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2714	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2715	writes into the OVF.
2716	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2717	type can use to specify which hard disk controller a virtual disk should be connected to.
2718	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2719	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2720	its virtual machines supports four channels (primary master, primary slave, secondary master,
2721	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2722	</li>
2723	<li>
2724	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2725	has no value in @a aOvfValues[] or @a aVBoxValues[].
2726	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2727	</li>
2728	<li>
2729	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2730	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2731	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2732	whereas VirtualBox considers it a class of storage controllers of its own; see
2733	<link to="StorageControllerType" />).
2734	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2735	</li>
2736	<li>
2737	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2738	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2739
2740	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2741	a path since the image file should be in the same location as the OVF file itself), whereas the
2742	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2743	hard disk image. This means that on import the image will be copied and converted from the
2744	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2745
2746	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2747	format: "controller=<index>;channel=<c>"
2748	In this string, <index> must be an integer specifying the hard disk controller to connect
2749	the image to. That number must be the index of an array item with one of the hard disk controller
2750	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2751	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2752	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2753	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2754	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2755	</li>
2756	<li>
2757	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2758	attachment information as with "HardDiskImage" items.
2759	</li>
2760	<li>
2761	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2762	attachment information as with "HardDiskImage" items.
2763	</li>
2764	<li>
2765	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2766	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2767	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2768	</li>
2769	<li>
2770	"USBController": a USB controller. There can be at most one such item. If and only if such an
2771	item ispresent, USB support will be enabled for the new virtual machine.
2772	</li>
2773	<li>
2774	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2775	present, sound support will be enabled for the new virtual machine. Note that the virtual
2776	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2777	may be different from the virtual soundcard expected by the appliance.
2778	</li>
2779	</ul>
2780
2781	</desc>
2782
2783	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2784	<desc></desc>
2785	</param>
2786
2787	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2788	<desc></desc>
2789	</param>
2790
2791	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2792	<desc></desc>
2793	</param>
2794
2795	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2796	<desc></desc>
2797	</param>
2798
2799	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2800	<desc></desc>
2801	</param>
2802
2803	</method>
2804
2805	<method name="getDescriptionByType">
2806	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2807	should be returned.</desc>
2808
2809	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2810	<desc></desc>
2811	</param>
2812
2813	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2814	<desc></desc>
2815	</param>
2816
2817	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2818	<desc></desc>
2819	</param>
2820
2821	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2822	<desc></desc>
2823	</param>
2824
2825	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2826	<desc></desc>
2827	</param>
2828
2829	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2830	<desc></desc>
2831	</param>
2832
2833	</method>
2834
2835	<method name="getValuesByType">
2836	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2837	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2838	values.</desc>
2839
2840	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2841	<desc></desc>
2842	</param>
2843
2844	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2845	<desc></desc>
2846	</param>
2847
2848	<param name="aValues" type="wstring" dir="return" safearray="yes">
2849	<desc></desc>
2850	</param>
2851
2852	</method>
2853
2854	<method name="setFinalValues">
2855	<desc>
2856	This method allows the appliance's user to change the configuration for the virtual
2857	system descriptions. For each array item returned from <link to="#getDescription" />,
2858	you must pass in one boolean value and one configuration value.
2859
2860	Each item in the boolean array determines whether the particular configuration item
2861	should be enabled.
2862	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2863	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2864	and SoundCard.
2865
2866	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2867	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2868	the configuration remains unchanged. Please see the documentation for getDescription()
2869	for valid configuration values for the individual array item types. If the
2870	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2871	</desc>
2872
2873	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2874	<desc></desc>
2875	</param>
2876
2877	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2878	<desc></desc>
2879	</param>
2880
2881	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2882	<desc></desc>
2883	</param>
2884	</method>
2885
2886	<method name="addDescription">
2887	<desc>
2888	This method adds an additional description entry to the stack of already
2889	available descriptions for this virtual system. This is handy for writing
2890	values which aren't directly supported by VirtualBox. One example would
2891	be the License type of <link to="VirtualSystemDescriptionType" />.
2892	</desc>
2893
2894	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2895	<desc></desc>
2896	</param>
2897
2898	<param name="aVBoxValue" type="wstring" dir="in">
2899	<desc></desc>
2900	</param>
2901
2902	<param name="aExtraConfigValue" type="wstring" dir="in">
2903	<desc></desc>
2904	</param>
2905	</method>
2906	</interface>
2907
2908
2909	<!--
2910	// IMachine
2911	/////////////////////////////////////////////////////////////////////////
2912	-->
2913
2914	<interface
2915	name="IInternalMachineControl" extends="$unknown"
2916	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2917	internal="yes"
2918	wsmap="suppress"
2919	>
2920	<method name="setRemoveSavedStateFile">
2921	<desc>
2922	Updates the flag whether the saved state file is removed on a
2923	machine state change from Saved to PoweredOff.
2924	</desc>
2925	<param name="aRemove" type="boolean" dir="in"/>
2926	</method>
2927
2928	<method name="updateState">
2929	<desc>
2930	Updates the VM state.
2931	<note>
2932	This operation will also update the settings file with the correct
2933	information about the saved state file and delete this file from disk
2934	when appropriate.
2935	</note>
2936	</desc>
2937	<param name="state" type="MachineState" dir="in"/>
2938	</method>
2939
2940	<method name="getIPCId">
2941	<param name="id" type="wstring" dir="return"/>
2942	</method>
2943
2944	<method name="beginPowerUp">
2945	<desc>
2946	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2947	gives it the progress object that should be part of any pending
2948	<link to="IMachine::launchVMProcess"/> operations. The progress
2949	object may be called back to reflect an early cancelation, so some care
2950	have to be taken with respect to any cancelation callbacks. The console
2951	object will call <link to="IInternalMachineControl::endPowerUp"/>
2952	to signal the completion of the progress object.
2953	</desc>
2954	<param name="aProgress" type="IProgress" dir="in" />
2955	</method>
2956
2957	<method name="endPowerUp">
2958	<desc>
2959	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2960	This method may query status information from the progress object it
2961	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2962	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2963	call in order to complete that progress object.
2964	</desc>
2965	<param name="result" type="long" dir="in"/>
2966	</method>
2967
2968	<method name="beginPoweringDown">
2969	<desc>
2970	Called by the VM process to inform the server it wants to
2971	stop the VM execution and power down.
2972	</desc>
2973	<param name="progress" type="IProgress" dir="out">
2974	<desc>
2975	Progress object created by VBoxSVC to wait until
2976	the VM is powered down.
2977	</desc>
2978	</param>
2979	</method>
2980
2981	<method name="endPoweringDown">
2982	<desc>
2983	Called by the VM process to inform the server that powering
2984	down previously requested by #beginPoweringDown is either
2985	successfully finished or there was a failure.
2986
2987	<result name="VBOX_E_FILE_ERROR">
2988	Settings file not accessible.
2989	</result>
2990	<result name="VBOX_E_XML_ERROR">
2991	Could not parse the settings file.
2992	</result>
2993
2994	</desc>
2995
2996	<param name="result" type="long" dir="in">
2997	<desc>@c S_OK to indicate success.
2998	</desc>
2999	</param>
3000	<param name="errMsg" type="wstring" dir="in">
3001	<desc>@c human readable error message in case of failure.
3002	</desc>
3003	</param>
3004	</method>
3005
3006	<method name="runUSBDeviceFilters">
3007	<desc>
3008	Asks the server to run USB devices filters of the associated
3009	machine against the given USB device and tell if there is
3010	a match.
3011	<note>
3012	Intended to be used only for remote USB devices. Local
3013	ones don't require to call this method (this is done
3014	implicitly by the Host and USBProxyService).
3015	</note>
3016	</desc>
3017	<param name="device" type="IUSBDevice" dir="in"/>
3018	<param name="matched" type="boolean" dir="out"/>
3019	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3020	</method>
3021
3022	<method name="captureUSBDevice">
3023	<desc>
3024	Requests a capture of the given host USB device.
3025	When the request is completed, the VM process will
3026	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3027	notification.
3028	</desc>
3029	<param name="id" type="uuid" mod="string" dir="in"/>
3030	</method>
3031
3032	<method name="detachUSBDevice">
3033	<desc>
3034	Notification that a VM is going to detach (@a done = @c false) or has
3035	already detached (@a done = @c true) the given USB device.
3036	When the @a done = @c true request is completed, the VM process will
3037	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3038	notification.
3039	<note>
3040	In the @a done = @c true case, the server must run its own filters
3041	and filters of all VMs but this one on the detached device
3042	as if it were just attached to the host computer.
3043	</note>
3044	</desc>
3045	<param name="id" type="uuid" mod="string" dir="in"/>
3046	<param name="done" type="boolean" dir="in"/>
3047	</method>
3048
3049	<method name="autoCaptureUSBDevices">
3050	<desc>
3051	Requests a capture all matching USB devices attached to the host.
3052	When the request is completed, the VM process will
3053	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3054	notification per every captured device.
3055	</desc>
3056	</method>
3057
3058	<method name="detachAllUSBDevices">
3059	<desc>
3060	Notification that a VM that is being powered down. The done
3061	parameter indicates whether which stage of the power down
3062	we're at. When @a done = @c false the VM is announcing its
3063	intentions, while when @a done = @c true the VM is reporting
3064	what it has done.
3065	<note>
3066	In the @a done = @c true case, the server must run its own filters
3067	and filters of all VMs but this one on all detach devices as
3068	if they were just attached to the host computer.
3069	</note>
3070	</desc>
3071	<param name="done" type="boolean" dir="in"/>
3072	</method>
3073
3074	<method name="onSessionEnd">
3075	<desc>
3076	Triggered by the given session object when the session is about
3077	to close normally.
3078	</desc>
3079	<param name="session" type="ISession" dir="in">
3080	<desc>Session that is being closed</desc>
3081	</param>
3082	<param name="progress" type="IProgress" dir="return">
3083	<desc>
3084	Used to wait until the corresponding machine is actually
3085	dissociated from the given session on the server.
3086	Returned only when this session is a direct one.
3087	</desc>
3088	</param>
3089	</method>
3090
3091	<method name="beginSavingState">
3092	<desc>
3093	Called by the VM process to inform the server it wants to
3094	save the current state and stop the VM execution.
3095	</desc>
3096	<param name="progress" type="IProgress" dir="out">
3097	<desc>
3098	Progress object created by VBoxSVC to wait until
3099	the state is saved.
3100	</desc>
3101	</param>
3102	<param name="stateFilePath" type="wstring" dir="out">
3103	<desc>
3104	File path the VM process must save the execution state to.
3105	</desc>
3106	</param>
3107	</method>
3108
3109	<method name="endSavingState">
3110	<desc>
3111	Called by the VM process to inform the server that saving
3112	the state previously requested by #beginSavingState is either
3113	successfully finished or there was a failure.
3114
3115	<result name="VBOX_E_FILE_ERROR">
3116	Settings file not accessible.
3117	</result>
3118	<result name="VBOX_E_XML_ERROR">
3119	Could not parse the settings file.
3120	</result>
3121
3122	</desc>
3123
3124	<param name="result" type="long" dir="in">
3125	<desc>@c S_OK to indicate success.
3126	</desc>
3127	</param>
3128	<param name="errMsg" type="wstring" dir="in">
3129	<desc>@c human readable error message in case of failure.
3130	</desc>
3131	</param>
3132	</method>
3133
3134	<method name="adoptSavedState">
3135	<desc>
3136	Gets called by IConsole::adoptSavedState.
3137	<result name="VBOX_E_FILE_ERROR">
3138	Invalid saved state file path.
3139	</result>
3140	</desc>
3141	<param name="savedStateFile" type="wstring" dir="in">
3142	<desc>Path to the saved state file to adopt.</desc>
3143	</param>
3144	</method>
3145
3146	<method name="beginTakingSnapshot">
3147	<desc>
3148	Called from the VM process to request from the server to perform the
3149	server-side actions of creating a snapshot (creating differencing images
3150	and the snapshot object).
3151
3152	<result name="VBOX_E_FILE_ERROR">
3153	Settings file not accessible.
3154	</result>
3155	<result name="VBOX_E_XML_ERROR">
3156	Could not parse the settings file.
3157	</result>
3158	</desc>
3159	<param name="initiator" type="IConsole" dir="in">
3160	<desc>The console object that initiated this call.</desc>
3161	</param>
3162	<param name="name" type="wstring" dir="in">
3163	<desc>Snapshot name.</desc>
3164	</param>
3165	<param name="description" type="wstring" dir="in">
3166	<desc>Snapshot description.</desc>
3167	</param>
3168	<param name="consoleProgress" type="IProgress" dir="in">
3169	<desc>
3170	Progress object created by the VM process tracking the
3171	snapshot's progress. This has the following sub-operations:
3172	<ul>
3173	<li>setting up (weight 1);</li>
3174	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3175	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3176	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3177	<li>finishing up (weight 1)</li>
3178	</ul>
3179	</desc>
3180	</param>
3181	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3182	<desc>
3183	Whether this is an online snapshot (i.e. the machine is running).
3184	</desc>
3185	</param>
3186	<param name="stateFilePath" type="wstring" dir="out">
3187	<desc>
3188	File path the VM process must save the execution state to.
3189	</desc>
3190	</param>
3191	</method>
3192
3193	<method name="endTakingSnapshot">
3194	<desc>
3195	Called by the VM process to inform the server that the snapshot
3196	previously requested by #beginTakingSnapshot is either
3197	successfully taken or there was a failure.
3198	</desc>
3199
3200	<param name="success" type="boolean" dir="in">
3201	<desc>@c true to indicate success and @c false otherwise</desc>
3202	</param>
3203	</method>
3204
3205	<method name="deleteSnapshot">
3206	<desc>
3207	Gets called by IConsole::deleteSnapshot.
3208	<result name="VBOX_E_INVALID_OBJECT_STATE">
3209	Snapshot has more than one child snapshot.
3210	</result>
3211	</desc>
3212	<param name="initiator" type="IConsole" dir="in">
3213	<desc>The console object that initiated this call.</desc>
3214	</param>
3215	<param name="id" type="uuid" mod="string" dir="in">
3216	<desc>UUID of the snapshot to delete.</desc>
3217	</param>
3218	<param name="machineState" type="MachineState" dir="out">
3219	<desc>New machine state after this operation is started.</desc>
3220	</param>
3221	<param name="progress" type="IProgress" dir="return">
3222	<desc>Progress object to track the operation completion.</desc>
3223	</param>
3224	</method>
3225
3226	<method name="finishOnlineMergeMedium">
3227	<desc>
3228	Gets called by IConsole::onlineMergeMedium.
3229	</desc>
3230	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3231	<desc>The medium attachment which needs to be cleaned up.</desc>
3232	</param>
3233	<param name="source" type="IMedium" dir="in">
3234	<desc>Merge source medium.</desc>
3235	</param>
3236	<param name="target" type="IMedium" dir="in">
3237	<desc>Merge target medium.</desc>
3238	</param>
3239	<param name="mergeForward" type="boolean" dir="in">
3240	<desc>Merge direction.</desc>
3241	</param>
3242	<param name="parentForTarget" type="IMedium" dir="in">
3243	<desc>For forward merges: new parent for target medium.</desc>
3244	</param>
3245	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3246	<desc>For backward merges: list of media which need their parent UUID
3247	updated.</desc>
3248	</param>
3249	</method>
3250
3251	<method name="restoreSnapshot">
3252	<desc>
3253	Gets called by IConsole::RestoreSnapshot.
3254	</desc>
3255	<param name="initiator" type="IConsole" dir="in">
3256	<desc>The console object that initiated this call.</desc>
3257	</param>
3258	<param name="snapshot" type="ISnapshot" dir="in">
3259	<desc>The snapshot to restore the VM state from.</desc>
3260	</param>
3261	<param name="machineState" type="MachineState" dir="out">
3262	<desc>New machine state after this operation is started.</desc>
3263	</param>
3264	<param name="progress" type="IProgress" dir="return">
3265	<desc>Progress object to track the operation completion.</desc>
3266	</param>
3267	</method>
3268
3269	<method name="pullGuestProperties">
3270	<desc>
3271	Get the list of the guest properties matching a set of patterns along
3272	with their values, time stamps and flags and give responsibility for
3273	managing properties to the console.
3274	</desc>
3275	<param name="name" type="wstring" dir="out" safearray="yes">
3276	<desc>
3277	The names of the properties returned.
3278	</desc>
3279	</param>
3280	<param name="value" type="wstring" dir="out" safearray="yes">
3281	<desc>
3282	The values of the properties returned. The array entries match the
3283	corresponding entries in the @a name array.
3284	</desc>
3285	</param>
3286	<param name="timestamp" type="long long" dir="out" safearray="yes">
3287	<desc>
3288	The time stamps of the properties returned. The array entries match
3289	the corresponding entries in the @a name array.
3290	</desc>
3291	</param>
3292	<param name="flags" type="wstring" dir="out" safearray="yes">
3293	<desc>
3294	The flags of the properties returned. The array entries match the
3295	corresponding entries in the @a name array.
3296	</desc>
3297	</param>
3298	</method>
3299
3300	<method name="pushGuestProperty">
3301	<desc>
3302	Update a single guest property in IMachine.
3303	</desc>
3304	<param name="name" type="wstring" dir="in">
3305	<desc>
3306	The name of the property to be updated.
3307	</desc>
3308	</param>
3309	<param name="value" type="wstring" dir="in">
3310	<desc>
3311	The value of the property.
3312	</desc>
3313	</param>
3314	<param name="timestamp" type="long long" dir="in">
3315	<desc>
3316	The timestamp of the property.
3317	</desc>
3318	</param>
3319	<param name="flags" type="wstring" dir="in">
3320	<desc>
3321	The flags of the property.
3322	</desc>
3323	</param>
3324	</method>
3325
3326	<method name="lockMedia">
3327	<desc>
3328	Locks all media attached to the machine for writing and parents of
3329	attached differencing media (if any) for reading. This operation is
3330	atomic so that if it fails no media is actually locked.
3331
3332	This method is intended to be called when the machine is in Starting or
3333	Restoring state. The locked media will be automatically unlocked when
3334	the machine is powered off or crashed.
3335	</desc>
3336	</method>
3337	<method name="unlockMedia">
3338	<desc>
3339	Unlocks all media previously locked using
3340	<link to="IInternalMachineControl::lockMedia"/>.
3341
3342	This method is intended to be used with teleportation so that it is
3343	possible to teleport between processes on the same machine.
3344	</desc>
3345	</method>
3346	</interface>
3347
3348	<interface
3349	name="IBIOSSettings" extends="$unknown"
3350	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3351	wsmap="managed"
3352	>
3353	<desc>
3354	The IBIOSSettings interface represents BIOS settings of the virtual
3355	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3356	</desc>
3357	<attribute name="logoFadeIn" type="boolean">
3358	<desc>Fade in flag for BIOS logo animation.</desc>
3359	</attribute>
3360
3361	<attribute name="logoFadeOut" type="boolean">
3362	<desc>Fade out flag for BIOS logo animation.</desc>
3363	</attribute>
3364
3365	<attribute name="logoDisplayTime" type="unsigned long">
3366	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3367	</attribute>
3368
3369	<attribute name="logoImagePath" type="wstring">
3370	<desc>
3371	Local file system path for external BIOS splash image. Empty string
3372	means the default image is shown on boot.
3373	</desc>
3374	</attribute>
3375
3376	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3377	<desc>Mode of the BIOS boot device menu.</desc>
3378	</attribute>
3379
3380	<attribute name="ACPIEnabled" type="boolean">
3381	<desc>ACPI support flag.</desc>
3382	</attribute>
3383
3384	<attribute name="IOAPICEnabled" type="boolean">
3385	<desc>
3386	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3387	and support IRQs above 15.
3388	</desc>
3389	</attribute>
3390
3391	<attribute name="timeOffset" type="long long">
3392	<desc>
3393	Offset in milliseconds from the host system time. This allows for
3394	guests running with a different system date/time than the host.
3395	It is equivalent to setting the system date/time in the BIOS except
3396	it is not an absolute value but a relative one. Guest Additions
3397	time synchronization honors this offset.
3398	</desc>
3399	</attribute>
3400
3401	<attribute name="PXEDebugEnabled" type="boolean">
3402	<desc>
3403	PXE debug logging flag. If set, VirtualBox will write extensive
3404	PXE trace information to the release log.
3405	</desc>
3406	</attribute>
3407
3408	</interface>
3409
3410	<enum
3411	name="CleanupMode"
3412	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3413	>
3414	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3415	</desc>
3416	<const name="UnregisterOnly" value="1">
3417	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3418	</const>
3419	<const name="DetachAllReturnNone" value="2">
3420	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3421	</const>
3422	<const name="DetachAllReturnHardDisksOnly" value="3">
3423	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removeable media.</desc>
3424	</const>
3425	<const name="Full" value="4">
3426	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3427	</const>
3428	</enum>
3429
3430	<interface
3431	name="IPciAddress" extends="$unknown"
3432	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3433	wsmap="struct"
3434	>
3435
3436	<desc>
3437	Address on the PCI bus.
3438	</desc>
3439
3440	<attribute name="bus" type="short">
3441	<desc>
3442	Bus number.
3443	</desc>
3444	</attribute>
3445
3446	<attribute name="device" type="short">
3447	<desc>
3448	Device number.
3449	</desc>
3450	</attribute>
3451
3452	<attribute name="devFunction" type="short">
3453	<desc>
3454	Device function number.
3455	</desc>
3456	</attribute>
3457
3458	<method name="asLong">
3459	<desc>
3460	Convert PCI address into long.
3461	</desc>
3462	<param name="result" type="long" dir="return" />
3463	</method>
3464
3465	<method name="fromLong">
3466	<desc>
3467	Make PCI address from long.
3468	</desc>
3469	<param name="number" type="long" dir="in" />
3470	</method>
3471	</interface>
3472
3473	<interface
3474	name="IPciDeviceAttachment" extends="$unknown"
3475	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3476	wsmap="struct"
3477	>
3478
3479	<desc>
3480	Information about PCI attachments.
3481	</desc>
3482
3483	<attribute name="name" type="wstring" readonly="yes">
3484	<desc>
3485	Device name.
3486	</desc>
3487	</attribute>
3488
3489	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3490	<desc>
3491	If this is physical or virtual device.
3492	</desc>
3493	</attribute>
3494
3495	<attribute name="hostAddress" type="long" readonly="yes">
3496	<desc>
3497	Address of device on the host, applicable only to host devices.
3498	</desc>
3499	</attribute>
3500
3501	<attribute name="guestAddress" type="long" readonly="yes">
3502	<desc>
3503	Address of device on the guest.
3504	</desc>
3505	</attribute>
3506
3507	</interface>
3508
3509
3510	<interface
3511	name="IMachine" extends="$unknown"
3512	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3513	wsmap="managed"
3514	>
3515	<desc>
3516	The IMachine interface represents a virtual machine, or guest, created
3517	in VirtualBox.
3518
3519	This interface is used in two contexts. First of all, a collection of
3520	objects implementing this interface is stored in the
3521	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3522	machines that are currently registered with this VirtualBox
3523	installation. Also, once a session has been opened for the given virtual
3524	machine (e.g. the virtual machine is running), the machine object
3525	associated with the open session can be queried from the session object;
3526	see <link to="ISession"/> for details.
3527
3528	The main role of this interface is to expose the settings of the virtual
3529	machine and provide methods to change various aspects of the virtual
3530	machine's configuration. For machine objects stored in the
3531	<link to="IVirtualBox::machines"/> collection, all attributes are
3532	read-only unless explicitly stated otherwise in individual attribute
3533	and method descriptions.
3534
3535	In order to change a machine setting, a session for this machine must be
3536	opened using one of the <link to="IMachine::lockMachine" /> or
3537	<link to="IMachine::launchVMProcess"/> methods. After the
3538	machine has been successfully locked for a session, a mutable machine object
3539	needs to be queried from the session object and then the desired settings
3540	changes can be applied to the returned object using IMachine attributes and
3541	methods. See the <link to="ISession"/> interface description for more
3542	information about sessions.
3543
3544	Note that IMachine does not provide methods to control virtual machine
3545	execution (such as start the machine, or power it down) -- these methods
3546	are grouped in a separate interface called <link to="IConsole" />.
3547
3548	<see>ISession, IConsole</see>
3549	</desc>
3550
3551	<attribute name="parent" type="IVirtualBox" readonly="yes">
3552	<desc>Associated parent object.</desc>
3553	</attribute>
3554
3555	<attribute name="accessible" type="boolean" readonly="yes">
3556	<desc>
3557	Whether this virtual machine is currently accessible or not.
3558
3559	A machine is always deemed accessible unless it is registered <i>and</i>
3560	its settings file cannot be read or parsed (either because the file itself
3561	is unavailable or has invalid XML contents).
3562
3563	Every time this property is read, the accessibility state of
3564	this machine is re-evaluated. If the returned value is @c false,
3565	the <link to="#accessError"/> property may be used to get the
3566	detailed error information describing the reason of
3567	inaccessibility, including XML error messages.
3568
3569	When the machine is inaccessible, only the following properties
3570	can be used on it:
3571	<ul>
3572	<li><link to="#parent"/></li>
3573	<li><link to="#id"/></li>
3574	<li><link to="#settingsFilePath"/></li>
3575	<li><link to="#accessible"/></li>
3576	<li><link to="#accessError"/></li>
3577	</ul>
3578
3579	An attempt to access any other property or method will return
3580	an error.
3581
3582	The only possible action you can perform on an inaccessible
3583	machine is to unregister it using the
3584	<link to="IMachine::unregister"/> call (or, to check
3585	for the accessibility state once more by querying this
3586	property).
3587
3588	<note>
3589	In the current implementation, once this property returns
3590	@c true, the machine will never become inaccessible
3591	later, even if its settings file cannot be successfully
3592	read/written any more (at least, until the VirtualBox
3593	server is restarted). This limitation may be removed in
3594	future releases.
3595	</note>
3596	</desc>
3597	</attribute>
3598
3599	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3600	<desc>
3601	Error information describing the reason of machine
3602	inaccessibility.
3603
3604	Reading this property is only valid after the last call to
3605	<link to="#accessible"/> returned @c false (i.e. the
3606	machine is currently inaccessible). Otherwise, a @c null
3607	IVirtualBoxErrorInfo object will be returned.
3608	</desc>
3609	</attribute>
3610
3611	<attribute name="name" type="wstring">
3612	<desc>
3613	Name of the virtual machine.
3614
3615	Besides being used for human-readable identification purposes
3616	everywhere in VirtualBox, the virtual machine name is also used
3617	as a name of the machine's settings file and as a name of the
3618	subdirectory this settings file resides in. Thus, every time you
3619	change the value of this property, the settings file will be
3620	renamed once you call <link to="#saveSettings"/> to confirm the
3621	change. The containing subdirectory will be also renamed, but
3622	only if it has exactly the same name as the settings file
3623	itself prior to changing this property (for backward compatibility
3624	with previous API releases). The above implies the following
3625	limitations:
3626	<ul>
3627	<li>The machine name cannot be empty.</li>
3628	<li>The machine name can contain only characters that are valid
3629	file name characters according to the rules of the file
3630	system used to store VirtualBox configuration.</li>
3631	<li>You cannot have two or more machines with the same name
3632	if they use the same subdirectory for storing the machine
3633	settings files.</li>
3634	<li>You cannot change the name of the machine if it is running,
3635	or if any file in the directory containing the settings file
3636	is being used by another running machine or by any other
3637	process in the host operating system at a time when
3638	<link to="#saveSettings"/> is called.
3639	</li>
3640	</ul>
3641	If any of the above limitations are hit, <link to="#saveSettings"/>
3642	will return an appropriate error message explaining the exact
3643	reason and the changes you made to this machine will not be saved.
3644
3645	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3646	file is recommended, but not enforced. (Previous versions always
3647	used a generic ".xml" extension.)
3648	</desc>
3649	</attribute>
3650
3651	<attribute name="description" type="wstring">
3652	<desc>
3653	Description of the virtual machine.
3654
3655	The description attribute can contain any text and is
3656	typically used to describe the hardware and software
3657	configuration of the virtual machine in detail (i.e. network
3658	settings, versions of the installed software and so on).
3659	</desc>
3660	</attribute>
3661
3662	<attribute name="id" type="uuid" mod="string" readonly="yes">
3663	<desc>UUID of the virtual machine.</desc>
3664	</attribute>
3665
3666	<attribute name="OSTypeId" type="wstring">
3667	<desc>
3668	User-defined identifier of the Guest OS type.
3669	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3670	an IGuestOSType object representing details about the given
3671	Guest OS type.
3672	<note>
3673	This value may differ from the value returned by
3674	<link to="IGuest::OSTypeId"/> if Guest Additions are
3675	installed to the guest OS.
3676	</note>
3677	</desc>
3678	</attribute>
3679
3680	<attribute name="HardwareVersion" type="wstring">
3681	<desc>Hardware version identifier. Internal use only for now.</desc>
3682	</attribute>
3683
3684	<attribute name="hardwareUUID" type="uuid" mod="string">
3685	<desc>
3686	The UUID presented to the guest via memory tables, hardware and guest
3687	properties. For most VMs this is the same as the @a id, but for VMs
3688	which have been cloned or teleported it may be the same as the source
3689	VM. This latter is because the guest shouldn't notice that it was
3690	cloned or teleported.
3691	</desc>
3692	</attribute>
3693
3694	<attribute name="CPUCount" type="unsigned long">
3695	<desc>Number of virtual CPUs in the VM.</desc>
3696	</attribute>
3697
3698	<attribute name="CPUHotPlugEnabled" type="boolean">
3699	<desc>
3700	This setting determines whether VirtualBox allows CPU
3701	hotplugging for this machine.</desc>
3702	</attribute>
3703
3704	<attribute name="CPUExecutionCap" type="unsigned long">
3705	<desc>
3706	Means to limit the number of CPU cycles a guest can use. The unit
3707	is percentage of host CPU cycles per second. The valid range
3708	is 1 - 100. 100 (the default) implies no limit.
3709	</desc>
3710	</attribute>
3711
3712	<attribute name="memorySize" type="unsigned long">
3713	<desc>System memory size in megabytes.</desc>
3714	</attribute>
3715
3716	<attribute name="memoryBalloonSize" type="unsigned long">
3717	<desc>Memory balloon size in megabytes.</desc>
3718	</attribute>
3719
3720	<attribute name="PageFusionEnabled" type="boolean">
3721	<desc>
3722	This setting determines whether VirtualBox allows page
3723	fusion for this machine (64 bits host only).
3724	</desc>
3725	</attribute>
3726
3727	<attribute name="VRAMSize" type="unsigned long">
3728	<desc>Video memory size in megabytes.</desc>
3729	</attribute>
3730
3731	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3732	<desc>
3733	This setting determines whether VirtualBox allows this machine to make
3734	use of the 3D graphics support available on the host.</desc>
3735	</attribute>
3736
3737	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3738	<desc>
3739	This setting determines whether VirtualBox allows this machine to make
3740	use of the 2D video acceleration support available on the host.</desc>
3741	</attribute>
3742
3743	<attribute name="monitorCount" type="unsigned long">
3744	<desc>
3745	Number of virtual monitors.
3746	<note>
3747	Only effective on Windows XP and later guests with
3748	Guest Additions installed.
3749	</note>
3750	</desc>
3751	</attribute>
3752
3753	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3754	<desc>Object containing all BIOS settings.</desc>
3755	</attribute>
3756
3757	<attribute name="firmwareType" type="FirmwareType">
3758	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3759	bootstrap in this VM.</desc>
3760	</attribute>
3761
3762	<attribute name="pointingHidType" type="PointingHidType">
3763	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3764	The default is typically "PS2Mouse" but can vary depending on the
3765	requirements of the guest operating system.</desc>
3766	</attribute>
3767
3768	<attribute name="keyboardHidType" type="KeyboardHidType">
3769	<desc>Type of keyboard HID used in this VM.
3770	The default is typically "PS2Keyboard" but can vary depending on the
3771	requirements of the guest operating system.</desc>
3772	</attribute>
3773
3774	<attribute name="hpetEnabled" type="boolean">
3775	<desc>This attribute controls if High Precision Event Timer (HPET) is
3776	enabled in this VM. Use this property if you want to provide guests
3777	with additional time source, or if guest requires HPET to function correctly.
3778	Default is false.</desc>
3779	</attribute>
3780
3781	<attribute name="chipsetType" type="ChipsetType">
3782	<desc>Chipset type used in this VM.</desc>
3783	</attribute>
3784
3785	<attribute name="snapshotFolder" type="wstring">
3786	<desc>
3787	Full path to the directory used to store snapshot data
3788	(differencing media and saved state files) of this machine.
3789
3790	The initial value of this property is
3791	<tt><</tt><link to="#settingsFilePath">
3792	path_to_settings_file</link><tt>>/<</tt>
3793	<link to="#id">machine_uuid</link>
3794	<tt>></tt>.
3795
3796	Currently, it is an error to try to change this property on
3797	a machine that has snapshots (because this would require to
3798	move possibly large files to a different location).
3799	A separate method will be available for this purpose later.
3800
3801	<note>
3802	Setting this property to @c null or to an empty string will restore
3803	the initial value.
3804	</note>
3805	<note>
3806	When setting this property, the specified path can be
3807	absolute (full path) or relative to the directory where the
3808	<link to="#settingsFilePath">machine settings file</link>
3809	is located. When reading this property, a full path is
3810	always returned.
3811	</note>
3812	<note>
3813	The specified path may not exist, it will be created
3814	when necessary.
3815	</note>
3816	</desc>
3817	</attribute>
3818
3819	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3820	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3821	</attribute>
3822
3823	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3824	<desc>Array of media attached to this machine.</desc>
3825	</attribute>
3826
3827	<attribute name="USBController" type="IUSBController" readonly="yes">
3828	<desc>
3829	Associated USB controller object.
3830
3831	<note>
3832	If USB functionality is not available in the given edition of
3833	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3834	</note>
3835	</desc>
3836	</attribute>
3837
3838	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3839	<desc>Associated audio adapter, always present.</desc>
3840	</attribute>
3841
3842	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3843	<desc>Array of storage controllers attached to this machine.</desc>
3844	</attribute>
3845
3846	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3847	<desc>
3848	Full name of the file containing machine settings data.
3849	</desc>
3850	</attribute>
3851
3852	<attribute name="settingsModified" type="boolean" readonly="yes">
3853	<desc>
3854	Whether the settings of this machine have been modified
3855	(but neither yet saved nor discarded).
3856	<note>
3857	Reading this property is only valid on instances returned
3858	by <link to="ISession::machine"/> and on new machines
3859	created by <link to="IVirtualBox::createMachine"/> or opened
3860	by <link to="IVirtualBox::openMachine"/> but not
3861	yet registered, or on unregistered machines after calling
3862	<link to="IMachine::unregister"/>. For all other
3863	cases, the settings can never be modified.
3864	</note>
3865	<note>
3866	For newly created unregistered machines, the value of this
3867	property is always @c true until <link to="#saveSettings"/>
3868	is called (no matter if any machine settings have been
3869	changed after the creation or not). For opened machines
3870	the value is set to @c false (and then follows to normal rules).
3871	</note>
3872	</desc>
3873	</attribute>
3874
3875	<attribute name="sessionState" type="SessionState" readonly="yes">
3876	<desc>Current session state for this machine.</desc>
3877	</attribute>
3878
3879	<attribute name="sessionType" type="wstring" readonly="yes">
3880	<desc>
3881	Type of the session. If <link to="#sessionState"/> is
3882	Spawning or Locked, this attribute contains the
3883	same value as passed to the
3884	<link to="IMachine::launchVMProcess"/> method in the
3885	@a type parameter. If the session was used with
3886	<link to="IMachine::lockMachine" />, or if
3887	<link to="#sessionState"/> is SessionClosed, the value of this
3888	attribute is an empty string.
3889	</desc>
3890	</attribute>
3891
3892	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3893	<desc>
3894	Identifier of the session process. This attribute contains the
3895	platform-dependent identifier of the process whose session was
3896	used with <link to="IMachine::lockMachine" /> call. The returned
3897	value is only valid if <link to="#sessionState"/> is Locked or
3898	Unlocking by the time this property is read.
3899	</desc>
3900	</attribute>
3901
3902	<attribute name="state" type="MachineState" readonly="yes">
3903	<desc>Current execution state of this machine.</desc>
3904	</attribute>
3905
3906	<attribute name="lastStateChange" type="long long" readonly="yes">
3907	<desc>
3908	Time stamp of the last execution state change,
3909	in milliseconds since 1970-01-01 UTC.
3910	</desc>
3911	</attribute>
3912
3913	<attribute name="stateFilePath" type="wstring" readonly="yes">
3914	<desc>
3915	Full path to the file that stores the execution state of
3916	the machine when it is in the <link to="MachineState_Saved"/> state.
3917	<note>
3918	When the machine is not in the Saved state, this attribute is
3919	an empty string.
3920	</note>
3921	</desc>
3922	</attribute>
3923
3924	<attribute name="logFolder" type="wstring" readonly="yes">
3925	<desc>
3926	Full path to the folder that stores a set of rotated log files
3927	recorded during machine execution. The most recent log file is
3928	named <tt>VBox.log</tt>, the previous log file is
3929	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3930	in the current version).
3931	</desc>
3932	</attribute>
3933
3934	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3935	<desc>
3936	Current snapshot of this machine. This is @c null if the machine
3937	currently has no snapshots. If it is not @c null, then it was
3938	set by one of <link to="IConsole::takeSnapshot" />,
3939	<link to="IConsole::deleteSnapshot" />
3940	or <link to="IConsole::restoreSnapshot" />, depending on which
3941	was called last. See <link to="ISnapshot"/> for details.
3942	</desc>
3943	</attribute>
3944
3945	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3946	<desc>
3947	Number of snapshots taken on this machine. Zero means the
3948	machine doesn't have any snapshots.
3949	</desc>
3950	</attribute>
3951
3952	<attribute name="currentStateModified" type="boolean" readonly="yes">
3953	<desc>
3954	Returns @c true if the current state of the machine is not
3955	identical to the state stored in the current snapshot.
3956
3957	The current state is identical to the current snapshot only
3958	directly after one of the following calls are made:
3959
3960	<ul>
3961	<li><link to="IConsole::restoreSnapshot"/>
3962	</li>
3963	<li><link to="IConsole::takeSnapshot"/> (issued on a
3964	"powered off" or "saved" machine, for which
3965	<link to="#settingsModified"/> returns @c false)
3966	</li>
3967	</ul>
3968
3969	The current state remains identical until one of the following
3970	happens:
3971	<ul>
3972	<li>settings of the machine are changed</li>
3973	<li>the saved state is deleted</li>
3974	<li>the current snapshot is deleted</li>
3975	<li>an attempt to execute the machine is made</li>
3976	</ul>
3977
3978	<note>
3979	For machines that don't have snapshots, this property is
3980	always @c false.
3981	</note>
3982	</desc>
3983	</attribute>
3984
3985	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3986	<desc>
3987	Collection of shared folders for this machine (permanent shared
3988	folders). These folders are shared automatically at machine startup
3989	and available only to the guest OS installed within this machine.
3990
3991	New shared folders are added to the collection using
3992	<link to="#createSharedFolder"/>. Existing shared folders can be
3993	removed using <link to="#removeSharedFolder"/>.
3994	</desc>
3995	</attribute>
3996
3997	<attribute name="clipboardMode" type="ClipboardMode">
3998	<desc>
3999	Synchronization mode between the host OS clipboard
4000	and the guest OS clipboard.
4001	</desc>
4002	</attribute>
4003
4004	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4005	<desc>
4006	A comma-separated list of simple glob patterns. Changes to guest
4007	properties whose name matches one of the patterns will generate an
4008	<link to="IGuestPropertyChangedEvent"/> signal.
4009	</desc>
4010	</attribute>
4011
4012	<attribute name="teleporterEnabled" type="boolean">
4013	<desc>
4014	When set to @a true, the virtual machine becomes a target teleporter
4015	the next time it is powered on. This can only set to @a true when the
4016	VM is in the @a PoweredOff or @a Aborted state.
4017
4018	<!-- This property is automatically set to @a false when the VM is powered
4019	on. (bird: This doesn't work yet ) -->
4020	</desc>
4021	</attribute>
4022
4023	<attribute name="teleporterPort" type="unsigned long">
4024	<desc>
4025	The TCP port the target teleporter will listen for incoming
4026	teleportations on.
4027
4028	0 means the port is automatically selected upon power on. The actual
4029	value can be read from this property while the machine is waiting for
4030	incoming teleportations.
4031	</desc>
4032	</attribute>
4033
4034	<attribute name="teleporterAddress" type="wstring">
4035	<desc>
4036	The address the target teleporter will listen on. If set to an empty
4037	string, it will listen on all addresses.
4038	</desc>
4039	</attribute>
4040
4041	<attribute name="teleporterPassword" type="wstring">
4042	<desc>
4043	The password to check for on the target teleporter. This is just a
4044	very basic measure to prevent simple hacks and operators accidentally
4045	beaming a virtual machine to the wrong place.
4046	</desc>
4047	</attribute>
4048
4049	<attribute name="faultToleranceState" type="FaultToleranceState">
4050	<desc>
4051	Fault tolerance state; disabled, source or target.
4052	This property can be changed at any time. If you change it for a running
4053	VM, then the fault tolerance address and port must be set beforehand.
4054	</desc>
4055	</attribute>
4056
4057	<attribute name="faultTolerancePort" type="unsigned long">
4058	<desc>
4059	The TCP port the fault tolerance source or target will use for
4060	communication.
4061	</desc>
4062	</attribute>
4063
4064	<attribute name="faultToleranceAddress" type="wstring">
4065	<desc>
4066	The address the fault tolerance source or target.
4067	</desc>
4068	</attribute>
4069
4070	<attribute name="faultTolerancePassword" type="wstring">
4071	<desc>
4072	The password to check for on the standby VM. This is just a
4073	very basic measure to prevent simple hacks and operators accidentally
4074	choosing the wrong standby VM.
4075	</desc>
4076	</attribute>
4077
4078	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4079	<desc>
4080	The interval in ms used for syncing the state between source and target.
4081	</desc>
4082	</attribute>
4083
4084	<attribute name="RTCUseUTC" type="boolean">
4085	<desc>
4086	When set to @a true, the RTC device of the virtual machine will run
4087	in UTC time, otherwise in local time. Especially Unix guests prefer
4088	the time in UTC.
4089	</desc>
4090	</attribute>
4091
4092	<attribute name="ioCacheEnabled" type="boolean">
4093	<desc>
4094	When set to @a true, the builtin I/O cache of the virtual machine
4095	will be enabled.
4096	</desc>
4097	</attribute>
4098
4099	<attribute name="ioCacheSize" type="unsigned long">
4100	<desc>
4101	Maximum size of the I/O cache in MB.
4102	</desc>
4103	</attribute>
4104
4105	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4106	<desc>
4107	Bandwidth control manager.
4108	</desc>
4109	</attribute>
4110
4111	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4112	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4113	attached to the machine use IConsole::attachedPciDevices attribute, as
4114	this attribute is intended to list only devices additional to what
4115	described in virtual hardware config. Usually, this list keeps host's
4116	physical devices assigned to the particular machine.
4117	</desc>
4118	</attribute>
4119
4120	<method name="lockMachine">
4121	<desc>
4122	Locks the machine for the given session to enable the caller
4123	to make changes to the machine or start the VM or control
4124	VM execution.
4125
4126	There are two ways to lock a machine for such uses:
4127
4128	<ul>
4129	<li>If you want to make changes to the machine settings,
4130	you must obtain an exclusive write lock on the machine
4131	by setting @a lockType to @c Write.
4132
4133	This will only succeed if no other process has locked
4134	the machine to prevent conflicting changes. Only after
4135	an exclusive write lock has been obtained using this method, one
4136	can change all VM settings or execute the VM in the process
4137	space of the session object. (Note that the latter is only of
4138	interest if you actually want to write a new front-end for
4139	virtual machines; but this API gets called internally by
4140	the existing front-ends such as VBoxHeadless and the VirtualBox
4141	GUI to acquire a write lock on the machine that they are running.)
4142
4143	On success, write-locking the machine for a session creates
4144	a second copy of the IMachine object. It is this second object
4145	upon which changes can be made; in VirtualBox terminology, the
4146	second copy is "mutable". It is only this second, mutable machine
4147	object upon which you can call methods that change the
4148	machine state. After having called this method, you can
4149	obtain this second, mutable machine object using the
4150	<link to="ISession::machine" /> attribute.
4151	</li>
4152	<li>If you only want to check the machine state or control
4153	machine execution without actually changing machine
4154	settings (e.g. to get access to VM statistics or take
4155	a snapshot or save the machine state), then set the
4156	@a lockType argument to @c Shared.
4157
4158	If no other session has obtained a lock, you will obtain an
4159	exclusive write lock as described above. However, if another
4160	session has already obtained such a lock, then a link to that
4161	existing session will be established which allows you
4162	to control that existing session.
4163
4164	To find out which type of lock was obtained, you can
4165	inspect <link to="ISession::type" />, which will have been
4166	set to either @c WriteLock or @c Shared.
4167	</li>
4168	</ul>
4169
4170	In either case, you can get access to the <link to="IConsole" />
4171	object which controls VM execution.
4172
4173	Also in all of the above cases, one must always call
4174	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4175	the machine's state will eventually be set to "Aborted".
4176
4177	To change settings on a machine, the following sequence is typically
4178	performed:
4179
4180	<ol>
4181	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4182
4183	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4184
4185	<li>Change the settings of the machine by invoking IMachine methods.</li>
4186
4187	<li>Call <link to="IMachine::saveSettings" />.</li>
4188
4189	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4190	</ol>
4191
4192	<result name="E_UNEXPECTED">
4193	Virtual machine not registered.
4194	</result>
4195	<result name="E_ACCESSDENIED">
4196	Process not started by OpenRemoteSession.
4197	</result>
4198	<result name="VBOX_E_INVALID_OBJECT_STATE">
4199	Session already open or being opened.
4200	</result>
4201	<result name="VBOX_E_VM_ERROR">
4202	Failed to assign machine to session.
4203	</result>
4204	</desc>
4205	<param name="session" type="ISession" dir="in">
4206	<desc>
4207	Session object for which the machine will be locked.
4208	</desc>
4209	</param>
4210	<param name="lockType" type="LockType" dir="in">
4211	<desc>
4212	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4213	If set to @c Shared, then either acquire an exclusive write lock or establish
4214	a link to an existing session.
4215	</desc>
4216	</param>
4217	</method>
4218
4219	<method name="launchVMProcess">
4220	<desc>
4221	Spawns a new process that will execute the virtual machine and obtains a shared
4222	lock on the machine for the calling session.
4223
4224	If launching the VM succeeds, the new VM process will create its own session
4225	and write-lock the machine for it, preventing conflicting changes from other
4226	processes. If the machine is already locked (because it is already running or
4227	because another session has a write lock), launching the VM process will therefore
4228	fail. Reversely, future attempts to obtain a write lock will also fail while the
4229	machine is running.
4230
4231	The caller's session object remains separate from the session opened by the new
4232	VM process. It receives its own <link to="IConsole" /> object which can be used
4233	to control machine execution, but it cannot be used to change all VM settings
4234	which would be available after a <link to="#lockMachine" /> call.
4235
4236	The caller must eventually release the session's shared lock by calling
4237	<link to="ISession::unlockMachine" /> on the local session object once this call
4238	has returned. However, the session's state (see <link to="ISession::state" />)
4239	will not return to "Unlocked" until the remote session has also unlocked
4240	the machine (i.e. the machine has stopped running).
4241
4242	Launching a VM process can take some time (a new VM is started in a new process,
4243	for which memory and other resources need to be set up). Because of this,
4244	an <link to="IProgress" /> object is returned to allow the caller to wait
4245	for this asynchronous operation to be completed. Until then, the caller's
4246	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4247	and <link to="ISession::console" /> attributes cannot be accessed.
4248	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4249	similar calls to wait for completion. Completion is signalled when the VM
4250	is powered on. If launching the VM fails, error messages can be queried
4251	via the progress object, if available.
4252
4253	The progress object will have at least 2 sub-operations. The first
4254	operation covers the period up to the new VM process calls powerUp.
4255	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4256	progress object. Because <link to="IConsole::powerUp"/> may require
4257	some extra sub-operations, the <link to="IProgress::operationCount"/>
4258	may change at the completion of operation.
4259
4260	For details on the teleportation progress operation, see
4261	<link to="IConsole::powerUp"/>.
4262
4263	The @a environment argument is a string containing definitions of
4264	environment variables in the following format:
4265	@code
4266	NAME[=VALUE]\n
4267	NAME[=VALUE]\n
4268	...
4269	@endcode
4270	where <tt>\\n</tt> is the new line character. These environment
4271	variables will be appended to the environment of the VirtualBox server
4272	process. If an environment variable exists both in the server process
4273	and in this list, the value from this list takes precedence over the
4274	server's variable. If the value of the environment variable is
4275	omitted, this variable will be removed from the resulting environment.
4276	If the environment string is @c null or empty, the server environment
4277	is inherited by the started process as is.
4278
4279	<result name="E_UNEXPECTED">
4280	Virtual machine not registered.
4281	</result>
4282	<result name="E_INVALIDARG">
4283	Invalid session type @a type.
4284	</result>
4285	<result name="VBOX_E_OBJECT_NOT_FOUND">
4286	No machine matching @a machineId found.
4287	</result>
4288	<result name="VBOX_E_INVALID_OBJECT_STATE">
4289	Session already open or being opened.
4290	</result>
4291	<result name="VBOX_E_IPRT_ERROR">
4292	Launching process for machine failed.
4293	</result>
4294	<result name="VBOX_E_VM_ERROR">
4295	Failed to assign machine to session.
4296	</result>
4297	</desc>
4298	<param name="session" type="ISession" dir="in">
4299	<desc>
4300	Client session object to which the VM process will be connected (this
4301	must be in "Unlocked" state).
4302	</desc>
4303	</param>
4304	<param name="type" type="wstring" dir="in">
4305	<desc>
4306	Front-end to use for the new VM process. The following are currently supported:
4307	<ul>
4308	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4309	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4310	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4311	</ul>
4312	</desc>
4313	</param>
4314	<param name="environment" type="wstring" dir="in">
4315	<desc>
4316	Environment to pass to the VM process.
4317	</desc>
4318	</param>
4319	<param name="progress" type="IProgress" dir="return">
4320	<desc>Progress object to track the operation completion.</desc>
4321	</param>
4322	</method>
4323
4324	<method name="setBootOrder">
4325	<desc>
4326	Puts the given device to the specified position in
4327	the boot order.
4328
4329	To indicate that no device is associated with the given position,
4330	<link to="DeviceType_Null"/> should be used.
4331
4332	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4333
4334	<result name="E_INVALIDARG">
4335	Boot @a position out of range.
4336	</result>
4337	<result name="E_NOTIMPL">
4338	Booting from USB @a device currently not supported.
4339	</result>
4340
4341	</desc>
4342	<param name="position" type="unsigned long" dir="in">
4343	<desc>
4344	Position in the boot order (@c 1 to the total number of
4345	devices the machine can boot from, as returned by
4346	<link to="ISystemProperties::maxBootPosition"/>).
4347	</desc>
4348	</param>
4349	<param name="device" type="DeviceType" dir="in">
4350	<desc>
4351	The type of the device used to boot at the given position.
4352	</desc>
4353	</param>
4354	</method>
4355
4356	<method name="getBootOrder" const="yes">
4357	<desc>
4358	Returns the device type that occupies the specified
4359	position in the boot order.
4360
4361	@todo [remove?]
4362	If the machine can have more than one device of the returned type
4363	(such as hard disks), then a separate method should be used to
4364	retrieve the individual device that occupies the given position.
4365
4366	If here are no devices at the given position, then
4367	<link to="DeviceType_Null"/> is returned.
4368
4369	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4370
4371	<result name="E_INVALIDARG">
4372	Boot @a position out of range.
4373	</result>
4374
4375	</desc>
4376	<param name="position" type="unsigned long" dir="in">
4377	<desc>
4378	Position in the boot order (@c 1 to the total number of
4379	devices the machine can boot from, as returned by
4380	<link to="ISystemProperties::maxBootPosition"/>).
4381	</desc>
4382	</param>
4383	<param name="device" type="DeviceType" dir="return">
4384	<desc>
4385	Device at the given position.
4386	</desc>
4387	</param>
4388	</method>
4389
4390	<method name="attachDevice">
4391	<desc>
4392	Attaches a device and optionally mounts a medium to the given storage
4393	controller (<link to="IStorageController" />, identified by @a name),
4394	at the indicated port and device.
4395
4396	This method is intended for managing storage devices in general while a
4397	machine is powered off. It can be used to attach and detach fixed
4398	and removeable media. The following kind of media can be attached
4399	to a machine:
4400
4401	<ul>
4402	<li>For fixed and removable media, you can pass in a medium that was
4403	previously opened using <link to="IVirtualBox::openMedium" />.
4404	</li>
4405
4406	<li>Only for storage devices supporting removable media (such as
4407	DVDs and floppies), you can also specify a null pointer to
4408	indicate an empty drive or one of the medium objects listed
4409	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4410	arrays to indicate a host drive.
4411	For removeable devices, you can also use <link to="IMachine::mountMedium"/>
4412	to change the media while the machine is running.
4413	</li>
4414	</ul>
4415
4416	In a VM's default configuration of virtual machines, the secondary
4417	master of the IDE controller is used for a CD/DVD drive.
4418
4419	After calling this returns successfully, a new instance of
4420	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4421	attachments (see <link to="IMachine::mediumAttachments"/>).
4422
4423	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4424	information about attaching media.
4425
4426	The specified device slot must not have a device attached to it,
4427	or this method will fail.
4428
4429	<note>
4430	You cannot attach a device to a newly created machine until
4431	this machine's settings are saved to disk using
4432	<link to="#saveSettings"/>.
4433	</note>
4434	<note>
4435	If the medium is being attached indirectly, a new differencing medium
4436	will implicitly be created for it and attached instead. If the
4437	changes made to the machine settings (including this indirect
4438	attachment) are later cancelled using <link to="#discardSettings"/>,
4439	this implicitly created differencing medium will implicitly
4440	be deleted.
4441	</note>
4442
4443	<result name="E_INVALIDARG">
4444	SATA device, SATA port, IDE port or IDE slot out of range, or
4445	file or UUID not found.
4446	</result>
4447	<result name="VBOX_E_INVALID_OBJECT_STATE">
4448	Machine must be registered before media can be attached.
4449	</result>
4450	<result name="VBOX_E_INVALID_VM_STATE">
4451	Invalid machine state.
4452	</result>
4453	<result name="VBOX_E_OBJECT_IN_USE">
4454	A medium is already attached to this or another virtual machine.
4455	</result>
4456
4457	</desc>
4458	<param name="name" type="wstring" dir="in">
4459	<desc>Name of the storage controller to attach the device to.</desc>
4460	</param>
4461	<param name="controllerPort" type="long" dir="in">
4462	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4463	the primary controller and 1 specifies the secondary controller.
4464	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4465	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4466	</param>
4467	<param name="device" type="long" dir="in">
4468	<desc>Device slot in the given port to attach the device to. This is only
4469	relevant for IDE controllers, for which 0 specifies the master device and
4470	1 specifies the slave device. For all other controller types, this must
4471	be 0.</desc>
4472	</param>
4473	<param name="type" type="DeviceType" dir="in">
4474	<desc>Device type of the attached device. For media opened by
4475	<link to="IVirtualBox::openMedium" />, this must match the device type
4476	specified there.</desc>
4477	</param>
4478	<param name="medium" type="IMedium" dir="in">
4479	<desc>Medium to mount or NULL for an empty drive.</desc>
4480	</param>
4481	</method>
4482
4483	<method name="detachDevice">
4484	<desc>
4485	Detaches the device attached to a device slot of the specified bus.
4486
4487	Detaching the device from the virtual machine is deferred. This means
4488	that the medium remains associated with the machine when this method
4489	returns and gets actually de-associated only after a successful
4490	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4491	for more detailed information about attaching media.
4492
4493	<note>
4494	You cannot detach a device from a running machine.
4495	</note>
4496	<note>
4497	Detaching differencing media implicitly created by <link
4498	to="#attachDevice"/> for the indirect attachment using this
4499	method will <b>not</b> implicitly delete them. The
4500	<link to="IMedium::deleteStorage"/> operation should be
4501	explicitly performed by the caller after the medium is successfully
4502	detached and the settings are saved with
4503	<link to="#saveSettings"/>, if it is the desired action.
4504	</note>
4505
4506	<result name="VBOX_E_INVALID_VM_STATE">
4507	Attempt to detach medium from a running virtual machine.
4508	</result>
4509	<result name="VBOX_E_OBJECT_NOT_FOUND">
4510	No medium attached to given slot/bus.
4511	</result>
4512	<result name="VBOX_E_NOT_SUPPORTED">
4513	Medium format does not support storage deletion.
4514	</result>
4515
4516	</desc>
4517	<param name="name" type="wstring" dir="in">
4518	<desc>Name of the storage controller to detach the medium from.</desc>
4519	</param>
4520	<param name="controllerPort" type="long" dir="in">
4521	<desc>Port number to detach the medium from.</desc>
4522	</param>
4523	<param name="device" type="long" dir="in">
4524	<desc>Device slot number to detach the medium from.</desc>
4525	</param>
4526	</method>
4527
4528	<method name="passthroughDevice">
4529	<desc>
4530	Sets the passthrough mode of an existing DVD device. Changing the
4531	setting while the VM is running is forbidden. The setting is only used
4532	if at VM start the device is configured as a host DVD drive, in all
4533	other cases it is ignored. The device must already exist; see
4534	<link to="IMachine::attachDevice"/> for how to attach a new device.
4535
4536	The @a controllerPort and @a device parameters specify the device slot and
4537	have have the same meaning as with <link to="IMachine::attachDevice" />.
4538
4539	<result name="E_INVALIDARG">
4540	SATA device, SATA port, IDE port or IDE slot out of range.
4541	</result>
4542	<result name="VBOX_E_INVALID_OBJECT_STATE">
4543	Attempt to modify an unregistered virtual machine.
4544	</result>
4545	<result name="VBOX_E_INVALID_VM_STATE">
4546	Invalid machine state.
4547	</result>
4548
4549	</desc>
4550	<param name="name" type="wstring" dir="in">
4551	<desc>Name of the storage controller.</desc>
4552	</param>
4553	<param name="controllerPort" type="long" dir="in">
4554	<desc>Storage controller port.</desc>
4555	</param>
4556	<param name="device" type="long" dir="in">
4557	<desc>Device slot in the given port.</desc>
4558	</param>
4559	<param name="passthrough" type="boolean" dir="in">
4560	<desc>New value for the passthrough setting.</desc>
4561	</param>
4562	</method>
4563
4564	<method name="setBandwidthGroupForDevice">
4565	<desc>
4566	Sets the passthrough mode of an existing DVD device. Changing the
4567	setting while the VM is running is forbidden. The setting is only used
4568	if at VM start the device is configured as a host DVD drive, in all
4569	other cases it is ignored. The device must already exist; see
4570	<link to="IMachine::attachDevice"/> for how to attach a new device.
4571
4572	The @a controllerPort and @a device parameters specify the device slot and
4573	have have the same meaning as with <link to="IMachine::attachDevice" />.
4574
4575	<result name="E_INVALIDARG">
4576	SATA device, SATA port, IDE port or IDE slot out of range.
4577	</result>
4578	<result name="VBOX_E_INVALID_OBJECT_STATE">
4579	Attempt to modify an unregistered virtual machine.
4580	</result>
4581	<result name="VBOX_E_INVALID_VM_STATE">
4582	Invalid machine state.
4583	</result>
4584
4585	</desc>
4586	<param name="name" type="wstring" dir="in">
4587	<desc>Name of the storage controller.</desc>
4588	</param>
4589	<param name="controllerPort" type="long" dir="in">
4590	<desc>Storage controller port.</desc>
4591	</param>
4592	<param name="device" type="long" dir="in">
4593	<desc>Device slot in the given port.</desc>
4594	</param>
4595	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4596	<desc>New value for the bandwidth group or NULL for no group.</desc>
4597	</param>
4598	</method>
4599
4600	<method name="mountMedium">
4601	<desc>
4602	Mounts a medium (<link to="IMedium" />, identified
4603	by the given UUID @a id) to the given storage controller
4604	(<link to="IStorageController" />, identified by @a name),
4605	at the indicated port and device. The device must already exist;
4606	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4607
4608	This method is intended only for managing removable media, where the
4609	device is fixed but media is changeable at runtime (such as DVDs
4610	and floppies). It cannot be used for fixed media such as hard disks.
4611
4612	The @a controllerPort and @a device parameters specify the device slot and
4613	have have the same meaning as with <link to="IMachine::attachDevice" />.
4614
4615	The specified device slot can have a medium mounted, which will be
4616	unmounted first. Specifying a zero UUID (or an empty string) for
4617	@a medium does just an unmount.
4618
4619	See <link to="IMedium"/> for more detailed information about
4620	attaching media.
4621
4622	<result name="E_INVALIDARG">
4623	SATA device, SATA port, IDE port or IDE slot out of range.
4624	</result>
4625	<result name="VBOX_E_INVALID_OBJECT_STATE">
4626	Attempt to attach medium to an unregistered virtual machine.
4627	</result>
4628	<result name="VBOX_E_INVALID_VM_STATE">
4629	Invalid machine state.
4630	</result>
4631	<result name="VBOX_E_OBJECT_IN_USE">
4632	Medium already attached to this or another virtual machine.
4633	</result>
4634
4635	</desc>
4636	<param name="name" type="wstring" dir="in">
4637	<desc>Name of the storage controller to attach the medium to.</desc>
4638	</param>
4639	<param name="controllerPort" type="long" dir="in">
4640	<desc>Port to attach the medium to.</desc>
4641	</param>
4642	<param name="device" type="long" dir="in">
4643	<desc>Device slot in the given port to attach the medium to.</desc>
4644	</param>
4645	<param name="medium" type="IMedium" dir="in">
4646	<desc>Medium to mount or NULL for an empty drive.</desc>
4647	</param>
4648	<param name="force" type="boolean" dir="in">
4649	<desc>Allows to force unmount/mount of a medium which is locked by
4650	the device slot in the given port to attach the medium to.</desc>
4651	</param>
4652	</method>
4653
4654	<method name="getMedium" const="yes">
4655	<desc>
4656	Returns the virtual medium attached to a device slot of the specified
4657	bus.
4658
4659	Note that if the medium was indirectly attached by
4660	<link to="#mountMedium"/> to the given device slot then this
4661	method will return not the same object as passed to the
4662	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4663	more detailed information about mounting a medium.
4664
4665	<result name="VBOX_E_OBJECT_NOT_FOUND">
4666	No medium attached to given slot/bus.
4667	</result>
4668
4669	</desc>
4670	<param name="name" type="wstring" dir="in">
4671	<desc>Name of the storage controller the medium is attached to.</desc>
4672	</param>
4673	<param name="controllerPort" type="long" dir="in">
4674	<desc>Port to query.</desc>
4675	</param>
4676	<param name="device" type="long" dir="in">
4677	<desc>Device slot in the given port to query.</desc>
4678	</param>
4679	<param name="medium" type="IMedium" dir="return">
4680	<desc>Attached medium object.</desc>
4681	</param>
4682	</method>
4683
4684	<method name="getMediumAttachmentsOfController" const="yes">
4685	<desc>
4686	Returns an array of medium attachments which are attached to the
4687	the controller with the given name.
4688
4689	<result name="VBOX_E_OBJECT_NOT_FOUND">
4690	A storage controller with given name doesn't exist.
4691	</result>
4692	</desc>
4693	<param name="name" type="wstring" dir="in"/>
4694	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4695	</method>
4696
4697	<method name="getMediumAttachment" const="yes">
4698	<desc>
4699	Returns a medium attachment which corresponds to the controller with
4700	the given name, on the given port and device slot.
4701
4702	<result name="VBOX_E_OBJECT_NOT_FOUND">
4703	No attachment exists for the given controller/port/device combination.
4704	</result>
4705	</desc>
4706	<param name="name" type="wstring" dir="in"/>
4707	<param name="controllerPort" type="long" dir="in"/>
4708	<param name="device" type="long" dir="in"/>
4709	<param name="attachment" type="IMediumAttachment" dir="return"/>
4710	</method>
4711
4712	<method name="attachHostPciDevice">
4713	<desc>
4714	Attaches host PCI device with the given (host) PCI address to the
4715	PCI bus of the virtual machine. Please note, that this operation
4716	is two phase, as real attachment will happen when VM will start,
4717	and most information will be delivered as IHostPciDevicePlugEvent
4718	on IVirtualBox event source.
4719	<note>
4720	Not yet implemented.
4721	</note>
4722
4723	<see>IHostPciDevicePlugEvent</see>
4724
4725	<result name="VBOX_E_INVALID_VM_STATE">
4726	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4727	</result>
4728	<result name="VBOX_E_PDM_ERROR">
4729	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4730	</result>
4731	<result name="VBOX_E_NOT_SUPPORTED">
4732	Hardware or host OS doesn't allow PCI device passthrought.
4733	</result>
4734	</desc>
4735	<param name="hostAddress" type="long" dir="in">
4736	<desc>Address of the host PCI device.</desc>
4737	</param>
4738	<param name="desiredGuestAddress" type="long" dir="in">
4739	<desc>Desired position of this device on guest PCI bus.</desc>
4740	</param>
4741	<param name="tryToUnbind" type="boolean" dir="in">
4742	<desc>If VMM shall try to unbind existing drivers from the
4743	device before attaching it to the guest.</desc>
4744	</param>
4745	</method>
4746
4747	<method name="detachHostPciDevice">
4748	<desc>
4749	Detach host PCI device from the virtual machine.
4750	Also HostPciDevicePlugEvent on IVirtualBox event source
4751	will be delivered. As currently we don't support hot device
4752	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4753
4754	<note>
4755	Not yet implemented.
4756	</note>
4757
4758	<see>IHostPciDevicePlugEvent</see>
4759
4760	<result name="VBOX_E_INVALID_VM_STATE">
4761	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4762	</result>
4763	<result name="VBOX_E_OBJECT_NOT_FOUND">
4764	This host device is not attached to this machine.
4765	</result>
4766	<result name="VBOX_E_PDM_ERROR">
4767	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4768	</result>
4769	<result name="VBOX_E_NOT_SUPPORTED">
4770	Hardware or host OS doesn't allow PCI device passthrought.
4771	</result>
4772	</desc>
4773	<param name="hostAddress" type="long" dir="in">
4774	<desc>Address of the host PCI device.</desc>
4775	</param>
4776	</method>
4777
4778	<method name="getNetworkAdapter" const="yes">
4779	<desc>
4780	Returns the network adapter associated with the given slot.
4781	Slots are numbered sequentially, starting with zero. The total
4782	number of adapters per machine is defined by the
4783	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
4784	so the maximum slot number is one less than that property's value.
4785
4786	<result name="E_INVALIDARG">
4787	Invalid @a slot number.
4788	</result>
4789
4790	</desc>
4791	<param name="slot" type="unsigned long" dir="in"/>
4792	<param name="adapter" type="INetworkAdapter" dir="return"/>
4793	</method>
4794
4795	<method name="addStorageController">
4796	<desc>
4797	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4798	machine and returns it as an instance of
4799	<link to="IStorageController" />.
4800
4801	@a name identifies the controller for subsequent calls such as
4802	<link to="#getStorageControllerByName" />,
4803	<link to="#getStorageControllerByInstance" />,
4804	<link to="#removeStorageController" />,
4805	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4806
4807	After the controller has been added, you can set its exact
4808	type by setting the <link to="IStorageController::controllerType" />.
4809
4810	<result name="VBOX_E_OBJECT_IN_USE">
4811	A storage controller with given name exists already.
4812	</result>
4813	<result name="E_INVALIDARG">
4814	Invalid @a controllerType.
4815	</result>
4816	</desc>
4817	<param name="name" type="wstring" dir="in"/>
4818	<param name="connectionType" type="StorageBus" dir="in"/>
4819	<param name="controller" type="IStorageController" dir="return"/>
4820	</method>
4821
4822	<method name="getStorageControllerByName" const="yes">
4823	<desc>
4824	Returns a storage controller with the given name.
4825
4826	<result name="VBOX_E_OBJECT_NOT_FOUND">
4827	A storage controller with given name doesn't exist.
4828	</result>
4829	</desc>
4830	<param name="name" type="wstring" dir="in"/>
4831	<param name="storageController" type="IStorageController" dir="return"/>
4832	</method>
4833
4834	<method name="getStorageControllerByInstance" const="yes">
4835	<desc>
4836	Returns a storage controller with the given instance number.
4837
4838	<result name="VBOX_E_OBJECT_NOT_FOUND">
4839	A storage controller with given instance number doesn't exist.
4840	</result>
4841	</desc>
4842	<param name="instance" type="unsigned long" dir="in"/>
4843	<param name="storageController" type="IStorageController" dir="return"/>
4844	</method>
4845
4846	<method name="removeStorageController">
4847	<desc>
4848	Removes a storage controller from the machine.
4849
4850	<result name="VBOX_E_OBJECT_NOT_FOUND">
4851	A storage controller with given name doesn't exist.
4852	</result>
4853	</desc>
4854	<param name="name" type="wstring" dir="in"/>
4855	</method>
4856
4857	<method name="setStorageControllerBootable">
4858	<desc>
4859	Sets the bootable flag of the storage controller with the given name.
4860
4861	<result name="VBOX_E_OBJECT_NOT_FOUND">
4862	A storage controller with given name doesn't exist.
4863	</result>
4864	<result name="VBOX_E_OBJECT_IN_USE">
4865	Another storage controller is marked as bootable already.
4866	</result>
4867	</desc>
4868	<param name="name" type="wstring" dir="in"/>
4869	<param name="bootable" type="boolean" dir="in"/>
4870	</method>
4871
4872	<method name="getSerialPort" const="yes">
4873	<desc>
4874	Returns the serial port associated with the given slot.
4875	Slots are numbered sequentially, starting with zero. The total
4876	number of serial ports per machine is defined by the
4877	<link to="ISystemProperties::serialPortCount"/> property,
4878	so the maximum slot number is one less than that property's value.
4879
4880	<result name="E_INVALIDARG">
4881	Invalid @a slot number.
4882	</result>
4883
4884	</desc>
4885	<param name="slot" type="unsigned long" dir="in"/>
4886	<param name="port" type="ISerialPort" dir="return"/>
4887	</method>
4888
4889	<method name="getParallelPort" const="yes">
4890	<desc>
4891	Returns the parallel port associated with the given slot.
4892	Slots are numbered sequentially, starting with zero. The total
4893	number of parallel ports per machine is defined by the
4894	<link to="ISystemProperties::parallelPortCount"/> property,
4895	so the maximum slot number is one less than that property's value.
4896
4897	<result name="E_INVALIDARG">
4898	Invalid @a slot number.
4899	</result>
4900
4901	</desc>
4902	<param name="slot" type="unsigned long" dir="in"/>
4903	<param name="port" type="IParallelPort" dir="return"/>
4904	</method>
4905
4906	<method name="getExtraDataKeys">
4907	<desc>
4908	Returns an array representing the machine-specific extra data keys
4909	which currently have values defined.
4910	</desc>
4911	<param name="value" type="wstring" dir="return" safearray="yes">
4912	<desc>Array of extra data keys.</desc>
4913	</param>
4914	</method>
4915
4916	<method name="getExtraData">
4917	<desc>
4918	Returns associated machine-specific extra data.
4919
4920	If the requested data @a key does not exist, this function will
4921	succeed and return an empty string in the @a value argument.
4922
4923	<result name="VBOX_E_FILE_ERROR">
4924	Settings file not accessible.
4925	</result>
4926	<result name="VBOX_E_XML_ERROR">
4927	Could not parse the settings file.
4928	</result>
4929
4930	</desc>
4931	<param name="key" type="wstring" dir="in">
4932	<desc>Name of the data key to get.</desc>
4933	</param>
4934	<param name="value" type="wstring" dir="return">
4935	<desc>Value of the requested data key.</desc>
4936	</param>
4937	</method>
4938
4939	<method name="setExtraData">
4940	<desc>
4941	Sets associated machine-specific extra data.
4942
4943	If you pass @c null or an empty string as a key @a value, the given
4944	@a key will be deleted.
4945
4946	<note>
4947	Before performing the actual data change, this method will ask all
4948	registered listeners using the
4949	<link to="IExtraDataCanChangeEvent"/>
4950	notification for a permission. If one of the listeners refuses the
4951	new value, the change will not be performed.
4952	</note>
4953	<note>
4954	On success, the
4955	<link to="IExtraDataChangedEvent"/> notification
4956	is called to inform all registered listeners about a successful data
4957	change.
4958	</note>
4959	<note>
4960	This method can be called outside the machine session and therefore
4961	it's a caller's responsibility to handle possible race conditions
4962	when several clients change the same key at the same time.
4963	</note>
4964
4965	<result name="VBOX_E_FILE_ERROR">
4966	Settings file not accessible.
4967	</result>
4968	<result name="VBOX_E_XML_ERROR">
4969	Could not parse the settings file.
4970	</result>
4971
4972	</desc>
4973	<param name="key" type="wstring" dir="in">
4974	<desc>Name of the data key to set.</desc>
4975	</param>
4976	<param name="value" type="wstring" dir="in">
4977	<desc>Value to assign to the key.</desc>
4978	</param>
4979	</method>
4980
4981	<method name="getCPUProperty" const="yes">
4982	<desc>
4983	Returns the virtual CPU boolean value of the specified property.
4984
4985	<result name="E_INVALIDARG">
4986	Invalid property.
4987	</result>
4988
4989	</desc>
4990	<param name="property" type="CPUPropertyType" dir="in">
4991	<desc>
4992	Property type to query.
4993	</desc>
4994	</param>
4995	<param name="value" type="boolean" dir="return">
4996	<desc>
4997	Property value.
4998	</desc>
4999	</param>
5000	</method>
5001
5002	<method name="setCPUProperty">
5003	<desc>
5004	Sets the virtual CPU boolean value of the specified property.
5005
5006	<result name="E_INVALIDARG">
5007	Invalid property.
5008	</result>
5009
5010	</desc>
5011	<param name="property" type="CPUPropertyType" dir="in">
5012	<desc>
5013	Property type to query.
5014	</desc>
5015	</param>
5016	<param name="value" type="boolean" dir="in">
5017	<desc>
5018	Property value.
5019	</desc>
5020	</param>
5021	</method>
5022
5023	<method name="getCPUIDLeaf" const="yes">
5024	<desc>
5025	Returns the virtual CPU cpuid information for the specified leaf.
5026
5027	Currently supported index values for cpuid:
5028	Standard CPUID leafs: 0 - 0xA
5029	Extended CPUID leafs: 0x80000000 - 0x8000000A
5030
5031	See the Intel and AMD programmer's manuals for detailed information
5032	about the cpuid instruction and its leafs.
5033	<result name="E_INVALIDARG">
5034	Invalid id.
5035	</result>
5036
5037	</desc>
5038	<param name="id" type="unsigned long" dir="in">
5039	<desc>
5040	CPUID leaf index.
5041	</desc>
5042	</param>
5043	<param name="valEax" type="unsigned long" dir="out">
5044	<desc>
5045	CPUID leaf value for register eax.
5046	</desc>
5047	</param>
5048	<param name="valEbx" type="unsigned long" dir="out">
5049	<desc>
5050	CPUID leaf value for register ebx.
5051	</desc>
5052	</param>
5053	<param name="valEcx" type="unsigned long" dir="out">
5054	<desc>
5055	CPUID leaf value for register ecx.
5056	</desc>
5057	</param>
5058	<param name="valEdx" type="unsigned long" dir="out">
5059	<desc>
5060	CPUID leaf value for register edx.
5061	</desc>
5062	</param>
5063	</method>
5064
5065	<method name="setCPUIDLeaf">
5066	<desc>
5067	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5068	are not passed unmodified. VirtualBox clears features that it doesn't support.
5069
5070	Currently supported index values for cpuid:
5071	Standard CPUID leafs: 0 - 0xA
5072	Extended CPUID leafs: 0x80000000 - 0x8000000A
5073
5074	See the Intel and AMD programmer's manuals for detailed information
5075	about the cpuid instruction and its leafs.
5076
5077	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5078	random crashes inside VMs.
5079	<result name="E_INVALIDARG">
5080	Invalid id.
5081	</result>
5082
5083	</desc>
5084	<param name="id" type="unsigned long" dir="in">
5085	<desc>
5086	CPUID leaf index.
5087	</desc>
5088	</param>
5089	<param name="valEax" type="unsigned long" dir="in">
5090	<desc>
5091	CPUID leaf value for register eax.
5092	</desc>
5093	</param>
5094	<param name="valEbx" type="unsigned long" dir="in">
5095	<desc>
5096	CPUID leaf value for register ebx.
5097	</desc>
5098	</param>
5099	<param name="valEcx" type="unsigned long" dir="in">
5100	<desc>
5101	CPUID leaf value for register ecx.
5102	</desc>
5103	</param>
5104	<param name="valEdx" type="unsigned long" dir="in">
5105	<desc>
5106	CPUID leaf value for register edx.
5107	</desc>
5108	</param>
5109	</method>
5110
5111	<method name="removeCPUIDLeaf">
5112	<desc>
5113	Removes the virtual CPU cpuid leaf for the specified index
5114
5115	<result name="E_INVALIDARG">
5116	Invalid id.
5117	</result>
5118
5119	</desc>
5120	<param name="id" type="unsigned long" dir="in">
5121	<desc>
5122	CPUID leaf index.
5123	</desc>
5124	</param>
5125	</method>
5126
5127	<method name="removeAllCPUIDLeaves">
5128	<desc>
5129	Removes all the virtual CPU cpuid leaves
5130	</desc>
5131	</method>
5132
5133	<method name="getHWVirtExProperty" const="yes">
5134	<desc>
5135	Returns the value of the specified hardware virtualization boolean property.
5136
5137	<result name="E_INVALIDARG">
5138	Invalid property.
5139	</result>
5140
5141	</desc>
5142	<param name="property" type="HWVirtExPropertyType" dir="in">
5143	<desc>
5144	Property type to query.
5145	</desc>
5146	</param>
5147	<param name="value" type="boolean" dir="return">
5148	<desc>
5149	Property value.
5150	</desc>
5151	</param>
5152	</method>
5153
5154	<method name="setHWVirtExProperty">
5155	<desc>
5156	Sets a new value for the specified hardware virtualization boolean property.
5157
5158	<result name="E_INVALIDARG">
5159	Invalid property.
5160	</result>
5161
5162	</desc>
5163	<param name="property" type="HWVirtExPropertyType" dir="in">
5164	<desc>
5165	Property type to set.
5166	</desc>
5167	</param>
5168	<param name="value" type="boolean" dir="in">
5169	<desc>
5170	New property value.
5171	</desc>
5172	</param>
5173	</method>
5174
5175	<method name="saveSettings">
5176	<desc>
5177	Saves any changes to machine settings made since the session
5178	has been opened or a new machine has been created, or since the
5179	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5180	For registered machines, new settings become visible to all
5181	other VirtualBox clients after successful invocation of this
5182	method.
5183	<note>
5184	The method sends <link to="IMachineDataChangedEvent"/>
5185	notification event after the configuration has been successfully
5186	saved (only for registered machines).
5187	</note>
5188	<note>
5189	Calling this method is only valid on instances returned
5190	by <link to="ISession::machine"/> and on new machines
5191	created by <link to="IVirtualBox::createMachine"/> but not
5192	yet registered, or on unregistered machines after calling
5193	<link to="IMachine::unregister"/>.
5194	</note>
5195
5196	<result name="VBOX_E_FILE_ERROR">
5197	Settings file not accessible.
5198	</result>
5199	<result name="VBOX_E_XML_ERROR">
5200	Could not parse the settings file.
5201	</result>
5202	<result name="E_ACCESSDENIED">
5203	Modification request refused.
5204	</result>
5205
5206	</desc>
5207	</method>
5208
5209	<method name="discardSettings">
5210	<desc>
5211	Discards any changes to the machine settings made since the session
5212	has been opened or since the last call to <link to="#saveSettings"/>
5213	or <link to="#discardSettings"/>.
5214	<note>
5215	Calling this method is only valid on instances returned
5216	by <link to="ISession::machine"/> and on new machines
5217	created by <link to="IVirtualBox::createMachine"/> or
5218	opened by <link to="IVirtualBox::openMachine"/> but not
5219	yet registered, or on unregistered machines after calling
5220	<link to="IMachine::unregister"/>.
5221	</note>
5222
5223	<result name="VBOX_E_INVALID_VM_STATE">
5224	Virtual machine is not mutable.
5225	</result>
5226
5227	</desc>
5228	</method>
5229
5230	<method name="unregister">
5231	<desc>
5232	Unregisters a machine previously registered with
5233	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5234	cleanup before the machine is unregistered.
5235
5236	This method does not delete any files. It only changes the machine configuration and
5237	the list of registered machines in the VirtualBox object. To delete the files which
5238	belonged to the machine, including the XML file of the machine itself, call
5239	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5240	from this method.
5241
5242	How thoroughly this method cleans up the machine configuration before unregistering
5243	the machine depends on the @a cleanupMode argument.
5244
5245	<ul>
5246	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5247	cleanup will be performed. The call will fail if the machine is in "Saved" state
5248	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5249	It is the responsibility of the caller to delete all such configuration in this mode.
5250	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5251	which it replaces.</li>
5252	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5253	state or if it has snapshots or media attached. All media attached to the current machine
5254	state or in snapshots will be detached. For machines created with VirtualBox 4.0 or
5255	later, media which are registered in this machine's media registry which are still
5256	attached to another machine besides this machine will be moved a another machine's
5257	registry. No medium objects will be returned; all of the machine's media will remain open.</li>
5258	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5259	except that all the hard disk medium objects which were detached from the machine will
5260	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5261	API for closing and deletion.</li>
5262	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5263	that all media will be returned in the array, including removeable media like DVDs and
5264	floppies. This might be useful if the user wants to inspect in detail which media were
5265	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5266	in that case because users will typically want to preserve ISO and RAW image files.</li>
5267	</ul>
5268
5269	This API does not verify whether the media files returned in the array are still
5270	attached to other machines (i.e. shared between several machines). If such a shared
5271	image is passed to <link to="#delete" /> however, closing the image will fail there
5272	and the image will be silently skipped.
5273
5274	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5275	resulting IMedia array to <link to="#delete"/>. This way, the machine is completely
5276	deleted with all its saved states and hard disk images, but images for removeable
5277	drives (such as ISO and RAW files) will remain on disk.
5278
5279	The call will fail if the machine is currently locked (see <link to="ISession" />).
5280	It implicitly calls <link to="#saveSettings"/> to save all current machine settings
5281	before unregistering it.
5282
5283	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5284	is fired.
5285
5286	<note>
5287	If the given machine is inaccessible (see <link to="#accessible"/>), it
5288	will be unregistered and fully uninitialized right afterwards. As a result,
5289	the returned machine object will be unusable and an attempt to call
5290	<b>any</b> method will return the "Object not ready" error.
5291	</note>
5292
5293	<result name="VBOX_E_INVALID_OBJECT_STATE">
5294	Machine is currently locked for a session.
5295	</result>
5296	</desc>
5297
5298	<param name="cleanupMode" type="CleanupMode" dir="in">
5299	<desc>How to clean up after the machine has been unregistered.</desc>
5300	</param>
5301	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5302	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5303	</param>
5304	</method>
5305
5306	<method name="delete">
5307	<desc>
5308	Deletes the files associated with this machine from disk. If medium objects are passed
5309	in with the @a aMedia argument, they are closed and, if closing was successful, their
5310	storage files are deleted as well. For convenience, this array of media files can be
5311	the same as the one returned from a previous <link to="#unregister" /> call.
5312
5313	This method must only be called on machines which are either write-locked (i.e. on instances
5314	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5315	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5316	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5317
5318	The following files will be deleted by this method:
5319	<ul>
5320	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5321	argument other than "UnregisterOnly", this will delete all saved state files that
5322	the machine had in use; possibly one if the machine was in "Saved" state and one
5323	for each online snapshot that the machine had.</li>
5324	<li>On each medium object passed in the @a aMedia array, this will call
5325	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5326	medium's storage on disk. Since the close() call will fail if the medium is still
5327	in use, e.g. because it is still attached to a second machine; in that case the
5328	storage will not be deleted.</li>
5329	<li>Finally, the machine's own XML file will be deleted.</li>
5330	</ul>
5331
5332	Since deleting large disk image files can be a time-consuming I/O operation, this
5333	method operates asynchronously and returns an IProgress object to allow the caller
5334	to monitor the progress. There will be one sub-operation for each file that is
5335	being deleted (saved state or medium storage file).
5336
5337	<note>
5338	<link to="#settingsModified"/> will return @c true after this
5339	method successfully returns.
5340	</note>
5341
5342	<result name="VBOX_E_INVALID_VM_STATE">
5343	Machine is registered but not write-locked.
5344	</result>
5345	<result name="VBOX_E_IPRT_ERROR">
5346	Could not delete the settings file.
5347	</result>
5348	</desc>
5349	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5350	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5351	</param>
5352	<param name="aProgress" type="IProgress" dir="return">
5353	<desc>Progress object to track the operation completion.</desc>
5354	</param>
5355	</method>
5356
5357	<method name="export">
5358	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5359	steps required to export VirtualBox machines to OVF.
5360	</desc>
5361
5362	<param name="aAppliance" type="IAppliance" dir="in">
5363	<desc>Appliance to export this machine to.</desc>
5364	</param>
5365	<param name="location" type="wstring" dir="in">
5366	<desc>The target location.</desc>
5367	</param>
5368	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5369	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5370	</param>
5371	</method >
5372
5373	<method name="findSnapshot">
5374	<desc>
5375	Returns a snapshot of this machine with the given name or UUID.
5376
5377	Returns a snapshot of this machine with the given UUID.
5378	A @c null argument can be used to obtain the first snapshot
5379	taken on this machine. To traverse the whole tree of snapshots
5380	starting from the root, inspect the root snapshot's
5381	<link to="ISnapshot::children" /> attribute and recurse over those children.
5382
5383	<result name="VBOX_E_OBJECT_NOT_FOUND">
5384	Virtual machine has no snapshots or snapshot not found.
5385	</result>
5386
5387	</desc>
5388	<param name="nameOrId" type="wstring" dir="in">
5389	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5390	</param>
5391	<param name="snapshot" type="ISnapshot" dir="return">
5392	<desc>Snapshot object with the given name.</desc>
5393	</param>
5394	</method>
5395
5396	<method name="createSharedFolder">
5397	<desc>
5398	Creates a new permanent shared folder by associating the given logical
5399	name with the given host path, adds it to the collection of shared
5400	folders and starts sharing it. Refer to the description of
5401	<link to="ISharedFolder"/> to read more about logical names.
5402
5403	<result name="VBOX_E_OBJECT_IN_USE">
5404	Shared folder already exists.
5405	</result>
5406	<result name="VBOX_E_FILE_ERROR">
5407	Shared folder @a hostPath not accessible.
5408	</result>
5409
5410	</desc>
5411	<param name="name" type="wstring" dir="in">
5412	<desc>Unique logical name of the shared folder.</desc>
5413	</param>
5414	<param name="hostPath" type="wstring" dir="in">
5415	<desc>Full path to the shared folder in the host file system.</desc>
5416	</param>
5417	<param name="writable" type="boolean" dir="in">
5418	<desc>Whether the share is writable or readonly.</desc>
5419	</param>
5420	<param name="automount" type="boolean" dir="in">
5421	<desc>Whether the share gets automatically mounted by the guest
5422	or not.</desc>
5423	</param>
5424	</method>
5425
5426	<method name="removeSharedFolder">
5427	<desc>
5428	Removes the permanent shared folder with the given name previously
5429	created by <link to="#createSharedFolder"/> from the collection of
5430	shared folders and stops sharing it.
5431
5432	<result name="VBOX_E_INVALID_VM_STATE">
5433	Virtual machine is not mutable.
5434	</result>
5435	<result name="VBOX_E_OBJECT_NOT_FOUND">
5436	Shared folder @a name does not exist.
5437	</result>
5438
5439	</desc>
5440	<param name="name" type="wstring" dir="in">
5441	<desc>Logical name of the shared folder to remove.</desc>
5442	</param>
5443	</method>
5444
5445	<method name="canShowConsoleWindow">
5446	<desc>
5447	Returns @c true if the VM console process can activate the
5448	console window and bring it to foreground on the desktop of
5449	the host PC.
5450	<note>
5451	This method will fail if a session for this machine is not
5452	currently open.
5453	</note>
5454
5455	<result name="VBOX_E_INVALID_VM_STATE">
5456	Machine session is not open.
5457	</result>
5458
5459	</desc>
5460	<param name="canShow" type="boolean" dir="return">
5461	<desc>
5462	@c true if the console window can be shown and @c false otherwise.
5463	</desc>
5464	</param>
5465	</method>
5466
5467	<method name="showConsoleWindow">
5468	<desc>
5469	Activates the console window and brings it to foreground on
5470	the desktop of the host PC. Many modern window managers on
5471	many platforms implement some sort of focus stealing
5472	prevention logic, so that it may be impossible to activate
5473	a window without the help of the currently active
5474	application. In this case, this method will return a non-zero
5475	identifier that represents the top-level window of the VM
5476	console process. The caller, if it represents a currently
5477	active process, is responsible to use this identifier (in a
5478	platform-dependent manner) to perform actual window
5479	activation.
5480	<note>
5481	This method will fail if a session for this machine is not
5482	currently open.
5483	</note>
5484
5485	<result name="VBOX_E_INVALID_VM_STATE">
5486	Machine session is not open.
5487	</result>
5488
5489	</desc>
5490	<param name="winId" type="long long" dir="return">
5491	<desc>
5492	Platform-dependent identifier of the top-level VM console
5493	window, or zero if this method has performed all actions
5494	necessary to implement the <i>show window</i> semantics for
5495	the given platform and/or VirtualBox front-end.
5496	</desc>
5497	</param>
5498	</method>
5499
5500	<method name="getGuestProperty" const="yes">
5501	<desc>
5502	Reads an entry from the machine's guest property store.
5503
5504	<result name="VBOX_E_INVALID_VM_STATE">
5505	Machine session is not open.
5506	</result>
5507
5508	</desc>
5509	<param name="name" type="wstring" dir="in">
5510	<desc>
5511	The name of the property to read.
5512	</desc>
5513	</param>
5514	<param name="value" type="wstring" dir="out">
5515	<desc>
5516	The value of the property. If the property does not exist then this
5517	will be empty.
5518	</desc>
5519	</param>
5520	<param name="timestamp" type="long long" dir="out">
5521	<desc>
5522	The time at which the property was last modified, as seen by the
5523	server process.
5524	</desc>
5525	</param>
5526	<param name="flags" type="wstring" dir="out">
5527	<desc>
5528	Additional property parameters, passed as a comma-separated list of
5529	"name=value" type entries.
5530	</desc>
5531	</param>
5532	</method>
5533
5534	<method name="getGuestPropertyValue" const="yes">
5535	<desc>
5536	Reads a value from the machine's guest property store.
5537
5538	<result name="VBOX_E_INVALID_VM_STATE">
5539	Machine session is not open.
5540	</result>
5541
5542	</desc>
5543	<param name="property" type="wstring" dir="in">
5544	<desc>
5545	The name of the property to read.
5546	</desc>
5547	</param>
5548	<param name="value" type="wstring" dir="return">
5549	<desc>
5550	The value of the property. If the property does not exist then this
5551	will be empty.
5552	</desc>
5553	</param>
5554	</method>
5555
5556	<method name="getGuestPropertyTimestamp" const="yes">
5557	<desc>
5558	Reads a property timestamp from the machine's guest property store.
5559
5560	<result name="VBOX_E_INVALID_VM_STATE">
5561	Machine session is not open.
5562	</result>
5563
5564	</desc>
5565	<param name="property" type="wstring" dir="in">
5566	<desc>
5567	The name of the property to read.
5568	</desc>
5569	</param>
5570	<param name="value" type="long long" dir="return">
5571	<desc>
5572	The timestamp. If the property does not exist then this will be
5573	empty.
5574	</desc>
5575	</param>
5576	</method>
5577
5578	<method name="setGuestProperty">
5579	<desc>
5580	Sets, changes or deletes an entry in the machine's guest property
5581	store.
5582
5583	<result name="E_ACCESSDENIED">
5584	Property cannot be changed.
5585	</result>
5586	<result name="E_INVALIDARG">
5587	Invalid @a flags.
5588	</result>
5589	<result name="VBOX_E_INVALID_VM_STATE">
5590	Virtual machine is not mutable or session not open.
5591	</result>
5592	<result name="VBOX_E_INVALID_OBJECT_STATE">
5593	Cannot set transient property when machine not running.
5594	</result>
5595
5596	</desc>
5597	<param name="property" type="wstring" dir="in">
5598	<desc>
5599	The name of the property to set, change or delete.
5600	</desc>
5601	</param>
5602	<param name="value" type="wstring" dir="in">
5603	<desc>
5604	The new value of the property to set, change or delete. If the
5605	property does not yet exist and value is non-empty, it will be
5606	created. If the value is @c null or empty, the property will be
5607	deleted if it exists.
5608	</desc>
5609	</param>
5610	<param name="flags" type="wstring" dir="in">
5611	<desc>
5612	Additional property parameters, passed as a comma-separated list of
5613	"name=value" type entries.
5614	</desc>
5615	</param>
5616	</method>
5617
5618	<method name="setGuestPropertyValue">
5619	<desc>
5620	Sets, changes or deletes a value in the machine's guest property
5621	store. The flags field will be left unchanged or created empty for a
5622	new property.
5623
5624	<result name="E_ACCESSDENIED">
5625	Property cannot be changed.
5626	</result>
5627	<result name="VBOX_E_INVALID_VM_STATE">
5628	Virtual machine is not mutable or session not open.
5629	</result>
5630	<result name="VBOX_E_INVALID_OBJECT_STATE">
5631	Cannot set transient property when machine not running.
5632	</result>
5633	</desc>
5634
5635	<param name="property" type="wstring" dir="in">
5636	<desc>
5637	The name of the property to set, change or delete.
5638	</desc>
5639	</param>
5640	<param name="value" type="wstring" dir="in">
5641	<desc>
5642	The new value of the property to set, change or delete. If the
5643	property does not yet exist and value is non-empty, it will be
5644	created. If the value is @c null or empty, the property will be
5645	deleted if it exists.
5646	</desc>
5647	</param>
5648	</method>
5649
5650	<method name="enumerateGuestProperties">
5651	<desc>
5652	Return a list of the guest properties matching a set of patterns along
5653	with their values, time stamps and flags.
5654	</desc>
5655	<param name="patterns" type="wstring" dir="in">
5656	<desc>
5657	The patterns to match the properties against, separated by '\|'
5658	characters. If this is empty or @c null, all properties will match.
5659	</desc>
5660	</param>
5661	<param name="name" type="wstring" dir="out" safearray="yes">
5662	<desc>
5663	The names of the properties returned.
5664	</desc>
5665	</param>
5666	<param name="value" type="wstring" dir="out" safearray="yes">
5667	<desc>
5668	The values of the properties returned. The array entries match the
5669	corresponding entries in the @a name array.
5670	</desc>
5671	</param>
5672	<param name="timestamp" type="long long" dir="out" safearray="yes">
5673	<desc>
5674	The time stamps of the properties returned. The array entries match
5675	the corresponding entries in the @a name array.
5676	</desc>
5677	</param>
5678	<param name="flags" type="wstring" dir="out" safearray="yes">
5679	<desc>
5680	The flags of the properties returned. The array entries match the
5681	corresponding entries in the @a name array.
5682	</desc>
5683	</param>
5684	</method>
5685
5686	<method name="querySavedGuestSize">
5687	<desc>
5688	Returns the guest dimensions from the saved state.
5689	</desc>
5690	<param name="screenId" type="unsigned long" dir="in">
5691	<desc>
5692	Saved guest screen to query info from.
5693	</desc>
5694	</param>
5695	<param name="width" type="unsigned long" dir="out">
5696	<desc>
5697	Guest width at the time of the saved state was taken.
5698	</desc>
5699	</param>
5700	<param name="height" type="unsigned long" dir="out">
5701	<desc>
5702	Guest height at the time of the saved state was taken.
5703	</desc>
5704	</param>
5705	</method>
5706
5707	<method name="querySavedThumbnailSize">
5708	<desc>
5709	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5710	</desc>
5711	<param name="screenId" type="unsigned long" dir="in">
5712	<desc>
5713	Saved guest screen to query info from.
5714	</desc>
5715	</param>
5716	<param name="size" type="unsigned long" dir="out">
5717	<desc>
5718	Size of buffer required to store the bitmap.
5719	</desc>
5720	</param>
5721	<param name="width" type="unsigned long" dir="out">
5722	<desc>
5723	Bitmap width.
5724	</desc>
5725	</param>
5726	<param name="height" type="unsigned long" dir="out">
5727	<desc>
5728	Bitmap height.
5729	</desc>
5730	</param>
5731	</method>
5732
5733	<method name="readSavedThumbnailToArray">
5734	<desc>
5735	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5736	</desc>
5737	<param name="screenId" type="unsigned long" dir="in">
5738	<desc>
5739	Saved guest screen to read from.
5740	</desc>
5741	</param>
5742	<param name="BGR" type="boolean" dir="in">
5743	<desc>
5744	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5745	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5746	</desc>
5747	</param>
5748	<param name="width" type="unsigned long" dir="out">
5749	<desc>
5750	Bitmap width.
5751	</desc>
5752	</param>
5753	<param name="height" type="unsigned long" dir="out">
5754	<desc>
5755	Bitmap height.
5756	</desc>
5757	</param>
5758	<param name="data" type="octet" safearray="yes" dir="return">
5759	<desc>
5760	Array with resulting bitmap data.
5761	</desc>
5762	</param>
5763	</method>
5764
5765	<method name="readSavedThumbnailPNGToArray">
5766	<desc>
5767	Thumbnail in PNG format is retrieved to an array of bytes.
5768	</desc>
5769	<param name="screenId" type="unsigned long" dir="in">
5770	<desc>
5771	Saved guest screen to read from.
5772	</desc>
5773	</param>
5774	<param name="width" type="unsigned long" dir="out">
5775	<desc>
5776	Image width.
5777	</desc>
5778	</param>
5779	<param name="height" type="unsigned long" dir="out">
5780	<desc>
5781	Image height.
5782	</desc>
5783	</param>
5784	<param name="data" type="octet" dir="return" safearray="yes">
5785	<desc>
5786	Array with resulting PNG data.
5787	</desc>
5788	</param>
5789	</method>
5790
5791	<method name="querySavedScreenshotPNGSize">
5792	<desc>
5793	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5794	</desc>
5795	<param name="screenId" type="unsigned long" dir="in">
5796	<desc>
5797	Saved guest screen to query info from.
5798	</desc>
5799	</param>
5800	<param name="size" type="unsigned long" dir="out">
5801	<desc>
5802	Size of buffer required to store the PNG binary data.
5803	</desc>
5804	</param>
5805	<param name="width" type="unsigned long" dir="out">
5806	<desc>
5807	Image width.
5808	</desc>
5809	</param>
5810	<param name="height" type="unsigned long" dir="out">
5811	<desc>
5812	Image height.
5813	</desc>
5814	</param>
5815	</method>
5816
5817	<method name="readSavedScreenshotPNGToArray">
5818	<desc>
5819	Screenshot in PNG format is retrieved to an array of bytes.
5820	</desc>
5821	<param name="screenId" type="unsigned long" dir="in">
5822	<desc>
5823	Saved guest screen to read from.
5824	</desc>
5825	</param>
5826	<param name="width" type="unsigned long" dir="out">
5827	<desc>
5828	Image width.
5829	</desc>
5830	</param>
5831	<param name="height" type="unsigned long" dir="out">
5832	<desc>
5833	Image height.
5834	</desc>
5835	</param>
5836	<param name="data" type="octet" dir="return" safearray="yes">
5837	<desc>
5838	Array with resulting PNG data.
5839	</desc>
5840	</param>
5841	</method>
5842
5843	<method name="hotPlugCPU">
5844	<desc>
5845	Plugs a CPU into the machine.
5846	</desc>
5847	<param name="cpu" type="unsigned long" dir="in">
5848	<desc>
5849	The CPU id to insert.
5850	</desc>
5851	</param>
5852	</method>
5853
5854	<method name="hotUnplugCPU">
5855	<desc>
5856	Removes a CPU from the machine.
5857	</desc>
5858	<param name="cpu" type="unsigned long" dir="in">
5859	<desc>
5860	The CPU id to remove.
5861	</desc>
5862	</param>
5863	</method>
5864
5865	<method name="getCPUStatus">
5866	<desc>
5867	Returns the current status of the given CPU.
5868	</desc>
5869	<param name="cpu" type="unsigned long" dir="in">
5870	<desc>
5871	The CPU id to check for.
5872	</desc>
5873	</param>
5874	<param name="attached" type="boolean" dir="return">
5875	<desc>
5876	Status of the CPU.
5877	</desc>
5878	</param>
5879	</method>
5880
5881	<method name="queryLogFilename">
5882	<desc>
5883	Queries for the VM log file name of an given index. Returns an empty
5884	string if a log file with that index doesn't exists.
5885	</desc>
5886	<param name="idx" type="unsigned long" dir="in">
5887	<desc>
5888	Which log file name to query. 0=current log file.
5889	</desc>
5890	</param>
5891	<param name="filename" type="wstring" dir="return">
5892	<desc>
5893	On return the full path to the log file or an empty string on error.
5894	</desc>
5895	</param>
5896	</method>
5897
5898	<method name="readLog">
5899	<desc>
5900	Reads the VM log file. The chunk size is limited, so even if you
5901	ask for a big piece there might be less data returned.
5902	</desc>
5903	<param name="idx" type="unsigned long" dir="in">
5904	<desc>
5905	Which log file to read. 0=current log file.
5906	</desc>
5907	</param>
5908	<param name="offset" type="long long" dir="in">
5909	<desc>
5910	Offset in the log file.
5911	</desc>
5912	</param>
5913	<param name="size" type="long long" dir="in">
5914	<desc>
5915	Chunk size to read in the log file.
5916	</desc>
5917	</param>
5918	<param name="data" type="octet" dir="return" safearray="yes">
5919	<desc>
5920	Data read from the log file. A data size of 0 means end of file
5921	if the requested chunk size was not 0. This is the unprocessed
5922	file data, i.e. the line ending style depends on the platform of
5923	the system the server is running on.
5924	</desc>
5925	</param>
5926	</method>
5927	</interface>
5928
5929	<!--
5930	// IConsole
5931	/////////////////////////////////////////////////////////////////////////
5932	-->
5933
5934	<interface
5935	name="IVRDEServerInfo" extends="$unknown"
5936	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5937	wsmap="struct"
5938	>
5939	<desc>
5940	Contains information about the remote desktop (VRDE) server capabilities and status.
5941	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5942	</desc>
5943
5944	<attribute name="active" type="boolean" readonly="yes">
5945	<desc>
5946	Whether the remote desktop connection is active.
5947	</desc>
5948	</attribute>
5949
5950	<attribute name="port" type="long" readonly="yes">
5951	<desc>
5952	VRDE server port number. If this property is equal to <tt>0</tt>, then
5953	the VRDE server failed to start, usually because there are no free IP
5954	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5955	server has not yet been started.
5956	</desc>
5957	</attribute>
5958
5959	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5960	<desc>
5961	How many times a client connected.
5962	</desc>
5963	</attribute>
5964
5965	<attribute name="beginTime" type="long long" readonly="yes">
5966	<desc>
5967	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5968	</desc>
5969	</attribute>
5970
5971	<attribute name="endTime" type="long long" readonly="yes">
5972	<desc>
5973	When the last connection was terminated or the current time, if
5974	connection is still active, in milliseconds since 1970-01-01 UTC.
5975	</desc>
5976	</attribute>
5977
5978	<attribute name="bytesSent" type="long long" readonly="yes">
5979	<desc>
5980	How many bytes were sent in last or current, if still active, connection.
5981	</desc>
5982	</attribute>
5983
5984	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5985	<desc>
5986	How many bytes were sent in all connections.
5987	</desc>
5988	</attribute>
5989
5990	<attribute name="bytesReceived" type="long long" readonly="yes">
5991	<desc>
5992	How many bytes were received in last or current, if still active, connection.
5993	</desc>
5994	</attribute>
5995
5996	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5997	<desc>
5998	How many bytes were received in all connections.
5999	</desc>
6000	</attribute>
6001
6002	<attribute name="user" type="wstring" readonly="yes">
6003	<desc>
6004	Login user name supplied by the client.
6005	</desc>
6006	</attribute>
6007
6008	<attribute name="domain" type="wstring" readonly="yes">
6009	<desc>
6010	Login domain name supplied by the client.
6011	</desc>
6012	</attribute>
6013
6014	<attribute name="clientName" type="wstring" readonly="yes">
6015	<desc>
6016	The client name supplied by the client.
6017	</desc>
6018	</attribute>
6019
6020	<attribute name="clientIP" type="wstring" readonly="yes">
6021	<desc>
6022	The IP address of the client.
6023	</desc>
6024	</attribute>
6025
6026	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6027	<desc>
6028	The client software version number.
6029	</desc>
6030	</attribute>
6031
6032	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6033	<desc>
6034	Public key exchange method used when connection was established.
6035	Values: 0 - RDP4 public key exchange scheme.
6036	1 - X509 certificates were sent to client.
6037	</desc>
6038	</attribute>
6039
6040	</interface>
6041
6042	<interface
6043	name="IConsole" extends="$unknown"
6044	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6045	wsmap="managed"
6046	>
6047	<desc>
6048	The IConsole interface represents an interface to control virtual
6049	machine execution.
6050
6051	A console object gets created when a machine has been locked for a
6052	particular session (client process) using <link to="IMachine::lockMachine" />
6053	or <link to="IMachine::launchVMProcess"/>. The console object can
6054	then be found in the session's <link to="ISession::console" /> attribute.
6055
6056	Methods of the IConsole interface allow the caller to query the current
6057	virtual machine execution state, pause the machine or power it down, save
6058	the machine state or take a snapshot, attach and detach removable media
6059	and so on.
6060
6061	<see>ISession</see>
6062	</desc>
6063
6064	<attribute name="machine" type="IMachine" readonly="yes">
6065	<desc>
6066	Machine object for this console session.
6067	<note>
6068	This is a convenience property, it has the same value as
6069	<link to="ISession::machine"/> of the corresponding session
6070	object.
6071	</note>
6072	</desc>
6073	</attribute>
6074
6075	<attribute name="state" type="MachineState" readonly="yes">
6076	<desc>
6077	Current execution state of the machine.
6078	<note>
6079	This property always returns the same value as the corresponding
6080	property of the IMachine object for this console session.
6081	For the process that owns (executes) the VM, this is the
6082	preferable way of querying the VM state, because no IPC
6083	calls are made.
6084	</note>
6085	</desc>
6086	</attribute>
6087
6088	<attribute name="guest" type="IGuest" readonly="yes">
6089	<desc>Guest object.</desc>
6090	</attribute>
6091
6092	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6093	<desc>
6094	Virtual keyboard object.
6095	<note>
6096	If the machine is not running, any attempt to use
6097	the returned object will result in an error.
6098	</note>
6099	</desc>
6100	</attribute>
6101
6102	<attribute name="mouse" type="IMouse" readonly="yes">
6103	<desc>
6104	Virtual mouse object.
6105	<note>
6106	If the machine is not running, any attempt to use
6107	the returned object will result in an error.
6108	</note>
6109	</desc>
6110	</attribute>
6111
6112	<attribute name="display" type="IDisplay" readonly="yes">
6113	<desc>Virtual display object.
6114	<note>
6115	If the machine is not running, any attempt to use
6116	the returned object will result in an error.
6117	</note>
6118	</desc>
6119	</attribute>
6120
6121	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6122	<desc>Debugging interface.</desc>
6123	</attribute>
6124
6125	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6126	<desc>
6127	Collection of USB devices currently attached to the virtual
6128	USB controller.
6129	<note>
6130	The collection is empty if the machine is not running.
6131	</note>
6132	</desc>
6133	</attribute>
6134
6135	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6136	<desc>
6137	List of USB devices currently attached to the remote VRDE client.
6138	Once a new device is physically attached to the remote host computer,
6139	it appears in this list and remains there until detached.
6140	</desc>
6141	</attribute>
6142
6143	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6144	<desc>
6145	Collection of shared folders for the current session. These folders
6146	are called transient shared folders because they are available to the
6147	guest OS running inside the associated virtual machine only for the
6148	duration of the session (as opposed to
6149	<link to="IMachine::sharedFolders"/> which represent permanent shared
6150	folders). When the session is closed (e.g. the machine is powered down),
6151	these folders are automatically discarded.
6152
6153	New shared folders are added to the collection using
6154	<link to="#createSharedFolder"/>. Existing shared folders can be
6155	removed using <link to="#removeSharedFolder"/>.
6156	</desc>
6157	</attribute>
6158
6159	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6160	<desc>
6161	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6162	</desc>
6163	</attribute>
6164
6165	<attribute name="eventSource" type="IEventSource" readonly="yes">
6166	<desc>
6167	Event source for console events.
6168	</desc>
6169	</attribute>
6170
6171	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6172	<desc>Array of PCI devices attached to this machine.</desc>
6173	</attribute>
6174
6175	<method name="powerUp">
6176	<desc>
6177	Starts the virtual machine execution using the current machine
6178	state (that is, its current execution state, current settings and
6179	current storage devices).
6180
6181	<note>
6182	This method is only useful for front-ends that want to actually
6183	execute virtual machines in their own process (like the VirtualBox
6184	or VBoxSDL front-ends). Unless you are intending to write such a
6185	front-end, do not call this method. If you simply want to
6186	start virtual machine execution using one of the existing front-ends
6187	(for example the VirtualBox GUI or headless server), use
6188	<link to="IMachine::launchVMProcess"/> instead; these
6189	front-ends will power up the machine automatically for you.
6190	</note>
6191
6192	If the machine is powered off or aborted, the execution will
6193	start from the beginning (as if the real hardware were just
6194	powered on).
6195
6196	If the machine is in the <link to="MachineState_Saved"/> state,
6197	it will continue its execution the point where the state has
6198	been saved.
6199
6200	If the machine <link to="IMachine::teleporterEnabled"/> property is
6201	enabled on the machine being powered up, the machine will wait for an
6202	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6203	state. The returned progress object will have at least three
6204	operations where the last three are defined as: (1) powering up and
6205	starting TCP server, (2) waiting for incoming teleportations, and
6206	(3) perform teleportation. These operations will be reflected as the
6207	last three operations of the progress objected returned by
6208	<link to="IMachine::launchVMProcess"/> as well.
6209
6210	<see>#saveState</see>
6211
6212	<result name="VBOX_E_INVALID_VM_STATE">
6213	Virtual machine already running.
6214	</result>
6215	<result name="VBOX_E_HOST_ERROR">
6216	Host interface does not exist or name not set.
6217	</result>
6218	<result name="VBOX_E_FILE_ERROR">
6219	Invalid saved state file.
6220	</result>
6221	</desc>
6222	<param name="progress" type="IProgress" dir="return">
6223	<desc>Progress object to track the operation completion.</desc>
6224	</param>
6225	</method>
6226
6227	<method name="powerUpPaused">
6228	<desc>
6229	Identical to powerUp except that the VM will enter the
6230	<link to="MachineState_Paused"/> state, instead of
6231	<link to="MachineState_Running"/>.
6232
6233	<see>#powerUp</see>
6234	<result name="VBOX_E_INVALID_VM_STATE">
6235	Virtual machine already running.
6236	</result>
6237	<result name="VBOX_E_HOST_ERROR">
6238	Host interface does not exist or name not set.
6239	</result>
6240	<result name="VBOX_E_FILE_ERROR">
6241	Invalid saved state file.
6242	</result>
6243	</desc>
6244	<param name="progress" type="IProgress" dir="return">
6245	<desc>Progress object to track the operation completion.</desc>
6246	</param>
6247	</method>
6248
6249	<method name="powerDown">
6250	<desc>
6251	Initiates the power down procedure to stop the virtual machine
6252	execution.
6253
6254	The completion of the power down procedure is tracked using the returned
6255	IProgress object. After the operation is complete, the machine will go
6256	to the PoweredOff state.
6257	<result name="VBOX_E_INVALID_VM_STATE">
6258	Virtual machine must be Running, Paused or Stuck to be powered down.
6259	</result>
6260	</desc>
6261	<param name="progress" type="IProgress" dir="return">
6262	<desc>Progress object to track the operation completion.</desc>
6263	</param>
6264	</method>
6265
6266	<method name="reset">
6267	<desc>Resets the virtual machine.
6268	<result name="VBOX_E_INVALID_VM_STATE">
6269	Virtual machine not in Running state.
6270	</result>
6271	<result name="VBOX_E_VM_ERROR">
6272	Virtual machine error in reset operation.
6273	</result>
6274	</desc>
6275	</method>
6276
6277	<method name="pause">
6278	<desc>Pauses the virtual machine execution.
6279	<result name="VBOX_E_INVALID_VM_STATE">
6280	Virtual machine not in Running state.
6281	</result>
6282	<result name="VBOX_E_VM_ERROR">
6283	Virtual machine error in suspend operation.
6284	</result>
6285	</desc>
6286	</method>
6287
6288	<method name="resume">
6289	<desc>Resumes the virtual machine execution.
6290	<result name="VBOX_E_INVALID_VM_STATE">
6291	Virtual machine not in Paused state.
6292	</result>
6293	<result name="VBOX_E_VM_ERROR">
6294	Virtual machine error in resume operation.
6295	</result>
6296	</desc>
6297	</method>
6298
6299	<method name="powerButton">
6300	<desc>Sends the ACPI power button event to the guest.
6301	<result name="VBOX_E_INVALID_VM_STATE">
6302	Virtual machine not in Running state.
6303	</result>
6304	<result name="VBOX_E_PDM_ERROR">
6305	Controlled power off failed.
6306	</result>
6307	</desc>
6308	</method>
6309
6310	<method name="sleepButton">
6311	<desc>Sends the ACPI sleep button event to the guest.
6312	<result name="VBOX_E_INVALID_VM_STATE">
6313	Virtual machine not in Running state.
6314	</result>
6315	<result name="VBOX_E_PDM_ERROR">
6316	Sending sleep button event failed.
6317	</result>
6318	</desc>
6319	</method>
6320
6321	<method name="getPowerButtonHandled">
6322	<desc>Checks if the last power button event was handled by guest.
6323	<result name="VBOX_E_PDM_ERROR">
6324	Checking if the event was handled by the guest OS failed.
6325	</result>
6326	</desc>
6327	<param name="handled" type="boolean" dir="return"/>
6328	</method>
6329
6330	<method name="getGuestEnteredACPIMode">
6331	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6332	G1 (sleeping). If this method returns @c false, the guest will
6333	most likely not respond to external ACPI events.
6334	<result name="VBOX_E_INVALID_VM_STATE">
6335	Virtual machine not in Running state.
6336	</result>
6337	</desc>
6338	<param name="entered" type="boolean" dir="return"/>
6339	</method>
6340
6341	<method name="saveState">
6342	<desc>
6343	Saves the current execution state of a running virtual machine
6344	and stops its execution.
6345
6346	After this operation completes, the machine will go to the
6347	Saved state. Next time it is powered up, this state will
6348	be restored and the machine will continue its execution from
6349	the place where it was saved.
6350
6351	This operation differs from taking a snapshot to the effect
6352	that it doesn't create new differencing media. Also, once
6353	the machine is powered up from the state saved using this method,
6354	the saved state is deleted, so it will be impossible to return
6355	to this state later.
6356
6357	<note>
6358	On success, this method implicitly calls
6359	<link to="IMachine::saveSettings"/> to save all current machine
6360	settings (including runtime changes to the DVD medium, etc.).
6361	Together with the impossibility to change any VM settings when it is
6362	in the Saved state, this guarantees adequate hardware
6363	configuration of the machine when it is restored from the saved
6364	state file.
6365	</note>
6366
6367	<note>
6368	The machine must be in the Running or Paused state, otherwise
6369	the operation will fail.
6370	</note>
6371	<result name="VBOX_E_INVALID_VM_STATE">
6372	Virtual machine state neither Running nor Paused.
6373	</result>
6374	<result name="VBOX_E_FILE_ERROR">
6375	Failed to create directory for saved state file.
6376	</result>
6377
6378	<see><link to="#takeSnapshot"/></see>
6379	</desc>
6380	<param name="progress" type="IProgress" dir="return">
6381	<desc>Progress object to track the operation completion.</desc>
6382	</param>
6383	</method>
6384
6385	<method name="adoptSavedState">
6386	<desc>
6387	Associates the given saved state file to the virtual machine.
6388
6389	On success, the machine will go to the Saved state. Next time it is
6390	powered up, it will be restored from the adopted saved state and
6391	continue execution from the place where the saved state file was
6392	created.
6393
6394	The specified saved state file path may be absolute or relative to the
6395	folder the VM normally saves the state to (usually,
6396	<link to="IMachine::snapshotFolder"/>).
6397
6398	<note>
6399	It's a caller's responsibility to make sure the given saved state
6400	file is compatible with the settings of this virtual machine that
6401	represent its virtual hardware (memory size, storage disk configuration
6402	etc.). If there is a mismatch, the behavior of the virtual machine
6403	is undefined.
6404	</note>
6405	<result name="VBOX_E_INVALID_VM_STATE">
6406	Virtual machine state neither PoweredOff nor Aborted.
6407	</result>
6408	</desc>
6409	<param name="savedStateFile" type="wstring" dir="in">
6410	<desc>Path to the saved state file to adopt.</desc>
6411	</param>
6412	</method>
6413
6414	<method name="discardSavedState">
6415	<desc>
6416	Forcibly resets the machine to "Powered Off" state if it is
6417	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6418	Next time the machine is powered up, a clean boot will occur.
6419	<note>
6420	This operation is equivalent to resetting or powering off
6421	the machine without doing a proper shutdown of the guest
6422	operating system; as with resetting a running phyiscal
6423	computer, it can can lead to data loss.
6424	</note>
6425	If @a fRemoveFile is @c true, the file in the machine directory
6426	into which the machine state was saved is also deleted. If
6427	this is @c false, then the state can be recovered and later
6428	re-inserted into a machine using <link to="#adoptSavedState" />.
6429	The location of the file can be found in the
6430	<link to="IMachine::stateFilePath" /> attribute.
6431	<result name="VBOX_E_INVALID_VM_STATE">
6432	Virtual machine not in state Saved.
6433	</result>
6434	</desc>
6435	<param name="fRemoveFile" type="boolean" dir="in" >
6436	<desc>Whether to also remove the saved state file.</desc>
6437	</param>
6438	</method>
6439
6440	<method name="getDeviceActivity">
6441	<desc>
6442	Gets the current activity type of a given device or device group.
6443	<result name="E_INVALIDARG">
6444	Invalid device type.
6445	</result>
6446	</desc>
6447	<param name="type" type="DeviceType" dir="in"/>
6448	<param name="activity" type="DeviceActivity" dir="return"/>
6449	</method>
6450
6451	<method name="attachUSBDevice">
6452	<desc>
6453	Attaches a host USB device with the given UUID to the
6454	USB controller of the virtual machine.
6455
6456	The device needs to be in one of the following states:
6457	<link to="USBDeviceState_Busy"/>,
6458	<link to="USBDeviceState_Available"/> or
6459	<link to="USBDeviceState_Held"/>,
6460	otherwise an error is immediately returned.
6461
6462	When the device state is
6463	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6464	be returned if the host computer refuses to release it for some reason.
6465
6466	<see>IUSBController::deviceFilters, USBDeviceState</see>
6467	<result name="VBOX_E_INVALID_VM_STATE">
6468	Virtual machine state neither Running nor Paused.
6469	</result>
6470	<result name="VBOX_E_PDM_ERROR">
6471	Virtual machine does not have a USB controller.
6472	</result>
6473	</desc>
6474	<param name="id" type="uuid" mod="string" dir="in">
6475	<desc>UUID of the host USB device to attach.</desc>
6476	</param>
6477	</method>
6478
6479	<method name="detachUSBDevice">
6480	<desc>
6481	Detaches an USB device with the given UUID from the USB controller
6482	of the virtual machine.
6483
6484	After this method succeeds, the VirtualBox server re-initiates
6485	all USB filters as if the device were just physically attached
6486	to the host, but filters of this machine are ignored to avoid
6487	a possible automatic re-attachment.
6488
6489	<see>IUSBController::deviceFilters, USBDeviceState</see>
6490
6491	<result name="VBOX_E_PDM_ERROR">
6492	Virtual machine does not have a USB controller.
6493	</result>
6494	<result name="E_INVALIDARG">
6495	USB device not attached to this virtual machine.
6496	</result>
6497	</desc>
6498	<param name="id" type="uuid" mod="string" dir="in">
6499	<desc>UUID of the USB device to detach.</desc>
6500	</param>
6501	<param name="device" type="IUSBDevice" dir="return">
6502	<desc>Detached USB device.</desc>
6503	</param>
6504	</method>
6505
6506	<method name="findUSBDeviceByAddress">
6507	<desc>
6508	Searches for a USB device with the given host address.
6509
6510	<result name="VBOX_E_OBJECT_NOT_FOUND">
6511	Given @c name does not correspond to any USB device.
6512	</result>
6513
6514	<see>IUSBDevice::address</see>
6515	</desc>
6516	<param name="name" type="wstring" dir="in">
6517	<desc>
6518	Address of the USB device (as assigned by the host) to
6519	search for.
6520	</desc>
6521	</param>
6522	<param name="device" type="IUSBDevice" dir="return">
6523	<desc>Found USB device object.</desc>
6524	</param>
6525	</method>
6526
6527	<method name="findUSBDeviceById">
6528	<desc>
6529	Searches for a USB device with the given UUID.
6530
6531	<result name="VBOX_E_OBJECT_NOT_FOUND">
6532	Given @c id does not correspond to any USB device.
6533	</result>
6534
6535	<see>IUSBDevice::id</see>
6536	</desc>
6537	<param name="id" type="uuid" mod="string" dir="in">
6538	<desc>UUID of the USB device to search for.</desc>
6539	</param>
6540	<param name="device" type="IUSBDevice" dir="return">
6541	<desc>Found USB device object.</desc>
6542	</param>
6543	</method>
6544
6545	<method name="createSharedFolder">
6546	<desc>
6547	Creates a transient new shared folder by associating the given logical
6548	name with the given host path, adds it to the collection of shared
6549	folders and starts sharing it. Refer to the description of
6550	<link to="ISharedFolder"/> to read more about logical names.
6551
6552	<result name="VBOX_E_INVALID_VM_STATE">
6553	Virtual machine in Saved state or currently changing state.
6554	</result>
6555	<result name="VBOX_E_FILE_ERROR">
6556	Shared folder already exists or not accessible.
6557	</result>
6558	</desc>
6559	<param name="name" type="wstring" dir="in">
6560	<desc>Unique logical name of the shared folder.</desc>
6561	</param>
6562	<param name="hostPath" type="wstring" dir="in">
6563	<desc>Full path to the shared folder in the host file system.</desc>
6564	</param>
6565	<param name="writable" type="boolean" dir="in">
6566	<desc>Whether the share is writable or readonly</desc>
6567	</param>
6568	<param name="automount" type="boolean" dir="in">
6569	<desc>Whether the share gets automatically mounted by the guest
6570	or not.</desc>
6571	</param>
6572	</method>
6573
6574	<method name="removeSharedFolder">
6575	<desc>
6576	Removes a transient shared folder with the given name previously
6577	created by <link to="#createSharedFolder"/> from the collection of
6578	shared folders and stops sharing it.
6579	<result name="VBOX_E_INVALID_VM_STATE">
6580	Virtual machine in Saved state or currently changing state.
6581	</result>
6582	<result name="VBOX_E_FILE_ERROR">
6583	Shared folder does not exists.
6584	</result>
6585	</desc>
6586	<param name="name" type="wstring" dir="in">
6587	<desc>Logical name of the shared folder to remove.</desc>
6588	</param>
6589	</method>
6590
6591	<method name="takeSnapshot">
6592	<desc>
6593	Saves the current execution state
6594	and all settings of the machine and creates differencing images
6595	for all normal (non-independent) media.
6596	See <link to="ISnapshot" /> for an introduction to snapshots.
6597
6598	This method can be called for a PoweredOff, Saved (see
6599	<link to="#saveState"/>), Running or
6600	Paused virtual machine. When the machine is PoweredOff, an
6601	offline snapshot is created. When the machine is Running a live
6602	snapshot is created, and an online snapshot is is created when Paused.
6603
6604	The taken snapshot is always based on the
6605	<link to="IMachine::currentSnapshot">current snapshot</link>
6606	of the associated virtual machine and becomes a new current snapshot.
6607
6608	<note>
6609	This method implicitly calls <link to="IMachine::saveSettings"/> to
6610	save all current machine settings before taking an offline snapshot.
6611	</note>
6612
6613	<result name="VBOX_E_INVALID_VM_STATE">
6614	Virtual machine currently changing state.
6615	</result>
6616	</desc>
6617	<param name="name" type="wstring" dir="in">
6618	<desc>Short name for the snapshot.</desc>
6619	</param>
6620	<param name="description" type="wstring" dir="in">
6621	<desc>Optional description of the snapshot.</desc>
6622	</param>
6623	<param name="progress" type="IProgress" dir="return">
6624	<desc>Progress object to track the operation completion.</desc>
6625	</param>
6626	</method>
6627
6628	<method name="deleteSnapshot">
6629	<desc>
6630	Starts deleting the specified snapshot asynchronously.
6631	See <link to="ISnapshot" /> for an introduction to snapshots.
6632
6633	The execution state and settings of the associated machine stored in
6634	the snapshot will be deleted. The contents of all differencing media of
6635	this snapshot will be merged with the contents of their dependent child
6636	media to keep the medium chain valid (in other words, all changes
6637	represented by media being deleted will be propagated to their child
6638	medium). After that, this snapshot's differencing medium will be
6639	deleted. The parent of this snapshot will become a new parent for all
6640	its child snapshots.
6641
6642	If the deleted snapshot is the current one, its parent snapshot will
6643	become a new current snapshot. The current machine state is not directly
6644	affected in this case, except that currently attached differencing
6645	media based on media of the deleted snapshot will be also merged as
6646	described above.
6647
6648	If the deleted snapshot is the first or current snapshot, then the
6649	respective IMachine attributes will be adjusted. Deleting the current
6650	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6651	to make all current machine settings permanent.
6652
6653	Deleting a snapshot has the following preconditions:
6654
6655	<ul>
6656	<li>Child media of all normal media of the deleted snapshot
6657	must be accessible (see <link to="IMedium::state"/>) for this
6658	operation to succeed. In particular, this means that all virtual
6659	machines whose media are directly or indirectly based on the
6660	media of deleted snapshot must be powered off.</li>
6661
6662	<li>You cannot delete the snapshot if a medium attached to it has
6663	more than once child medium (differencing images) because otherwise
6664	merging would be impossible. This might be the case if there is
6665	more than one child snapshot or differencing images were created
6666	for other reason (e.g. implicitly because of multiple machine
6667	attachments).</li>
6668	</ul>
6669
6670
6671	The virtual machine's <link to="IMachine::state">state</link> is
6672	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6673	"DeletingSnapshotPaused" while this operation is in progress.
6674
6675	<note>
6676	Merging medium contents can be very time and disk space
6677	consuming, if these media are big in size and have many
6678	children. However, if the snapshot being deleted is the last
6679	(head) snapshot on the branch, the operation will be rather
6680	quick.
6681	</note>
6682	<result name="VBOX_E_INVALID_VM_STATE">
6683	The running virtual machine prevents deleting this snapshot. This
6684	happens only in very specific situations, usually snapshots can be
6685	deleted without trouble while a VM is running. The error message
6686	text explains the reason for the failure.
6687	</result>
6688	</desc>
6689	<param name="id" type="uuid" mod="string" dir="in">
6690	<desc>UUID of the snapshot to delete.</desc>
6691	</param>
6692	<param name="progress" type="IProgress" dir="return">
6693	<desc>Progress object to track the operation completion.</desc>
6694	</param>
6695	</method>
6696
6697	<method name="restoreSnapshot">
6698	<desc>
6699	Starts resetting the machine's current state to the state contained
6700	in the given snapshot, asynchronously. All current settings of the
6701	machine will be reset and changes stored in differencing media
6702	will be lost.
6703	See <link to="ISnapshot" /> for an introduction to snapshots.
6704
6705	After this operation is successfully completed, new empty differencing
6706	media are created for all normal media of the machine.
6707
6708	If the given snapshot is an online snapshot, the machine will go to
6709	the <link to="MachineState_Saved"> saved state</link>, so that the
6710	next time it is powered on, the execution state will be restored
6711	from the state of the snapshot.
6712
6713	<note>
6714	The machine must not be running, otherwise the operation will fail.
6715	</note>
6716
6717	<note>
6718	If the machine state is <link to="MachineState_Saved">Saved</link>
6719	prior to this operation, the saved state file will be implicitly
6720	deleted (as if <link to="IConsole::discardSavedState"/> were
6721	called).
6722	</note>
6723
6724	<result name="VBOX_E_INVALID_VM_STATE">
6725	Virtual machine is running.
6726	</result>
6727	</desc>
6728	<param name="snapshot" type="ISnapshot" dir="in">
6729	<desc>The snapshot to restore the VM state from.</desc>
6730	</param>
6731	<param name="progress" type="IProgress" dir="return">
6732	<desc>Progress object to track the operation completion.</desc>
6733	</param>
6734	</method>
6735
6736	<method name="teleport">
6737	<desc>
6738	Teleport the VM to a different host machine or process.
6739
6740	TODO explain the details.
6741
6742	<result name="VBOX_E_INVALID_VM_STATE">
6743	Virtual machine not running or paused.
6744	</result>
6745	</desc>
6746	<param name="hostname" type="wstring" dir="in">
6747	<desc>The name or IP of the host to teleport to.</desc>
6748	</param>
6749	<param name="tcpport" type="unsigned long" dir="in">
6750	<desc>The TCP port to connect to (1..65535).</desc>
6751	</param>
6752	<param name="password" type="wstring" dir="in">
6753	<desc>The password.</desc>
6754	</param>
6755	<param name="maxDowntime" type="unsigned long" dir="in">
6756	<desc>
6757	The maximum allowed downtime given as milliseconds. 0 is not a valid
6758	value. Recommended value: 250 ms.
6759
6760	The higher the value is, the greater the chance for a successful
6761	teleportation. A small value may easily result in the teleportation
6762	process taking hours and eventually fail.
6763
6764	<note>
6765	The current implementation treats this a guideline, not as an
6766	absolute rule.
6767	</note>
6768	</desc>
6769	</param>
6770	<param name="progress" type="IProgress" dir="return">
6771	<desc>Progress object to track the operation completion.</desc>
6772	</param>
6773	</method>
6774
6775	</interface>
6776
6777	<!--
6778	// IHost
6779	/////////////////////////////////////////////////////////////////////////
6780	-->
6781
6782	<enum
6783	name="HostNetworkInterfaceMediumType"
6784	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6785	>
6786	<desc>
6787	Type of encapsulation. Ethernet encapsulation includes both wired and
6788	wireless Ethernet connections.
6789	<see>IHostNetworkInterface</see>
6790	</desc>
6791
6792	<const name="Unknown" value="0">
6793	<desc>
6794	The type of interface cannot be determined.
6795	</desc>
6796	</const>
6797	<const name="Ethernet" value="1">
6798	<desc>
6799	Ethernet frame encapsulation.
6800	</desc>
6801	</const>
6802	<const name="PPP" value="2">
6803	<desc>
6804	Point-to-point protocol encapsulation.
6805	</desc>
6806	</const>
6807	<const name="SLIP" value="3">
6808	<desc>
6809	Serial line IP encapsulation.
6810	</desc>
6811	</const>
6812	</enum>
6813
6814	<enum
6815	name="HostNetworkInterfaceStatus"
6816	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6817	>
6818	<desc>
6819	Current status of the interface.
6820	<see>IHostNetworkInterface</see>
6821	</desc>
6822
6823	<const name="Unknown" value="0">
6824	<desc>
6825	The state of interface cannot be determined.
6826	</desc>
6827	</const>
6828	<const name="Up" value="1">
6829	<desc>
6830	The interface is fully operational.
6831	</desc>
6832	</const>
6833	<const name="Down" value="2">
6834	<desc>
6835	The interface is not functioning.
6836	</desc>
6837	</const>
6838	</enum>
6839
6840	<enum
6841	name="HostNetworkInterfaceType"
6842	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6843	>
6844	<desc>
6845	Network interface type.
6846	</desc>
6847	<const name="Bridged" value="1"/>
6848	<const name="HostOnly" value="2"/>
6849	</enum>
6850
6851	<interface
6852	name="IHostNetworkInterface" extends="$unknown"
6853	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6854	wsmap="managed"
6855	>
6856	<desc>
6857	Represents one of host's network interfaces. IP V6 address and network
6858	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6859	separated by colons.
6860	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6861	</desc>
6862	<attribute name="name" type="wstring" readonly="yes">
6863	<desc>Returns the host network interface name.</desc>
6864	</attribute>
6865
6866	<attribute name="id" type="uuid" mod="string" readonly="yes">
6867	<desc>Returns the interface UUID.</desc>
6868	</attribute>
6869
6870	<attribute name="networkName" type="wstring" readonly="yes">
6871	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6872	</attribute>
6873
6874	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6875	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6876	</attribute>
6877
6878	<attribute name="IPAddress" type="wstring" readonly="yes">
6879	<desc>Returns the IP V4 address of the interface.</desc>
6880	</attribute>
6881
6882	<attribute name="networkMask" type="wstring" readonly="yes">
6883	<desc>Returns the network mask of the interface.</desc>
6884	</attribute>
6885
6886	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6887	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6888	</attribute>
6889
6890	<attribute name="IPV6Address" type="wstring" readonly="yes">
6891	<desc>Returns the IP V6 address of the interface.</desc>
6892	</attribute>
6893
6894	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6895	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6896	</attribute>
6897
6898	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6899	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6900	</attribute>
6901
6902	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6903	<desc>Type of protocol encapsulation used.</desc>
6904	</attribute>
6905
6906	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6907	<desc>Status of the interface.</desc>
6908	</attribute>
6909
6910	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6911	<desc>specifies the host interface type.</desc>
6912	</attribute>
6913
6914	<method name="enableStaticIpConfig">
6915	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6916	<param name="IPAddress" type="wstring" dir="in">
6917	<desc>
6918	IP address.
6919	</desc>
6920	</param>
6921	<param name="networkMask" type="wstring" dir="in">
6922	<desc>
6923	network mask.
6924	</desc>
6925	</param>
6926	</method>
6927
6928	<method name="enableStaticIpConfigV6">
6929	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6930	<param name="IPV6Address" type="wstring" dir="in">
6931	<desc>
6932	IP address.
6933	</desc>
6934	</param>
6935	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6936	<desc>
6937	network mask.
6938	</desc>
6939	</param>
6940	</method>
6941
6942	<method name="enableDynamicIpConfig">
6943	<desc>enables the dynamic IP configuration.</desc>
6944	</method>
6945
6946	<method name="dhcpRediscover">
6947	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6948	</method>
6949
6950	</interface>
6951
6952	<interface
6953	name="IHost" extends="$unknown"
6954	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6955	wsmap="managed"
6956	>
6957	<desc>
6958	The IHost interface represents the physical machine that this VirtualBox
6959	installation runs on.
6960
6961	An object implementing this interface is returned by the
6962	<link to="IVirtualBox::host" /> attribute. This interface contains
6963	read-only information about the host's physical hardware (such as what
6964	processors and disks are available, what the host operating system is,
6965	and so on) and also allows for manipulating some of the host's hardware,
6966	such as global USB device filters and host interface networking.
6967
6968	</desc>
6969	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6970	<desc>List of DVD drives available on the host.</desc>
6971	</attribute>
6972
6973	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6974	<desc>List of floppy drives available on the host.</desc>
6975	</attribute>
6976
6977	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6978	<desc>
6979	List of USB devices currently attached to the host.
6980	Once a new device is physically attached to the host computer,
6981	it appears in this list and remains there until detached.
6982
6983	<note>
6984	If USB functionality is not available in the given edition of
6985	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6986	</note>
6987	</desc>
6988	</attribute>
6989
6990	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6991	<desc>
6992	List of USB device filters in action.
6993	When a new device is physically attached to the host computer,
6994	filters from this list are applied to it (in order they are stored
6995	in the list). The first matched filter will determine the
6996	<link to="IHostUSBDeviceFilter::action">action</link>
6997	performed on the device.
6998
6999	Unless the device is ignored by these filters, filters of all
7000	currently running virtual machines
7001	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7002
7003	<note>
7004	If USB functionality is not available in the given edition of
7005	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7006	</note>
7007
7008	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7009	</desc>
7010	</attribute>
7011
7012	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7013	<desc>List of host network interfaces currently defined on the host.</desc>
7014	</attribute>
7015
7016	<attribute name="processorCount" type="unsigned long" readonly="yes">
7017	<desc>Number of (logical) CPUs installed in the host system.</desc>
7018	</attribute>
7019
7020	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7021	<desc>Number of (logical) CPUs online in the host system.</desc>
7022	</attribute>
7023
7024	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7025	<desc>Number of physical processor cores installed in the host system.</desc>
7026	</attribute>
7027
7028	<method name="getProcessorSpeed">
7029	<desc>Query the (approximate) maximum speed of a specified host CPU in
7030	Megahertz.
7031	</desc>
7032	<param name="cpuId" type="unsigned long" dir="in">
7033	<desc>
7034	Identifier of the CPU.
7035	</desc>
7036	</param>
7037	<param name="speed" type="unsigned long" dir="return">
7038	<desc>
7039	Speed value. 0 is returned if value is not known or @a cpuId is
7040	invalid.
7041	</desc>
7042	</param>
7043	</method>
7044
7045	<method name="getProcessorFeature">
7046	<desc>Query whether a CPU feature is supported or not.</desc>
7047	<param name="feature" type="ProcessorFeature" dir="in">
7048	<desc>
7049	CPU Feature identifier.
7050	</desc>
7051	</param>
7052	<param name="supported" type="boolean" dir="return">
7053	<desc>
7054	Feature is supported or not.
7055	</desc>
7056	</param>
7057	</method>
7058
7059	<method name="getProcessorDescription">
7060	<desc>Query the model string of a specified host CPU.
7061	</desc>
7062	<param name="cpuId" type="unsigned long" dir="in">
7063	<desc>
7064	Identifier of the CPU.
7065	<note>
7066	The current implementation might not necessarily return the
7067	description for this exact CPU.
7068	</note>
7069	</desc>
7070	</param>
7071	<param name="description" type="wstring" dir="return">
7072	<desc>
7073	Model string. An empty string is returned if value is not known or
7074	@a cpuId is invalid.
7075	</desc>
7076	</param>
7077	</method>
7078
7079	<method name="getProcessorCPUIDLeaf">
7080	<desc>
7081	Returns the CPU cpuid information for the specified leaf.
7082	</desc>
7083	<param name="cpuId" type="unsigned long" dir="in">
7084	<desc>
7085	Identifier of the CPU. The CPU most be online.
7086	<note>
7087	The current implementation might not necessarily return the
7088	description for this exact CPU.
7089	</note>
7090	</desc>
7091	</param>
7092	<param name="leaf" type="unsigned long" dir="in">
7093	<desc>
7094	CPUID leaf index (eax).
7095	</desc>
7096	</param>
7097	<param name="subLeaf" type="unsigned long" dir="in">
7098	<desc>
7099	CPUID leaf sub index (ecx). This currently only applies to cache
7100	information on Intel CPUs. Use 0 if retrieving values for
7101	<link to="IMachine::setCPUIDLeaf"/>.
7102	</desc>
7103	</param>
7104	<param name="valEax" type="unsigned long" dir="out">
7105	<desc>
7106	CPUID leaf value for register eax.
7107	</desc>
7108	</param>
7109	<param name="valEbx" type="unsigned long" dir="out">
7110	<desc>
7111	CPUID leaf value for register ebx.
7112	</desc>
7113	</param>
7114	<param name="valEcx" type="unsigned long" dir="out">
7115	<desc>
7116	CPUID leaf value for register ecx.
7117	</desc>
7118	</param>
7119	<param name="valEdx" type="unsigned long" dir="out">
7120	<desc>
7121	CPUID leaf value for register edx.
7122	</desc>
7123	</param>
7124	</method>
7125
7126	<attribute name="memorySize" type="unsigned long" readonly="yes">
7127	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7128	</attribute>
7129
7130	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7131	<desc>Available system memory in the host system.</desc>
7132	</attribute>
7133
7134	<attribute name="operatingSystem" type="wstring" readonly="yes">
7135	<desc>Name of the host system's operating system.</desc>
7136	</attribute>
7137
7138	<attribute name="OSVersion" type="wstring" readonly="yes">
7139	<desc>Host operating system's version string.</desc>
7140	</attribute>
7141
7142	<attribute name="UTCTime" type="long long" readonly="yes">
7143	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7144	</attribute>
7145
7146	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7147	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7148	</attribute>
7149
7150	<method name="createHostOnlyNetworkInterface">
7151	<desc>
7152	Creates a new adapter for Host Only Networking.
7153	<result name="E_INVALIDARG">
7154	Host network interface @a name already exists.
7155	</result>
7156	</desc>
7157	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7158	<desc>
7159	Created host interface object.
7160	</desc>
7161	</param>
7162	<param name="progress" type="IProgress" dir="return">
7163	<desc>
7164	Progress object to track the operation completion.
7165	</desc>
7166	</param>
7167	</method>
7168
7169	<method name="removeHostOnlyNetworkInterface">
7170	<desc>
7171	Removes the given Host Only Networking interface.
7172	<result name="VBOX_E_OBJECT_NOT_FOUND">
7173	No host network interface matching @a id found.
7174	</result>
7175	</desc>
7176	<param name="id" type="uuid" mod="string" dir="in">
7177	<desc>
7178	Adapter GUID.
7179	</desc>
7180	</param>
7181	<param name="progress" type="IProgress" dir="return">
7182	<desc>
7183	Progress object to track the operation completion.
7184	</desc>
7185	</param>
7186	</method>
7187
7188	<method name="createUSBDeviceFilter">
7189	<desc>
7190	Creates a new USB device filter. All attributes except
7191	the filter name are set to empty (any match),
7192	<i>active</i> is @c false (the filter is not active).
7193
7194	The created filter can be added to the list of filters using
7195	<link to="#insertUSBDeviceFilter"/>.
7196
7197	<see>#USBDeviceFilters</see>
7198	</desc>
7199	<param name="name" type="wstring" dir="in">
7200	<desc>
7201	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7202	</desc>
7203	</param>
7204	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7205	<desc>Created filter object.</desc>
7206	</param>
7207	</method>
7208
7209	<method name="insertUSBDeviceFilter">
7210	<desc>
7211	Inserts the given USB device to the specified position
7212	in the list of filters.
7213
7214	Positions are numbered starting from @c 0. If the specified
7215	position is equal to or greater than the number of elements in
7216	the list, the filter is added at the end of the collection.
7217
7218	<note>
7219	Duplicates are not allowed, so an attempt to insert a
7220	filter already in the list is an error.
7221	</note>
7222	<note>
7223	If USB functionality is not available in the given edition of
7224	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7225	</note>
7226
7227	<see>#USBDeviceFilters</see>
7228
7229	<result name="VBOX_E_INVALID_OBJECT_STATE">
7230	USB device filter is not created within this VirtualBox instance.
7231	</result>
7232	<result name="E_INVALIDARG">
7233	USB device filter already in list.
7234	</result>
7235
7236	</desc>
7237	<param name="position" type="unsigned long" dir="in">
7238	<desc>Position to insert the filter to.</desc>
7239	</param>
7240	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7241	<desc>USB device filter to insert.</desc>
7242	</param>
7243	</method>
7244
7245	<method name="removeUSBDeviceFilter">
7246	<desc>
7247	Removes a USB device filter from the specified position in the
7248	list of filters.
7249
7250	Positions are numbered starting from @c 0. Specifying a
7251	position equal to or greater than the number of elements in
7252	the list will produce an error.
7253
7254	<note>
7255	If USB functionality is not available in the given edition of
7256	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7257	</note>
7258
7259	<see>#USBDeviceFilters</see>
7260
7261	<result name="E_INVALIDARG">
7262	USB device filter list empty or invalid @a position.
7263	</result>
7264
7265	</desc>
7266	<param name="position" type="unsigned long" dir="in">
7267	<desc>Position to remove the filter from.</desc>
7268	</param>
7269	</method>
7270
7271	<method name="findHostDVDDrive">
7272	<desc>
7273	Searches for a host DVD drive with the given @c name.
7274
7275	<result name="VBOX_E_OBJECT_NOT_FOUND">
7276	Given @c name does not correspond to any host drive.
7277	</result>
7278
7279	</desc>
7280	<param name="name" type="wstring" dir="in">
7281	<desc>Name of the host drive to search for</desc>
7282	</param>
7283	<param name="drive" type="IMedium" dir="return">
7284	<desc>Found host drive object</desc>
7285	</param>
7286	</method>
7287
7288	<method name="findHostFloppyDrive">
7289	<desc>
7290	Searches for a host floppy drive with the given @c name.
7291
7292	<result name="VBOX_E_OBJECT_NOT_FOUND">
7293	Given @c name does not correspond to any host floppy drive.
7294	</result>
7295
7296	</desc>
7297	<param name="name" type="wstring" dir="in">
7298	<desc>Name of the host floppy drive to search for</desc>
7299	</param>
7300	<param name="drive" type="IMedium" dir="return">
7301	<desc>Found host floppy drive object</desc>
7302	</param>
7303	</method>
7304
7305	<method name="findHostNetworkInterfaceByName">
7306	<desc>
7307	Searches through all host network interfaces for an interface with
7308	the given @c name.
7309	<note>
7310	The method returns an error if the given @c name does not
7311	correspond to any host network interface.
7312	</note>
7313	</desc>
7314	<param name="name" type="wstring" dir="in">
7315	<desc>Name of the host network interface to search for.</desc>
7316	</param>
7317	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7318	<desc>Found host network interface object.</desc>
7319	</param>
7320	</method>
7321	<method name="findHostNetworkInterfaceById">
7322	<desc>
7323	Searches through all host network interfaces for an interface with
7324	the given GUID.
7325	<note>
7326	The method returns an error if the given GUID does not
7327	correspond to any host network interface.
7328	</note>
7329	</desc>
7330	<param name="id" type="uuid" mod="string" dir="in">
7331	<desc>GUID of the host network interface to search for.</desc>
7332	</param>
7333	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7334	<desc>Found host network interface object.</desc>
7335	</param>
7336	</method>
7337	<method name="findHostNetworkInterfacesOfType">
7338	<desc>
7339	Searches through all host network interfaces and returns a list of interfaces of the specified type
7340	</desc>
7341	<param name="type" type="HostNetworkInterfaceType" dir="in">
7342	<desc>type of the host network interfaces to search for.</desc>
7343	</param>
7344	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7345	<desc>Found host network interface objects.</desc>
7346	</param>
7347	</method>
7348
7349	<method name="findUSBDeviceById">
7350	<desc>
7351	Searches for a USB device with the given UUID.
7352
7353	<result name="VBOX_E_OBJECT_NOT_FOUND">
7354	Given @c id does not correspond to any USB device.
7355	</result>
7356
7357	<see>IHostUSBDevice::id</see>
7358	</desc>
7359	<param name="id" type="uuid" mod="string" dir="in">
7360	<desc>UUID of the USB device to search for.</desc>
7361	</param>
7362	<param name="device" type="IHostUSBDevice" dir="return">
7363	<desc>Found USB device object.</desc>
7364	</param>
7365	</method>
7366
7367	<method name="findUSBDeviceByAddress">
7368	<desc>
7369	Searches for a USB device with the given host address.
7370
7371	<result name="VBOX_E_OBJECT_NOT_FOUND">
7372	Given @c name does not correspond to any USB device.
7373	</result>
7374
7375	<see>IHostUSBDevice::address</see>
7376	</desc>
7377	<param name="name" type="wstring" dir="in">
7378	<desc>
7379	Address of the USB device (as assigned by the host) to
7380	search for.
7381	</desc>
7382	</param>
7383	<param name="device" type="IHostUSBDevice" dir="return">
7384	<desc>Found USB device object.</desc>
7385	</param>
7386	</method>
7387
7388	</interface>
7389
7390	<!--
7391	// ISystemProperties
7392	/////////////////////////////////////////////////////////////////////////
7393	-->
7394
7395	<interface
7396	name="ISystemProperties"
7397	extends="$unknown"
7398	uuid="2f89cdfe-2d10-43d4-b37f-61760f877f29"
7399	wsmap="managed"
7400	>
7401	<desc>
7402	The ISystemProperties interface represents global properties of the given
7403	VirtualBox installation.
7404
7405	These properties define limits and default values for various attributes
7406	and parameters. Most of the properties are read-only, but some can be
7407	changed by a user.
7408	</desc>
7409
7410	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7411	<desc>Minimum guest system memory in Megabytes.</desc>
7412	</attribute>
7413
7414	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7415	<desc>Maximum guest system memory in Megabytes.</desc>
7416	</attribute>
7417
7418	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7419	<desc>Minimum guest video memory in Megabytes.</desc>
7420	</attribute>
7421
7422	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7423	<desc>Maximum guest video memory in Megabytes.</desc>
7424	</attribute>
7425
7426	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7427	<desc>Minimum CPU count.</desc>
7428	</attribute>
7429
7430	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7431	<desc>Maximum CPU count.</desc>
7432	</attribute>
7433
7434	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7435	<desc>Maximum of monitors which could be connected.</desc>
7436	</attribute>
7437
7438	<attribute name="infoVDSize" type="long long" readonly="yes">
7439	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7440	does not reflect the limits of any virtual disk image format.</desc>
7441	</attribute>
7442
7443	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7444	<desc>
7445	Maximum number of serial ports associated with every
7446	<link to="IMachine"/> instance.
7447	</desc>
7448	</attribute>
7449
7450	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7451	<desc>
7452	Maximum number of parallel ports associated with every
7453	<link to="IMachine"/> instance.
7454	</desc>
7455	</attribute>
7456
7457	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7458	<desc>
7459	Maximum device position in the boot order. This value corresponds
7460	to the total number of devices a machine can boot from, to make it
7461	possible to include all possible devices to the boot list.
7462	<see><link to="IMachine::setBootOrder"/></see>
7463	</desc>
7464	</attribute>
7465
7466	<attribute name="defaultMachineFolder" type="wstring">
7467	<desc>
7468	Full path to the default directory used to create new or open
7469	existing machines when a machine settings file name contains no
7470	path.
7471
7472	Starting with VirtualBox 4.0, by default, this attribute contains
7473	the full path of folder named "VirtualBox VMs" in the user's
7474	home directory, which depends on the host platform.
7475
7476	When setting this attribute, a full path must be specified.
7477	Setting this property to @c null or an empty string or the
7478	special value "Machines" (for compatibility reasons) will restore
7479	that default value.
7480
7481	If the folder specified herein does not exist, it will be created
7482	automatically as needed.
7483
7484	<see>
7485	<link to="IVirtualBox::createMachine"/>,
7486	<link to="IVirtualBox::openMachine"/>
7487	</see>
7488	</desc>
7489	</attribute>
7490
7491	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7492	<desc>
7493	List of all medium storage formats supported by this VirtualBox
7494	installation.
7495
7496	Keep in mind that the medium format identifier
7497	(<link to="IMediumFormat::id"/>) used in other API calls like
7498	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7499	medium format is a case-insensitive string. This means that, for
7500	example, all of the following strings:
7501	<pre>
7502	"VDI"
7503	"vdi"
7504	"VdI"</pre>
7505	refer to the same medium format.
7506
7507	Note that the virtual medium framework is backend-based, therefore
7508	the list of supported formats depends on what backends are currently
7509	installed.
7510
7511	<see>
7512	<link to="IMediumFormat"/>,
7513	</see>
7514	</desc>
7515	</attribute>
7516
7517	<attribute name="defaultHardDiskFormat" type="wstring">
7518	<desc>
7519	Identifier of the default medium format used by VirtualBox.
7520
7521	The medium format set by this attribute is used by VirtualBox
7522	when the medium format was not specified explicitly. One example is
7523	<link to="IVirtualBox::createHardDisk"/> with the empty
7524	format argument. A more complex example is implicit creation of
7525	differencing media when taking a snapshot of a virtual machine:
7526	this operation will try to use a format of the parent medium first
7527	and if this format does not support differencing media the default
7528	format specified by this argument will be used.
7529
7530	The list of supported medium formats may be obtained by the
7531	<link to="#mediumFormats"/> call. Note that the default medium
7532	format must have a capability to create differencing media;
7533	otherwise operations that create media implicitly may fail
7534	unexpectedly.
7535
7536	The initial value of this property is <tt>"VDI"</tt> in the current
7537	version of the VirtualBox product, but may change in the future.
7538
7539	<note>
7540	Setting this property to @c null or empty string will restore the
7541	initial value.
7542	</note>
7543
7544	<see>
7545	<link to="#mediumFormats"/>,
7546	<link to="IMediumFormat::id"/>,
7547	<link to="IVirtualBox::createHardDisk"/>
7548	</see>
7549	</desc>
7550	</attribute>
7551
7552	<attribute name="freeDiskSpaceWarning" type="long long">
7553	<desc>Issue a warning if the free disk space is below (or in some disk
7554	intensive operation is expected to go below) the given size in
7555	bytes.</desc>
7556	</attribute>
7557
7558	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7559	<desc>Issue a warning if the free disk space is below (or in some disk
7560	intensive operation is expected to go below) the given percentage.</desc>
7561	</attribute>
7562
7563	<attribute name="freeDiskSpaceError" type="long long">
7564	<desc>Issue an error if the free disk space is below (or in some disk
7565	intensive operation is expected to go below) the given size in
7566	bytes.</desc>
7567	</attribute>
7568
7569	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7570	<desc>Issue an error if the free disk space is below (or in some disk
7571	intensive operation is expected to go below) the given percentage.</desc>
7572	</attribute>
7573
7574	<attribute name="VRDEAuthLibrary" type="wstring">
7575	<desc>
7576	Library that provides authentication for Remote Desktop clients. The library
7577	is used if a virtual machine's authentication type is set to "external"
7578	in the VM RemoteDisplay configuration.
7579
7580	The system library extension (".DLL" or ".so") must be omitted.
7581	A full path can be specified; if not, then the library must reside on the
7582	system's default library path.
7583
7584	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7585	of that name in one of the default VirtualBox library directories.
7586
7587	For details about VirtualBox authentication libraries and how to implement
7588	them, please refer to the VirtualBox manual.
7589
7590	<note>
7591	Setting this property to @c null or empty string will restore the
7592	initial value.
7593	</note>
7594	</desc>
7595	</attribute>
7596
7597	<attribute name="webServiceAuthLibrary" type="wstring">
7598	<desc>
7599	Library that provides authentication for webservice clients. The library
7600	is used if a virtual machine's authentication type is set to "external"
7601	in the VM RemoteDisplay configuration and will be called from
7602	within the <link to="IWebsessionManager::logon" /> implementation.
7603
7604	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7605	there is no per-VM setting for this, as the webservice is a global
7606	resource (if it is running). Only for this setting (for the webservice),
7607	setting this value to a literal <tt>"null"</tt> string disables authentication,
7608	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7609	no matter what user name and password are supplied.
7610
7611	The initial value of this property is <tt>"VBoxAuth"</tt>,
7612	meaning that the webservice will use the same authentication
7613	library that is used by default for VRDE (again, see
7614	<link to="ISystemProperties::VRDEAuthLibrary" />).
7615	The format and calling convention of authentication libraries
7616	is the same for the webservice as it is for VRDE.
7617
7618	<note>
7619	Setting this property to @c null or empty string will restore the
7620	initial value.
7621	</note>
7622	</desc>
7623	</attribute>
7624
7625	<attribute name="defaultVRDEExtPack" type="wstring">
7626	<desc>
7627	The name of the extension pack providing the default VRDE.
7628
7629	This attribute is for choosing between multiple extension packs
7630	providing VRDE. If only one is installed, it will automatically be the
7631	default one. The attribute value can be empty if no VRDE extension
7632	pack is installed.
7633
7634	For details about VirtualBox Remote Desktop Extension and how to
7635	implement one, please refer to the VirtualBox SDK.
7636	</desc>
7637	</attribute>
7638
7639	<attribute name="LogHistoryCount" type="unsigned long">
7640	<desc>
7641	This value specifies how many old release log files are kept.
7642	</desc>
7643	</attribute>
7644
7645	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7646	<desc>This value hold the default audio driver for the current
7647	system.</desc>
7648	</attribute>
7649
7650
7651	<method name="getMaxNetworkAdapters">
7652	<desc>
7653	Maximum total number of network adapters associated with every
7654	<link to="IMachine"/> instance.
7655	</desc>
7656
7657	<param name="chipset" type="ChipsetType" dir="in">
7658	<desc>The chipset type to get the value for.</desc>
7659	</param>
7660
7661
7662	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7663	<desc>The maximum total number of network adapters allowed.</desc>
7664	</param>
7665
7666	</method>
7667
7668	<method name="getMaxNetworkAdaptersOfType">
7669	<desc>
7670	Maximum number of network adapters of a given attachment type,
7671	associated with every <link to="IMachine"/> instance.
7672	</desc>
7673
7674	<param name="chipset" type="ChipsetType" dir="in">
7675	<desc>The chipset type to get the value for.</desc>
7676	</param>
7677
7678	<param name="type" type="NetworkAttachmentType" dir="in">
7679	<desc>Type of attachment.</desc>
7680	</param>
7681
7682	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7683	<desc>The maximum number of network adapters allowed for
7684	particular chipset and attachment type.</desc>
7685	</param>
7686
7687	</method>
7688
7689
7690	<method name="getMaxDevicesPerPortForStorageBus">
7691	<desc>Returns the maximum number of devices which can be attached to a port
7692	for the given storage bus.</desc>
7693
7694	<param name="bus" type="StorageBus" dir="in">
7695	<desc>The storage bus type to get the value for.</desc>
7696	</param>
7697
7698	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7699	<desc>The maximum number of devices which can be attached to the port for the given
7700	storage bus.</desc>
7701	</param>
7702	</method>
7703
7704	<method name="getMinPortCountForStorageBus">
7705	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7706
7707	<param name="bus" type="StorageBus" dir="in">
7708	<desc>The storage bus type to get the value for.</desc>
7709	</param>
7710
7711	<param name="minPortCount" type="unsigned long" dir="return">
7712	<desc>The minimum number of ports for the given storage bus.</desc>
7713	</param>
7714	</method>
7715
7716	<method name="getMaxPortCountForStorageBus">
7717	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7718
7719	<param name="bus" type="StorageBus" dir="in">
7720	<desc>The storage bus type to get the value for.</desc>
7721	</param>
7722
7723	<param name="maxPortCount" type="unsigned long" dir="return">
7724	<desc>The maximum number of ports for the given storage bus.</desc>
7725	</param>
7726	</method>
7727
7728	<method name="getMaxInstancesOfStorageBus">
7729	<desc>Returns the maximum number of storage bus instances which
7730	can be configured for each VM. This corresponds to the number of
7731	storage controllers one can have. Value may depend on chipset type
7732	used.</desc>
7733
7734	<param name="chipset" type="ChipsetType" dir="in">
7735	<desc>The chipset type to get the value for.</desc>
7736	</param>
7737
7738	<param name="bus" type="StorageBus" dir="in">
7739	<desc>The storage bus type to get the value for.</desc>
7740	</param>
7741
7742	<param name="maxInstances" type="unsigned long" dir="return">
7743	<desc>The maximum number of instances for the given storage bus.</desc>
7744	</param>
7745	</method>
7746
7747	<method name="getDeviceTypesForStorageBus">
7748	<desc>Returns list of all the supported device types
7749	(<link to="DeviceType"/>) for the given type of storage
7750	bus.</desc>
7751
7752	<param name="bus" type="StorageBus" dir="in">
7753	<desc>The storage bus type to get the value for.</desc>
7754	</param>
7755
7756	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7757	<desc>The list of all supported device types for the given storage bus.</desc>
7758	</param>
7759	</method>
7760
7761	<method name="getDefaultIoCacheSettingForStorageController">
7762	<desc>Returns the default I/O cache setting for the
7763	given storage controller</desc>
7764
7765	<param name="controllerType" type="StorageControllerType" dir="in">
7766	<desc>The storage controller to the setting for.</desc>
7767	</param>
7768
7769	<param name="enabled" type="boolean" dir="return">
7770	<desc>Returned flag indicating the default value</desc>
7771	</param>
7772	</method>
7773	</interface>
7774
7775	<!--
7776	// IGuest
7777	/////////////////////////////////////////////////////////////////////////
7778	-->
7779
7780	<interface
7781	name="IGuestOSType" extends="$unknown"
7782	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7783	wsmap="struct"
7784	>
7785	<desc>
7786	</desc>
7787
7788	<attribute name="familyId" type="wstring" readonly="yes">
7789	<desc>Guest OS family identifier string.</desc>
7790	</attribute>
7791
7792	<attribute name="familyDescription" type="wstring" readonly="yes">
7793	<desc>Human readable description of the guest OS family.</desc>
7794	</attribute>
7795
7796	<attribute name="id" type="wstring" readonly="yes">
7797	<desc>Guest OS identifier string.</desc>
7798	</attribute>
7799
7800	<attribute name="description" type="wstring" readonly="yes">
7801	<desc>Human readable description of the guest OS.</desc>
7802	</attribute>
7803
7804	<attribute name="is64Bit" type="boolean" readonly="yes">
7805	<desc>Returns @c true if the given OS is 64-bit</desc>
7806	</attribute>
7807
7808	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7809	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7810	</attribute>
7811
7812	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7813	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7814	</attribute>
7815
7816	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7817	<desc>Recommended RAM size in Megabytes.</desc>
7818	</attribute>
7819
7820	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7821	<desc>Recommended video RAM size in Megabytes.</desc>
7822	</attribute>
7823
7824	<attribute name="recommendedHDD" type="long long" readonly="yes">
7825	<desc>Recommended hard disk size in bytes.</desc>
7826	</attribute>
7827
7828	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7829	<desc>Returns recommended network adapter for this OS type.</desc>
7830	</attribute>
7831
7832	<attribute name="recommendedPae" type="boolean" readonly="yes">
7833	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7834	</attribute>
7835
7836	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7837	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7838	</attribute>
7839
7840	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7841	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7842	</attribute>
7843
7844	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7845	<desc>Recommended storage controller type for HD drives.</desc>
7846	</attribute>
7847
7848	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7849	<desc>Recommended storage bus type for HD drives.</desc>
7850	</attribute>
7851
7852	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7853	<desc>Recommended firmware type.</desc>
7854	</attribute>
7855
7856	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7857	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7858	</attribute>
7859
7860	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7861	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7862	</attribute>
7863
7864	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7865	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7866	</attribute>
7867
7868	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7869	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7870	</attribute>
7871
7872	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7873	<desc>Recommended chipset type.</desc>
7874	</attribute>
7875
7876	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7877	<desc>Recommended audio type.</desc>
7878	</attribute>
7879
7880	</interface>
7881
7882	<enum
7883	name="AdditionsFacilityType"
7884	uuid="bcf4f5e7-86d6-4b8c-99cd-449a79114fb4"
7885	>
7886	<desc>
7887	Guest Additions facility IDs.
7888	</desc>
7889
7890	<const name="None" value="0">
7891	<desc>No/invalid facility.</desc>
7892	</const>
7893	<const name="VBoxGuestDriver" value="20">
7894	<desc>VirtualBox base driver (VBoxGuest).</desc>
7895	</const>
7896	<const name="VBoxService" value="100">
7897	<desc>VirtualBox system service (VBoxService).</desc>
7898	</const>
7899	<const name="VBoxTrayClient" value="101">
7900	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
7901	</const>
7902	<const name="All" value="999">
7903	<desc>All facilities selected.</desc>
7904	</const>
7905	</enum>
7906
7907	<enum
7908	name="AdditionsFacilityStatus"
7909	uuid="730a42a1-dac6-4194-b394-744a5ea487f3"
7910	>
7911	<desc>
7912	Guest Additions facility states.
7913	</desc>
7914
7915	<const name="Disabled" value="0">
7916	<desc>Facility is disabled.</desc>
7917	</const>
7918	<const name="Inactive" value="1">
7919	<desc>Facility is enabled but inactive.</desc>
7920	</const>
7921	<const name="Paused" value="2">
7922	<desc>Facility has been paused.</desc>
7923	</const>
7924	<const name="PreInit" value="20">
7925	<desc>Facility is preparing to initialize.</desc>
7926	</const>
7927	<const name="Init" value="30">
7928	<desc>Facility is initializing.</desc>
7929	</const>
7930	<const name="Active" value="50">
7931	<desc>Facility is up and running.</desc>
7932	</const>
7933	<const name="Terminating" value="100">
7934	<desc>Facility is shutting down.</desc>
7935	</const>
7936	<const name="Terminated" value="101">
7937	<desc>Facility successfully shut down.</desc>
7938	</const>
7939	<const name="Failed" value="800">
7940	<desc>Facility failed to start.</desc>
7941	</const>
7942	<const name="Unknown" value="999">
7943	<desc>Facility status is unknown.</desc>
7944	</const>
7945	</enum>
7946
7947	<enum
7948	name="AdditionsRunLevelType"
7949	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
7950	>
7951	<desc>
7952	Guest Additions run level type.
7953	</desc>
7954
7955	<const name="None" value="0">
7956	<desc>Guest Additions are not loaded.</desc>
7957	</const>
7958	<const name="System" value="1">
7959	<desc>Guest drivers are loaded.</desc>
7960	</const>
7961	<const name="Userland" value="2">
7962	<desc>Common components (such as application services) are loaded.</desc>
7963	</const>
7964	<const name="Desktop" value="3">
7965	<desc>Per-user desktop components are loaded.</desc>
7966	</const>
7967	</enum>
7968
7969	<enum
7970	name="AdditionsUpdateFlag"
7971	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
7972	>
7973	<desc>
7974	Guest Additions update flags.
7975	</desc>
7976
7977	<const name="None" value="0">
7978	<desc>No flag set.</desc>
7979	</const>
7980	<const name="WaitForUpdateStartOnly" value="1">
7981	<desc>Only wait for the update process being started and do not
7982	wait while peforming the actual update.</desc>
7983	</const>
7984	</enum>
7985
7986	<enum
7987	name="ExecuteProcessFlag"
7988	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
7989	>
7990	<desc>
7991	Guest process execution flags.
7992	</desc>
7993
7994	<const name="None" value="0">
7995	<desc>No flag set.</desc>
7996	</const>
7997
7998	<const name="WaitForProcessStartOnly" value="1">
7999	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8000	process itself then uses an infinite timeout.</desc>
8001	</const>
8002
8003	<const name="IgnoreOrphanedProcesses" value="2">
8004	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8005	</const>
8006
8007	<const name="Hidden" value="4">
8008	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8009	</const>
8010	</enum>
8011
8012	<enum
8013	name="ProcessInputFlag"
8014	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8015	>
8016	<desc>
8017	Guest process input flags.
8018	</desc>
8019
8020	<const name="None" value="0">
8021	<desc>No flag set.</desc>
8022	</const>
8023	<const name="EndOfFile" value="1">
8024	<desc>End of file (input) reached.</desc>
8025	</const>
8026	</enum>
8027
8028	<enum
8029	name="CopyFileFlag"
8030	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8031	>
8032	<desc>
8033	Host/Guest copy flags. At the moment none of these flags
8034	are implemented.
8035	</desc>
8036
8037	<const name="None" value="0">
8038	<desc>No flag set.</desc>
8039	</const>
8040
8041	<const name="Recursive" value="1">
8042	<desc>Copy directories recursively.</desc>
8043	</const>
8044
8045	<const name="Update" value="2">
8046	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8047	</const>
8048
8049	<const name="FollowLinks" value="4">
8050	<desc>Follow symbolic links.</desc>
8051	</const>
8052	</enum>
8053
8054	<enum
8055	name="CreateDirectoryFlag"
8056	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
8057	>
8058	<desc>
8059	Directory creation flags.
8060	</desc>
8061
8062	<const name="None" value="0">
8063	<desc>No flag set.</desc>
8064	</const>
8065
8066	<const name="Parents" value="1">
8067	<desc>No error if existing, make parent directories as needed.</desc>
8068	</const>
8069	</enum>
8070
8071	<interface
8072	name="IGuest" extends="$unknown"
8073	uuid="09c2e2e0-f6f9-45ec-91a1-aaab3fad9f1f"
8074	wsmap="managed"
8075	>
8076	<desc>
8077	The IGuest interface represents information about the operating system
8078	running inside the virtual machine. Used in
8079	<link to="IConsole::guest"/>.
8080
8081	IGuest provides information about the guest operating system, whether
8082	Guest Additions are installed and other OS-specific virtual machine
8083	properties.
8084	</desc>
8085
8086	<attribute name="OSTypeId" type="wstring" readonly="yes">
8087	<desc>
8088	Identifier of the Guest OS type as reported by the Guest
8089	Additions.
8090	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8091	an IGuestOSType object representing details about the given
8092	Guest OS type.
8093	<note>
8094	If Guest Additions are not installed, this value will be
8095	the same as <link to="IMachine::OSTypeId"/>.
8096	</note>
8097	</desc>
8098	</attribute>
8099
8100	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8101	<desc>
8102	Current run level of the Guest Additions.
8103	</desc>
8104	</attribute>
8105
8106	<attribute name="additionsVersion" type="wstring" readonly="yes">
8107	<desc>
8108	Version of the Guest Additions including the revision (3 decimal numbers
8109	separated by dots + revision number) installed on the guest or empty
8110	when the Additions are not installed.
8111	</desc>
8112	</attribute>
8113
8114	<attribute name="supportsSeamless" type="boolean" readonly="yes">
8115	<desc>
8116	Flag whether seamless guest display rendering (seamless desktop
8117	integration) is supported.
8118	</desc>
8119	</attribute>
8120
8121	<attribute name="supportsGraphics" type="boolean" readonly="yes">
8122	<desc>
8123	Flag whether the guest is in graphics mode. If it is not, then
8124	seamless rendering will not work, resize hints are not immediately
8125	acted on and guest display resizes are probably not initiated by
8126	the guest additions.
8127	</desc>
8128	</attribute>
8129
8130	<attribute name="memoryBalloonSize" type="unsigned long">
8131	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8132	</attribute>
8133
8134	<attribute name="statisticsUpdateInterval" type="unsigned long">
8135	<desc>Interval to update guest statistics in seconds.</desc>
8136	</attribute>
8137
8138	<method name="internalGetStatistics">
8139	<desc>
8140	Internal method; do not use as it might change at any time.
8141	</desc>
8142	<param name="cpuUser" type="unsigned long" dir="out">
8143	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8144	</param>
8145	<param name="cpuKernel" type="unsigned long" dir="out">
8146	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8147	</param>
8148	<param name="cpuIdle" type="unsigned long" dir="out">
8149	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8150	</param>
8151	<param name="memTotal" type="unsigned long" dir="out">
8152	<desc>Total amount of physical guest RAM.</desc>
8153	</param>
8154	<param name="memFree" type="unsigned long" dir="out">
8155	<desc>Free amount of physical guest RAM.</desc>
8156	</param>
8157	<param name="memBalloon" type="unsigned long" dir="out">
8158	<desc>Amount of ballooned physical guest RAM.</desc>
8159	</param>
8160	<param name="memShared" type="unsigned long" dir="out">
8161	<desc>Amount of shared physical guest RAM.</desc>
8162	</param>
8163	<param name="memCache" type="unsigned long" dir="out">
8164	<desc>Total amount of guest (disk) cache memory.</desc>
8165	</param>
8166	<param name="pagedTotal" type="unsigned long" dir="out">
8167	<desc>Total amount of space in the page file.</desc>
8168	</param>
8169	<param name="memAllocTotal" type="unsigned long" dir="out">
8170	<desc>Total amount of memory allocated by the hypervisor.</desc>
8171	</param>
8172	<param name="memFreeTotal" type="unsigned long" dir="out">
8173	<desc>Total amount of free memory available in the hypervisor.</desc>
8174	</param>
8175	<param name="memBalloonTotal" type="unsigned long" dir="out">
8176	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8177	</param>
8178	<param name="memSharedTotal" type="unsigned long" dir="out">
8179	<desc>Total amount of shared memory in the hypervisor.</desc>
8180	</param>
8181	</method>
8182
8183	<method name="getFacilityStatus">
8184	<desc>
8185	Get the current status of a Guest Additions facility.
8186	</desc>
8187	<param name="facility" type="AdditionsFacilityType" dir="in">
8188	<desc>Facility to check status for.</desc>
8189	</param>
8190	<param name="timestamp" type="long long" dir="out">
8191	<desc>Timestamp (in ms) of last status update of this facility seen by the host.</desc>
8192	</param>
8193	<param name="status" type="AdditionsFacilityStatus" dir="return">
8194	<desc>The current (latest) facility status.</desc>
8195	</param>
8196	</method>
8197
8198	<method name="getAdditionsStatus">
8199	<desc>
8200	Retrieve the current status of a certain Guest Additions run level.
8201
8202	<result name="VBOX_E_NOT_SUPPORTED">
8203	Wrong status level specified.
8204	</result>
8205
8206	</desc>
8207	<param name="level" type="AdditionsRunLevelType" dir="in">
8208	<desc>Status level to check</desc>
8209	</param>
8210	<param name="active" type="boolean" dir="return">
8211	<desc>Flag whether the status level has been reached or not</desc>
8212	</param>
8213	</method>
8214
8215	<method name="setCredentials">
8216	<desc>
8217	Store login credentials that can be queried by guest operating
8218	systems with Additions installed. The credentials are transient
8219	to the session and the guest may also choose to erase them. Note
8220	that the caller cannot determine whether the guest operating system
8221	has queried or made use of the credentials.
8222
8223	<result name="VBOX_E_VM_ERROR">
8224	VMM device is not available.
8225	</result>
8226
8227	</desc>
8228	<param name="userName" type="wstring" dir="in">
8229	<desc>User name string, can be empty</desc>
8230	</param>
8231	<param name="password" type="wstring" dir="in">
8232	<desc>Password string, can be empty</desc>
8233	</param>
8234	<param name="domain" type="wstring" dir="in">
8235	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8236	</param>
8237	<param name="allowInteractiveLogon" type="boolean" dir="in">
8238	<desc>
8239	Flag whether the guest should alternatively allow the user to
8240	interactively specify different credentials. This flag might
8241	not be supported by all versions of the Additions.
8242	</desc>
8243	</param>
8244	</method>
8245
8246	<method name="executeProcess">
8247	<desc>
8248	Executes an existing program inside the guest VM.
8249
8250	<result name="VBOX_E_IPRT_ERROR">
8251	Could not execute process.
8252	</result>
8253
8254	</desc>
8255	<param name="execName" type="wstring" dir="in">
8256	<desc>
8257	Full path name of the command to execute on the guest; the
8258	commands has to exists in the guest VM in order to be executed.
8259	</desc>
8260	</param>
8261	<param name="flags" type="unsigned long" dir="in">
8262	<desc>
8263	<link to="ExecuteProcessFlag"/> flags.
8264	</desc>
8265	</param>
8266	<param name="arguments" type="wstring" safearray="yes" dir="in">
8267	<desc>
8268	Array of arguments passed to the execution command.
8269	</desc>
8270	</param>
8271	<param name="environment" type="wstring" safearray="yes" dir="in">
8272	<desc>
8273	Environment variables that can be set while the command is being
8274	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8275	variable just set its name ("NAME") without a value.
8276	</desc>
8277	</param>
8278	<param name="userName" type="wstring" dir="in">
8279	<desc>
8280	User name under which the command will be executed; has to exist
8281	and have the appropriate rights to execute programs in the VM.
8282	</desc>
8283	</param>
8284	<param name="password" type="wstring" dir="in">
8285	<desc>
8286	Password of the user account specified.
8287	</desc>
8288	</param>
8289	<param name="timeoutMS" type="unsigned long" dir="in">
8290	<desc>
8291	The maximum timeout value (in msec) to wait for finished program
8292	execution. Pass 0 for an infinite timeout.
8293	</desc>
8294	</param>
8295	<param name="pid" type="unsigned long" dir="out">
8296	<desc>
8297	The PID (process ID) of the started command for later reference.
8298	</desc>
8299	</param>
8300	<param name="progress" type="IProgress" dir="return">
8301	<desc>Progress object to track the operation completion.</desc>
8302	</param>
8303	</method>
8304
8305	<method name="getProcessOutput">
8306	<desc>
8307	Retrieves output of a formerly started process.
8308
8309	<result name="VBOX_E_IPRT_ERROR">
8310	Could not retrieve output.
8311	</result>
8312
8313	</desc>
8314	<param name="pid" type="unsigned long" dir="in">
8315	<desc>
8316	Process id returned by earlier executeProcess() call.
8317	</desc>
8318	</param>
8319	<param name="flags" type="unsigned long" dir="in">
8320	<desc>
8321	Flags describing which output to retrieve.
8322	</desc>
8323	</param>
8324	<param name="timeoutMS" type="unsigned long" dir="in">
8325	<desc>
8326	The maximum timeout value (in msec) to wait for output
8327	data. Pass 0 for an infinite timeout.
8328	</desc>
8329	</param>
8330	<param name="size" type="long long" dir="in">
8331	<desc>
8332	Size in bytes to read in the buffer.
8333	</desc>
8334	</param>
8335	<param name="data" type="octet" dir="return" safearray="yes">
8336	<desc>
8337	Buffer for retrieving the actual output. A data size of 0 means end of file
8338	if the requested size was not 0. This is the unprocessed
8339	output data, i.e. the line ending style depends on the platform of
8340	the system the server is running on.
8341	</desc>
8342	</param>
8343	</method>
8344
8345	<method name="getProcessStatus">
8346	<desc>
8347	Retrieves status, exit code and the exit reason of a formerly started process.
8348
8349	<result name="VBOX_E_IPRT_ERROR">
8350	Process with specified PID was not found.
8351	</result>
8352
8353	</desc>
8354	<param name="pid" type="unsigned long" dir="in">
8355	<desc>
8356	Process id returned by earlier executeProcess() call.
8357	</desc>
8358	</param>
8359	<param name="exitcode" type="unsigned long" dir="out">
8360	<desc>
8361	The exit code (if available).
8362	</desc>
8363	</param>
8364	<param name="flags" type="unsigned long" dir="out">
8365	<desc>
8366	Additional flags of process status. Not used at the moment and
8367	must be set to 0.
8368	</desc>
8369	</param>
8370	<param name="reason" type="unsigned long" dir="return">
8371	<desc>
8372	The current process status.
8373	</desc>
8374	</param>
8375	</method>
8376
8377	<method name="copyToGuest">
8378	<desc>
8379	Copies files/directories from host to the guest.
8380
8381	<result name="VBOX_E_IPRT_ERROR">
8382	Error while copying.
8383	</result>
8384
8385	</desc>
8386	<param name="source" type="wstring" dir="in">
8387	<desc>
8388	Source file on the host to copy.
8389	</desc>
8390	</param>
8391	<param name="dest" type="wstring" dir="in">
8392	<desc>
8393	Destination path on the guest.
8394	</desc>
8395	</param>
8396	<param name="userName" type="wstring" dir="in">
8397	<desc>
8398	User name under which the copy command will be executed; the
8399	user has to exist and have the appropriate rights to write to
8400	the destination path.
8401	</desc>
8402	</param>
8403	<param name="password" type="wstring" dir="in">
8404	<desc>
8405	Password of the user account specified.
8406	</desc>
8407	</param>
8408	<param name="flags" type="unsigned long" dir="in">
8409	<desc>
8410	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8411	</desc>
8412	</param>
8413	<param name="progress" type="IProgress" dir="return">
8414	<desc>Progress object to track the operation completion.</desc>
8415	</param>
8416	</method>
8417
8418	<method name="createDirectory">
8419	<desc>
8420	Creates a directory on the guest.
8421
8422	<result name="VBOX_E_IPRT_ERROR">
8423	Error while creating directory.
8424	</result>
8425
8426	</desc>
8427	<param name="directory" type="wstring" dir="in">
8428	<desc>
8429	Directory to create.
8430	</desc>
8431	</param>
8432	<param name="userName" type="wstring" dir="in">
8433	<desc>
8434	User name under which the directory creation will be executed; the
8435	user has to exist and have the appropriate rights to create the
8436	desired directory.
8437	</desc>
8438	</param>
8439	<param name="password" type="wstring" dir="in">
8440	<desc>
8441	Password of the user account specified.
8442	</desc>
8443	</param>
8444	<param name="mode" type="unsigned long" dir="in">
8445	<desc>
8446	File mode.
8447	</desc>
8448	</param>
8449	<param name="flags" type="unsigned long" dir="in">
8450	<desc>
8451	<link to="CreateDirectoryFlag"/> flags.
8452	</desc>
8453	</param>
8454	<param name="progress" type="IProgress" dir="return">
8455	<desc>Progress object to track the operation completion.</desc>
8456	</param>
8457	</method>
8458
8459	<method name="setProcessInput">
8460	<desc>
8461	Sends input into a formerly started process.
8462
8463	<result name="VBOX_E_IPRT_ERROR">
8464	Could not send input.
8465	</result>
8466
8467	</desc>
8468	<param name="pid" type="unsigned long" dir="in">
8469	<desc>
8470	Process id returned by earlier executeProcess() call.
8471	</desc>
8472	</param>
8473	<param name="flags" type="unsigned long" dir="in">
8474	<desc>
8475	<link to="ProcessInputFlag"/> flags.
8476	</desc>
8477	</param>
8478	<param name="timeoutMS" type="unsigned long" dir="in">
8479	<desc>
8480	The maximum timeout value (in msec) to wait for getting the
8481	data transfered to the guest. Pass 0 for an infinite timeout.
8482	</desc>
8483	</param>
8484	<param name="data" type="octet" dir="in" safearray="yes">
8485	<desc>
8486	Buffer of input data to send to the started process to.
8487	</desc>
8488	</param>
8489	<param name="written" type="unsigned long" dir="return">
8490	<desc>
8491	Number of bytes written.
8492	</desc>
8493	</param>
8494	</method>
8495
8496	<method name="updateGuestAdditions">
8497	<desc>
8498	Updates already installed Guest Additions in a VM
8499	(Windows guests only).
8500
8501	<result name="VBOX_E_IPRT_ERROR">
8502	Error while updating.
8503	</result>
8504
8505	</desc>
8506	<param name="source" type="wstring" dir="in">
8507	<desc>
8508	Path to the Guest Additions .ISO file to use for the upate.
8509	</desc>
8510	</param>
8511	<param name="flags" type="unsigned long" dir="in">
8512	<desc>
8513	<link to="AdditionsUpdateFlag"/> flags.
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	</interface>
8522
8523
8524	<!--
8525	// IProgress
8526	/////////////////////////////////////////////////////////////////////////
8527	-->
8528
8529	<interface
8530	name="IProgress" extends="$unknown"
8531	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8532	wsmap="managed"
8533	>
8534	<desc>
8535	The IProgress interface is used to track and control
8536	asynchronous tasks within VirtualBox.
8537
8538	An instance of this is returned every time VirtualBox starts
8539	an asynchronous task (in other words, a separate thread) which
8540	continues to run after a method call returns. For example,
8541	<link to="IConsole::saveState" />, which saves the state of
8542	a running virtual machine, can take a long time to complete.
8543	To be able to display a progress bar, a user interface such as
8544	the VirtualBox graphical user interface can use the IProgress
8545	object returned by that method.
8546
8547	Note that IProgress is a "read-only" interface in the sense
8548	that only the VirtualBox internals behind the Main API can
8549	create and manipulate progress objects, whereas client code
8550	can only use the IProgress object to monitor a task's
8551	progress and, if <link to="#cancelable" /> is @c true,
8552	cancel the task by calling <link to="#cancel" />.
8553
8554	A task represented by IProgress consists of either one or
8555	several sub-operations that run sequentially, one by one (see
8556	<link to="#operation" /> and <link to="#operationCount" />).
8557	Every operation is identified by a number (starting from 0)
8558	and has a separate description.
8559
8560	You can find the individual percentage of completion of the current
8561	operation in <link to="#operationPercent" /> and the
8562	percentage of completion of the task as a whole
8563	in <link to="#percent" />.
8564
8565	Similarly, you can wait for the completion of a particular
8566	operation via <link to="#waitForOperationCompletion" /> or
8567	for the completion of the whole task via
8568	<link to="#waitForCompletion" />.
8569	</desc>
8570
8571	<attribute name="id" type="uuid" mod="string" readonly="yes">
8572	<desc>ID of the task.</desc>
8573	</attribute>
8574
8575	<attribute name="description" type="wstring" readonly="yes">
8576	<desc>Description of the task.</desc>
8577	</attribute>
8578
8579	<attribute name="initiator" type="$unknown" readonly="yes">
8580	<desc>Initiator of the task.</desc>
8581	</attribute>
8582
8583	<attribute name="cancelable" type="boolean" readonly="yes">
8584	<desc>Whether the task can be interrupted.</desc>
8585	</attribute>
8586
8587	<attribute name="percent" type="unsigned long" readonly="yes">
8588	<desc>
8589	Current progress value of the task as a whole, in percent.
8590	This value depends on how many operations are already complete.
8591	Returns 100 if <link to="#completed" /> is @c true.
8592	</desc>
8593	</attribute>
8594
8595	<attribute name="timeRemaining" type="long" readonly="yes">
8596	<desc>
8597	Estimated remaining time until the task completes, in
8598	seconds. Returns 0 once the task has completed; returns -1
8599	if the remaining time cannot be computed, in particular if
8600	the current progress is 0.
8601
8602	Even if a value is returned, the estimate will be unreliable
8603	for low progress values. It will become more reliable as the
8604	task progresses; it is not recommended to display an ETA
8605	before at least 20% of a task have completed.
8606	</desc>
8607	</attribute>
8608
8609	<attribute name="completed" type="boolean" readonly="yes">
8610	<desc>Whether the task has been completed.</desc>
8611	</attribute>
8612
8613	<attribute name="canceled" type="boolean" readonly="yes">
8614	<desc>Whether the task has been canceled.</desc>
8615	</attribute>
8616
8617	<attribute name="resultCode" type="long" readonly="yes">
8618	<desc>
8619	Result code of the progress task.
8620	Valid only if <link to="#completed"/> is @c true.
8621	</desc>
8622	</attribute>
8623
8624	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8625	<desc>
8626	Extended information about the unsuccessful result of the
8627	progress operation. May be @c null if no extended information
8628	is available.
8629	Valid only if <link to="#completed"/> is @c true and
8630	<link to="#resultCode"/> indicates a failure.
8631	</desc>
8632	</attribute>
8633
8634	<attribute name="operationCount" type="unsigned long" readonly="yes">
8635	<desc>
8636	Number of sub-operations this task is divided into.
8637	Every task consists of at least one suboperation.
8638	</desc>
8639	</attribute>
8640
8641	<attribute name="operation" type="unsigned long" readonly="yes">
8642	<desc>Number of the sub-operation being currently executed.</desc>
8643	</attribute>
8644
8645	<attribute name="operationDescription" type="wstring" readonly="yes">
8646	<desc>
8647	Description of the sub-operation being currently executed.
8648	</desc>
8649	</attribute>
8650
8651	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8652	<desc>Progress value of the current sub-operation only, in percent.</desc>
8653	</attribute>
8654
8655	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8656	<desc>Weight value of the current sub-operation only.</desc>
8657	</attribute>
8658
8659	<attribute name="timeout" type="unsigned long">
8660	<desc>
8661	When non-zero, this specifies the number of milliseconds after which
8662	the operation will automatically be canceled. This can only be set on
8663	cancelable objects.
8664	</desc>
8665	</attribute>
8666
8667	<method name="setCurrentOperationProgress">
8668	<desc>Internal method, not to be called externally.</desc>
8669	<param name="percent" type="unsigned long" dir="in" />
8670	</method>
8671	<method name="setNextOperation">
8672	<desc>Internal method, not to be called externally.</desc>
8673	<param name="nextOperationDescription" type="wstring" dir="in" />
8674	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8675	</method>
8676
8677	<method name="waitForCompletion">
8678	<desc>
8679	Waits until the task is done (including all sub-operations)
8680	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8681
8682	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8683	thread are not processed while waiting. Neglecting event queues may
8684	have dire consequences (degrade performance, resource hogs,
8685	deadlocks, etc.), this is specially so for the main thread on
8686	platforms using XPCOM. Callers are adviced wait for short periods
8687	and service their event queues between calls, or to create a worker
8688	thread to do the waiting.
8689
8690	<result name="VBOX_E_IPRT_ERROR">
8691	Failed to wait for task completion.
8692	</result>
8693	</desc>
8694
8695	<param name="timeout" type="long" dir="in">
8696	<desc>
8697	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8698	</desc>
8699	</param>
8700	</method>
8701
8702	<method name="waitForOperationCompletion">
8703	<desc>
8704	Waits until the given operation is done with a given timeout in
8705	milliseconds; specify -1 for an indefinite wait.
8706
8707	See <link to="#waitForCompletion"> for event queue considerations.</link>
8708
8709	<result name="VBOX_E_IPRT_ERROR">
8710	Failed to wait for operation completion.
8711	</result>
8712
8713	</desc>
8714	<param name="operation" type="unsigned long" dir="in">
8715	<desc>
8716	Number of the operation to wait for.
8717	Must be less than <link to="#operationCount"/>.
8718	</desc>
8719	</param>
8720	<param name="timeout" type="long" dir="in">
8721	<desc>
8722	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8723	</desc>
8724	</param>
8725	</method>
8726
8727	<method name="cancel">
8728	<desc>
8729	Cancels the task.
8730	<note>
8731	If <link to="#cancelable"/> is @c false, then this method will fail.
8732	</note>
8733
8734	<result name="VBOX_E_INVALID_OBJECT_STATE">
8735	Operation cannot be canceled.
8736	</result>
8737
8738	</desc>
8739	</method>
8740
8741	</interface>
8742
8743	<!--
8744	// ISnapshot
8745	/////////////////////////////////////////////////////////////////////////
8746	-->
8747
8748	<interface
8749	name="ISnapshot" extends="$unknown"
8750	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8751	wsmap="managed"
8752	>
8753	<desc>
8754	The ISnapshot interface represents a snapshot of the virtual
8755	machine.
8756
8757	Together with the differencing media that are created
8758	when a snapshot is taken, a machine can be brought back to
8759	the exact state it was in when the snapshot was taken.
8760
8761	The ISnapshot interface has no methods, only attributes; snapshots
8762	are controlled through methods of the <link to="IConsole" /> interface
8763	which also manage the media associated with the snapshot.
8764	The following operations exist:
8765
8766	<ul>
8767	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8768	by creating new, empty differencing images for the machine's
8769	media and saving the VM settings and (if the VM is running)
8770	the current VM state in the snapshot.
8771
8772	The differencing images will then receive all data written to
8773	the machine's media, while their parent (base) images
8774	remain unmodified after the snapshot has been taken (see
8775	<link to="IMedium" /> for details about differencing images).
8776	This simplifies restoring a machine to the state of a snapshot:
8777	only the differencing images need to be deleted.
8778
8779	The current machine state is not changed by taking a snapshot
8780	except that <link to="IMachine::currentSnapshot" /> is set to
8781	the newly created snapshot, which is also added to the machine's
8782	snapshots tree.
8783	</li>
8784
8785	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8786	the state of a previous snapshot by deleting the differencing
8787	image of each of the machine's media and setting the machine's
8788	settings and state to the state that was saved in the snapshot (if any).
8789
8790	This destroys the machine's current state. After calling this,
8791	<link to="IMachine::currentSnapshot" /> points to the snapshot
8792	that was restored.
8793	</li>
8794
8795	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8796	without affecting the current machine state.
8797
8798	This does not change the current machine state, but instead frees the
8799	resources allocated when the snapshot was taken: the settings and machine
8800	state file are deleted (if any), and the snapshot's differencing image for
8801	each of the machine's media gets merged with its parent image.
8802
8803	Neither the current machine state nor other snapshots are affected
8804	by this operation, except that parent media will be modified
8805	to contain the disk data associated with the snapshot being deleted.
8806
8807	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8808	attribute is set to the current snapshot's parent or NULL if it
8809	has no parent. Otherwise the attribute is unchanged.
8810	</li>
8811	</ul>
8812
8813	Each snapshot contains a copy of virtual machine's settings (hardware
8814	configuration etc.). This copy is contained in an immutable (read-only)
8815	instance of <link to="IMachine" /> which is available from the snapshot's
8816	<link to="#machine" /> attribute. When restoring the snapshot, these
8817	settings are copied back to the original machine.
8818
8819	In addition, if the machine was running when the
8820	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8821	the current VM state is saved in the snapshot (similarly to what happens
8822	when a VM's state is saved). The snapshot is then said to be <i>online</i>
8823	because when restoring it, the VM will be running.
8824
8825	If the machine was in <link to="MachineState_Saved">saved</link> saved,
8826	the snapshot receives a copy of the execution state file
8827	(<link to="IMachine::stateFilePath"/>).
8828
8829	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8830	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8831	it then contains a so-called "zero execution state", representing a
8832	machine that is powered off.
8833	</desc>
8834
8835	<attribute name="id" type="uuid" mod="string" readonly="yes">
8836	<desc>UUID of the snapshot.</desc>
8837	</attribute>
8838
8839	<attribute name="name" type="wstring">
8840	<desc>Short name of the snapshot.
8841	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8842	be called implicitly.</note>
8843	</desc>
8844	</attribute>
8845
8846	<attribute name="description" type="wstring">
8847	<desc>Optional description of the snapshot.
8848	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8849	be called implicitly.</note>
8850	</desc>
8851	</attribute>
8852
8853	<attribute name="timeStamp" type="long long" readonly="yes">
8854	<desc>
8855	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8856	</desc>
8857	</attribute>
8858
8859	<attribute name="online" type="boolean" readonly="yes">
8860	<desc>
8861	@c true if this snapshot is an online snapshot and @c false otherwise.
8862
8863	When this attribute is @c true, the
8864	<link to="IMachine::stateFilePath"/> attribute of the
8865	<link to="#machine"/> object associated with this snapshot
8866	will point to the saved state file. Otherwise, it will be
8867	an empty string.
8868	</desc>
8869	</attribute>
8870
8871	<attribute name="machine" type="IMachine" readonly="yes">
8872	<desc>
8873	Virtual machine this snapshot is taken on. This object
8874	stores all settings the machine had when taking this snapshot.
8875	<note>
8876	The returned machine object is immutable, i.e. no
8877	any settings can be changed.
8878	</note>
8879	</desc>
8880	</attribute>
8881
8882	<attribute name="parent" type="ISnapshot" readonly="yes">
8883	<desc>
8884	Parent snapshot (a snapshot this one is based on), or
8885	@c null if the snapshot has no parent (i.e. is the first snapshot).
8886	</desc>
8887	</attribute>
8888
8889	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8890	<desc>
8891	Child snapshots (all snapshots having this one as a parent).
8892	By inspecting this attribute starting with a machine's root snapshot
8893	(which can be obtained by calling <link to="IMachine::findSnapshot" />
8894	with a @c null UUID), a machine's snapshots tree can be iterated over.
8895	</desc>
8896	</attribute>
8897
8898	</interface>
8899
8900
8901	<!--
8902	// IMedium
8903	/////////////////////////////////////////////////////////////////////////
8904	-->
8905
8906	<enum
8907	name="MediumState"
8908	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8909	>
8910	<desc>
8911	Virtual medium state.
8912	<see>IMedium</see>
8913	</desc>
8914
8915	<const name="NotCreated" value="0">
8916	<desc>
8917	Associated medium storage does not exist (either was not created yet or
8918	was deleted).
8919	</desc>
8920	</const>
8921	<const name="Created" value="1">
8922	<desc>
8923	Associated storage exists and accessible; this gets set if the
8924	accessibility check performed by <link to="IMedium::refreshState" />
8925	was successful.
8926	</desc>
8927	</const>
8928	<const name="LockedRead" value="2">
8929	<desc>
8930	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8931	no data modification is possible.
8932	</desc>
8933	</const>
8934	<const name="LockedWrite" value="3">
8935	<desc>
8936	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8937	no concurrent data reading or modification is possible.
8938	</desc>
8939	</const>
8940	<const name="Inaccessible" value="4">
8941	<desc>
8942	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8943	not yet been performed, or else, associated medium storage is not
8944	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8945	is empty, in the second case, it describes the error that occurred.
8946	</desc>
8947	</const>
8948	<const name="Creating" value="5">
8949	<desc>
8950	Associated medium storage is being created.
8951	</desc>
8952	</const>
8953	<const name="Deleting" value="6">
8954	<desc>
8955	Associated medium storage is being deleted.
8956	</desc>
8957	</const>
8958	</enum>
8959
8960	<enum
8961	name="MediumType"
8962	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
8963	>
8964	<desc>
8965	Virtual medium type.
8966	<see>IMedium</see>
8967	</desc>
8968
8969	<const name="Normal" value="0">
8970	<desc>
8971	Normal medium (attached directly or indirectly, preserved
8972	when taking snapshots).
8973	</desc>
8974	</const>
8975	<const name="Immutable" value="1">
8976	<desc>
8977	Immutable medium (attached indirectly, changes are wiped out
8978	the next time the virtual machine is started).
8979	</desc>
8980	</const>
8981	<const name="Writethrough" value="2">
8982	<desc>
8983	Write through medium (attached directly, ignored when
8984	taking snapshots).
8985	</desc>
8986	</const>
8987	<const name="Shareable" value="3">
8988	<desc>
8989	Allow using this medium concurrently by several machines.
8990	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
8991	</desc>
8992	</const>
8993	<const name="Readonly" value="4">
8994	<desc>
8995	A readonly medium, which can of course be used by several machines.
8996	<note>Present and accepted since VirtualBox 4.0.</note>
8997	</desc>
8998	</const>
8999	<const name="MultiAttach" value="5">
9000	<desc>
9001	A medium which is is indirectly attached, so that one base medium can
9002	be used for several VMs which have their own differencing medium to
9003	store their modifications. In some sense a variant of Immutable
9004	with unset AutoReset flag in each differencing medium.
9005	<note>Present and accepted since VirtualBox 4.0.</note>
9006	</desc>
9007	</const>
9008	</enum>
9009
9010	<enum
9011	name="MediumVariant"
9012	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9013	>
9014	<desc>
9015	Virtual medium image variant. More than one flag may be set.
9016	<see>IMedium</see>
9017	</desc>
9018
9019	<const name="Standard" value="0">
9020	<desc>
9021	No particular variant requested, results in using the backend default.
9022	</desc>
9023	</const>
9024	<const name="VmdkSplit2G" value="0x01">
9025	<desc>
9026	VMDK image split in chunks of less than 2GByte.
9027	</desc>
9028	</const>
9029	<const name="VmdkStreamOptimized" value="0x04">
9030	<desc>
9031	VMDK streamOptimized image. Special import/export format which is
9032	read-only/append-only.
9033	</desc>
9034	</const>
9035	<const name="VmdkESX" value="0x08">
9036	<desc>
9037	VMDK format variant used on ESX products.
9038	</desc>
9039	</const>
9040	<const name="Fixed" value="0x10000">
9041	<desc>
9042	Fixed image. Only allowed for base images.
9043	</desc>
9044	</const>
9045	<const name="Diff" value="0x20000">
9046	<desc>
9047	Differencing image. Only allowed for child images.
9048	</desc>
9049	</const>
9050	</enum>
9051
9052	<interface
9053	name="IMediumAttachment" extends="$unknown"
9054	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
9055	wsmap="struct"
9056	>
9057	<desc>
9058	The IMediumAttachment interface links storage media to virtual machines.
9059	For each medium (<link to="IMedium"/>) which has been attached to a
9060	storage controller (<link to="IStorageController"/>) of a machine
9061	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9062	method, one instance of IMediumAttachment is added to the machine's
9063	<link to="IMachine::mediumAttachments"/> array attribute.
9064
9065	Each medium attachment specifies the storage controller as well as a
9066	port and device number and the IMedium instance representing a virtual
9067	hard disk or floppy or DVD image.
9068
9069	For removeable media (DVDs or floppies), there are two additional
9070	options. For one, the IMedium instance can be @c null to represent
9071	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9072	secondly, the medium can be one of the pseudo-media for host drives
9073	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9074	</desc>
9075
9076	<attribute name="medium" type="IMedium" readonly="yes">
9077	<desc>Medium object associated with this attachment; it
9078	can be @c null for removable devices.</desc>
9079	</attribute>
9080
9081	<attribute name="controller" type="wstring" readonly="yes">
9082	<desc>Name of the storage controller of this attachment; this
9083	refers to one of the controllers in <link to="IMachine::storageControllers" />
9084	by name.</desc>
9085	</attribute>
9086
9087	<attribute name="port" type="long" readonly="yes">
9088	<desc>Port number of this attachment.
9089	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9090	</desc>
9091	</attribute>
9092
9093	<attribute name="device" type="long" readonly="yes">
9094	<desc>Device slot number of this attachment.
9095	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9096	</desc>
9097	</attribute>
9098
9099	<attribute name="type" type="DeviceType" readonly="yes">
9100	<desc>Device type of this attachment.</desc>
9101	</attribute>
9102
9103	<attribute name="passthrough" type="boolean" readonly="yes">
9104	<desc>Pass I/O requests through to a device on the host.</desc>
9105	</attribute>
9106
9107	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9108	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9109	</attribute>
9110
9111	</interface>
9112
9113	<interface
9114	name="IMedium" extends="$unknown"
9115	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
9116	wsmap="managed"
9117	>
9118	<desc>
9119	The IMedium interface represents virtual storage for a machine's
9120	hard disks, CD/DVD or floppy drives. It will typically represent
9121	a disk image on the host, for example a VDI or VMDK file representing
9122	a virtual hard disk, or an ISO or RAW file representing virtual
9123	removable media, but can also point to a network location (e.g.
9124	for iSCSI targets).
9125
9126	Instances of IMedium are connected to virtual machines by way of
9127	medium attachments (see <link to="IMediumAttachment" />), which link
9128	the storage medium to a particular device slot of a storage controller
9129	of the virtual machine.
9130	In the VirtualBox API, virtual storage is therefore always represented
9131	by the following chain of object links:
9132
9133	<ul>
9134	<li><link to="IMachine::storageControllers"/> contains an array of
9135	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9136	these are instances of <link to="IStorageController"/>).</li>
9137	<li><link to="IMachine::mediumAttachments"/> contains an array of
9138	medium attachments (instances of <link to="IMediumAttachment"/>),
9139	each containing a storage controller from the above array, a
9140	port/device specification, and an instance of IMedium representing
9141	the medium storage (image file).
9142
9143	For removable media, the storage medium is optional; a medium
9144	attachment with no medium represents a CD/DVD or floppy drive
9145	with no medium inserted. By contrast, hard disk attachments
9146	will always have an IMedium object attached.</li>
9147	<li>Each IMedium in turn points to a storage unit (such as a file
9148	on the host computer or a network resource) that holds actual
9149	data. This location is represented by the <link to="#location"/>
9150	attribute.</li>
9151	</ul>
9152
9153	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9154	new hard disk media can be created with the VirtualBox API using the
9155	<link to="IVirtualBox::createHardDisk"/> method.
9156
9157	CD/DVD and floppy images (ISO and RAW files) are usually created outside
9158	VirtualBox, e.g. by storing a copy of the real medium of the corresponding
9159	type in a regular file.
9160
9161	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9162	drive; in that case the <link to="#id" /> attribute contains the UUID of
9163	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9164
9165	<h3>Known media</h3>
9166
9167	When an existing medium is opened and attached to a virtual machine, it
9168	is automatically added to a media registry. If the medium has first
9169	been attached to a machine which was created by VirtualBox 4.0 or later,
9170	it is added to that machine's media registry (in the machine XML settings
9171	file; this way all information about a machine's media attachments is
9172	contained in a single file). For older media attachments (i.e. if the
9173	medium was first attached to a machine which was created with a VirtualBox
9174	version before 4.0), media continue to be registered in the global
9175	VirtualBox settings file, for backwards compatibility.
9176
9177	See <link to="IVirtualBox::openMedium" /> for more information.
9178
9179	All known media can be enumerated using
9180	<link to="IVirtualBox::hardDisks"/>,
9181	<link to="IVirtualBox::DVDImages"/> and
9182	<link to="IVirtualBox::floppyImages"/> attributes. Individual media can be
9183	quickly found using the <link to="IVirtualBox::findMedium"/> method.
9184
9185	Only known media can be attached to virtual machines.
9186
9187	Removing known media from the media registry is performed when the given
9188	medium is closed using the <link to="#close"/> method or when its
9189	associated storage unit is deleted.
9190
9191	<h3>Accessibility checks</h3>
9192
9193	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9194	method is called explicitly on a medium. This is done to make the VirtualBox object
9195	ready for serving requests as fast as possible and let the end-user
9196	application decide if it needs to check media accessibility right away or not.
9197
9198	As a result, when VirtualBox starts up (e.g. the VirtualBox
9199	object gets created for the first time), all known media are in the
9200	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9201	attribute is an empty string because no actual accessibility check has
9202	been made yet.
9203
9204	After calling <link to="#refreshState" />, a medium is considered
9205	<i>accessible</i> if its storage unit can be read. In that case, the
9206	<link to="#state"/> attribute has a value of "Created". If the storage
9207	unit cannot be read (for example, because it is located on a disconnected
9208	network resource, or was accidentally deleted outside VirtualBox),
9209	the medium is considered <i>inaccessible</i>, which is indicated by the
9210	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9211	obtained by reading the <link to="#lastAccessError"/> attribute.
9212
9213	<h3>Medium types</h3>
9214
9215	There are four types of medium behavior (see <link to="MediumType" />):
9216	"normal", "immutable", "writethrough" and "shareable", represented by the
9217	<link to="#type"/> attribute. The type of the medium defines how the
9218	medium is attached to a virtual machine and what happens when a
9219	<link to="ISnapshot">snapshot</link> of the virtual machine with the
9220	attached medium is taken. At the moment DVD and floppy media are always
9221	of type "writethrough".
9222
9223	All media can be also divided in two groups: <i>base</i> media and
9224	<i>differencing</i> media. A base medium contains all sectors of the
9225	medium data in its own storage and therefore can be used independently.
9226	In contrast, a differencing medium is a "delta" to some other medium and
9227	contains only those sectors which differ from that other medium, which is
9228	then called a <i>parent</i>. The differencing medium is said to be
9229	<i>linked to</i> that parent. The parent may be itself a differencing
9230	medium, thus forming a chain of linked media. The last element in that
9231	chain must always be a base medium. Note that several differencing
9232	media may be linked to the same parent medium.
9233
9234	Differencing media can be distinguished from base media by querying the
9235	<link to="#parent"/> attribute: base media do not have parents they would
9236	depend on, so the value of this attribute is always @c null for them.
9237	Using this attribute, it is possible to walk up the medium tree (from the
9238	child medium to its parent). It is also possible to walk down the tree
9239	using the <link to="#children"/> attribute.
9240
9241	Note that the type of all differencing media is "normal"; all other
9242	values are meaningless for them. Base media may be of any type.
9243
9244	<h3>Creating hard disks</h3>
9245
9246	New base hard disks are created using
9247	<link to="IVirtualBox::createHardDisk"/>. Existing hard disks are
9248	opened using <link to="IVirtualBox::openMedium"/>. Differencing hard
9249	disks are usually implicitly created by VirtualBox when needed but may
9250	also be created explicitly using <link to="#createDiffStorage"/>.
9251
9252	After the hard disk is successfully created (including the storage unit)
9253	or opened, it becomes a known hard disk (remembered in the internal media
9254	registry). Known hard disks can be attached to a virtual machine, accessed
9255	through <link to="IVirtualBox::findMedium"/> or enumerated using the
9256	<link to="IVirtualBox::hardDisks"/> array (only for base hard disks).
9257
9258	The following methods, besides <link to="IMedium::close"/>,
9259	automatically remove the hard disk from the media registry:
9260	<ul>
9261	<li><link to="#deleteStorage"/></li>
9262	<li><link to="#mergeTo"/></li>
9263	</ul>
9264
9265	If the storage unit of the hard disk is a regular file in the host's
9266	file system then the rules stated in the description of the
9267	<link to="IMedium::location"/> attribute apply when setting its value.
9268
9269	<h4>Automatic composition of the file name part</h4>
9270
9271	Another extension to the <link to="IMedium::location"/> attribute is that
9272	there is a possibility to cause VirtualBox to compose a unique value for
9273	the file name part of the location using the UUID of the hard disk. This
9274	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9275	e.g. before the storage unit is created, and works as follows. You set the
9276	value of the <link to="IMedium::location"/> attribute to a location
9277	specification which only contains the path specification but not the file
9278	name part and ends with either a forward slash or a backslash character.
9279	In response, VirtualBox will generate a new UUID for the hard disk and
9280	compose the file name using the following pattern:
9281	<pre>
9282	<path>/{<uuid>}.<ext>
9283	</pre>
9284	where <tt><path></tt> is the supplied path specification,
9285	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9286	is the default extension for the storage format of this hard disk. After
9287	that, you may call any of the methods that create a new hard disk storage
9288	unit and they will use the generated UUID and file name.
9289
9290	<h3>Attaching Hard Disks</h3>
9291
9292	Hard disks are attached to virtual machines using the
9293	<link to="IMachine::attachDevice"/> method and detached using the
9294	<link to="IMachine::detachDevice"/> method. Depending on their
9295	<link to="#type"/>, hard disks are attached either
9296	<i>directly</i> or <i>indirectly</i>.
9297
9298	When a hard disk is being attached directly, it is associated with the
9299	virtual machine and used for hard disk operations when the machine is
9300	running. When a hard disk is being attached indirectly, a new differencing
9301	hard disk linked to it is implicitly created and this differencing hard
9302	disk is associated with the machine and used for hard disk operations.
9303	This also means that if <link to="IMachine::attachDevice"/> performs
9304	a direct attachment then the same hard disk will be returned in response
9305	to the subsequent <link to="IMachine::getMedium"/> call; however if
9306	an indirect attachment is performed then
9307	<link to="IMachine::getMedium"/> will return the implicitly created
9308	differencing hard disk, not the original one passed to <link
9309	to="IMachine::attachDevice"/>. In detail:
9310
9311	<ul>
9312	<li><b>Normal base</b> hard disks that do not have children (i.e.
9313	differencing hard disks linked to them) and that are not already
9314	attached to virtual machines in snapshots are attached <b>directly</b>.
9315	Otherwise, they are attached <b>indirectly</b> because having
9316	dependent children or being part of the snapshot makes it impossible
9317	to modify hard disk contents without breaking the integrity of the
9318	dependent party. The <link to="#readOnly"/> attribute allows to
9319	quickly determine the kind of the attachment for the given hard
9320	disk. Note that if a normal base hard disk is to be indirectly
9321	attached to a virtual machine with snapshots then a special
9322	procedure called <i>smart attachment</i> is performed (see below).</li>
9323	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9324	they are attached <b>directly</b> if they do not have children and are
9325	not attached to virtual machines in snapshots, and <b>indirectly</b>
9326	otherwise. Note that the smart attachment procedure is never performed
9327	for differencing hard disks.</li>
9328	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9329	they are designed to be non-writable. If an immutable hard disk is
9330	attached to a virtual machine with snapshots then a special
9331	procedure called smart attachment is performed (see below).</li>
9332	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9333	also as designed. This also means that writethrough hard disks cannot
9334	have other hard disks linked to them at all.</li>
9335	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9336	also as designed. This also means that shareable hard disks cannot
9337	have other hard disks linked to them at all. They behave almost
9338	like writethrough hard disks, except that shareable hard disks can
9339	be attached to several virtual machines which are running, allowing
9340	concurrent accesses. You need special cluster software running in
9341	the virtual machines to make use of such disks.</li>
9342	</ul>
9343
9344	Note that the same hard disk, regardless of its type, may be attached to
9345	more than one virtual machine at a time. In this case, the machine that is
9346	started first gains exclusive access to the hard disk and attempts to
9347	start other machines having this hard disk attached will fail until the
9348	first machine is powered down.
9349
9350	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9351	that the given hard disk remains associated with the given machine after a
9352	successful <link to="IMachine::detachDevice"/> call until
9353	<link to="IMachine::saveSettings"/> is called to save all changes to
9354	machine settings to disk. This deferring is necessary to guarantee that
9355	the hard disk configuration may be restored at any time by a call to
9356	<link to="IMachine::discardSettings"/> before the settings
9357	are saved (committed).
9358
9359	Note that if <link to="IMachine::discardSettings"/> is called after
9360	indirectly attaching some hard disks to the machine but before a call to
9361	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9362	all differencing hard disks implicitly created by
9363	<link to="IMachine::attachDevice"/> for these indirect attachments.
9364	Such implicitly created hard disks will also be immediately deleted when
9365	detached explicitly using the <link to="IMachine::detachDevice"/>
9366	call if it is made before <link to="IMachine::saveSettings"/>. This
9367	implicit deletion is safe because newly created differencing hard
9368	disks do not contain any user data.
9369
9370	However, keep in mind that detaching differencing hard disks that were
9371	implicitly created by <link to="IMachine::attachDevice"/>
9372	before the last <link to="IMachine::saveSettings"/> call will
9373	<b>not</b> implicitly delete them as they may already contain some data
9374	(for example, as a result of virtual machine execution). If these hard
9375	disks are no more necessary, the caller can always delete them explicitly
9376	using <link to="#deleteStorage"/> after they are actually de-associated
9377	from this machine by the <link to="IMachine::saveSettings"/> call.
9378
9379	<h3>Smart Attachment</h3>
9380
9381	When normal base or immutable hard disks are indirectly attached to a
9382	virtual machine then some additional steps are performed to make sure the
9383	virtual machine will have the most recent "view" of the hard disk being
9384	attached. These steps include walking through the machine's snapshots
9385	starting from the current one and going through ancestors up to the first
9386	snapshot. Hard disks attached to the virtual machine in all
9387	of the encountered snapshots are checked whether they are descendants of
9388	the given normal base or immutable hard disk. The first found child (which
9389	is the differencing hard disk) will be used instead of the normal base or
9390	immutable hard disk as a parent for creating a new differencing hard disk
9391	that will be actually attached to the machine. And only if no descendants
9392	are found or if the virtual machine does not have any snapshots then the
9393	normal base or immutable hard disk will be used itself as a parent for
9394	this differencing hard disk.
9395
9396	It is easier to explain what smart attachment does using the
9397	following example:
9398	<pre>
9399	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9400
9401	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9402	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9403	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9404	Snapshot 4 (none) Snapshot 4 (none)
9405	CurState (none) CurState (D3->D2.vdi)
9406
9407	NOT
9408	...
9409	CurState (D3->B.vdi)
9410	</pre>
9411	The first column is the virtual machine configuration before the base hard
9412	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9413	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9414	mean that the hard disk that is actually attached to the machine is a
9415	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9416	another hard disk, <tt>B.vdi</tt>.
9417
9418	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9419	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9420	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9421	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9422	it cannot be attached directly and needs an indirect attachment (i.e.
9423	implicit creation of a new differencing hard disk). Due to the smart
9424	attachment procedure, the new differencing hard disk
9425	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9426	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9427	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9428	machine.
9429
9430	Note that if there is more than one descendant hard disk of the given base
9431	hard disk found in a snapshot, and there is an exact device, channel and
9432	bus match, then this exact match will be used. Otherwise, the youngest
9433	descendant will be picked up.
9434
9435	There is one more important aspect of the smart attachment procedure which
9436	is not related to snapshots at all. Before walking through the snapshots
9437	as described above, the backup copy of the current list of hard disk
9438	attachment is searched for descendants. This backup copy is created when
9439	the hard disk configuration is changed for the first time after the last
9440	<link to="IMachine::saveSettings"/> call and used by
9441	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9442	changes. When such a descendant is found in this backup copy, it will be
9443	simply re-attached back, without creating a new differencing hard disk for
9444	it. This optimization is necessary to make it possible to re-attach the
9445	base or immutable hard disk to a different bus, channel or device slot
9446	without losing the contents of the differencing hard disk actually
9447	attached to the machine in place of it.
9448	</desc>
9449
9450	<attribute name="id" type="uuid" mod="string" readonly="yes">
9451	<desc>
9452	UUID of the medium. For a newly created medium, this value is a randomly
9453	generated UUID.
9454
9455	<note>
9456	For media in one of MediumState_NotCreated, MediumState_Creating or
9457	MediumState_Deleting states, the value of this property is undefined
9458	and will most likely be an empty UUID.
9459	</note>
9460	</desc>
9461	</attribute>
9462
9463	<attribute name="description" type="wstring">
9464	<desc>
9465	Optional description of the medium. For a newly created medium the value
9466	of this attribute is an empty string.
9467
9468	Medium types that don't support this attribute will return E_NOTIMPL in
9469	attempt to get or set this attribute's value.
9470
9471	<note>
9472	For some storage types, reading this attribute may return an outdated
9473	(last known) value when <link to="#state"/> is <link
9474	to="MediumState_Inaccessible"/> or <link
9475	to="MediumState_LockedWrite"/> because the value of this attribute is
9476	stored within the storage unit itself. Also note that changing the
9477	attribute value is not possible in such case, as well as when the
9478	medium is the <link to="MediumState_LockedRead"/> state.
9479	</note>
9480	</desc>
9481	</attribute>
9482
9483	<attribute name="state" type="MediumState" readonly="yes">
9484	<desc>
9485	Returns the current medium state, which is the last state set by
9486	the accessibility check performed by <link to="#refreshState"/>.
9487	If that method has not yet been called on the medium, the state
9488	is "Inaccessible"; as opposed to truly inaccessible media, the
9489	value of <link to="#lastAccessError"/> will be an empty string in
9490	that case.
9491
9492	<note>As of version 3.1, this no longer performs an accessibility check
9493	automatically; call <link to="#refreshState"/> for that.
9494	</note>
9495	</desc>
9496	</attribute>
9497
9498	<attribute name="variant" type="unsigned long" readonly="yes">
9499	<desc>
9500	Returns the storage format variant information for this medium
9501	as a combination of the flags described at <link to="MediumVariant" />.
9502	Before <link to="#refreshState"/> is called this method returns
9503	an undefined value.
9504	</desc>
9505	</attribute>
9506
9507	<attribute name="location" type="wstring">
9508	<desc>
9509	Location of the storage unit holding medium data.
9510
9511	The format of the location string is medium type specific. For medium
9512	types using regular files in a host's file system, the location
9513	string is the full file name.
9514
9515	Some medium types may support changing the storage unit location by
9516	simply changing the value of this property. If this operation is not
9517	supported, the implementation will return E_NOTIMPL in attempt to set
9518	this attribute's value.
9519
9520	When setting a value of the location attribute which is a regular file
9521	in the host's file system, the given file name may be either relative to
9522	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9523	absolute. Note that if the given location specification does not contain
9524	the file extension part then a proper default extension will be
9525	automatically appended by the implementation depending on the medium type.
9526	</desc>
9527	</attribute>
9528
9529	<attribute name="name" type="wstring" readonly="yes">
9530	<desc>
9531	Name of the storage unit holding medium data.
9532
9533	The returned string is a short version of the <link to="#location"/>
9534	attribute that is suitable for representing the medium in situations
9535	where the full location specification is too long (such as lists
9536	and comboboxes in GUI frontends). This string is also used by frontends
9537	to sort the media list alphabetically when needed.
9538
9539	For example, for locations that are regular files in the host's file
9540	system, the value of this attribute is just the file name (+ extension),
9541	without the path specification.
9542
9543	Note that as opposed to the <link to="#location"/> attribute, the name
9544	attribute will not necessary be unique for a list of media of the
9545	given type and format.
9546	</desc>
9547	</attribute>
9548
9549	<attribute name="deviceType" type="DeviceType" readonly="yes">
9550	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9551	medium.</desc>
9552	</attribute>
9553
9554	<attribute name="hostDrive" type="boolean" readonly="yes">
9555	<desc>True if this corresponds to a drive on the host.</desc>
9556	</attribute>
9557
9558	<attribute name="size" type="long long" readonly="yes">
9559	<desc>
9560	Physical size of the storage unit used to hold medium data (in bytes).
9561
9562	<note>
9563	For media whose <link to="#state"/> is <link
9564	to="MediumState_Inaccessible"/>, the value of this property is the
9565	last known size. For <link to="MediumState_NotCreated"/> media,
9566	the returned value is zero.
9567	</note>
9568	</desc>
9569	</attribute>
9570
9571	<attribute name="format" type="wstring" readonly="yes">
9572	<desc>
9573	Storage format of this medium.
9574
9575	The value of this attribute is a string that specifies a backend used
9576	to store medium data. The storage format is defined when you create a
9577	new medium or automatically detected when you open an existing medium,
9578	and cannot be changed later.
9579
9580	The list of all storage formats supported by this VirtualBox
9581	installation can be obtained using
9582	<link to="ISystemProperties::mediumFormats"/>.
9583	</desc>
9584	</attribute>
9585
9586	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9587	<desc>
9588	Storage medium format object corresponding to this medium.
9589
9590	The value of this attribute is a reference to the medium format object
9591	that specifies the backend properties used to store medium data. The
9592	storage format is defined when you create a new medium or automatically
9593	detected when you open an existing medium, and cannot be changed later.
9594
9595	<note>@c null is returned if there is no associated medium format
9596	object. This can e.g. happen for medium objects representing host
9597	drives and other special medium objects.</note>
9598	</desc>
9599	</attribute>
9600
9601	<attribute name="type" type="MediumType">
9602	<desc>
9603	Type (role) of this medium.
9604
9605	The following constraints apply when changing the value of this
9606	attribute:
9607	<ul>
9608	<li>If a medium is attached to a virtual machine (either in the
9609	current state or in one of the snapshots), its type cannot be
9610	changed.
9611	</li>
9612	<li>As long as the medium has children, its type cannot be set
9613	to <link to="MediumType_Writethrough"/>.
9614	</li>
9615	<li>The type of all differencing media is
9616	<link to="MediumType_Normal"/> and cannot be changed.
9617	</li>
9618	</ul>
9619
9620	The type of a newly created or opened medium is set to
9621	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9622	which have a type of <link to="MediumType_Writethrough"/>.
9623	</desc>
9624	</attribute>
9625
9626	<attribute name="parent" type="IMedium" readonly="yes">
9627	<desc>
9628	Parent of this medium (the medium this medium is directly based
9629	on).
9630
9631	Only differencing media have parents. For base (non-differencing)
9632	media, @c null is returned.
9633	</desc>
9634	</attribute>
9635
9636	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9637	<desc>
9638	Children of this medium (all differencing media directly based
9639	on this medium). A @c null array is returned if this medium
9640	does not have any children.
9641	</desc>
9642	</attribute>
9643
9644	<attribute name="base" type="IMedium" readonly="yes">
9645	<desc>
9646	Base medium of this medium.
9647
9648	If this is a differencing medium, its base medium is the medium
9649	the given medium branch starts from. For all other types of media, this
9650	property returns the medium object itself (i.e. the same object this
9651	property is read on).
9652	</desc>
9653	</attribute>
9654
9655	<attribute name="readOnly" type="boolean" readonly="yes">
9656	<desc>
9657	Returns @c true if this medium is read-only and @c false otherwise.
9658
9659	A medium is considered to be read-only when its contents cannot be
9660	modified without breaking the integrity of other parties that depend on
9661	this medium such as its child media or snapshots of virtual machines
9662	where this medium is attached to these machines. If there are no
9663	children and no such snapshots then there is no dependency and the
9664	medium is not read-only.
9665
9666	The value of this attribute can be used to determine the kind of the
9667	attachment that will take place when attaching this medium to a
9668	virtual machine. If the value is @c false then the medium will
9669	be attached directly. If the value is @c true then the medium
9670	will be attached indirectly by creating a new differencing child
9671	medium for that. See the interface description for more information.
9672
9673	Note that all <link to="MediumType_Immutable">Immutable</link> media
9674	are always read-only while all
9675	<link to="MediumType_Writethrough">Writethrough</link> media are
9676	always not.
9677
9678	<note>
9679	The read-only condition represented by this attribute is related to
9680	the medium type and usage, not to the current
9681	<link to="IMedium::state">medium state</link> and not to the read-only
9682	state of the storage unit.
9683	</note>
9684	</desc>
9685	</attribute>
9686
9687	<attribute name="logicalSize" type="long long" readonly="yes">
9688	<desc>
9689	Logical size of this medium (in bytes), as reported to the
9690	guest OS running inside the virtual machine this medium is
9691	attached to. The logical size is defined when the medium is created
9692	and cannot be changed later.
9693
9694	<note>
9695	Reading this property on a differencing medium will return the size
9696	of its <link to="#base"/> medium.
9697	</note>
9698	<note>
9699	For media whose state is <link to="#state"/> is <link
9700	to="MediumState_Inaccessible"/>, the value of this property is the
9701	last known logical size. For <link to="MediumState_NotCreated"/>
9702	media, the returned value is zero.
9703	</note>
9704	</desc>
9705	</attribute>
9706
9707	<attribute name="autoReset" type="boolean">
9708	<desc>
9709	Whether this differencing medium will be automatically reset each
9710	time a virtual machine it is attached to is powered up. This
9711	attribute is automatically set to @c true for the last
9712	differencing image of an "immutable" medium (see
9713	<link to="MediumType" />).
9714
9715	See <link to="#reset"/> for more information about resetting
9716	differencing media.
9717
9718	<note>
9719	Reading this property on a base (non-differencing) medium will
9720	always @c false. Changing the value of this property in this
9721	case is not supported.
9722	</note>
9723
9724	<result name="VBOX_E_NOT_SUPPORTED">
9725	This is not a differencing medium (when changing the attribute
9726	value).
9727	</result>
9728	</desc>
9729	</attribute>
9730
9731	<attribute name="lastAccessError" type="wstring" readonly="yes">
9732	<desc>
9733	Text message that represents the result of the last accessibility
9734	check performed by <link to="#refreshState"/>.
9735
9736	An empty string is returned if the last accessibility check
9737	was successful or has not yet been called. As a result, if
9738	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9739	then <link to="#refreshState"/> has yet to be called; this is the
9740	default value of media after VirtualBox initialization.
9741	A non-empty string indicates a failure and should normally describe
9742	a reason of the failure (for example, a file read error).
9743	</desc>
9744	</attribute>
9745
9746	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9747	<desc>
9748	Array of UUIDs of all machines this medium is attached to.
9749
9750	A @c null array is returned if this medium is not attached to any
9751	machine or to any machine's snapshot.
9752
9753	<note>
9754	The returned array will include a machine even if this medium is not
9755	attached to that machine in the current state but attached to it in
9756	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9757	details.
9758	</note>
9759	</desc>
9760	</attribute>
9761
9762	<method name="setIDs">
9763	<desc>
9764	Changes the UUID and parent UUID for a hard disk medium.
9765	</desc>
9766	<param name="setImageId" type="boolean" dir="in">
9767	<desc>
9768	Select whether a new image UUID is set or not.
9769	</desc>
9770	</param>
9771	<param name="imageId" type="uuid" mod="string" dir="in">
9772	<desc>
9773	New UUID for the image. If an empty string is passed, then a new
9774	UUID is automatically created, provided that @a setImageId is @c true.
9775	Specifying a zero UUID is not allowed.
9776	</desc>
9777	</param>
9778	<param name="setParentId" type="boolean" dir="in">
9779	<desc>
9780	Select whether a new parent UUID is set or not.
9781	</desc>
9782	</param>
9783	<param name="parentId" type="uuid" mod="string" dir="in">
9784	<desc>
9785	New parent UUID for the image. If an empty string is passed, then a
9786	new UUID is automatically created, provided @a setParentId is
9787	@c true. A zero UUID is valid.
9788	</desc>
9789	</param>
9790	<result name="E_INVALIDARG">
9791	Invalid parameter combination.
9792	</result>
9793	<result name="VBOX_E_NOT_SUPPORTED">
9794	Medium is not a hard disk medium.
9795	</result>
9796	</method>
9797
9798	<method name="refreshState">
9799	<desc>
9800	If the current medium state (see <link to="MediumState"/>) is one of
9801	"Created", "Inaccessible" or "LockedRead", then this performs an
9802	accessibility check on the medium and sets the value of the <link to="#state"/>
9803	attribute accordingly; that value is also returned for convenience.
9804
9805	For all other state values, this does not perform a refresh but returns
9806	the state only.
9807
9808	The refresh, if performed, may take a long time (several seconds or even
9809	minutes, depending on the storage unit location and format) because it performs an
9810	accessibility check of the storage unit. This check may cause a significant
9811	delay if the storage unit of the given medium is, for example, a file located
9812	on a network share which is not currently accessible due to connectivity
9813	problems. In that case, the call will not return until a timeout
9814	interval defined by the host OS for this operation expires. For this reason,
9815	it is recommended to never read this attribute on the main UI thread to avoid
9816	making the UI unresponsive.
9817
9818	If the last known state of the medium is "Created" and the accessibility
9819	check fails, then the state would be set to "Inaccessible", and
9820	<link to="#lastAccessError"/> may be used to get more details about the
9821	failure. If the state of the medium is "LockedRead", then it remains the
9822	same, and a non-empty value of <link to="#lastAccessError"/> will
9823	indicate a failed accessibility check in this case.
9824
9825	Note that not all medium states are applicable to all medium types.
9826	</desc>
9827	<param name="state" type="MediumState" dir="return">
9828	<desc>
9829	New medium state.
9830	</desc>
9831	</param>
9832	</method>
9833
9834	<method name="getSnapshotIds">
9835	<desc>
9836	Returns an array of UUIDs of all snapshots of the given machine where
9837	this medium is attached to.
9838
9839	If the medium is attached to the machine in the current state, then the
9840	first element in the array will always be the ID of the queried machine
9841	(i.e. the value equal to the @c machineId argument), followed by
9842	snapshot IDs (if any).
9843
9844	If the medium is not attached to the machine in the current state, then
9845	the array will contain only snapshot IDs.
9846
9847	The returned array may be @c null if this medium is not attached
9848	to the given machine at all, neither in the current state nor in one of
9849	the snapshots.
9850	</desc>
9851	<param name="machineId" type="uuid" mod="string" dir="in">
9852	<desc>
9853	UUID of the machine to query.
9854	</desc>
9855	</param>
9856	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9857	<desc>
9858	Array of snapshot UUIDs of the given machine using this medium.
9859	</desc>
9860	</param>
9861	</method>
9862
9863	<method name="lockRead">
9864	<desc>
9865	Locks this medium for reading.
9866
9867	A read lock is shared: many clients can simultaneously lock the
9868	same medium for reading unless it is already locked for writing (see
9869	<link to="#lockWrite"/>) in which case an error is returned.
9870
9871	When the medium is locked for reading, it cannot be modified
9872	from within VirtualBox. This means that any method that changes
9873	the properties of this medium or contents of the storage unit
9874	will return an error (unless explicitly stated otherwise). That
9875	includes an attempt to start a virtual machine that wants to
9876	write to the the medium.
9877
9878	When the virtual machine is started up, it locks for reading all
9879	media it uses in read-only mode. If some medium cannot be locked
9880	for reading, the startup procedure will fail.
9881	A medium is typically locked for reading while it is used by a running
9882	virtual machine but has a depending differencing image that receives
9883	the actual write operations. This way one base medium can have
9884	multiple child differencing images which can be written to
9885	simultaneously. Read-only media such as DVD and floppy images are
9886	also locked for reading only (so they can be in use by multiple
9887	machines simultaneously).
9888
9889	A medium is also locked for reading when it is the source of a
9890	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9891
9892	The medium locked for reading must be unlocked using the <link
9893	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9894	can be nested and must be followed by the same number of paired
9895	<link to="#unlockRead"/> calls.
9896
9897	This method sets the medium state (see <link to="#state"/>) to
9898	"LockedRead" on success. The medium's previous state must be
9899	one of "Created", "Inaccessible" or "LockedRead".
9900
9901	Locking an inaccessible medium is not an error; this method performs
9902	a logical lock that prevents modifications of this medium through
9903	the VirtualBox API, not a physical file-system lock of the underlying
9904	storage unit.
9905
9906	This method returns the current state of the medium
9907	<i>before</i> the operation.
9908
9909	<result name="VBOX_E_INVALID_OBJECT_STATE">
9910	Invalid medium state (e.g. not created, locked, inaccessible,
9911	creating, deleting).
9912	</result>
9913
9914	</desc>
9915	<param name="state" type="MediumState" dir="return">
9916	<desc>
9917	State of the medium after the operation.
9918	</desc>
9919	</param>
9920	</method>
9921
9922	<method name="unlockRead">
9923	<desc>
9924	Cancels the read lock previously set by <link to="#lockRead"/>.
9925
9926	For both success and failure, this method returns the current state
9927	of the medium <i>after</i> the operation.
9928
9929	See <link to="#lockRead"/> for more details.
9930
9931	<result name="VBOX_E_INVALID_OBJECT_STATE">
9932	Medium not locked for reading.
9933	</result>
9934
9935	</desc>
9936	<param name="state" type="MediumState" dir="return">
9937	<desc>
9938	State of the medium after the operation.
9939	</desc>
9940	</param>
9941	</method>
9942
9943	<method name="lockWrite">
9944	<desc>
9945	Locks this medium for writing.
9946
9947	A write lock, as opposed to <link to="#lockRead"/>, is
9948	exclusive: there may be only one client holding a write lock,
9949	and there may be no read locks while the write lock is held.
9950	As a result, read-locking fails if a write lock is held, and
9951	write-locking fails if either a read or another write lock is held.
9952
9953	When a medium is locked for writing, it cannot be modified
9954	from within VirtualBox, and it is not guaranteed that the values
9955	of its properties are up-to-date. Any method that changes the
9956	properties of this medium or contents of the storage unit will
9957	return an error (unless explicitly stated otherwise).
9958
9959	When a virtual machine is started up, it locks for writing all
9960	media it uses to write data to. If any medium could not be locked
9961	for writing, the startup procedure will fail. If a medium has
9962	differencing images, then while the machine is running, only
9963	the last ("leaf") differencing image is locked for writing,
9964	whereas its parents are locked for reading only.
9965
9966	A medium is also locked for writing when it is the target of a
9967	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9968
9969	The medium locked for writing must be unlocked using the <link
9970	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
9971
9972	This method sets the medium state (see <link to="#state"/>) to
9973	"LockedWrite" on success. The medium's previous state must be
9974	either "Created" or "Inaccessible".
9975
9976	Locking an inaccessible medium is not an error; this method performs
9977	a logical lock that prevents modifications of this medium through
9978	the VirtualBox API, not a physical file-system lock of the underlying
9979	storage unit.
9980
9981	For both, success and failure, this method returns the current
9982	state of the medium <i>before</i> the operation.
9983
9984	<result name="VBOX_E_INVALID_OBJECT_STATE">
9985	Invalid medium state (e.g. not created, locked, inaccessible,
9986	creating, deleting).
9987	</result>
9988
9989	</desc>
9990	<param name="state" type="MediumState" dir="return">
9991	<desc>
9992	State of the medium after the operation.
9993	</desc>
9994	</param>
9995	</method>
9996
9997	<method name="unlockWrite">
9998	<desc>
9999	Cancels the write lock previously set by <link to="#lockWrite"/>.
10000
10001	For both success and failure, this method returns the current
10002	state of the medium <i>after</i> the operation.
10003
10004	See <link to="#lockWrite"/> for more details.
10005
10006	<result name="VBOX_E_INVALID_OBJECT_STATE">
10007	Medium not locked for writing.
10008	</result>
10009
10010	</desc>
10011	<param name="state" type="MediumState" dir="return">
10012	<desc>
10013	State of the medium after the operation.
10014	</desc>
10015	</param>
10016	</method>
10017
10018	<method name="close">
10019	<desc>
10020	Closes this medium.
10021
10022	The medium must not be attached to any known virtual machine
10023	and must not have any known child media, otherwise the
10024	operation will fail.
10025
10026	When the medium is successfully closed, it is removed from
10027	the list of registered media, but its storage unit is not
10028	deleted. In particular, this means that this medium can
10029	later be opened again using the <link to="IVirtualBox::openMedium"/>
10030	call.
10031
10032	Note that after this method successfully returns, the given medium
10033	object becomes uninitialized. This means that any attempt
10034	to call any of its methods or attributes will fail with the
10035	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10036
10037	<result name="VBOX_E_INVALID_OBJECT_STATE">
10038	Invalid medium state (other than not created, created or
10039	inaccessible).
10040	</result>
10041	<result name="VBOX_E_OBJECT_IN_USE">
10042	Medium attached to virtual machine.
10043	</result>
10044	<result name="VBOX_E_FILE_ERROR">
10045	Settings file not accessible.
10046	</result>
10047	<result name="VBOX_E_XML_ERROR">
10048	Could not parse the settings file.
10049	</result>
10050
10051	</desc>
10052	</method>
10053
10054	<!-- storage methods -->
10055
10056	<method name="getProperty">
10057	<desc>
10058	Returns the value of the custom medium property with the given name.
10059
10060	The list of all properties supported by the given medium format can
10061	be obtained with <link to="IMediumFormat::describeProperties"/>.
10062
10063	Note that if this method returns an empty string in @a value, the
10064	requested property is supported but currently not assigned any value.
10065
10066	<result name="VBOX_E_OBJECT_NOT_FOUND">
10067	Requested property does not exist (not supported by the format).
10068	</result>
10069	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10070	</desc>
10071	<param name="name" type="wstring" dir="in">
10072	<desc>Name of the property to get.</desc>
10073	</param>
10074	<param name="value" type="wstring" dir="return">
10075	<desc>Current property value.</desc>
10076	</param>
10077	</method>
10078
10079	<method name="setProperty">
10080	<desc>
10081	Sets the value of the custom medium property with the given name.
10082
10083	The list of all properties supported by the given medium format can
10084	be obtained with <link to="IMediumFormat::describeProperties"/>.
10085
10086	Note that setting the property value to @c null or an empty string is
10087	equivalent to deleting the existing value. A default value (if it is
10088	defined for this property) will be used by the format backend in this
10089	case.
10090
10091	<result name="VBOX_E_OBJECT_NOT_FOUND">
10092	Requested property does not exist (not supported by the format).
10093	</result>
10094	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10095	</desc>
10096	<param name="name" type="wstring" dir="in">
10097	<desc>Name of the property to set.</desc>
10098	</param>
10099	<param name="value" type="wstring" dir="in">
10100	<desc>Property value to set.</desc>
10101	</param>
10102	</method>
10103
10104	<method name="getProperties">
10105	<desc>
10106	Returns values for a group of properties in one call.
10107
10108	The names of the properties to get are specified using the @a names
10109	argument which is a list of comma-separated property names or
10110	an empty string if all properties are to be returned. Note that currently
10111	the value of this argument is ignored and the method always returns all
10112	existing properties.
10113
10114	The list of all properties supported by the given medium format can
10115	be obtained with <link to="IMediumFormat::describeProperties"/>.
10116
10117	The method returns two arrays, the array of property names corresponding
10118	to the @a names argument and the current values of these properties.
10119	Both arrays have the same number of elements with each elemend at the
10120	given index in the first array corresponds to an element at the same
10121	index in the second array.
10122
10123	Note that for properties that do not have assigned values,
10124	an empty string is returned at the appropriate index in the
10125	@a returnValues array.
10126
10127	</desc>
10128	<param name="names" type="wstring" dir="in">
10129	<desc>
10130	Names of properties to get.
10131	</desc>
10132	</param>
10133	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10134	<desc>Names of returned properties.</desc>
10135	</param>
10136	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10137	<desc>Values of returned properties.</desc>
10138	</param>
10139	</method>
10140
10141	<method name="setProperties">
10142	<desc>
10143	Sets values for a group of properties in one call.
10144
10145	The names of the properties to set are passed in the @a names
10146	array along with the new values for them in the @a values array. Both
10147	arrays have the same number of elements with each elemend at the given
10148	index in the first array corresponding to an element at the same index
10149	in the second array.
10150
10151	If there is at least one property name in @a names that is not valid,
10152	the method will fail before changing the values of any other properties
10153	from the @a names array.
10154
10155	Using this method over <link to="#setProperty"/> is preferred if you
10156	need to set several properties at once since it will result into less
10157	IPC calls.
10158
10159	The list of all properties supported by the given medium format can
10160	be obtained with <link to="IMediumFormat::describeProperties"/>.
10161
10162	Note that setting the property value to @c null or an empty string is
10163	equivalent to deleting the existing value. A default value (if it is
10164	defined for this property) will be used by the format backend in this
10165	case.
10166	</desc>
10167	<param name="names" type="wstring" safearray="yes" dir="in">
10168	<desc>Names of properties to set.</desc>
10169	</param>
10170	<param name="values" type="wstring" safearray="yes" dir="in">
10171	<desc>Values of properties to set.</desc>
10172	</param>
10173	</method>
10174
10175	<!-- storage methods -->
10176
10177	<method name="createBaseStorage">
10178	<desc>
10179	Starts creating a hard disk storage unit (fixed/dynamic, according
10180	to the variant flags) in in the background. The previous storage unit
10181	created for this object, if any, must first be deleted using
10182	<link to="#deleteStorage"/>, otherwise the operation will fail.
10183
10184	Before the operation starts, the medium is placed in
10185	<link to="MediumState_Creating"/> state. If the create operation
10186	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10187	state.
10188
10189	After the returned progress object reports that the operation has
10190	successfully completed, the medium state will be set to <link
10191	to="MediumState_Created"/>, the medium will be remembered by this
10192	VirtualBox installation and may be attached to virtual machines.
10193
10194	<result name="VBOX_E_NOT_SUPPORTED">
10195	The variant of storage creation operation is not supported. See <link
10196	to="IMediumFormat::capabilities"/>.
10197	</result>
10198	</desc>
10199	<param name="logicalSize" type="long long" dir="in">
10200	<desc>Maximum logical size of the medium in bytes.</desc>
10201	</param>
10202	<param name="variant" type="unsigned long" dir="in">
10203	<desc>Exact image variant which should be created (as a combination of
10204	<link to="MediumVariant" /> flags).</desc>
10205	</param>
10206	<param name="progress" type="IProgress" dir="return">
10207	<desc>Progress object to track the operation completion.</desc>
10208	</param>
10209	</method>
10210
10211	<method name="deleteStorage">
10212	<desc>
10213	Starts deleting the storage unit of this medium.
10214
10215	The medium must not be attached to any known virtual machine and must
10216	not have any known child media, otherwise the operation will fail.
10217	It will also fail if there is no storage unit to delete or if deletion
10218	is already in progress, or if the medium is being in use (locked for
10219	read or for write) or inaccessible. Therefore, the only valid state for
10220	this operation to succeed is <link to="MediumState_Created"/>.
10221
10222	Before the operation starts, the medium is placed in
10223	<link to="MediumState_Deleting"/> state and gets removed from the list
10224	of remembered hard disks (media registry). If the delete operation
10225	fails, the medium will be remembered again and placed back to
10226	<link to="MediumState_Created"/> state.
10227
10228	After the returned progress object reports that the operation is
10229	complete, the medium state will be set to
10230	<link to="MediumState_NotCreated"/> and you will be able to use one of
10231	the storage creation methods to create it again.
10232
10233	<see>#close()</see>
10234
10235	<result name="VBOX_E_OBJECT_IN_USE">
10236	Medium is attached to a virtual machine.
10237	</result>
10238	<result name="VBOX_E_NOT_SUPPORTED">
10239	Storage deletion is not allowed because neither of storage creation
10240	operations are supported. See
10241	<link to="IMediumFormat::capabilities"/>.
10242	</result>
10243
10244	<note>
10245	If the deletion operation fails, it is not guaranteed that the storage
10246	unit still exists. You may check the <link to="IMedium::state"/> value
10247	to answer this question.
10248	</note>
10249	</desc>
10250	<param name="progress" type="IProgress" dir="return">
10251	<desc>Progress object to track the operation completion.</desc>
10252	</param>
10253	</method>
10254
10255	<!-- diff methods -->
10256
10257	<method name="createDiffStorage">
10258	<desc>
10259	Starts creating an empty differencing storage unit based on this
10260	medium in the format and at the location defined by the @a target
10261	argument.
10262
10263	The target medium must be in <link to="MediumState_NotCreated"/>
10264	state (i.e. must not have an existing storage unit). Upon successful
10265	completion, this operation will set the type of the target medium to
10266	<link to="MediumType_Normal"/> and create a storage unit necessary to
10267	represent the differencing medium data in the given format (according
10268	to the storage format of the target object).
10269
10270	After the returned progress object reports that the operation is
10271	successfully complete, the target medium gets remembered by this
10272	VirtualBox installation and may be attached to virtual machines.
10273
10274	<note>
10275	The medium will be set to <link to="MediumState_LockedRead"/>
10276	state for the duration of this operation.
10277	</note>
10278	<result name="VBOX_E_OBJECT_IN_USE">
10279	Medium not in @c NotCreated state.
10280	</result>
10281	</desc>
10282	<param name="target" type="IMedium" dir="in">
10283	<desc>Target medium.</desc>
10284	</param>
10285	<param name="variant" type="unsigned long" dir="in">
10286	<desc>Exact image variant which should be created (as a combination of
10287	<link to="MediumVariant" /> flags).</desc>
10288	</param>
10289	<param name="progress" type="IProgress" dir="return">
10290	<desc>Progress object to track the operation completion.</desc>
10291	</param>
10292	</method>
10293
10294	<method name="mergeTo">
10295	<desc>
10296	Starts merging the contents of this medium and all intermediate
10297	differencing media in the chain to the given target medium.
10298
10299	The target medium must be either a descendant of this medium or
10300	its ancestor (otherwise this method will immediately return a failure).
10301	It follows that there are two logical directions of the merge operation:
10302	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10303	ancestor (<i>backward merge</i>). Let us consider the following medium
10304	chain:
10305
10306	<pre>Base <- Diff_1 <- Diff_2</pre>
10307
10308	Here, calling this method on the <tt>Base</tt> medium object with
10309	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10310	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10311	merge. Note that in both cases the contents of the resulting medium
10312	will be the same, the only difference is the medium object that takes
10313	the result of the merge operation. In case of the forward merge in the
10314	above example, the result will be written to <tt>Diff_2</tt>; in case of
10315	the backward merge, the result will be written to <tt>Base</tt>. In
10316	other words, the result of the operation is always stored in the target
10317	medium.
10318
10319	Upon successful operation completion, the storage units of all media in
10320	the chain between this (source) medium and the target medium, including
10321	the source medium itself, will be automatically deleted and the
10322	relevant medium objects (including this medium) will become
10323	uninitialized. This means that any attempt to call any of
10324	their methods or attributes will fail with the
10325	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10326	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10327	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10328	Note that <tt>Diff_2</tt> in this case will become a base medium
10329	itself since it will no longer be based on any other medium.
10330
10331	Considering the above, all of the following conditions must be met in
10332	order for the merge operation to succeed:
10333	<ul>
10334	<li>
10335	Neither this (source) medium nor any intermediate
10336	differencing medium in the chain between it and the target
10337	medium is attached to any virtual machine.
10338	</li>
10339	<li>
10340	Neither the source medium nor the target medium is an
10341	<link to="MediumType_Immutable"/> medium.
10342	</li>
10343	<li>
10344	The part of the medium tree from the source medium to the
10345	target medium is a linear chain, i.e. all medium in this
10346	chain have exactly one child which is the next medium in this
10347	chain. The only exception from this rule is the target medium in
10348	the forward merge operation; it is allowed to have any number of
10349	child media because the merge operation will not change its
10350	logical contents (as it is seen by the guest OS or by children).
10351	</li>
10352	<li>
10353	None of the involved media are in
10354	<link to="MediumState_LockedRead"/> or
10355	<link to="MediumState_LockedWrite"/> state.
10356	</li>
10357	</ul>
10358
10359	<note>
10360	This (source) medium and all intermediates will be placed to <link
10361	to="MediumState_Deleting"/> state and the target medium will be
10362	placed to <link to="MediumState_LockedWrite"/> state and for the
10363	duration of this operation.
10364	</note>
10365	</desc>
10366	<param name="target" type="IMedium" dir="in">
10367	<desc>Target medium.</desc>
10368	</param>
10369	<param name="progress" type="IProgress" dir="return">
10370	<desc>Progress object to track the operation completion.</desc>
10371	</param>
10372	</method>
10373
10374	<!-- clone method -->
10375
10376	<method name="cloneTo">
10377	<desc>
10378	Starts creating a clone of this medium in the format and at the
10379	location defined by the @a target argument.
10380
10381	The target medium must be either in <link to="MediumState_NotCreated"/>
10382	state (i.e. must not have an existing storage unit) or in
10383	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10384	big enough to hold the data or else the copy will be partial). Upon
10385	successful completion, the cloned medium will contain exactly the
10386	same sector data as the medium being cloned, except that in the
10387	first case a new UUID for the clone will be randomly generated, and in
10388	the second case the UUID will remain unchanged.
10389
10390	The @a parent argument defines which medium will be the parent
10391	of the clone. Passing a @c null reference indicates that the clone will
10392	be a base image, i.e. completely independent. It is possible to specify
10393	an arbitrary medium for this parameter, including the parent of the
10394	medium which is being cloned. Even cloning to a child of the source
10395	medium is possible. Note that when cloning to an existing image, the
10396	@a parent irgument is ignored.
10397
10398	After the returned progress object reports that the operation is
10399	successfully complete, the target medium gets remembered by this
10400	VirtualBox installation and may be attached to virtual machines.
10401
10402	<note>
10403	This medium will be placed to <link to="MediumState_LockedRead"/>
10404	state for the duration of this operation.
10405	</note>
10406	<result name="E_NOTIMPL">
10407	The specified cloning variant is not supported at the moment.
10408	</result>
10409	</desc>
10410	<param name="target" type="IMedium" dir="in">
10411	<desc>Target medium.</desc>
10412	</param>
10413	<param name="variant" type="unsigned long" dir="in">
10414	<desc>Exact image variant which should be created (as a combination of
10415	<link to="MediumVariant" /> flags).</desc>
10416	</param>
10417	<param name="parent" type="IMedium" dir="in">
10418	<desc>Parent of the cloned medium.</desc>
10419	</param>
10420	<param name="progress" type="IProgress" dir="return">
10421	<desc>Progress object to track the operation completion.</desc>
10422	</param>
10423	</method>
10424
10425	<!-- other methods -->
10426
10427	<method name="compact">
10428	<desc>
10429	Starts compacting of this medium. This means that the medium is
10430	transformed into a possibly more compact storage representation.
10431	This potentially creates temporary images, which can require a
10432	substantial amount of additional disk space.
10433
10434	This medium will be placed to <link to="MediumState_LockedWrite"/>
10435	state and all its parent media (if any) will be placed to
10436	<link to="MediumState_LockedRead"/> state for the duration of this
10437	operation.
10438
10439	Please note that the results can be either returned straight away,
10440	or later as the result of the background operation via the object
10441	returned via the @a progress parameter.
10442
10443	<result name="VBOX_E_NOT_SUPPORTED">
10444	Medium format does not support compacting (but potentially
10445	needs it).
10446	</result>
10447	</desc>
10448	<param name="progress" type="IProgress" dir="return">
10449	<desc>Progress object to track the operation completion.</desc>
10450	</param>
10451	</method>
10452
10453	<method name="resize">
10454	<desc>
10455	Starts resizing this medium. This means that the nominal size of the
10456	medium is set to the new value. Both increasing and decreasing the
10457	size is possible, and there are no safety checks, since VirtualBox
10458	does not make any assumptions about the medium contents.
10459
10460	Resizing usually needs additional disk space, and possibly also
10461	some temporary disk space. Note that resize does not create a full
10462	temporary copy of the medium, so the additional disk space requirement
10463	is usually much lower than using the clone operation.
10464
10465	This medium will be placed to <link to="MediumState_LockedWrite"/>
10466	state for the duration of this operation.
10467
10468	Please note that the results can be either returned straight away,
10469	or later as the result of the background operation via the object
10470	returned via the @a progress parameter.
10471
10472	<result name="VBOX_E_NOT_SUPPORTED">
10473	Medium format does not support resizing.
10474	</result>
10475	</desc>
10476	<param name="logicalSize" type="long long" dir="in">
10477	<desc>New nominal capacity of the medium in bytes.</desc>
10478	</param>
10479	<param name="progress" type="IProgress" dir="return">
10480	<desc>Progress object to track the operation completion.</desc>
10481	</param>
10482	</method>
10483
10484	<method name="reset">
10485	<desc>
10486	Starts erasing the contents of this differencing medium.
10487
10488	This operation will reset the differencing medium to its initial
10489	state when it does not contain any sector data and any read operation is
10490	redirected to its parent medium. This automatically gets called
10491	during VM power-up for every medium whose <link to="#autoReset" />
10492	attribute is @c true.
10493
10494	The medium will be write-locked for the duration of this operation (see
10495	<link to="#lockWrite" />).
10496
10497	<result name="VBOX_E_NOT_SUPPORTED">
10498	This is not a differencing medium.
10499	</result>
10500	<result name="VBOX_E_INVALID_OBJECT_STATE">
10501	Medium is not in <link to="MediumState_Created"/> or
10502	<link to="MediumState_Inaccessible"/> state.
10503	</result>
10504	</desc>
10505	<param name="progress" type="IProgress" dir="return">
10506	<desc>Progress object to track the operation completion.</desc>
10507	</param>
10508	</method>
10509
10510	</interface>
10511
10512
10513	<!--
10514	// IMediumFormat
10515	/////////////////////////////////////////////////////////////////////////
10516	-->
10517
10518	<enum
10519	name="DataType"
10520	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10521	>
10522	<const name="Int32" value="0"/>
10523	<const name="Int8" value="1"/>
10524	<const name="String" value="2"/>
10525	</enum>
10526
10527	<enum
10528	name="DataFlags"
10529	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10530	>
10531	<const name="None" value="0x00"/>
10532	<const name="Mandatory" value="0x01"/>
10533	<const name="Expert" value="0x02"/>
10534	<const name="Array" value="0x04"/>
10535	<const name="FlagMask" value="0x07"/>
10536	</enum>
10537
10538	<enum
10539	name="MediumFormatCapabilities"
10540	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10541	>
10542	<desc>
10543	Medium format capability flags.
10544	</desc>
10545
10546	<const name="Uuid" value="0x01">
10547	<desc>
10548	Supports UUIDs as expected by VirtualBox code.
10549	</desc>
10550	</const>
10551
10552	<const name="CreateFixed" value="0x02">
10553	<desc>
10554	Supports creating fixed size images, allocating all space instantly.
10555	</desc>
10556	</const>
10557
10558	<const name="CreateDynamic" value="0x04">
10559	<desc>
10560	Supports creating dynamically growing images, allocating space on
10561	demand.
10562	</desc>
10563	</const>
10564
10565	<const name="CreateSplit2G" value="0x08">
10566	<desc>
10567	Supports creating images split in chunks of a bit less than 2 GBytes.
10568	</desc>
10569	</const>
10570
10571	<const name="Differencing" value="0x10">
10572	<desc>
10573	Supports being used as a format for differencing media (see <link
10574	to="IMedium::createDiffStorage"/>).
10575	</desc>
10576	</const>
10577
10578	<const name="Asynchronous" value="0x20">
10579	<desc>
10580	Supports asynchronous I/O operations for at least some configurations.
10581	</desc>
10582	</const>
10583
10584	<const name="File" value="0x40">
10585	<desc>
10586	The format backend operates on files (the <link to="IMedium::location"/>
10587	attribute of the medium specifies a file used to store medium
10588	data; for a list of supported file extensions see
10589	<link to="IMediumFormat::describeFileExtensions"/>).
10590	</desc>
10591	</const>
10592
10593	<const name="Properties" value="0x80">
10594	<desc>
10595	The format backend uses the property interface to configure the storage
10596	location and properties (the <link to="IMediumFormat::describeProperties"/>
10597	method is used to get access to properties supported by the given medium format).
10598	</desc>
10599	</const>
10600
10601	<const name="TcpNetworking" value="0x100">
10602	<desc>
10603	The format backend uses the TCP networking interface for network access.
10604	</desc>
10605	</const>
10606
10607	<const name="VFS" value="0x200">
10608	<desc>
10609	The format backend supports virtual filesystem functionality.
10610	</desc>
10611	</const>
10612
10613	<const name="CapabilityMask" value="0x3FF"/>
10614	</enum>
10615
10616	<interface
10617	name="IMediumFormat" extends="$unknown"
10618	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10619	wsmap="managed"
10620	>
10621	<desc>
10622	The IMediumFormat interface represents a medium format.
10623
10624	Each medium format has an associated backend which is used to handle
10625	media stored in this format. This interface provides information
10626	about the properties of the associated backend.
10627
10628	Each medium format is identified by a string represented by the
10629	<link to="#id"/> attribute. This string is used in calls like
10630	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10631	format.
10632
10633	The list of all supported medium formats can be obtained using
10634	<link to="ISystemProperties::mediumFormats"/>.
10635
10636	<see>IMedium</see>
10637	</desc>
10638
10639	<attribute name="id" type="wstring" readonly="yes">
10640	<desc>
10641	Identifier of this format.
10642
10643	The format identifier is a non-@c null non-empty ASCII string. Note that
10644	this string is case-insensitive. This means that, for example, all of
10645	the following strings:
10646	<pre>
10647	"VDI"
10648	"vdi"
10649	"VdI"</pre>
10650	refer to the same medium format.
10651
10652	This string is used in methods of other interfaces where it is necessary
10653	to specify a medium format, such as
10654	<link to="IVirtualBox::createHardDisk"/>.
10655	</desc>
10656	</attribute>
10657
10658	<attribute name="name" type="wstring" readonly="yes">
10659	<desc>
10660	Human readable description of this format.
10661
10662	Mainly for use in file open dialogs.
10663	</desc>
10664	</attribute>
10665
10666	<attribute name="capabilities" type="unsigned long" readonly="yes">
10667	<desc>
10668	Capabilities of the format as a set of bit flags.
10669
10670	For the meaning of individual capability flags see
10671	<link to="MediumFormatCapabilities"/>.
10672	</desc>
10673	</attribute>
10674
10675	<method name="describeFileExtensions">
10676	<desc>
10677	Returns two arrays describing the supported file extensions.
10678
10679	The first array contains the supported extensions and the seconds one
10680	the type each extension supports. Both have the same size.
10681
10682	Note that some backends do not work on files, so this array may be
10683	empty.
10684
10685	<see>IMediumFormat::capabilities</see>
10686	</desc>
10687	<param name="extensions" type="wstring" safearray="yes" dir="out">
10688	<desc>The array of supported extensions.</desc>
10689	</param>
10690	<param name="type" type="DeviceType" safearray="yes" dir="out">
10691	<desc>The array which indicates the device type for every given extension.</desc>
10692	</param>
10693	</method>
10694
10695	<method name="describeProperties">
10696	<desc>
10697	Returns several arrays describing the properties supported by this
10698	format.
10699
10700	An element with the given index in each array describes one
10701	property. Thus, the number of elements in each returned array is the
10702	same and corresponds to the number of supported properties.
10703
10704	The returned arrays are filled in only if the
10705	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10706	All arguments must be non-@c null.
10707
10708	<see>DataType</see>
10709	<see>DataFlags</see>
10710	</desc>
10711
10712	<param name="names" type="wstring" safearray="yes" dir="out">
10713	<desc>Array of property names.</desc>
10714	</param>
10715	<param name="description" type="wstring" safearray="yes" dir="out">
10716	<desc>Array of property descriptions.</desc>
10717	</param>
10718	<param name="types" type="DataType" safearray="yes" dir="out">
10719	<desc>Array of property types.</desc>
10720	</param>
10721	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10722	<desc>Array of property flags.</desc>
10723	</param>
10724	<param name="defaults" type="wstring" safearray="yes" dir="out">
10725	<desc>Array of default property values.</desc>
10726	</param>
10727	</method>
10728
10729	</interface>
10730
10731
10732	<!--
10733	// IKeyboard
10734	/////////////////////////////////////////////////////////////////////////
10735	-->
10736
10737	<interface
10738	name="IKeyboard" extends="$unknown"
10739	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10740	wsmap="managed"
10741	>
10742	<desc>
10743	The IKeyboard interface represents the virtual machine's keyboard. Used
10744	in <link to="IConsole::keyboard"/>.
10745
10746	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10747	to the virtual machine.
10748
10749	</desc>
10750	<method name="putScancode">
10751	<desc>Sends a scancode to the keyboard.
10752
10753	<result name="VBOX_E_IPRT_ERROR">
10754	Could not send scan code to virtual keyboard.
10755	</result>
10756
10757	</desc>
10758	<param name="scancode" type="long" dir="in"/>
10759	</method>
10760
10761	<method name="putScancodes">
10762	<desc>Sends an array of scancodes to the keyboard.
10763
10764	<result name="VBOX_E_IPRT_ERROR">
10765	Could not send all scan codes to virtual keyboard.
10766	</result>
10767
10768	</desc>
10769	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10770	<param name="codesStored" type="unsigned long" dir="return"/>
10771	</method>
10772
10773	<method name="putCAD">
10774	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10775	function is nothing special, it is just a convenience function
10776	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10777
10778	<result name="VBOX_E_IPRT_ERROR">
10779	Could not send all scan codes to virtual keyboard.
10780	</result>
10781
10782	</desc>
10783	</method>
10784
10785	<attribute name="eventSource" type="IEventSource" readonly="yes">
10786	<desc>
10787	Event source for keyboard events.
10788	</desc>
10789	</attribute>
10790
10791	</interface>
10792
10793
10794	<!--
10795	// IMouse
10796	/////////////////////////////////////////////////////////////////////////
10797	-->
10798
10799	<enum
10800	name="MouseButtonState"
10801	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10802	>
10803	<desc>
10804	Mouse button state.
10805	</desc>
10806
10807	<const name="LeftButton" value="0x01"/>
10808	<const name="RightButton" value="0x02"/>
10809	<const name="MiddleButton" value="0x04"/>
10810	<const name="WheelUp" value="0x08"/>
10811	<const name="WheelDown" value="0x10"/>
10812	<const name="XButton1" value="0x20"/>
10813	<const name="XButton2" value="0x40"/>
10814	<const name="MouseStateMask" value="0x7F"/>
10815	</enum>
10816
10817	<interface
10818	name="IMouse" extends="$unknown"
10819	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10820	wsmap="managed"
10821	>
10822	<desc>
10823	The IMouse interface represents the virtual machine's mouse. Used in
10824	<link to="IConsole::mouse"/>.
10825
10826	Through this interface, the virtual machine's virtual mouse can be
10827	controlled.
10828	</desc>
10829
10830	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10831	<desc>
10832	Whether the guest OS supports absolute mouse pointer positioning
10833	or not.
10834	<note>
10835	You can use the <link to="IMouseCapabilityChangedEvent"/>
10836	event to be instantly informed about changes of this attribute
10837	during virtual machine execution.
10838	</note>
10839	<see><link to="#putMouseEventAbsolute"/></see>
10840	</desc>
10841	</attribute>
10842
10843	<attribute name="relativeSupported" type="boolean" readonly="yes">
10844	<desc>
10845	Whether the guest OS supports relative mouse pointer positioning
10846	or not.
10847	<note>
10848	You can use the <link to="IMouseCapabilityChangedEvent"/>
10849	event to be instantly informed about changes of this attribute
10850	during virtual machine execution.
10851	</note>
10852	<see><link to="#putMouseEvent"/></see>
10853	</desc>
10854	</attribute>
10855
10856	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10857	<desc>
10858	Whether the guest OS can currently switch to drawing it's own mouse
10859	cursor on demand.
10860	<note>
10861	You can use the <link to="IMouseCapabilityChangedEvent"/>
10862	event to be instantly informed about changes of this attribute
10863	during virtual machine execution.
10864	</note>
10865	<see><link to="#putMouseEvent"/></see>
10866	</desc>
10867	</attribute>
10868
10869	<method name="putMouseEvent">
10870	<desc>
10871	Initiates a mouse event using relative pointer movements
10872	along x and y axis.
10873
10874	<result name="E_ACCESSDENIED">
10875	Console not powered up.
10876	</result>
10877	<result name="VBOX_E_IPRT_ERROR">
10878	Could not send mouse event to virtual mouse.
10879	</result>
10880
10881	</desc>
10882
10883	<param name="dx" type="long" dir="in">
10884	<desc>
10885	Amount of pixels the mouse should move to the right.
10886	Negative values move the mouse to the left.
10887	</desc>
10888	</param>
10889	<param name="dy" type="long" dir="in">
10890	<desc>
10891	Amount of pixels the mouse should move downwards.
10892	Negative values move the mouse upwards.
10893	</desc>
10894	</param>
10895	<param name="dz" type="long" dir="in">
10896	<desc>
10897	Amount of mouse wheel moves.
10898	Positive values describe clockwise wheel rotations,
10899	negative values describe counterclockwise rotations.
10900	</desc>
10901	</param>
10902	<param name="dw" type="long" dir="in">
10903	<desc>
10904	Amount of horizontal mouse wheel moves.
10905	Positive values describe a movement to the left,
10906	negative values describe a movement to the right.
10907	</desc>
10908	</param>
10909	<param name="buttonState" type="long" dir="in">
10910	<desc>
10911	The current state of mouse buttons. Every bit represents
10912	a mouse button as follows:
10913	<table>
10914	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10915	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10916	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10917	</table>
10918	A value of <tt>1</tt> means the corresponding button is pressed.
10919	otherwise it is released.
10920	</desc>
10921	</param>
10922	</method>
10923
10924	<method name="putMouseEventAbsolute">
10925	<desc>
10926	Positions the mouse pointer using absolute x and y coordinates.
10927	These coordinates are expressed in pixels and
10928	start from <tt>[1,1]</tt> which corresponds to the top left
10929	corner of the virtual display.
10930
10931	<result name="E_ACCESSDENIED">
10932	Console not powered up.
10933	</result>
10934	<result name="VBOX_E_IPRT_ERROR">
10935	Could not send mouse event to virtual mouse.
10936	</result>
10937
10938	<note>
10939	This method will have effect only if absolute mouse
10940	positioning is supported by the guest OS.
10941	</note>
10942
10943	<see><link to="#absoluteSupported"/></see>
10944	</desc>
10945
10946	<param name="x" type="long" dir="in">
10947	<desc>
10948	X coordinate of the pointer in pixels, starting from @c 1.
10949	</desc>
10950	</param>
10951	<param name="y" type="long" dir="in">
10952	<desc>
10953	Y coordinate of the pointer in pixels, starting from @c 1.
10954	</desc>
10955	</param>
10956	<param name="dz" type="long" dir="in">
10957	<desc>
10958	Amount of mouse wheel moves.
10959	Positive values describe clockwise wheel rotations,
10960	negative values describe counterclockwise rotations.
10961	</desc>
10962	</param>
10963	<param name="dw" type="long" dir="in">
10964	<desc>
10965	Amount of horizontal mouse wheel moves.
10966	Positive values describe a movement to the left,
10967	negative values describe a movement to the right.
10968	</desc>
10969	</param>
10970	<param name="buttonState" type="long" dir="in">
10971	<desc>
10972	The current state of mouse buttons. Every bit represents
10973	a mouse button as follows:
10974	<table>
10975	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10976	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10977	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10978	</table>
10979	A value of @c 1 means the corresponding button is pressed.
10980	otherwise it is released.
10981	</desc>
10982	</param>
10983	</method>
10984
10985	<attribute name="eventSource" type="IEventSource" readonly="yes">
10986	<desc>
10987	Event source for mouse events.
10988	</desc>
10989	</attribute>
10990
10991	</interface>
10992
10993	<!--
10994	// IDisplay
10995	/////////////////////////////////////////////////////////////////////////
10996	-->
10997
10998	<enum
10999	name="FramebufferPixelFormat"
11000	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11001	>
11002	<desc>
11003	Format of the video memory buffer. Constants represented by this enum can
11004	be used to test for particular values of <link
11005	to="IFramebuffer::pixelFormat"/>. See also <link
11006	to="IFramebuffer::requestResize"/>.
11007
11008	See also www.fourcc.org for more information about FOURCC pixel formats.
11009	</desc>
11010
11011	<const name="Opaque" value="0">
11012	<desc>
11013	Unknown buffer format (the user may not assume any particular format of
11014	the buffer).
11015	</desc>
11016	</const>
11017	<const name="FOURCC_RGB" value="0x32424752">
11018	<desc>
11019	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11020	bit layout).
11021	</desc>
11022	</const>
11023	</enum>
11024
11025	<interface
11026	name="IFramebuffer" extends="$unknown"
11027	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11028	wsmap="suppress"
11029	>
11030	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11031	<desc>Address of the start byte of the frame buffer.</desc>
11032	</attribute>
11033
11034	<attribute name="width" type="unsigned long" readonly="yes">
11035	<desc>Frame buffer width, in pixels.</desc>
11036	</attribute>
11037
11038	<attribute name="height" type="unsigned long" readonly="yes">
11039	<desc>Frame buffer height, in pixels.</desc>
11040	</attribute>
11041
11042	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11043	<desc>
11044	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11045	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11046	are: 8, 15, 16, 24 and 32.
11047	</desc>
11048	</attribute>
11049
11050	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11051	<desc>
11052	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11053	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11054	size of the scan line must be aligned to 32 bits.
11055	</desc>
11056	</attribute>
11057
11058	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11059	<desc>
11060	Frame buffer pixel format. It's either one of the values defined by <link
11061	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11062	<note>
11063	This attribute must never return <link
11064	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11065	<link to="#address"/> points to must be always known.
11066	</note>
11067	</desc>
11068	</attribute>
11069
11070	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11071	<desc>
11072	Defines whether this frame buffer uses the virtual video card's memory
11073	buffer (guest VRAM) directly or not. See <link
11074	to="IFramebuffer::requestResize"/> for more information.
11075	</desc>
11076	</attribute>
11077
11078	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11079	<desc>
11080	Hint from the frame buffer about how much of the standard
11081	screen height it wants to use for itself. This information is
11082	exposed to the guest through the VESA BIOS and VMMDev interface
11083	so that it can use it for determining its video mode table. It
11084	is not guaranteed that the guest respects the value.
11085	</desc>
11086	</attribute>
11087
11088	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11089	<desc>
11090	An alpha-blended overlay which is superposed over the frame buffer.
11091	The initial purpose is to allow the display of icons providing
11092	information about the VM state, including disk activity, in front
11093	ends which do not have other means of doing that. The overlay is
11094	designed to controlled exclusively by IDisplay. It has no locking
11095	of its own, and any changes made to it are not guaranteed to be
11096	visible until the affected portion of IFramebuffer is updated. The
11097	overlay can be created lazily the first time it is requested. This
11098	attribute can also return @c null to signal that the overlay is not
11099	implemented.
11100	</desc>
11101	</attribute>
11102
11103	<attribute name="winId" type="long long" readonly="yes">
11104	<desc>
11105	Platform-dependent identifier of the window where context of this
11106	frame buffer is drawn, or zero if there's no such window.
11107	</desc>
11108	</attribute>
11109
11110	<method name="lock">
11111	<desc>
11112	Locks the frame buffer.
11113	Gets called by the IDisplay object where this frame buffer is
11114	bound to.
11115	</desc>
11116	</method>
11117
11118	<method name="unlock">
11119	<desc>
11120	Unlocks the frame buffer.
11121	Gets called by the IDisplay object where this frame buffer is
11122	bound to.
11123	</desc>
11124	</method>
11125
11126	<method name="notifyUpdate">
11127	<desc>
11128	Informs about an update.
11129	Gets called by the display object where this buffer is
11130	registered.
11131	</desc>
11132	<param name="x" type="unsigned long" dir="in"/>
11133	<param name="y" type="unsigned long" dir="in"/>
11134	<param name="width" type="unsigned long" dir="in"/>
11135	<param name="height" type="unsigned long" dir="in"/>
11136	</method>
11137
11138	<method name="requestResize">
11139	<desc>
11140	Requests a size and pixel format change.
11141
11142	There are two modes of working with the video buffer of the virtual
11143	machine. The <i>indirect</i> mode implies that the IFramebuffer
11144	implementation allocates a memory buffer for the requested display mode
11145	and provides it to the virtual machine. In <i>direct</i> mode, the
11146	IFramebuffer implementation uses the memory buffer allocated and owned
11147	by the virtual machine. This buffer represents the video memory of the
11148	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11149	usually faster because the implementation gets a raw pointer to the
11150	guest VRAM buffer which it can directly use for visualizing the contents
11151	of the virtual display, as opposed to the indirect mode where the
11152	contents of guest VRAM are copied to the memory buffer provided by
11153	the implementation every time a display update occurs.
11154
11155	It is important to note that the direct mode is really fast only when
11156	the implementation uses the given guest VRAM buffer directly, for
11157	example, by blitting it to the window representing the virtual machine's
11158	display, which saves at least one copy operation comparing to the
11159	indirect mode. However, using the guest VRAM buffer directly is not
11160	always possible: the format and the color depth of this buffer may be
11161	not supported by the target window, or it may be unknown (opaque) as in
11162	case of text or non-linear multi-plane VGA video modes. In this case,
11163	the indirect mode (that is always available) should be used as a
11164	fallback: when the guest VRAM contents are copied to the
11165	implementation-provided memory buffer, color and format conversion is
11166	done automatically by the underlying code.
11167
11168	The @a pixelFormat parameter defines whether the direct mode is
11169	available or not. If @a pixelFormat is <link
11170	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11171	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11172	@a bytesPerLine parameters must be ignored and the implementation must use
11173	the indirect mode (where it provides its own buffer in one of the
11174	supported formats). In all other cases, @a pixelFormat together with
11175	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11176	buffer pointed to by the @a VRAM parameter and the implementation is
11177	free to choose which mode to use. To indicate that this frame buffer uses
11178	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11179	attribute must return @c true and <link to="#address"/> must
11180	return exactly the same address that is passed in the @a VRAM parameter
11181	of this method; otherwise it is assumed that the indirect strategy is
11182	chosen.
11183
11184	The @a width and @a height parameters represent the size of the
11185	requested display mode in both modes. In case of indirect mode, the
11186	provided memory buffer should be big enough to store data of the given
11187	display mode. In case of direct mode, it is guaranteed that the given
11188	@a VRAM buffer contains enough space to represent the display mode of the
11189	given size. Note that this frame buffer's <link to="#width"/> and <link
11190	to="#height"/> attributes must return exactly the same values as
11191	passed to this method after the resize is completed (see below).
11192
11193	The @a finished output parameter determines if the implementation has
11194	finished resizing the frame buffer or not. If, for some reason, the
11195	resize cannot be finished immediately during this call, @a finished
11196	must be set to @c false, and the implementation must call
11197	<link to="IDisplay::resizeCompleted"/> after it has returned from
11198	this method as soon as possible. If @a finished is @c false, the
11199	machine will not call any frame buffer methods until
11200	<link to="IDisplay::resizeCompleted"/> is called.
11201
11202	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11203	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11204	this frame buffer must return exactly the same values as specified in the
11205	parameters of this method, after the resize is completed. If the
11206	indirect mode is chosen, these attributes must return values describing
11207	the format of the implementation's own memory buffer <link
11208	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11209	value must always correlate with <link to="#pixelFormat"/>. Note that
11210	the <link to="#pixelFormat"/> attribute must never return <link
11211	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11212
11213	<note>
11214	This method is called by the IDisplay object under the
11215	<link to="#lock"/> provided by this IFramebuffer
11216	implementation. If this method returns @c false in @a finished, then
11217	this lock is not released until
11218	<link to="IDisplay::resizeCompleted"/> is called.
11219	</note>
11220	</desc>
11221	<param name="screenId" type="unsigned long" dir="in">
11222	<desc>
11223	Logical screen number. Must be used in the corresponding call to
11224	<link to="IDisplay::resizeCompleted"/> if this call is made.
11225	</desc>
11226	</param>
11227	<param name="pixelFormat" type="unsigned long" dir="in">
11228	<desc>
11229	Pixel format of the memory buffer pointed to by @a VRAM.
11230	See also <link to="FramebufferPixelFormat"/>.
11231	</desc>
11232	</param>
11233	<param name="VRAM" type="octet" mod="ptr" dir="in">
11234	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11235	</param>
11236	<param name="bitsPerPixel" type="unsigned long" dir="in">
11237	<desc>Color depth, bits per pixel.</desc>
11238	</param>
11239	<param name="bytesPerLine" type="unsigned long" dir="in">
11240	<desc>Size of one scan line, in bytes.</desc>
11241	</param>
11242	<param name="width" type="unsigned long" dir="in">
11243	<desc>Width of the guest display, in pixels.</desc>
11244	</param>
11245	<param name="height" type="unsigned long" dir="in">
11246	<desc>Height of the guest display, in pixels.</desc>
11247	</param>
11248	<param name="finished" type="boolean" dir="return">
11249	<desc>
11250	Can the VM start using the new frame buffer immediately
11251	after this method returns or it should wait for
11252	<link to="IDisplay::resizeCompleted"/>.
11253	</desc>
11254	</param>
11255	</method>
11256
11257	<method name="videoModeSupported">
11258	<desc>
11259	Returns whether the frame buffer implementation is willing to
11260	support a given video mode. In case it is not able to render
11261	the video mode (or for some reason not willing), it should
11262	return @c false. Usually this method is called when the guest
11263	asks the VMM device whether a given video mode is supported
11264	so the information returned is directly exposed to the guest.
11265	It is important that this method returns very quickly.
11266	</desc>
11267	<param name="width" type="unsigned long" dir="in"/>
11268	<param name="height" type="unsigned long" dir="in"/>
11269	<param name="bpp" type="unsigned long" dir="in"/>
11270	<param name="supported" type="boolean" dir="return"/>
11271	</method>
11272
11273	<method name="getVisibleRegion">
11274	<desc>
11275	Returns the visible region of this frame buffer.
11276
11277	If the @a rectangles parameter is @c null then the value of the
11278	@a count parameter is ignored and the number of elements necessary to
11279	describe the current visible region is returned in @a countCopied.
11280
11281	If @a rectangles is not @c null but @a count is less
11282	than the required number of elements to store region data, the method
11283	will report a failure. If @a count is equal or greater than the
11284	required number of elements, then the actual number of elements copied
11285	to the provided array will be returned in @a countCopied.
11286
11287	<note>
11288	The address of the provided array must be in the process space of
11289	this IFramebuffer object.
11290	</note>
11291	<note>
11292	Method not yet implemented.
11293	</note>
11294	</desc>
11295	<param name="rectangles" type="octet" mod="ptr" dir="in">
11296	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11297	</param>
11298	<param name="count" type="unsigned long" dir="in">
11299	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11300	</param>
11301	<param name="countCopied" type="unsigned long" dir="return">
11302	<desc>Number of elements copied to the @a rectangles array.</desc>
11303	</param>
11304	</method>
11305
11306	<method name="setVisibleRegion">
11307	<desc>
11308	Suggests a new visible region to this frame buffer. This region
11309	represents the area of the VM display which is a union of regions of
11310	all top-level windows of the guest operating system running inside the
11311	VM (if the Guest Additions for this system support this
11312	functionality). This information may be used by the frontends to
11313	implement the seamless desktop integration feature.
11314
11315	<note>
11316	The address of the provided array must be in the process space of
11317	this IFramebuffer object.
11318	</note>
11319	<note>
11320	The IFramebuffer implementation must make a copy of the provided
11321	array of rectangles.
11322	</note>
11323	<note>
11324	Method not yet implemented.
11325	</note>
11326	</desc>
11327	<param name="rectangles" type="octet" mod="ptr" dir="in">
11328	<desc>Pointer to the @c RTRECT array.</desc>
11329	</param>
11330	<param name="count" type="unsigned long" dir="in">
11331	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11332	</param>
11333	</method>
11334
11335	<method name="processVHWACommand">
11336	<desc>
11337	Posts a Video HW Acceleration Command to the frame buffer for processing.
11338	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11339	are posted from quest to the host to be processed by the host hardware.
11340
11341	<note>
11342	The address of the provided command must be in the process space of
11343	this IFramebuffer object.
11344	</note>
11345	</desc>
11346
11347	<param name="command" type="octet" mod="ptr" dir="in">
11348	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11349	</param>
11350	</method>
11351
11352	</interface>
11353
11354	<interface
11355	name="IFramebufferOverlay" extends="IFramebuffer"
11356	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11357	wsmap="suppress"
11358	>
11359	<desc>
11360	The IFramebufferOverlay interface represents an alpha blended overlay
11361	for displaying status icons above an IFramebuffer. It is always created
11362	not visible, so that it must be explicitly shown. It only covers a
11363	portion of the IFramebuffer, determined by its width, height and
11364	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11365	that order) format, and may be written to directly. Do re-read the
11366	width though, after setting it, as it may be adjusted (increased) to
11367	make it more suitable for the front end.
11368	</desc>
11369	<attribute name="x" type="unsigned long" readonly="yes">
11370	<desc>X position of the overlay, relative to the frame buffer.</desc>
11371	</attribute>
11372
11373	<attribute name="y" type="unsigned long" readonly="yes">
11374	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11375	</attribute>
11376
11377	<attribute name="visible" type="boolean" readonly="no">
11378	<desc>
11379	Whether the overlay is currently visible.
11380	</desc>
11381	</attribute>
11382
11383	<attribute name="alpha" type="unsigned long" readonly="no">
11384	<desc>
11385	The global alpha value for the overlay. This may or may not be
11386	supported by a given front end.
11387	</desc>
11388	</attribute>
11389
11390	<method name="move">
11391	<desc>
11392	Changes the overlay's position relative to the IFramebuffer.
11393	</desc>
11394	<param name="x" type="unsigned long" dir="in"/>
11395	<param name="y" type="unsigned long" dir="in"/>
11396	</method>
11397
11398	</interface>
11399
11400	<interface
11401	name="IDisplay" extends="$unknown"
11402	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11403	wsmap="managed"
11404	>
11405	<desc>
11406	The IDisplay interface represents the virtual machine's display.
11407
11408	The object implementing this interface is contained in each
11409	<link to="IConsole::display"/> attribute and represents the visual
11410	output of the virtual machine.
11411
11412	The virtual display supports pluggable output targets represented by the
11413	IFramebuffer interface. Examples of the output target are a window on
11414	the host computer or an RDP session's display on a remote computer.
11415	</desc>
11416	<method name="getScreenResolution">
11417	<desc>Queries display width, height and color depth for given screen.</desc>
11418	<param name="screenId" type="unsigned long" dir="in"/>
11419	<param name="width" type="unsigned long" dir="out"/>
11420	<param name="height" type="unsigned long" dir="out"/>
11421	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11422	</method>
11423
11424	<method name="setFramebuffer">
11425	<desc>
11426	Sets the framebuffer for given screen.
11427	</desc>
11428	<param name="screenId" type="unsigned long" dir="in"/>
11429	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11430	</method>
11431
11432	<method name="getFramebuffer">
11433	<desc>
11434	Queries the framebuffer for given screen.
11435	</desc>
11436	<param name="screenId" type="unsigned long" dir="in"/>
11437	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11438	<param name="xOrigin" type="long" dir="out"/>
11439	<param name="yOrigin" type="long" dir="out"/>
11440	</method>
11441
11442	<method name="setVideoModeHint">
11443	<desc>
11444	Asks VirtualBox to request the given video mode from
11445	the guest. This is just a hint and it cannot be guaranteed
11446	that the requested resolution will be used. Guest Additions
11447	are required for the request to be seen by guests. The caller
11448	should issue the request and wait for a resolution change and
11449	after a timeout retry.
11450
11451	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11452	parameters means that the corresponding values should be taken from the
11453	current video mode (i.e. left unchanged).
11454
11455	If the guest OS supports multi-monitor configuration then the @a display
11456	parameter specifies the number of the guest display to send the hint to:
11457	@c 0 is the primary display, @c 1 is the first secondary and
11458	so on. If the multi-monitor configuration is not supported, @a display
11459	must be @c 0.
11460
11461	<result name="E_INVALIDARG">
11462	The @a display is not associated with any monitor.
11463	</result>
11464
11465	</desc>
11466	<param name="width" type="unsigned long" dir="in"/>
11467	<param name="height" type="unsigned long" dir="in"/>
11468	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11469	<param name="display" type="unsigned long" dir="in"/>
11470	</method>
11471
11472	<method name="setSeamlessMode">
11473	<desc>
11474	Enables or disables seamless guest display rendering (seamless desktop
11475	integration) mode.
11476	<note>
11477	Calling this method has no effect if <link
11478	to="IGuest::supportsSeamless"/> returns @c false.
11479	</note>
11480	</desc>
11481	<param name="enabled" type="boolean" dir="in"/>
11482	</method>
11483
11484	<method name="takeScreenShot">
11485	<desc>
11486	Takes a screen shot of the requested size and copies it to the
11487	32-bpp buffer allocated by the caller and pointed to by @a address.
11488	A pixel consists of 4 bytes in order: B, G, R, 0.
11489
11490	<note>This API can be used only by the COM/XPCOM C++ API as it
11491	requires pointer support. Use <link to="#takeScreenShotToArray" />
11492	with other language bindings.
11493	</note>
11494
11495	<result name="E_NOTIMPL">
11496	Feature not implemented.
11497	</result>
11498	<result name="VBOX_E_IPRT_ERROR">
11499	Could not take a screenshot.
11500	</result>
11501
11502	</desc>
11503	<param name="screenId" type="unsigned long" dir="in"/>
11504	<param name="address" type="octet" mod="ptr" dir="in"/>
11505	<param name="width" type="unsigned long" dir="in"/>
11506	<param name="height" type="unsigned long" dir="in"/>
11507	</method>
11508
11509	<method name="takeScreenShotToArray">
11510	<desc>
11511	Takes a guest screen shot of the requested size and returns it as
11512	an array of bytes in uncompressed 32-bit RGBA format.
11513	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11514
11515	This API is slow, but could be the only option to get guest screenshot
11516	for scriptable languages not allowed to manipulate with addresses
11517	directly.
11518
11519	<result name="E_NOTIMPL">
11520	Feature not implemented.
11521	</result>
11522	<result name="VBOX_E_IPRT_ERROR">
11523	Could not take a screenshot.
11524	</result>
11525	</desc>
11526	<param name="screenId" type="unsigned long" dir="in">
11527	<desc>
11528	Monitor to take screenshot from.
11529	</desc>
11530	</param>
11531	<param name="width" type="unsigned long" dir="in">
11532	<desc>
11533	Desired image width.
11534	</desc>
11535	</param>
11536	<param name="height" type="unsigned long" dir="in">
11537	<desc>
11538	Desired image height.
11539	</desc>
11540	</param>
11541	<param name="screenData" type="octet" dir="return" safearray="yes">
11542	<desc>
11543	Array with resulting screen data.
11544	</desc>
11545	</param>
11546	</method>
11547
11548	<method name="takeScreenShotPNGToArray">
11549	<desc>
11550	Takes a guest screen shot of the requested size and returns it as
11551	PNG image in array.
11552
11553	<result name="E_NOTIMPL">
11554	Feature not implemented.
11555	</result>
11556	<result name="VBOX_E_IPRT_ERROR">
11557	Could not take a screenshot.
11558	</result>
11559	</desc>
11560	<param name="screenId" type="unsigned long" dir="in">
11561	<desc>
11562	Monitor to take the screenshot from.
11563	</desc>
11564	</param>
11565	<param name="width" type="unsigned long" dir="in">
11566	<desc>
11567	Desired image width.
11568	</desc>
11569	</param>
11570	<param name="height" type="unsigned long" dir="in">
11571	<desc>
11572	Desired image height.
11573	</desc>
11574	</param>
11575	<param name="screenData" type="octet" dir="return" safearray="yes">
11576	<desc>
11577	Array with resulting screen data.
11578	</desc>
11579	</param>
11580	</method>
11581
11582	<method name="drawToScreen">
11583	<desc>
11584	Draws a 32-bpp image of the specified size from the given buffer
11585	to the given point on the VM display.
11586
11587	<result name="E_NOTIMPL">
11588	Feature not implemented.
11589	</result>
11590	<result name="VBOX_E_IPRT_ERROR">
11591	Could not draw to screen.
11592	</result>
11593
11594	</desc>
11595	<param name="screenId" type="unsigned long" dir="in">
11596	<desc>
11597	Monitor to take the screenshot from.
11598	</desc>
11599	</param>
11600	<param name="address" type="octet" mod="ptr" dir="in">
11601	<desc>
11602	Address to store the screenshot to
11603	</desc>
11604	</param>
11605	<param name="x" type="unsigned long" dir="in">
11606	<desc>
11607	Relative to the screen top left corner.
11608	</desc>
11609	</param>
11610	<param name="y" type="unsigned long" dir="in">
11611	<desc>
11612	Relative to the screen top left corner.
11613	</desc>
11614	</param>
11615	<param name="width" type="unsigned long" dir="in">
11616	<desc>
11617	Desired image width.
11618	</desc>
11619	</param>
11620	<param name="height" type="unsigned long" dir="in">
11621	<desc>
11622	Desired image height.
11623	</desc>
11624	</param>
11625	</method>
11626
11627	<method name="invalidateAndUpdate">
11628	<desc>
11629	Does a full invalidation of the VM display and instructs the VM
11630	to update it.
11631
11632	<result name="VBOX_E_IPRT_ERROR">
11633	Could not invalidate and update screen.
11634	</result>
11635
11636	</desc>
11637	</method>
11638
11639	<method name="resizeCompleted">
11640	<desc>
11641	Signals that a framebuffer has completed the resize operation.
11642
11643	<result name="VBOX_E_NOT_SUPPORTED">
11644	Operation only valid for external frame buffers.
11645	</result>
11646
11647	</desc>
11648	<param name="screenId" type="unsigned long" dir="in"/>
11649	</method>
11650
11651	<method name="completeVHWACommand">
11652	<desc>
11653	Signals that the Video HW Acceleration command has completed.
11654	</desc>
11655
11656	<param name="command" type="octet" mod="ptr" dir="in">
11657	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11658	</param>
11659	</method>
11660
11661	</interface>
11662
11663	<!--
11664	// INetworkAdapter
11665	/////////////////////////////////////////////////////////////////////////
11666	-->
11667
11668	<enum
11669	name="NetworkAttachmentType"
11670	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11671	>
11672	<desc>
11673	Network attachment type.
11674	</desc>
11675
11676	<const name="Null" value="0">
11677	<desc>Null value, also means "not attached".</desc>
11678	</const>
11679	<const name="NAT" value="1"/>
11680	<const name="Bridged" value="2"/>
11681	<const name="Internal" value="3"/>
11682	<const name="HostOnly" value="4"/>
11683	<const name="VDE" value="5"/>
11684	</enum>
11685
11686	<enum
11687	name="NetworkAdapterType"
11688	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11689	>
11690	<desc>
11691	Network adapter type.
11692	</desc>
11693
11694	<const name="Null" value="0">
11695	<desc>Null value (never used by the API).</desc>
11696	</const>
11697	<const name="Am79C970A" value="1">
11698	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11699	</const>
11700	<const name="Am79C973" value="2">
11701	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11702	</const>
11703	<const name="I82540EM" value="3">
11704	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11705	</const>
11706	<const name="I82543GC" value="4">
11707	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11708	</const>
11709	<const name="I82545EM" value="5">
11710	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11711	</const>
11712	<const name="Virtio" value="6">
11713	<desc>Virtio network device.</desc>
11714	</const>
11715	</enum>
11716
11717	<interface
11718	name="INetworkAdapter" extends="$unknown"
11719	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11720	wsmap="managed"
11721	>
11722	<desc>
11723	Represents a virtual network adapter that is attached to a virtual machine.
11724	Each virtual machine has a fixed number of network adapter slots with one
11725	instance of this attached to each of them. Call
11726	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11727	is attached to a given slot in a given machine.
11728
11729	Each network adapter can be in one of five attachment modes, which are
11730	represented by the <link to="NetworkAttachmentType" /> enumeration;
11731	see the <link to="#attachmentType" /> attribute.
11732	</desc>
11733
11734	<attribute name="adapterType" type="NetworkAdapterType">
11735	<desc>
11736	Type of the virtual network adapter. Depending on this value,
11737	VirtualBox will provide a different virtual network hardware
11738	to the guest.
11739	</desc>
11740	</attribute>
11741
11742	<attribute name="slot" type="unsigned long" readonly="yes">
11743	<desc>
11744	Slot number this adapter is plugged into. Corresponds to
11745	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11746	to obtain this instance.
11747	</desc>
11748	</attribute>
11749
11750	<attribute name="enabled" type="boolean">
11751	<desc>
11752	Flag whether the network adapter is present in the
11753	guest system. If disabled, the virtual guest hardware will
11754	not contain this network adapter. Can only be changed when
11755	the VM is not running.
11756	</desc>
11757	</attribute>
11758
11759	<attribute name="MACAddress" type="wstring">
11760	<desc>
11761	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11762	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11763	</desc>
11764	</attribute>
11765
11766	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11767
11768	<attribute name="hostInterface" type="wstring">
11769	<desc>
11770	Name of the host network interface the VM is attached to.
11771	</desc>
11772	</attribute>
11773
11774	<attribute name="internalNetwork" type="wstring">
11775	<desc>
11776	Name of the internal network the VM is attached to.
11777	</desc>
11778	</attribute>
11779
11780	<attribute name="NATNetwork" type="wstring">
11781	<desc>
11782	Name of the NAT network the VM is attached to.
11783	</desc>
11784	</attribute>
11785
11786	<attribute name="VDENetwork" type="wstring">
11787	<desc>
11788	Name of the VDE switch the VM is attached to.
11789	</desc>
11790	</attribute>
11791
11792	<attribute name="cableConnected" type="boolean">
11793	<desc>
11794	Flag whether the adapter reports the cable as connected or not.
11795	It can be used to report offline situations to a VM.
11796	</desc>
11797	</attribute>
11798
11799	<attribute name="lineSpeed" type="unsigned long">
11800	<desc>
11801	Line speed reported by custom drivers, in units of 1 kbps.
11802	</desc>
11803	</attribute>
11804
11805	<attribute name="traceEnabled" type="boolean">
11806	<desc>
11807	Flag whether network traffic from/to the network card should be traced.
11808	Can only be toggled when the VM is turned off.
11809	</desc>
11810	</attribute>
11811
11812	<attribute name="traceFile" type="wstring">
11813	<desc>
11814	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11815	will be used.
11816	</desc>
11817	</attribute>
11818
11819	<attribute name="natDriver" type="INATEngine" readonly="yes">
11820	<desc>
11821	Points to the NAT engine which handles the network address translation
11822	for this interface. This is active only when the interface actually uses
11823	NAT (see <link to="#attachToNAT" />).
11824	</desc>
11825	</attribute>
11826
11827	<attribute name="bootPriority" type="unsigned long">
11828	<desc>
11829	Network boot priority of the adapter. Priority 1 is highest. If not set,
11830	the priority is considered to be at the lowest possible setting.
11831	</desc>
11832	</attribute>
11833
11834	<attribute name="bandwidthLimit" type="unsigned long">
11835	<desc>
11836	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11837	A zero value means uncapped/unlimited.
11838	</desc>
11839	</attribute>
11840
11841	<method name="attachToNAT">
11842	<desc>
11843	Attach the network adapter to the Network Address Translation (NAT) interface.
11844	</desc>
11845	</method>
11846
11847	<method name="attachToBridgedInterface">
11848	<desc>
11849	Attach the network adapter to a bridged host interface.
11850	</desc>
11851	</method>
11852
11853	<method name="attachToInternalNetwork">
11854	<desc>
11855	Attach the network adapter to an internal network.
11856	</desc>
11857	</method>
11858
11859	<method name="attachToHostOnlyInterface">
11860	<desc>
11861	Attach the network adapter to the host-only network.
11862	</desc>
11863	</method>
11864
11865	<method name="attachToVDE">
11866	<desc>
11867	Attach the network adapter to a VDE network.
11868	</desc>
11869	</method>
11870
11871	<method name="detach">
11872	<desc>
11873	Detach the network adapter
11874	</desc>
11875	</method>
11876	</interface>
11877
11878
11879	<!--
11880	// ISerialPort
11881	/////////////////////////////////////////////////////////////////////////
11882	-->
11883
11884	<enum
11885	name="PortMode"
11886	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11887	>
11888	<desc>
11889	The PortMode enumeration represents possible communication modes for
11890	the virtual serial port device.
11891	</desc>
11892
11893	<const name="Disconnected" value="0">
11894	<desc>Virtual device is not attached to any real host device.</desc>
11895	</const>
11896	<const name="HostPipe" value="1">
11897	<desc>Virtual device is attached to a host pipe.</desc>
11898	</const>
11899	<const name="HostDevice" value="2">
11900	<desc>Virtual device is attached to a host device.</desc>
11901	</const>
11902	<const name="RawFile" value="3">
11903	<desc>Virtual device is attached to a raw file.</desc>
11904	</const>
11905	</enum>
11906
11907	<interface
11908	name="ISerialPort" extends="$unknown"
11909	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11910	wsmap="managed"
11911	>
11912
11913	<desc>
11914	The ISerialPort interface represents the virtual serial port device.
11915
11916	The virtual serial port device acts like an ordinary serial port
11917	inside the virtual machine. This device communicates to the real
11918	serial port hardware in one of two modes: host pipe or host device.
11919
11920	In host pipe mode, the #path attribute specifies the path to the pipe on
11921	the host computer that represents a serial port. The #server attribute
11922	determines if this pipe is created by the virtual machine process at
11923	machine startup or it must already exist before starting machine
11924	execution.
11925
11926	In host device mode, the #path attribute specifies the name of the
11927	serial port device on the host computer.
11928
11929	There is also a third communication mode: the disconnected mode. In this
11930	mode, the guest OS running inside the virtual machine will be able to
11931	detect the serial port, but all port write operations will be discarded
11932	and all port read operations will return no data.
11933
11934	<see>IMachine::getSerialPort</see>
11935	</desc>
11936
11937	<attribute name="slot" type="unsigned long" readonly="yes">
11938	<desc>
11939	Slot number this serial port is plugged into. Corresponds to
11940	the value you pass to <link to="IMachine::getSerialPort"/>
11941	to obtain this instance.
11942	</desc>
11943	</attribute>
11944
11945	<attribute name="enabled" type="boolean">
11946	<desc>
11947	Flag whether the serial port is enabled. If disabled,
11948	the serial port will not be reported to the guest OS.
11949	</desc>
11950	</attribute>
11951
11952	<attribute name="IOBase" type="unsigned long">
11953	<desc>Base I/O address of the serial port.</desc>
11954	</attribute>
11955
11956	<attribute name="IRQ" type="unsigned long">
11957	<desc>IRQ number of the serial port.</desc>
11958	</attribute>
11959
11960	<attribute name="hostMode" type="PortMode">
11961	<desc>
11962	How is this port connected to the host.
11963	<note>
11964	Changing this attribute may fail if the conditions for
11965	<link to="#path"/> are not met.
11966	</note>
11967	</desc>
11968	</attribute>
11969
11970	<attribute name="server" type="boolean">
11971	<desc>
11972	Flag whether this serial port acts as a server (creates a new pipe on
11973	the host) or as a client (uses the existing pipe). This attribute is
11974	used only when <link to="#hostMode"/> is PortMode_HostPipe.
11975	</desc>
11976	</attribute>
11977
11978	<attribute name="path" type="wstring">
11979	<desc>
11980	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
11981	PortMode_HostPipe, or the host serial device name when
11982	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
11983	cases, setting a @c null or empty string as the attribute's value
11984	is an error. Otherwise, the value of this property is ignored.
11985	</desc>
11986	</attribute>
11987
11988	</interface>
11989
11990	<!--
11991	// IParallelPort
11992	/////////////////////////////////////////////////////////////////////////
11993	-->
11994
11995	<interface
11996	name="IParallelPort" extends="$unknown"
11997	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
11998	wsmap="managed"
11999	>
12000
12001	<desc>
12002	The IParallelPort interface represents the virtual parallel port device.
12003
12004	The virtual parallel port device acts like an ordinary parallel port
12005	inside the virtual machine. This device communicates to the real
12006	parallel port hardware using the name of the parallel device on the host
12007	computer specified in the #path attribute.
12008
12009	Each virtual parallel port device is assigned a base I/O address and an
12010	IRQ number that will be reported to the guest operating system and used
12011	to operate the given parallel port from within the virtual machine.
12012
12013	<see>IMachine::getParallelPort</see>
12014	</desc>
12015
12016	<attribute name="slot" type="unsigned long" readonly="yes">
12017	<desc>
12018	Slot number this parallel port is plugged into. Corresponds to
12019	the value you pass to <link to="IMachine::getParallelPort"/>
12020	to obtain this instance.
12021	</desc>
12022	</attribute>
12023
12024	<attribute name="enabled" type="boolean">
12025	<desc>
12026	Flag whether the parallel port is enabled. If disabled,
12027	the parallel port will not be reported to the guest OS.
12028	</desc>
12029	</attribute>
12030
12031	<attribute name="IOBase" type="unsigned long">
12032	<desc>Base I/O address of the parallel port.</desc>
12033	</attribute>
12034
12035	<attribute name="IRQ" type="unsigned long">
12036	<desc>IRQ number of the parallel port.</desc>
12037	</attribute>
12038
12039	<attribute name="path" type="wstring">
12040	<desc>
12041	Host parallel device name. If this parallel port is enabled, setting a
12042	@c null or an empty string as this attribute's value will result into
12043	an error.
12044	</desc>
12045	</attribute>
12046
12047	</interface>
12048
12049
12050	<!--
12051	// IMachineDebugger
12052	/////////////////////////////////////////////////////////////////////////
12053	-->
12054
12055	<interface
12056	name="IMachineDebugger" extends="$unknown"
12057	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12058	wsmap="suppress"
12059	>
12060	<method name="dumpGuestCore">
12061	<desc>
12062	Takes a core dump of the guest.
12063
12064	See include/VBox/dbgfcorefmt.h for details on the file format.
12065	</desc>
12066	<param name="filename" type="wstring" dir="in">
12067	<desc>
12068	The name of the output file. The file must not exist.
12069	</desc>
12070	</param>
12071	<param name="compression" type="wstring" dir="in">
12072	<desc>
12073	Reserved for future compression method indicator.
12074	</desc>
12075	</param>
12076	</method>
12077
12078	<method name="dumpHostProcessCore">
12079	<desc>
12080	Takes a core dump of the VM process on the host.
12081
12082	This feature is not implemented in the 4.0.0 release but it may show up
12083	in a dot release.
12084	</desc>
12085	<param name="filename" type="wstring" dir="in">
12086	<desc>
12087	The name of the output file. The file must not exist.
12088	</desc>
12089	</param>
12090	<param name="compression" type="wstring" dir="in">
12091	<desc>
12092	Reserved for future compression method indicator.
12093	</desc>
12094	</param>
12095	</method>
12096
12097	<method name="info">
12098	<desc>
12099	Interfaces with the info dumpers (DBGFInfo).
12100
12101	This feature is not implemented in the 4.0.0 release but it may show up
12102	in a dot release.
12103	</desc>
12104	<param name="name" type="wstring" dir="in">
12105	<desc>
12106	The name of the info item.
12107	</desc>
12108	</param>
12109	<param name="args" type="wstring" dir="in">
12110	<desc>
12111	Arguments to the info dumper.
12112	</desc>
12113	</param>
12114	<param name="info" type="wstring" dir="return">
12115	<desc>
12116	The into string.
12117	</desc>
12118	</param>
12119	</method>
12120
12121	<method name="injectNMI">
12122	<desc>
12123	Inject an NMI into a running VT-x/AMD-V VM.
12124	</desc>
12125	</method>
12126
12127	<method name="modifyLogGroups">
12128	<desc>
12129	Modifies the group settings of the debug logger.
12130
12131	This feature is not implemented in the 4.0.0 release but may show up
12132	in a dot release.
12133	</desc>
12134	<param name="settings" type="wstring" dir="in">
12135	<desc>The group settings string. See iprt/log.h for details.</desc>
12136	</param>
12137	</method>
12138
12139	<method name="modifyLogFlags">
12140	<desc>
12141	Modifies the debug logger flags.
12142
12143	This feature is not implemented in the 4.0.0 release but may show up
12144	in a dot release.
12145	</desc>
12146	<param name="settings" type="wstring" dir="in">
12147	<desc>The flags settings string. See iprt/log.h for details.</desc>
12148	</param>
12149	</method>
12150
12151	<method name="modifyLogDestinations">
12152	<desc>
12153	Modifies the debug logger destinations.
12154
12155	This feature is not implemented in the 4.0.0 release but may show up
12156	in a dot release.
12157	</desc>
12158	<param name="settings" type="wstring" dir="in">
12159	<desc>The destination settings string. See iprt/log.h for details.</desc>
12160	</param>
12161	</method>
12162
12163	<method name="readPhysicalMemory">
12164	<desc>
12165	Reads guest physical memory, no side effects (MMIO++).
12166
12167	This feature is not implemented in the 4.0.0 release but may show up
12168	in a dot release.
12169	</desc>
12170	<param name="address" type="long long" dir="in">
12171	<desc>The guest physical address.</desc>
12172	</param>
12173	<param name="size" type="unsigned long" dir="in">
12174	<desc>The number of bytes to read.</desc>
12175	</param>
12176	<param name="bytes" type="octet" safearray="yes" dir="return">
12177	<desc>The bytes read.</desc>
12178	</param>
12179	</method>
12180
12181	<method name="writePhysicalMemory">
12182	<desc>
12183	Writes guest physical memory, access handles (MMIO++) are ignored.
12184
12185	This feature is not implemented in the 4.0.0 release but may show up
12186	in a dot release.
12187	</desc>
12188	<param name="address" type="long long" dir="in">
12189	<desc>The guest physical address.</desc>
12190	</param>
12191	<param name="size" type="unsigned long" dir="in">
12192	<desc>The number of bytes to read.</desc>
12193	</param>
12194	<param name="bytes" type="octet" safearray="yes" dir="in">
12195	<desc>The bytes to write.</desc>
12196	</param>
12197	</method>
12198
12199	<method name="readVirtualMemory">
12200	<desc>
12201	Reads guest virtual memory, no side effects (MMIO++).
12202
12203	This feature is not implemented in the 4.0.0 release but may show up
12204	in a dot release.
12205	</desc>
12206	<param name="cpuId" type="unsigned long" dir="in">
12207	<desc>The identifier of the Virtual CPU.</desc>
12208	</param>
12209	<param name="address" type="long long" dir="in">
12210	<desc>The guest virtual address.</desc>
12211	</param>
12212	<param name="size" type="unsigned long" dir="in">
12213	<desc>The number of bytes to read.</desc>
12214	</param>
12215	<param name="bytes" type="octet" safearray="yes" dir="return">
12216	<desc>The bytes read.</desc>
12217	</param>
12218	</method>
12219
12220	<method name="writeVirtualMemory">
12221	<desc>
12222	Writes guest virtual memory, access handles (MMIO++) are ignored.
12223
12224	This feature is not implemented in the 4.0.0 release but may show up
12225	in a dot release.
12226	</desc>
12227	<param name="cpuId" type="unsigned long" dir="in">
12228	<desc>The identifier of the Virtual CPU.</desc>
12229	</param>
12230	<param name="address" type="long long" dir="in">
12231	<desc>The guest virtual address.</desc>
12232	</param>
12233	<param name="size" type="unsigned long" dir="in">
12234	<desc>The number of bytes to read.</desc>
12235	</param>
12236	<param name="bytes" type="octet" safearray="yes" dir="in">
12237	<desc>The bytes to write.</desc>
12238	</param>
12239	</method>
12240
12241	<method name="detectOS">
12242	<desc>
12243	Tries to (re-)detect the guest OS kernel.
12244
12245	This feature is not implemented in the 4.0.0 release but may show up
12246	in a dot release.
12247	</desc>
12248	<param name="os" type="wstring" dir="return">
12249	<desc>
12250	The detected OS kernel on success.
12251	</desc>
12252	</param>
12253	</method>
12254
12255	<method name="getRegister">
12256	<desc>
12257	Gets one register.
12258
12259	This feature is not implemented in the 4.0.0 release but may show up
12260	in a dot release.
12261	</desc>
12262	<param name="cpuId" type="unsigned long" dir="in">
12263	<desc>The identifier of the Virtual CPU.</desc>
12264	</param>
12265	<param name="name" type="wstring" dir="in">
12266	<desc>The register name, case is ignored.</desc>
12267	</param>
12268	<param name="value" type="wstring" dir="return">
12269	<desc>
12270	The register value. This is usually a hex value (always 0x prefixed)
12271	but other format may be used for floating point registers (TBD).
12272	</desc>
12273	</param>
12274	</method>
12275
12276	<method name="getRegisters">
12277	<desc>
12278	Gets all the registers for the given CPU.
12279
12280	This feature is not implemented in the 4.0.0 release but may show up
12281	in a dot release.
12282	</desc>
12283	<param name="cpuId" type="unsigned long" dir="in">
12284	<desc>The identifier of the Virtual CPU.</desc>
12285	</param>
12286	<param name="names" type="wstring" dir="out" safearray="yes">
12287	<desc>Array containing the lowercase register names.</desc>
12288	</param>
12289	<param name="values" type="wstring" dir="out" safearray="yes">
12290	<desc>
12291	Array paralell to the names holding the register values as if the
12292	register was returned by <link to="IMachineDebugger::getRegister"/>.
12293	</desc>
12294	</param>
12295	</method>
12296
12297	<method name="setRegister">
12298	<desc>
12299	Gets one register.
12300
12301	This feature is not implemented in the 4.0.0 release but may show up
12302	in a dot release.
12303	</desc>
12304	<param name="cpuId" type="unsigned long" dir="in">
12305	<desc>The identifier of the Virtual CPU.</desc>
12306	</param>
12307	<param name="name" type="wstring" dir="in">
12308	<desc>The register name, case is ignored.</desc>
12309	</param>
12310	<param name="value" type="wstring" dir="in">
12311	<desc>
12312	The new register value. Hexadecimal, decimal and octal formattings
12313	are supported in addition to any special formattings returned by
12314	the getters.
12315	</desc>
12316	</param>
12317	</method>
12318
12319	<method name="setRegisters">
12320	<desc>
12321	Sets zero or more registers atomically.
12322
12323	This feature is not implemented in the 4.0.0 release but may show up
12324	in a dot release.
12325	</desc>
12326	<param name="cpuId" type="unsigned long" dir="in">
12327	<desc>The identifier of the Virtual CPU.</desc>
12328	</param>
12329	<param name="names" type="wstring" dir="in" safearray="yes">
12330	<desc>Array containing the register names, case ignored.</desc>
12331	</param>
12332	<param name="values" type="wstring" dir="in" safearray="yes">
12333	<desc>
12334	Array paralell to the names holding the register values. See
12335	<link to="IMachineDebugger::setRegister"/> for formatting
12336	guidelines.
12337	</desc>
12338	</param>
12339	</method>
12340
12341	<method name="dumpGuestStack">
12342	<desc>
12343	Produce a simple stack dump using the current guest state.
12344
12345	This feature is not implemented in the 4.0.0 release but may show up
12346	in a dot release.
12347	</desc>
12348	<param name="cpuId" type="unsigned long" dir="in">
12349	<desc>The identifier of the Virtual CPU.</desc>
12350	</param>
12351	<param name="stack" type="wstring" dir="return">
12352	<desc>String containing the formatted stack dump.</desc>
12353	</param>
12354	</method>
12355
12356	<method name="resetStats">
12357	<desc>
12358	Reset VM statistics.
12359	</desc>
12360	<param name="pattern" type="wstring" dir="in">
12361	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12362	</param>
12363	</method>
12364
12365	<method name="dumpStats">
12366	<desc>
12367	Dumps VM statistics.
12368	</desc>
12369	<param name="pattern" type="wstring" dir="in">
12370	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12371	</param>
12372	</method>
12373
12374	<method name="getStats">
12375	<desc>
12376	Get the VM statistics in a XMLish format.
12377	</desc>
12378	<param name="pattern" type="wstring" dir="in">
12379	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12380	</param>
12381	<param name="withDescriptions" type="boolean" dir="in">
12382	<desc>Whether to include the descriptions.</desc>
12383	</param>
12384	<param name="stats" type="wstring" dir="out">
12385	<desc>The XML document containing the statistics.</desc>
12386	</param>
12387	</method>
12388
12389	<attribute name="singlestep" type="boolean">
12390	<desc>Switch for enabling singlestepping.</desc>
12391	</attribute>
12392
12393	<attribute name="recompileUser" type="boolean">
12394	<desc>Switch for forcing code recompilation for user mode code.</desc>
12395	</attribute>
12396
12397	<attribute name="recompileSupervisor" type="boolean">
12398	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12399	</attribute>
12400
12401	<attribute name="PATMEnabled" type="boolean">
12402	<desc>Switch for enabling and disabling the PATM component.</desc>
12403	</attribute>
12404
12405	<attribute name="CSAMEnabled" type="boolean">
12406	<desc>Switch for enabling and disabling the CSAM component.</desc>
12407	</attribute>
12408
12409	<attribute name="logEnabled" type="boolean">
12410	<desc>Switch for enabling and disabling the debug logger.</desc>
12411	</attribute>
12412
12413	<attribute name="logFlags" type="wstring" readonly="yes">
12414	<desc>The debug logger flags.</desc>
12415	</attribute>
12416
12417	<attribute name="logGroups" type="wstring" readonly="yes">
12418	<desc>The debug logger's group settings.</desc>
12419	</attribute>
12420
12421	<attribute name="logDestinations" type="wstring" readonly="yes">
12422	<desc>The debug logger's destination settings.</desc>
12423	</attribute>
12424
12425	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12426	<desc>
12427	Flag indicating whether the VM is currently making use of CPU hardware
12428	virtualization extensions.
12429	</desc>
12430	</attribute>
12431
12432	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12433	<desc>
12434	Flag indicating whether the VM is currently making use of the nested paging
12435	CPU hardware virtualization extension.
12436	</desc>
12437	</attribute>
12438
12439	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12440	<desc>
12441	Flag indicating whether the VM is currently making use of the VPID
12442	VT-x extension.
12443	</desc>
12444	</attribute>
12445
12446	<attribute name="OSName" type="wstring" readonly="yes">
12447	<desc>
12448	Query the guest OS kernel name as detected by the DBGF.
12449
12450	This feature is not implemented in the 4.0.0 release but may show up
12451	in a dot release.
12452	</desc>
12453	</attribute>
12454
12455	<attribute name="OSVersion" type="wstring" readonly="yes">
12456	<desc>
12457	Query the guest OS kernel version string as detected by the DBGF.
12458
12459	This feature is not implemented in the 4.0.0 release but may show up
12460	in a dot release.
12461	</desc>
12462	</attribute>
12463
12464	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12465	<desc>
12466	Flag indicating whether the VM is currently making use of the Physical
12467	Address Extension CPU feature.
12468	</desc>
12469	</attribute>
12470
12471	<attribute name="virtualTimeRate" type="unsigned long">
12472	<desc>
12473	The rate at which the virtual time runs expressed as a percentage.
12474	The accepted range is 2% to 20000%.
12475	</desc>
12476	</attribute>
12477
12478	<attribute name="VM" type="long long" readonly="yes">
12479	<desc>
12480	Gets the VM handle. This is only for internal use while
12481	we carve the details of this interface.
12482	</desc>
12483	</attribute>
12484
12485	</interface>
12486
12487	<!--
12488	// IUSBController
12489	/////////////////////////////////////////////////////////////////////////
12490	-->
12491
12492	<interface
12493	name="IUSBController" extends="$unknown"
12494	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12495	wsmap="managed"
12496	>
12497	<attribute name="enabled" type="boolean">
12498	<desc>
12499	Flag whether the USB controller is present in the
12500	guest system. If disabled, the virtual guest hardware will
12501	not contain any USB controller. Can only be changed when
12502	the VM is powered off.
12503	</desc>
12504	</attribute>
12505
12506	<attribute name="enabledEhci" type="boolean">
12507	<desc>
12508	Flag whether the USB EHCI controller is present in the
12509	guest system. If disabled, the virtual guest hardware will
12510	not contain a USB EHCI controller. Can only be changed when
12511	the VM is powered off.
12512	</desc>
12513	</attribute>
12514
12515	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12516	<desc>
12517	Flag whether there is an USB proxy available.
12518	</desc>
12519	</attribute>
12520
12521	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12522	<desc>
12523	USB standard version which the controller implements.
12524	This is a BCD which means that the major version is in the
12525	high byte and minor version is in the low byte.
12526	</desc>
12527	</attribute>
12528
12529	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12530	<desc>
12531	List of USB device filters associated with the machine.
12532
12533	If the machine is currently running, these filters are activated
12534	every time a new (supported) USB device is attached to the host
12535	computer that was not ignored by global filters
12536	(<link to="IHost::USBDeviceFilters"/>).
12537
12538	These filters are also activated when the machine is powered up.
12539	They are run against a list of all currently available USB
12540	devices (in states
12541	<link to="USBDeviceState_Available"/>,
12542	<link to="USBDeviceState_Busy"/>,
12543	<link to="USBDeviceState_Held"/>) that were not previously
12544	ignored by global filters.
12545
12546	If at least one filter matches the USB device in question, this
12547	device is automatically captured (attached to) the virtual USB
12548	controller of this machine.
12549
12550	<see>IUSBDeviceFilter, ::IUSBController</see>
12551	</desc>
12552	</attribute>
12553
12554	<method name="createDeviceFilter">
12555	<desc>
12556	Creates a new USB device filter. All attributes except
12557	the filter name are set to empty (any match),
12558	<i>active</i> is @c false (the filter is not active).
12559
12560	The created filter can then be added to the list of filters using
12561	<link to="#insertDeviceFilter"/>.
12562
12563	<result name="VBOX_E_INVALID_VM_STATE">
12564	The virtual machine is not mutable.
12565	</result>
12566
12567	<see>#deviceFilters</see>
12568	</desc>
12569	<param name="name" type="wstring" dir="in">
12570	<desc>
12571	Filter name. See <link to="IUSBDeviceFilter::name"/>
12572	for more info.
12573	</desc>
12574	</param>
12575	<param name="filter" type="IUSBDeviceFilter" dir="return">
12576	<desc>Created filter object.</desc>
12577	</param>
12578	</method>
12579
12580	<method name="insertDeviceFilter">
12581	<desc>
12582	Inserts the given USB device to the specified position
12583	in the list of filters.
12584
12585	Positions are numbered starting from <tt>0</tt>. If the specified
12586	position is equal to or greater than the number of elements in
12587	the list, the filter is added to the end of the collection.
12588
12589	<note>
12590	Duplicates are not allowed, so an attempt to insert a
12591	filter that is already in the collection, will return an
12592	error.
12593	</note>
12594
12595	<result name="VBOX_E_INVALID_VM_STATE">
12596	Virtual machine is not mutable.
12597	</result>
12598	<result name="E_INVALIDARG">
12599	USB device filter not created within this VirtualBox instance.
12600	</result>
12601	<result name="VBOX_E_INVALID_OBJECT_STATE">
12602	USB device filter already in list.
12603	</result>
12604
12605	<see>#deviceFilters</see>
12606	</desc>
12607	<param name="position" type="unsigned long" dir="in">
12608	<desc>Position to insert the filter to.</desc>
12609	</param>
12610	<param name="filter" type="IUSBDeviceFilter" dir="in">
12611	<desc>USB device filter to insert.</desc>
12612	</param>
12613	</method>
12614
12615	<method name="removeDeviceFilter">
12616	<desc>
12617	Removes a USB device filter from the specified position in the
12618	list of filters.
12619
12620	Positions are numbered starting from <tt>0</tt>. Specifying a
12621	position equal to or greater than the number of elements in
12622	the list will produce an error.
12623
12624	<see>#deviceFilters</see>
12625
12626	<result name="VBOX_E_INVALID_VM_STATE">
12627	Virtual machine is not mutable.
12628	</result>
12629	<result name="E_INVALIDARG">
12630	USB device filter list empty or invalid @a position.
12631	</result>
12632
12633	</desc>
12634	<param name="position" type="unsigned long" dir="in">
12635	<desc>Position to remove the filter from.</desc>
12636	</param>
12637	<param name="filter" type="IUSBDeviceFilter" dir="return">
12638	<desc>Removed USB device filter.</desc>
12639	</param>
12640	</method>
12641
12642	</interface>
12643
12644
12645	<!--
12646	// IUSBDevice
12647	/////////////////////////////////////////////////////////////////////////
12648	-->
12649
12650	<interface
12651	name="IUSBDevice" extends="$unknown"
12652	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12653	wsmap="managed"
12654	>
12655	<desc>
12656	The IUSBDevice interface represents a virtual USB device attached to the
12657	virtual machine.
12658
12659	A collection of objects implementing this interface is stored in the
12660	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12661	attached to a running virtual machine's USB controller.
12662	</desc>
12663
12664	<attribute name="id" type="uuid" mod="string" readonly="yes">
12665	<desc>
12666	Unique USB device ID. This ID is built from #vendorId,
12667	#productId, #revision and #serialNumber.
12668	</desc>
12669	</attribute>
12670
12671	<attribute name="vendorId" type="unsigned short" readonly="yes">
12672	<desc>Vendor ID.</desc>
12673	</attribute>
12674
12675	<attribute name="productId" type="unsigned short" readonly="yes">
12676	<desc>Product ID.</desc>
12677	</attribute>
12678
12679	<attribute name="revision" type="unsigned short" readonly="yes">
12680	<desc>
12681	Product revision number. This is a packed BCD represented as
12682	unsigned short. The high byte is the integer part and the low
12683	byte is the decimal.
12684	</desc>
12685	</attribute>
12686
12687	<attribute name="manufacturer" type="wstring" readonly="yes">
12688	<desc>Manufacturer string.</desc>
12689	</attribute>
12690
12691	<attribute name="product" type="wstring" readonly="yes">
12692	<desc>Product string.</desc>
12693	</attribute>
12694
12695	<attribute name="serialNumber" type="wstring" readonly="yes">
12696	<desc>Serial number string.</desc>
12697	</attribute>
12698
12699	<attribute name="address" type="wstring" readonly="yes">
12700	<desc>Host specific address of the device.</desc>
12701	</attribute>
12702
12703	<attribute name="port" type="unsigned short" readonly="yes">
12704	<desc>
12705	Host USB port number the device is physically
12706	connected to.
12707	</desc>
12708	</attribute>
12709
12710	<attribute name="version" type="unsigned short" readonly="yes">
12711	<desc>
12712	The major USB version of the device - 1 or 2.
12713	</desc>
12714	</attribute>
12715
12716	<attribute name="portVersion" type="unsigned short" readonly="yes">
12717	<desc>
12718	The major USB version of the host USB port the device is
12719	physically connected to - 1 or 2. For devices not connected to
12720	anything this will have the same value as the version attribute.
12721	</desc>
12722	</attribute>
12723
12724	<attribute name="remote" type="boolean" readonly="yes">
12725	<desc>
12726	Whether the device is physically connected to a remote VRDE
12727	client or to a local host machine.
12728	</desc>
12729	</attribute>
12730
12731	</interface>
12732
12733
12734	<!--
12735	// IUSBDeviceFilter
12736	/////////////////////////////////////////////////////////////////////////
12737	-->
12738
12739	<interface
12740	name="IUSBDeviceFilter" extends="$unknown"
12741	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12742	wsmap="managed"
12743	>
12744	<desc>
12745	The IUSBDeviceFilter interface represents an USB device filter used
12746	to perform actions on a group of USB devices.
12747
12748	This type of filters is used by running virtual machines to
12749	automatically capture selected USB devices once they are physically
12750	attached to the host computer.
12751
12752	A USB device is matched to the given device filter if and only if all
12753	attributes of the device match the corresponding attributes of the
12754	filter (that is, attributes are joined together using the logical AND
12755	operation). On the other hand, all together, filters in the list of
12756	filters carry the semantics of the logical OR operation. So if it is
12757	desirable to create a match like "this vendor id OR this product id",
12758	one needs to create two filters and specify "any match" (see below)
12759	for unused attributes.
12760
12761	All filter attributes used for matching are strings. Each string
12762	is an expression representing a set of values of the corresponding
12763	device attribute, that will match the given filter. Currently, the
12764	following filtering expressions are supported:
12765
12766	<ul>
12767	<li><i>Interval filters</i>. Used to specify valid intervals for
12768	integer device attributes (Vendor ID, Product ID and Revision).
12769	The format of the string is:
12770
12771	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12772
12773	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12774	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12775	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12776	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12777	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12778	possible integer is assumed.
12779	</li>
12780	<li><i>Boolean filters</i>. Used to specify acceptable values for
12781	boolean device attributes. The format of the string is:
12782
12783	<tt>true\|false\|yes\|no\|0\|1</tt>
12784
12785	</li>
12786	<li><i>Exact match</i>. Used to specify a single value for the given
12787	device attribute. Any string that doesn't start with <tt>int:</tt>
12788	represents the exact match. String device attributes are compared to
12789	this string including case of symbols. Integer attributes are first
12790	converted to a string (see individual filter attributes) and then
12791	compared ignoring case.
12792
12793	</li>
12794	<li><i>Any match</i>. Any value of the corresponding device attribute
12795	will match the given filter. An empty or @c null string is
12796	used to construct this type of filtering expressions.
12797
12798	</li>
12799	</ul>
12800
12801	<note>
12802	On the Windows host platform, interval filters are not currently
12803	available. Also all string filter attributes
12804	(<link to="#manufacturer"/>, <link to="#product"/>,
12805	<link to="#serialNumber"/>) are ignored, so they behave as
12806	<i>any match</i> no matter what string expression is specified.
12807	</note>
12808
12809	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12810	</desc>
12811
12812	<attribute name="name" type="wstring">
12813	<desc>
12814	Visible name for this filter.
12815	This name is used to visually distinguish one filter from another,
12816	so it can neither be @c null nor an empty string.
12817	</desc>
12818	</attribute>
12819
12820	<attribute name="active" type="boolean">
12821	<desc>Whether this filter active or has been temporarily disabled.</desc>
12822	</attribute>
12823
12824	<attribute name="vendorId" type="wstring">
12825	<desc>
12826	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12827	The string representation for the <i>exact matching</i>
12828	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12829	(including leading zeroes).
12830	</desc>
12831	</attribute>
12832
12833	<attribute name="productId" type="wstring">
12834	<desc>
12835	<link to="IUSBDevice::productId">Product ID</link> filter.
12836	The string representation for the <i>exact matching</i>
12837	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12838	(including leading zeroes).
12839	</desc>
12840	</attribute>
12841
12842	<attribute name="revision" type="wstring">
12843	<desc>
12844	<link to="IUSBDevice::productId">Product revision number</link>
12845	filter. The string representation for the <i>exact matching</i>
12846	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12847	of the integer part of the revision, and <tt>F</tt> is the
12848	decimal digit of its fractional part (including leading and
12849	trailing zeros).
12850	Note that for interval filters, it's best to use the hexadecimal
12851	form, because the revision is stored as a 16 bit packed BCD value;
12852	so the expression <tt>int:0x0100-0x0199</tt> will match any
12853	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12854	</desc>
12855	</attribute>
12856
12857	<attribute name="manufacturer" type="wstring">
12858	<desc>
12859	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12860	</desc>
12861	</attribute>
12862
12863	<attribute name="product" type="wstring">
12864	<desc>
12865	<link to="IUSBDevice::product">Product</link> filter.
12866	</desc>
12867	</attribute>
12868
12869	<attribute name="serialNumber" type="wstring">
12870	<desc>
12871	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12872	</desc>
12873	</attribute>
12874
12875	<attribute name="port" type="wstring">
12876	<desc>
12877	<link to="IUSBDevice::port">Host USB port</link> filter.
12878	</desc>
12879	</attribute>
12880
12881	<attribute name="remote" type="wstring">
12882	<desc>
12883	<link to="IUSBDevice::remote">Remote state</link> filter.
12884	<note>
12885	This filter makes sense only for machine USB filters,
12886	i.e. it is ignored by IHostUSBDeviceFilter objects.
12887	</note>
12888	</desc>
12889	</attribute>
12890
12891	<attribute name="maskedInterfaces" type="unsigned long">
12892	<desc>
12893	This is an advanced option for hiding one or more USB interfaces
12894	from the guest. The value is a bit mask where the bits that are set
12895	means the corresponding USB interface should be hidden, masked off
12896	if you like.
12897	This feature only works on Linux hosts.
12898	</desc>
12899	</attribute>
12900
12901	</interface>
12902
12903
12904	<!--
12905	// IHostUSBDevice
12906	/////////////////////////////////////////////////////////////////////////
12907	-->
12908
12909	<enum
12910	name="USBDeviceState"
12911	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12912	>
12913	<desc>
12914	USB device state. This enumeration represents all possible states
12915	of the USB device physically attached to the host computer regarding
12916	its state on the host computer and availability to guest computers
12917	(all currently running virtual machines).
12918
12919	Once a supported USB device is attached to the host, global USB
12920	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12921	either ignore the device, or put it to USBDeviceState_Held state, or do
12922	nothing. Unless the device is ignored by global filters, filters of all
12923	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12924	activated that can put it to USBDeviceState_Captured state.
12925
12926	If the device was ignored by global filters, or didn't match
12927	any filters at all (including guest ones), it is handled by the host
12928	in a normal way. In this case, the device state is determined by
12929	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12930	or USBDeviceState_Available, depending on the current device usage.
12931
12932	Besides auto-capturing based on filters, the device can be manually
12933	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12934	state is USBDeviceState_Busy, USBDeviceState_Available or
12935	USBDeviceState_Held.
12936
12937	<note>
12938	Due to differences in USB stack implementations in Linux and Win32,
12939	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12940	only to the Linux version of the product. This also means that (<link
12941	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12942	device state is USBDeviceState_Held.
12943	</note>
12944
12945	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12946	</desc>
12947
12948	<const name="NotSupported" value="0">
12949	<desc>
12950	Not supported by the VirtualBox server, not available to guests.
12951	</desc>
12952	</const>
12953	<const name="Unavailable" value="1">
12954	<desc>
12955	Being used by the host computer exclusively,
12956	not available to guests.
12957	</desc>
12958	</const>
12959	<const name="Busy" value="2">
12960	<desc>
12961	Being used by the host computer, potentially available to guests.
12962	</desc>
12963	</const>
12964	<const name="Available" value="3">
12965	<desc>
12966	Not used by the host computer, available to guests (the host computer
12967	can also start using the device at any time).
12968	</desc>
12969	</const>
12970	<const name="Held" value="4">
12971	<desc>
12972	Held by the VirtualBox server (ignored by the host computer),
12973	available to guests.
12974	</desc>
12975	</const>
12976	<const name="Captured" value="5">
12977	<desc>
12978	Captured by one of the guest computers, not available
12979	to anybody else.
12980	</desc>
12981	</const>
12982	</enum>
12983
12984	<interface
12985	name="IHostUSBDevice" extends="IUSBDevice"
12986	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
12987	wsmap="managed"
12988	>
12989	<desc>
12990	The IHostUSBDevice interface represents a physical USB device attached
12991	to the host computer.
12992
12993	Besides properties inherited from IUSBDevice, this interface adds the
12994	<link to="#state"/> property that holds the current state of the USB
12995	device.
12996
12997	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
12998	</desc>
12999
13000	<attribute name="state" type="USBDeviceState" readonly="yes">
13001	<desc>
13002	Current state of the device.
13003	</desc>
13004	</attribute>
13005
13006	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13007
13008	</interface>
13009
13010
13011	<!--
13012	// IHostUSBDeviceFilter
13013	/////////////////////////////////////////////////////////////////////////
13014	-->
13015
13016	<enum
13017	name="USBDeviceFilterAction"
13018	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13019	>
13020	<desc>
13021	Actions for host USB device filters.
13022	<see>IHostUSBDeviceFilter, USBDeviceState</see>
13023	</desc>
13024
13025	<const name="Null" value="0">
13026	<desc>Null value (never used by the API).</desc>
13027	</const>
13028	<const name="Ignore" value="1">
13029	<desc>Ignore the matched USB device.</desc>
13030	</const>
13031	<const name="Hold" value="2">
13032	<desc>Hold the matched USB device.</desc>
13033	</const>
13034	</enum>
13035
13036	<interface
13037	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13038	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13039	wsmap="managed"
13040	>
13041	<desc>
13042	The IHostUSBDeviceFilter interface represents a global filter for a
13043	physical USB device used by the host computer. Used indirectly in
13044	<link to="IHost::USBDeviceFilters"/>.
13045
13046	Using filters of this type, the host computer determines the initial
13047	state of the USB device after it is physically attached to the
13048	host's USB controller.
13049
13050	<note>
13051	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13052	filters, because it makes sense only for
13053	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13054	</note>
13055
13056	<see>IHost::USBDeviceFilters</see>
13057	</desc>
13058
13059	<attribute name="action" type="USBDeviceFilterAction">
13060	<desc>
13061	Action performed by the host when an attached USB device
13062	matches this filter.
13063	</desc>
13064	</attribute>
13065
13066	</interface>
13067
13068	<!--
13069	// IAudioAdapter
13070	/////////////////////////////////////////////////////////////////////////
13071	-->
13072
13073	<enum
13074	name="AudioDriverType"
13075	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13076	>
13077	<desc>
13078	Host audio driver type.
13079	</desc>
13080
13081	<const name="Null" value="0">
13082	<desc>Null value, also means "dummy audio driver".</desc>
13083	</const>
13084	<const name="WinMM" value="1">
13085	<desc>Windows multimedia (Windows hosts only).</desc>
13086	</const>
13087	<const name="OSS" value="2">
13088	<desc>Open Sound System (Linux hosts only).</desc>
13089	</const>
13090	<const name="ALSA" value="3">
13091	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13092	</const>
13093	<const name="DirectSound" value="4">
13094	<desc>DirectSound (Windows hosts only).</desc>
13095	</const>
13096	<const name="CoreAudio" value="5">
13097	<desc>CoreAudio (Mac hosts only).</desc>
13098	</const>
13099	<const name="MMPM" value="6">
13100	<desc>Reserved for historical reasons.</desc>
13101	</const>
13102	<const name="Pulse" value="7">
13103	<desc>PulseAudio (Linux hosts only).</desc>
13104	</const>
13105	<const name="SolAudio" value="8">
13106	<desc>Solaris audio (Solaris hosts only).</desc>
13107	</const>
13108	</enum>
13109
13110	<enum
13111	name="AudioControllerType"
13112	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13113	>
13114	<desc>
13115	Virtual audio controller type.
13116	</desc>
13117
13118	<const name="AC97" value="0"/>
13119	<const name="SB16" value="1"/>
13120	<const name="HDA" value="2"/>
13121	</enum>
13122
13123	<interface
13124	name="IAudioAdapter" extends="$unknown"
13125	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13126	wsmap="managed"
13127	>
13128	<desc>
13129	The IAudioAdapter interface represents the virtual audio adapter of
13130	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13131	</desc>
13132	<attribute name="enabled" type="boolean">
13133	<desc>
13134	Flag whether the audio adapter is present in the
13135	guest system. If disabled, the virtual guest hardware will
13136	not contain any audio adapter. Can only be changed when
13137	the VM is not running.
13138	</desc>
13139	</attribute>
13140	<attribute name="audioController" type="AudioControllerType">
13141	<desc>
13142	The audio hardware we emulate.
13143	</desc>
13144	</attribute>
13145	<attribute name="audioDriver" type="AudioDriverType">
13146	<desc>
13147	Audio driver the adapter is connected to. This setting
13148	can only be changed when the VM is not running.
13149	</desc>
13150	</attribute>
13151	</interface>
13152
13153	<enum
13154	name="AuthType"
13155	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13156	>
13157	<desc>
13158	VirtualBox authentication type.
13159	</desc>
13160
13161	<const name="Null" value="0">
13162	<desc>Null value, also means "no authentication".</desc>
13163	</const>
13164	<const name="External" value="1"/>
13165	<const name="Guest" value="2"/>
13166	</enum>
13167
13168	<!--
13169	// IVRDEServer
13170	/////////////////////////////////////////////////////////////////////////
13171	-->
13172
13173	<interface
13174	name="IVRDEServer" extends="$unknown"
13175	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13176	wsmap="managed"
13177	>
13178	<attribute name="enabled" type="boolean">
13179	<desc>VRDE server status.</desc>
13180	</attribute>
13181
13182	<attribute name="authType" type="AuthType">
13183	<desc>VRDE authentication method.</desc>
13184	</attribute>
13185
13186	<attribute name="authTimeout" type="unsigned long">
13187	<desc>Timeout for guest authentication. Milliseconds.</desc>
13188	</attribute>
13189
13190	<attribute name="allowMultiConnection" type="boolean">
13191	<desc>
13192	Flag whether multiple simultaneous connections to the VM are permitted.
13193	Note that this will be replaced by a more powerful mechanism in the future.
13194	</desc>
13195	</attribute>
13196
13197	<attribute name="reuseSingleConnection" type="boolean">
13198	<desc>
13199	Flag whether the existing connection must be dropped and a new connection
13200	must be established by the VRDE server, when a new client connects in single
13201	connection mode.
13202	</desc>
13203	</attribute>
13204
13205	<attribute name="VRDEExtPack" type="wstring">
13206	<desc>
13207	The name of Extension Pack providing VRDE for this VM. Overrides
13208	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13209	</desc>
13210	</attribute>
13211
13212	<attribute name="AuthLibrary" type="wstring">
13213	<desc>
13214	Library used for authentication of RDP clients by this VM. Overrides
13215	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13216	</desc>
13217	</attribute>
13218
13219	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13220	<desc>
13221	Array of names of properties, which are supported by this VRDE server.
13222	</desc>
13223	</attribute>
13224
13225	<method name="setVRDEProperty">
13226	<desc>
13227	Sets a VRDE specific property string.
13228
13229	If you pass @c null or empty string as a key @a value, the given @a key
13230	will be deleted.
13231
13232	</desc>
13233	<param name="key" type="wstring" dir="in">
13234	<desc>Name of the key to set.</desc>
13235	</param>
13236	<param name="value" type="wstring" dir="in">
13237	<desc>Value to assign to the key.</desc>
13238	</param>
13239	</method>
13240
13241	<method name="getVRDEProperty">
13242	<desc>
13243	Returns a VRDE specific property string.
13244
13245	If the requested data @a key does not exist, this function will
13246	succeed and return an empty string in the @a value argument.
13247
13248	</desc>
13249	<param name="key" type="wstring" dir="in">
13250	<desc>Name of the key to get.</desc>
13251	</param>
13252	<param name="value" type="wstring" dir="return">
13253	<desc>Value of the requested key.</desc>
13254	</param>
13255	</method>
13256
13257	</interface>
13258
13259
13260	<!--
13261	// ISharedFolder
13262	/////////////////////////////////////////////////////////////////////////
13263	-->
13264
13265	<interface
13266	name="ISharedFolder" extends="$unknown"
13267	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13268	wsmap="struct"
13269	>
13270	<desc>
13271	The ISharedFolder interface represents a folder in the host computer's
13272	file system accessible from the guest OS running inside a virtual
13273	machine using an associated logical name.
13274
13275	There are three types of shared folders:
13276	<ul>
13277	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13278	folders available to all virtual machines.</li>
13279	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13280	VM-specific shared folders available to the given virtual machine at
13281	startup.</li>
13282	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13283	VM-specific shared folders created in the session context (for
13284	example, when the virtual machine is running) and automatically
13285	discarded when the session is closed (the VM is powered off).</li>
13286	</ul>
13287
13288	Logical names of shared folders must be unique within the given scope
13289	(global, permanent or transient). However, they do not need to be unique
13290	across scopes. In this case, the definition of the shared folder in a
13291	more specific scope takes precedence over definitions in all other
13292	scopes. The order of precedence is (more specific to more general):
13293	<ol>
13294	<li>Transient definitions</li>
13295	<li>Permanent definitions</li>
13296	<li>Global definitions</li>
13297	</ol>
13298
13299	For example, if MyMachine has a shared folder named
13300	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13301	transient shared folder named <tt>C_DRIVE</tt> (that points
13302	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13303	of <tt>C_DRIVE</tt> in the guest OS so
13304	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13305	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13306	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13307	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13308	to <tt>C:\\</tt> if it still exists.
13309
13310	Note that permanent and transient shared folders of different machines
13311	are in different name spaces, so they don't overlap and don't need to
13312	have unique logical names.
13313
13314	<note>
13315	Global shared folders are not implemented in the current version of the
13316	product.
13317	</note>
13318	</desc>
13319
13320	<attribute name="name" type="wstring" readonly="yes">
13321	<desc>Logical name of the shared folder.</desc>
13322	</attribute>
13323
13324	<attribute name="hostPath" type="wstring" readonly="yes">
13325	<desc>Full path to the shared folder in the host file system.</desc>
13326	</attribute>
13327
13328	<attribute name="accessible" type="boolean" readonly="yes">
13329	<desc>
13330	Whether the folder defined by the host path is currently
13331	accessible or not.
13332	For example, the folder can be inaccessible if it is placed
13333	on the network share that is not available by the time
13334	this property is read.
13335	</desc>
13336	</attribute>
13337
13338	<attribute name="writable" type="boolean" readonly="yes">
13339	<desc>
13340	Whether the folder defined by the host path is writable or
13341	not.
13342	</desc>
13343	</attribute>
13344
13345	<attribute name="autoMount" type="boolean" readonly="yes">
13346	<desc>
13347	Whether the folder gets automatically mounted by the guest or not.
13348	</desc>
13349	</attribute>
13350
13351	<attribute name="lastAccessError" type="wstring" readonly="yes">
13352	<desc>
13353	Text message that represents the result of the last accessibility
13354	check.
13355
13356	Accessibility checks are performed each time the <link to="#accessible"/>
13357	attribute is read. An empty string is returned if the last
13358	accessibility check was successful. A non-empty string indicates a
13359	failure and should normally describe a reason of the failure (for
13360	example, a file read error).
13361	</desc>
13362	</attribute>
13363
13364	</interface>
13365
13366	<!--
13367	// ISession
13368	/////////////////////////////////////////////////////////////////////////
13369	-->
13370
13371	<interface
13372	name="IInternalSessionControl" extends="$unknown"
13373	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
13374	internal="yes"
13375	wsmap="suppress"
13376	>
13377	<method name="getPID">
13378	<desc>PID of the process that has created this Session object.
13379	</desc>
13380	<param name="pid" type="unsigned long" dir="return"/>
13381	</method>
13382
13383	<method name="getRemoteConsole">
13384	<desc>
13385	Returns the console object suitable for remote control.
13386
13387	<result name="VBOX_E_INVALID_VM_STATE">
13388	Session state prevents operation.
13389	</result>
13390	<result name="VBOX_E_INVALID_OBJECT_STATE">
13391	Session type prevents operation.
13392	</result>
13393
13394	</desc>
13395	<param name="console" type="IConsole" dir="return"/>
13396	</method>
13397
13398	<method name="assignMachine">
13399	<desc>
13400	Assigns the machine object associated with this direct-type
13401	session or informs the session that it will be a remote one
13402	(if @a machine == @c null).
13403
13404	<result name="VBOX_E_INVALID_VM_STATE">
13405	Session state prevents operation.
13406	</result>
13407	<result name="VBOX_E_INVALID_OBJECT_STATE">
13408	Session type prevents operation.
13409	</result>
13410
13411	</desc>
13412	<param name="machine" type="IMachine" dir="in"/>
13413	</method>
13414
13415	<method name="assignRemoteMachine">
13416	<desc>
13417	Assigns the machine and the (remote) console object associated with
13418	this remote-type session.
13419
13420	<result name="VBOX_E_INVALID_VM_STATE">
13421	Session state prevents operation.
13422	</result>
13423
13424	</desc>
13425	<param name="machine" type="IMachine" dir="in"/>
13426	<param name="console" type="IConsole" dir="in"/>
13427	</method>
13428
13429	<method name="updateMachineState">
13430	<desc>
13431	Updates the machine state in the VM process.
13432	Must be called only in certain cases
13433	(see the method implementation).
13434
13435	<result name="VBOX_E_INVALID_VM_STATE">
13436	Session state prevents operation.
13437	</result>
13438	<result name="VBOX_E_INVALID_OBJECT_STATE">
13439	Session type prevents operation.
13440	</result>
13441
13442	</desc>
13443	<param name="aMachineState" type="MachineState" dir="in"/>
13444	</method>
13445
13446	<method name="uninitialize">
13447	<desc>
13448	Uninitializes (closes) this session. Used by VirtualBox to close
13449	the corresponding remote session when the direct session dies
13450	or gets closed.
13451
13452	<result name="VBOX_E_INVALID_VM_STATE">
13453	Session state prevents operation.
13454	</result>
13455
13456	</desc>
13457	</method>
13458
13459	<method name="onNetworkAdapterChange">
13460	<desc>
13461	Triggered when settings of a network adapter of the
13462	associated virtual machine have changed.
13463
13464	<result name="VBOX_E_INVALID_VM_STATE">
13465	Session state prevents operation.
13466	</result>
13467	<result name="VBOX_E_INVALID_OBJECT_STATE">
13468	Session type prevents operation.
13469	</result>
13470
13471	</desc>
13472	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13473	<param name="changeAdapter" type="boolean" dir="in"/>
13474	</method>
13475
13476	<method name="onSerialPortChange">
13477	<desc>
13478	Triggered when settings of a serial port of the
13479	associated virtual machine have changed.
13480
13481	<result name="VBOX_E_INVALID_VM_STATE">
13482	Session state prevents operation.
13483	</result>
13484	<result name="VBOX_E_INVALID_OBJECT_STATE">
13485	Session type prevents operation.
13486	</result>
13487
13488	</desc>
13489	<param name="serialPort" type="ISerialPort" dir="in"/>
13490	</method>
13491
13492	<method name="onParallelPortChange">
13493	<desc>
13494	Triggered when settings of a parallel port of the
13495	associated virtual machine have changed.
13496
13497	<result name="VBOX_E_INVALID_VM_STATE">
13498	Session state prevents operation.
13499	</result>
13500	<result name="VBOX_E_INVALID_OBJECT_STATE">
13501	Session type prevents operation.
13502	</result>
13503
13504	</desc>
13505	<param name="parallelPort" type="IParallelPort" dir="in"/>
13506	</method>
13507
13508	<method name="onStorageControllerChange">
13509	<desc>
13510	Triggered when settings of a storage controller of the
13511	associated virtual machine have changed.
13512
13513	<result name="VBOX_E_INVALID_VM_STATE">
13514	Session state prevents operation.
13515	</result>
13516	<result name="VBOX_E_INVALID_OBJECT_STATE">
13517	Session type prevents operation.
13518	</result>
13519
13520	</desc>
13521	</method>
13522
13523	<method name="onMediumChange">
13524	<desc>
13525	Triggered when attached media of the
13526	associated virtual machine have changed.
13527
13528	<result name="VBOX_E_INVALID_VM_STATE">
13529	Session state prevents operation.
13530	</result>
13531	<result name="VBOX_E_INVALID_OBJECT_STATE">
13532	Session type prevents operation.
13533	</result>
13534
13535	</desc>
13536
13537	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13538	<param name="force" type="boolean" dir="in"/>
13539	</method>
13540
13541	<method name="onCPUChange">
13542	<desc>
13543	Notification when a CPU changes.
13544	</desc>
13545	<param name="cpu" type="unsigned long" dir="in">
13546	<desc>The CPU which changed</desc>
13547	</param>
13548	<param name="add" type="boolean" dir="in">
13549	<desc>Flag whether the CPU was added or removed</desc>
13550	</param>
13551	</method>
13552
13553	<method name="onCPUExecutionCapChange">
13554	<desc>
13555	Notification when the CPU execution cap changes.
13556	</desc>
13557	<param name="executionCap" type="unsigned long" dir="in">
13558	<desc>The new CPU execution cap value. (1-100)</desc>
13559	</param>
13560	</method>
13561
13562	<method name="onVRDEServerChange">
13563	<desc>
13564	Triggered when settings of the VRDE server object of the
13565	associated virtual machine have changed.
13566
13567	<result name="VBOX_E_INVALID_VM_STATE">
13568	Session state prevents operation.
13569	</result>
13570	<result name="VBOX_E_INVALID_OBJECT_STATE">
13571	Session type prevents operation.
13572	</result>
13573
13574	</desc>
13575	<param name="restart" type="boolean" dir="in">
13576	<desc>Flag whether the server must be restarted</desc>
13577	</param>
13578	</method>
13579
13580	<method name="onUSBControllerChange">
13581	<desc>
13582	Triggered when settings of the USB controller object of the
13583	associated virtual machine have changed.
13584
13585	<result name="VBOX_E_INVALID_VM_STATE">
13586	Session state prevents operation.
13587	</result>
13588	<result name="VBOX_E_INVALID_OBJECT_STATE">
13589	Session type prevents operation.
13590	</result>
13591
13592	</desc>
13593	</method>
13594
13595	<method name="onSharedFolderChange">
13596	<desc>
13597	Triggered when a permanent (global or machine) shared folder has been
13598	created or removed.
13599	<note>
13600	We don't pass shared folder parameters in this notification because
13601	the order in which parallel notifications are delivered is not defined,
13602	therefore it could happen that these parameters were outdated by the
13603	time of processing this notification.
13604	</note>
13605
13606	<result name="VBOX_E_INVALID_VM_STATE">
13607	Session state prevents operation.
13608	</result>
13609	<result name="VBOX_E_INVALID_OBJECT_STATE">
13610	Session type prevents operation.
13611	</result>
13612
13613	</desc>
13614	<param name="global" type="boolean" dir="in"/>
13615	</method>
13616
13617	<method name="onUSBDeviceAttach">
13618	<desc>
13619	Triggered when a request to capture a USB device (as a result
13620	of matched USB filters or direct call to
13621	<link to="IConsole::attachUSBDevice"/>) has completed.
13622	A @c null @a error object means success, otherwise it
13623	describes a failure.
13624
13625	<result name="VBOX_E_INVALID_VM_STATE">
13626	Session state prevents operation.
13627	</result>
13628	<result name="VBOX_E_INVALID_OBJECT_STATE">
13629	Session type prevents operation.
13630	</result>
13631
13632	</desc>
13633	<param name="device" type="IUSBDevice" dir="in"/>
13634	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13635	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13636	</method>
13637
13638	<method name="onUSBDeviceDetach">
13639	<desc>
13640	Triggered when a request to release the USB device (as a result
13641	of machine termination or direct call to
13642	<link to="IConsole::detachUSBDevice"/>) has completed.
13643	A @c null @a error object means success, otherwise it
13644	describes a failure.
13645
13646	<result name="VBOX_E_INVALID_VM_STATE">
13647	Session state prevents operation.
13648	</result>
13649	<result name="VBOX_E_INVALID_OBJECT_STATE">
13650	Session type prevents operation.
13651	</result>
13652
13653	</desc>
13654	<param name="id" type="uuid" mod="string" dir="in"/>
13655	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13656	</method>
13657
13658	<method name="onShowWindow">
13659	<desc>
13660	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13661	<link to="IMachine::showConsoleWindow"/> in order to notify
13662	console listeners
13663	<link to="ICanShowWindowEvent"/>
13664	and <link to="IShowWindowEvent"/>.
13665
13666	<result name="VBOX_E_INVALID_OBJECT_STATE">
13667	Session type prevents operation.
13668	</result>
13669
13670	</desc>
13671	<param name="check" type="boolean" dir="in"/>
13672	<param name="canShow" type="boolean" dir="out"/>
13673	<param name="winId" type="long long" dir="out"/>
13674	</method>
13675
13676	<method name="onBandwidthGroupChange">
13677	<desc>
13678	Notification when one of the bandwidth groups change.
13679	</desc>
13680	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13681	<desc>The bandwidth group which changed.</desc>
13682	</param>
13683	</method>
13684
13685	<method name="accessGuestProperty">
13686	<desc>
13687	Called by <link to="IMachine::getGuestProperty"/> and by
13688	<link to="IMachine::setGuestProperty"/> in order to read and
13689	modify guest properties.
13690
13691	<result name="VBOX_E_INVALID_VM_STATE">
13692	Machine session is not open.
13693	</result>
13694	<result name="VBOX_E_INVALID_OBJECT_STATE">
13695	Session type is not direct.
13696	</result>
13697
13698	</desc>
13699	<param name="name" type="wstring" dir="in"/>
13700	<param name="value" type="wstring" dir="in"/>
13701	<param name="flags" type="wstring" dir="in"/>
13702	<param name="isSetter" type="boolean" dir="in"/>
13703	<param name="retValue" type="wstring" dir="out"/>
13704	<param name="retTimestamp" type="long long" dir="out"/>
13705	<param name="retFlags" type="wstring" dir="out"/>
13706	</method>
13707
13708	<method name="enumerateGuestProperties">
13709	<desc>
13710	Return a list of the guest properties matching a set of patterns along
13711	with their values, time stamps and flags.
13712
13713	<result name="VBOX_E_INVALID_VM_STATE">
13714	Machine session is not open.
13715	</result>
13716	<result name="VBOX_E_INVALID_OBJECT_STATE">
13717	Session type is not direct.
13718	</result>
13719
13720	</desc>
13721	<param name="patterns" type="wstring" dir="in">
13722	<desc>
13723	The patterns to match the properties against as a comma-separated
13724	string. If this is empty, all properties currently set will be
13725	returned.
13726	</desc>
13727	</param>
13728	<param name="key" type="wstring" dir="out" safearray="yes">
13729	<desc>
13730	The key names of the properties returned.
13731	</desc>
13732	</param>
13733	<param name="value" type="wstring" dir="out" safearray="yes">
13734	<desc>
13735	The values of the properties returned. The array entries match the
13736	corresponding entries in the @a key array.
13737	</desc>
13738	</param>
13739	<param name="timestamp" type="long long" dir="out" safearray="yes">
13740	<desc>
13741	The time stamps of the properties returned. The array entries match
13742	the corresponding entries in the @a key array.
13743	</desc>
13744	</param>
13745	<param name="flags" type="wstring" dir="out" safearray="yes">
13746	<desc>
13747	The flags of the properties returned. The array entries match the
13748	corresponding entries in the @a key array.
13749	</desc>
13750	</param>
13751	</method>
13752
13753	<method name="onlineMergeMedium">
13754	<desc>
13755	Triggers online merging of a hard disk. Used internally when deleting
13756	a snapshot while a VM referring to the same hard disk chain is running.
13757
13758	<result name="VBOX_E_INVALID_VM_STATE">
13759	Machine session is not open.
13760	</result>
13761	<result name="VBOX_E_INVALID_OBJECT_STATE">
13762	Session type is not direct.
13763	</result>
13764
13765	</desc>
13766	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13767	<desc>The medium attachment to identify the medium chain.</desc>
13768	</param>
13769	<param name="sourceIdx" type="unsigned long" dir="in">
13770	<desc>The index of the source image in the chain.
13771	Redundant, but drastically reduces IPC.</desc>
13772	</param>
13773	<param name="targetIdx" type="unsigned long" dir="in">
13774	<desc>The index of the target image in the chain.
13775	Redundant, but drastically reduces IPC.</desc>
13776	</param>
13777	<param name="source" type="IMedium" dir="in">
13778	<desc>Merge source medium.</desc>
13779	</param>
13780	<param name="target" type="IMedium" dir="in">
13781	<desc>Merge target medium.</desc>
13782	</param>
13783	<param name="mergeForward" type="boolean" dir="in">
13784	<desc>Merge direction.</desc>
13785	</param>
13786	<param name="parentForTarget" type="IMedium" dir="in">
13787	<desc>For forward merges: new parent for target medium.</desc>
13788	</param>
13789	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13790	<desc>For backward merges: list of media which need their parent UUID
13791	updated.</desc>
13792	</param>
13793	<param name="progress" type="IProgress" dir="in">
13794	<desc>
13795	Progress object for this operation.
13796	</desc>
13797	</param>
13798	</method>
13799
13800	</interface>
13801
13802	<interface
13803	name="ISession" extends="$unknown"
13804	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13805	wsmap="managed"
13806	>
13807	<desc>
13808	The ISession interface represents a client process and allows for locking
13809	virtual machines (represented by IMachine objects) to prevent conflicting
13810	changes to the machine.
13811
13812	Any caller wishing to manipulate a virtual machine needs to create a session
13813	object first, which lives in its own process space. Such session objects are
13814	then associated with <link to="IMachine" /> objects living in the VirtualBox
13815	server process to coordinate such changes.
13816
13817	There are two typical scenarios in which sessions are used:
13818
13819	<ul>
13820	<li>To alter machine settings or control a running virtual machine, one
13821	needs to lock a machine for a given session (client process) by calling
13822	<link to="IMachine::lockMachine"/>.
13823
13824	Whereas multiple sessions may control a running virtual machine, only
13825	one process can obtain a write lock on the machine to prevent conflicting
13826	changes. A write lock is also needed if a process wants to actually run a
13827	virtual machine in its own context, such as the VirtualBox GUI or
13828	VBoxHeadless front-ends. They must also lock a machine for their own
13829	sessions before they are allowed to power up the virtual machine.
13830
13831	As a result, no machine settings can be altered while another process is
13832	already using it, either because that process is modifying machine settings
13833	or because the machine is running.
13834	</li>
13835	<li>
13836	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13837	VirtualBox GUI or VBoxHeadless), one would use
13838	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13839	as its first parameter. This session then identifies the caller and lets the
13840	caller control the started machine (for example, pause machine execution or
13841	power it down) as well as be notified about machine execution state changes.
13842	</li>
13843	</ul>
13844
13845	How sessions objects are created in a client process depends on whether you use
13846	the Main API via COM or via the webservice:
13847
13848	<ul>
13849	<li>When using the COM API directly, an object of the Session class from the
13850	VirtualBox type library needs to be created. In regular COM C++ client code,
13851	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13852	This object will then act as a local session object in further calls to open
13853	a session.
13854	</li>
13855
13856	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13857	a session object automatically whenever <link to="IWebsessionManager::logon" />
13858	is called. A managed object reference to that session object can be retrieved by
13859	calling <link to="IWebsessionManager::getSessionObject" />.
13860	</li>
13861	</ul>
13862	</desc>
13863
13864	<attribute name="state" type="SessionState" readonly="yes">
13865	<desc>Current state of this session.</desc>
13866	</attribute>
13867
13868	<attribute name="type" type="SessionType" readonly="yes">
13869	<desc>
13870	Type of this session. The value of this attribute is valid only
13871	if the session currently has a machine locked (i.e. its
13872	<link to="#state" /> is Locked), otherwise an error will be returned.
13873	</desc>
13874	</attribute>
13875
13876	<attribute name="machine" type="IMachine" readonly="yes">
13877	<desc>Machine object associated with this session.</desc>
13878	</attribute>
13879
13880	<attribute name="console" type="IConsole" readonly="yes">
13881	<desc>Console object associated with this session.</desc>
13882	</attribute>
13883
13884	<method name="unlockMachine">
13885	<desc>
13886	Unlocks a machine that was previously locked for the current session.
13887
13888	Calling this method is required every time a machine has been locked
13889	for a particular session using the <link to="IMachine::launchVMProcess" />
13890	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13891	the machine will be set to <link to="MachineState_Aborted" /> on the
13892	server, and changes made to the machine settings will be lost.
13893
13894	Generally, it is recommended to unlock all machines explicitly
13895	before terminating the application (regardless of the reason for
13896	the termination).
13897
13898	<note>
13899	Do not expect the session state (<link to="ISession::state" />
13900	to return to "Unlocked" immediately after you invoke this method,
13901	particularly if you have started a new VM process. The session
13902	state will automatically return to "Unlocked" once the VM is no
13903	longer executing, which can of course take a very long time.
13904	</note>
13905
13906	<result name="E_UNEXPECTED">
13907	Session is not locked.
13908	</result>
13909
13910	</desc>
13911	</method>
13912
13913	</interface>
13914
13915	<!--
13916	// IStorageController
13917	/////////////////////////////////////////////////////////////////////////
13918	-->
13919
13920	<enum
13921	name="StorageBus"
13922	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13923	>
13924	<desc>
13925	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13926	see <link to="IStorageController::bus" />.
13927	</desc>
13928	<const name="Null" value="0">
13929	<desc>@c null value. Never used by the API.</desc>
13930	</const>
13931	<const name="IDE" value="1"/>
13932	<const name="SATA" value="2"/>
13933	<const name="SCSI" value="3"/>
13934	<const name="Floppy" value="4"/>
13935	<const name="SAS" value="5"/>
13936	</enum>
13937
13938	<enum
13939	name="StorageControllerType"
13940	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13941	>
13942	<desc>
13943	The exact variant of storage controller hardware presented
13944	to the guest; see <link to="IStorageController::controllerType" />.
13945	</desc>
13946
13947	<const name="Null" value="0">
13948	<desc>@c null value. Never used by the API.</desc>
13949	</const>
13950	<const name="LsiLogic" value="1">
13951	<desc>A SCSI controller of the LsiLogic variant.</desc>
13952	</const>
13953	<const name="BusLogic" value="2">
13954	<desc>A SCSI controller of the BusLogic variant.</desc>
13955	</const>
13956	<const name="IntelAhci" value="3">
13957	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13958	</const>
13959	<const name="PIIX3" value="4">
13960	<desc>An IDE controller of the PIIX3 variant.</desc>
13961	</const>
13962	<const name="PIIX4" value="5">
13963	<desc>An IDE controller of the PIIX4 variant.</desc>
13964	</const>
13965	<const name="ICH6" value="6">
13966	<desc>An IDE controller of the ICH6 variant.</desc>
13967	</const>
13968	<const name="I82078" value="7">
13969	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
13970	</const>
13971	<const name="LsiLogicSas" value="8">
13972	<desc>A variant of the LsiLogic controller using SAS.</desc>
13973	</const>
13974	</enum>
13975
13976	<enum
13977	name="ChipsetType"
13978	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
13979	>
13980	<desc>
13981	Type of emulated chipset (mostly southbridge).
13982	</desc>
13983
13984	<const name="Null" value="0">
13985	<desc>@c null value. Never used by the API.</desc>
13986	</const>
13987	<const name="PIIX3" value="1">
13988	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
13989	</const>
13990	<const name="ICH9" value="2">
13991	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
13992	</const>
13993	</enum>
13994
13995	<interface
13996	name="IStorageController" extends="$unknown"
13997	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
13998	wsmap="managed"
13999	>
14000	<desc>
14001	Represents a storage controller that is attached to a virtual machine
14002	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14003	attached to storage controllers in a real computer, virtual drives
14004	(represented by <link to="IMediumAttachment" />) are attached to virtual
14005	storage controllers, represented by this interface.
14006
14007	As opposed to physical hardware, VirtualBox has a very generic concept
14008	of a storage controller, and for purposes of the Main API, all virtual
14009	storage is attached to virtual machines via instances of this interface.
14010	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14011	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14012	is used, certain sub-types may be available and can be selected in
14013	<link to="#controllerType" />.
14014
14015	Depending on these settings, the guest operating system might see
14016	significantly different virtual hardware.
14017	</desc>
14018
14019	<attribute name="name" type="wstring" readonly="yes">
14020	<desc>
14021	Name of the storage controller, as originally specified with
14022	<link to="IMachine::addStorageController" />. This then uniquely
14023	identifies this controller with other method calls such as
14024	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14025	</desc>
14026	</attribute>
14027
14028	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14029	<desc>
14030	Maximum number of devices which can be attached to one port.
14031	</desc>
14032	</attribute>
14033
14034	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14035	<desc>
14036	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14037	</desc>
14038	</attribute>
14039
14040	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14041	<desc>
14042	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14043	</desc>
14044	</attribute>
14045
14046	<attribute name="instance" type="unsigned long">
14047	<desc>
14048	The instance number of the device in the running VM.
14049	</desc>
14050	</attribute>
14051
14052	<attribute name="portCount" type="unsigned long">
14053	<desc>
14054	The number of currently usable ports on the controller.
14055	The minimum and maximum number of ports for one controller are
14056	stored in <link to="IStorageController::minPortCount"/>
14057	and <link to="IStorageController::maxPortCount"/>.
14058	</desc>
14059	</attribute>
14060
14061	<attribute name="bus" type="StorageBus" readonly="yes">
14062	<desc>
14063	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14064	</desc>
14065	</attribute>
14066
14067	<attribute name="controllerType" type="StorageControllerType">
14068	<desc>
14069	The exact variant of storage controller hardware presented
14070	to the guest.
14071	Depending on this value, VirtualBox will provide a different
14072	virtual storage controller hardware to the guest.
14073	For SATA, SAS and floppy controllers, only one variant is
14074	available, but for IDE and SCSI, there are several.
14075
14076	For SCSI controllers, the default type is LsiLogic.
14077	</desc>
14078	</attribute>
14079
14080	<attribute name="useHostIOCache" type="boolean">
14081	<desc>
14082	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14083	caches and use synchronous file APIs on the host. This was the only option in the API before
14084	VirtualBox 3.2 and is still the default for IDE controllers.
14085
14086	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14087	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14088	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14089	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14090	virtual machines are running at the same time to prevent I/O cache related hangs.
14091	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14092	</desc>
14093	</attribute>
14094
14095	<attribute name="bootable" type="boolean" readonly="yes">
14096	<desc>
14097	Returns whether it is possible to boot from disks attached to this controller.
14098	</desc>
14099	</attribute>
14100
14101	<method name="getIDEEmulationPort">
14102	<desc>
14103	Gets the corresponding port number which is emulated as an IDE device.
14104	Works only with SATA controllers.
14105
14106	<result name="E_INVALIDARG">
14107	The @a devicePosition is not in the range 0 to 3.
14108	</result>
14109	<result name="E_NOTIMPL">
14110	The storage controller type is not SATAIntelAhci.
14111	</result>
14112
14113	</desc>
14114	<param name="devicePosition" type="long" dir="in"/>
14115	<param name="portNumber" type="long" dir="return"/>
14116	</method>
14117
14118	<method name="setIDEEmulationPort">
14119	<desc>
14120	Sets the port number which is emulated as an IDE device.
14121	Works only with SATA controllers.
14122
14123	<result name="E_INVALIDARG">
14124	The @a devicePosition is not in the range 0 to 3 or the
14125	@a portNumber is not in the range 0 to 29.
14126	</result>
14127	<result name="E_NOTIMPL">
14128	The storage controller type is not SATAIntelAhci.
14129	</result>
14130
14131	</desc>
14132	<param name="devicePosition" type="long" dir="in"/>
14133	<param name="portNumber" type="long" dir="in"/>
14134	</method>
14135
14136	</interface>
14137
14138	<if target="wsdl">
14139
14140	<!--
14141	// IManagedObjectRef
14142	/////////////////////////////////////////////////////////////////////////
14143	-->
14144
14145	<interface
14146	name="IManagedObjectRef" extends="$unknown"
14147	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14148	internal="yes"
14149	wsmap="managed"
14150	wscpp="hardcoded"
14151	>
14152	<desc>
14153	Managed object reference.
14154
14155	Only within the webservice, a managed object reference (which is really
14156	an opaque number) allows a webservice client to address an object
14157	that lives in the address space of the webservice server.
14158
14159	Behind each managed object reference, there is a COM object that lives
14160	in the webservice server's address space. The COM object is not freed
14161	until the managed object reference is released, either by an explicit
14162	call to <link to="IManagedObjectRef::release" /> or by logging off from
14163	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14164	all objects created during the webservice session.
14165
14166	Whenever a method call of the VirtualBox API returns a COM object, the
14167	webservice representation of that method will instead return a
14168	managed object reference, which can then be used to invoke methods
14169	on that object.
14170	</desc>
14171
14172	<method name="getInterfaceName">
14173	<desc>
14174	Returns the name of the interface that this managed object represents,
14175	for example, "IMachine", as a string.
14176	</desc>
14177	<param name="return" type="wstring" dir="return"/>
14178	</method>
14179
14180	<method name="release">
14181	<desc>
14182	Releases this managed object reference and frees the resources that
14183	were allocated for it in the webservice server process. After calling
14184	this method, the identifier of the reference can no longer be used.
14185	</desc>
14186	</method>
14187
14188	</interface>
14189
14190	<!--
14191	// IWebsessionManager
14192	/////////////////////////////////////////////////////////////////////////
14193	-->
14194
14195	<interface
14196	name="IWebsessionManager" extends="$unknown"
14197	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14198	internal="yes"
14199	wsmap="global"
14200	wscpp="hardcoded"
14201	>
14202	<desc>
14203	Websession manager. This provides essential services
14204	to webservice clients.
14205	</desc>
14206	<method name="logon">
14207	<desc>
14208	Logs a new client onto the webservice and returns a managed object reference to
14209	the IVirtualBox instance, which the client can then use as a basis to further
14210	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14211	interface, in one way or the other.
14212	</desc>
14213	<param name="username" type="wstring" dir="in"/>
14214	<param name="password" type="wstring" dir="in"/>
14215	<param name="return" type="IVirtualBox" dir="return"/>
14216	</method>
14217
14218	<method name="getSessionObject">
14219	<desc>
14220	Returns a managed object reference to the internal ISession object that was created
14221	for this web service session when the client logged on.
14222
14223	<see>ISession</see>
14224	</desc>
14225	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14226	<param name="return" type="ISession" dir="return"/>
14227	</method>
14228
14229	<method name="logoff">
14230	<desc>
14231	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14232	and destroys all resources associated with the session (most importantly, all
14233	managed objects created in the server while the session was active).
14234	</desc>
14235	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14236	</method>
14237
14238	</interface>
14239
14240	</if>
14241
14242	<!--
14243	// IPerformanceCollector & friends
14244	/////////////////////////////////////////////////////////////////////////
14245	-->
14246
14247	<interface
14248	name="IPerformanceMetric" extends="$unknown"
14249	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14250	>
14251	<desc>
14252	The IPerformanceMetric interface represents parameters of the given
14253	performance metric.
14254	</desc>
14255
14256	<attribute name="metricName" type="wstring" readonly="yes">
14257	<desc>
14258	Name of the metric.
14259	</desc>
14260	</attribute>
14261
14262	<attribute name="object" type="$unknown" readonly="yes">
14263	<desc>
14264	Object this metric belongs to.
14265	</desc>
14266	</attribute>
14267
14268	<attribute name="description" type="wstring" readonly="yes">
14269	<desc>
14270	Textual description of the metric.
14271	</desc>
14272	</attribute>
14273
14274	<attribute name="period" type="unsigned long" readonly="yes">
14275	<desc>
14276	Time interval between samples, measured in seconds.
14277	</desc>
14278	</attribute>
14279
14280	<attribute name="count" type="unsigned long" readonly="yes">
14281	<desc>
14282	Number of recent samples retained by the performance collector for this
14283	metric.
14284
14285	When the collected sample count exceeds this number, older samples
14286	are discarded.
14287	</desc>
14288	</attribute>
14289
14290	<attribute name="unit" type="wstring" readonly="yes">
14291	<desc>
14292	Unit of measurement.
14293	</desc>
14294	</attribute>
14295
14296	<attribute name="minimumValue" type="long" readonly="yes">
14297	<desc>
14298	Minimum possible value of this metric.
14299	</desc>
14300	</attribute>
14301
14302	<attribute name="maximumValue" type="long" readonly="yes">
14303	<desc>
14304	Maximum possible value of this metric.
14305	</desc>
14306	</attribute>
14307	</interface>
14308
14309	<interface
14310	name="IPerformanceCollector" extends="$unknown"
14311	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14312	wsmap="managed"
14313	>
14314	<desc>
14315	The IPerformanceCollector interface represents a service that collects
14316	and stores performance metrics data.
14317
14318	Performance metrics are associated with objects of interfaces like IHost
14319	and IMachine. Each object has a distinct set of performance metrics. The
14320	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14321
14322	Metric data is collected at the specified intervals and is retained
14323	internally. The interval and the number of retained samples can be set
14324	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14325	and collection settings are not persistent, they are discarded as soon as
14326	VBoxSVC process terminates. Moreover, metric settings and data associated
14327	with a particular VM only exist while VM is running. They disappear as
14328	soon as VM shuts down. It is not possible to set up metrics for machines
14329	that are powered off. One needs to start VM first, then set up metric
14330	collection parameters.
14331
14332	Metrics are organized hierarchically, with each level separated by a
14333	slash (/) character. Generally, the scheme for metric names is like this:
14334
14335	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14336
14337	"Category/Metric" together form the base metric name. A base metric is
14338	the smallest unit for which a sampling interval and the number of
14339	retained samples can be set. Only base metrics can be enabled and
14340	disabled. All sub-metrics are collected when their base metric is
14341	collected. Collected values for any set of sub-metrics can be queried
14342	with <link to="IPerformanceCollector::queryMetricsData" />.
14343
14344	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14345	category, "Load" metric, "User" submetric, "average" aggregate. An
14346	aggregate function is computed over all retained data. Valid aggregate
14347	functions are:
14348
14349	<ul>
14350	<li>avg -- average</li>
14351	<li>min -- minimum</li>
14352	<li>max -- maximum</li>
14353	</ul>
14354
14355	When setting up metric parameters, querying metric data, enabling or
14356	disabling metrics wildcards can be used in metric names to specify a
14357	subset of metrics. For example, to select all CPU-related metrics
14358	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14359	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14360
14361	The valid names for base metrics are:
14362
14363	<ul>
14364	<li>CPU/Load</li>
14365	<li>CPU/MHz</li>
14366	<li>RAM/Usage</li>
14367	</ul>
14368
14369	The general sequence for collecting and retrieving the metrics is:
14370	<ul>
14371	<li>
14372	Obtain an instance of IPerformanceCollector with
14373	<link to="IVirtualBox::performanceCollector" />
14374	</li>
14375	<li>
14376	Allocate and populate an array with references to objects the metrics
14377	will be collected for. Use references to IHost and IMachine objects.
14378	</li>
14379	<li>
14380	Allocate and populate an array with base metric names the data will
14381	be collected for.
14382	</li>
14383	<li>
14384	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14385	the metric data will be collected and stored.
14386	</li>
14387	<li>
14388	Wait for the data to get collected.
14389	</li>
14390	<li>
14391	Allocate and populate an array with references to objects the metric
14392	values will be queried for. You can re-use the object array used for
14393	setting base metrics.
14394	</li>
14395	<li>
14396	Allocate and populate an array with metric names the data will be
14397	collected for. Note that metric names differ from base metric names.
14398	</li>
14399	<li>
14400	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14401	that have been collected so far are returned. Note that the values
14402	are still retained internally and data collection continues.
14403	</li>
14404	</ul>
14405
14406	For an example of usage refer to the following files in VirtualBox SDK:
14407	<ul>
14408	<li>
14409	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14410	</li>
14411	<li>
14412	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14413	</li>
14414	</ul>
14415	</desc>
14416
14417	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14418	<desc>
14419	Array of unique names of metrics.
14420
14421	This array represents all metrics supported by the performance
14422	collector. Individual objects do not necessarily support all of them.
14423	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14424	list of supported metrics for a particular object.
14425	</desc>
14426	</attribute>
14427
14428	<method name="getMetrics">
14429	<desc>
14430	Returns parameters of specified metrics for a set of objects.
14431	<note>
14432	@c Null metrics array means all metrics. @c Null object array means
14433	all existing objects.
14434	</note>
14435	</desc>
14436	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14437	<desc>
14438	Metric name filter. Currently, only a comma-separated list of metrics
14439	is supported.
14440	</desc>
14441	</param>
14442	<param name="objects" type="$unknown" dir="in" safearray="yes">
14443	<desc>
14444	Set of objects to return metric parameters for.
14445	</desc>
14446	</param>
14447	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14448	<desc>
14449	Array of returned metric parameters.
14450	</desc>
14451	</param>
14452	</method>
14453
14454	<method name="setupMetrics">
14455	<desc>
14456	Sets parameters of specified base metrics for a set of objects. Returns
14457	an array of <link to="IPerformanceMetric" /> describing the metrics
14458	have been affected.
14459	<note>
14460	@c Null or empty metric name array means all metrics. @c Null or
14461	empty object array means all existing objects. If metric name array
14462	contains a single element and object array contains many, the single
14463	metric name array element is applied to each object array element to
14464	form metric/object pairs.
14465	</note>
14466	</desc>
14467	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14468	<desc>
14469	Metric name filter. Comma-separated list of metrics with wildcard
14470	support.
14471	</desc>
14472	</param>
14473	<param name="objects" type="$unknown" dir="in" safearray="yes">
14474	<desc>
14475	Set of objects to setup metric parameters for.
14476	</desc>
14477	</param>
14478	<param name="period" type="unsigned long" dir="in">
14479	<desc>
14480	Time interval in seconds between two consecutive samples of
14481	performance data.
14482	</desc>
14483	</param>
14484	<param name="count" type="unsigned long" dir="in">
14485	<desc>
14486	Number of samples to retain in performance data history. Older
14487	samples get discarded.
14488	</desc>
14489	</param>
14490	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14491	<desc>
14492	Array of metrics that have been modified by the call to this method.
14493	</desc>
14494	</param>
14495	</method>
14496
14497	<method name="enableMetrics">
14498	<desc>
14499	Turns on collecting specified base metrics. Returns an array of
14500	<link to="IPerformanceMetric" /> describing the metrics have been
14501	affected.
14502	<note>
14503	@c Null or empty metric name array means all metrics. @c Null or
14504	empty object array means all existing objects. If metric name array
14505	contains a single element and object array contains many, the single
14506	metric name array element is applied to each object array element to
14507	form metric/object pairs.
14508	</note>
14509	</desc>
14510	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14511	<desc>
14512	Metric name filter. Comma-separated list of metrics with wildcard
14513	support.
14514	</desc>
14515	</param>
14516	<param name="objects" type="$unknown" dir="in" safearray="yes">
14517	<desc>
14518	Set of objects to enable metrics for.
14519	</desc>
14520	</param>
14521	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14522	<desc>
14523	Array of metrics that have been modified by the call to this method.
14524	</desc>
14525	</param>
14526	</method>
14527
14528	<method name="disableMetrics">
14529	<desc>
14530	Turns off collecting specified base metrics. Returns an array of
14531	<link to="IPerformanceMetric" /> describing the metrics have been
14532	affected.
14533	<note>
14534	@c Null or empty metric name array means all metrics. @c Null or
14535	empty object array means all existing objects. If metric name array
14536	contains a single element and object array contains many, the single
14537	metric name array element is applied to each object array element to
14538	form metric/object pairs.
14539	</note>
14540	</desc>
14541	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14542	<desc>
14543	Metric name filter. Comma-separated list of metrics with wildcard
14544	support.
14545	</desc>
14546	</param>
14547	<param name="objects" type="$unknown" dir="in" safearray="yes">
14548	<desc>
14549	Set of objects to disable metrics for.
14550	</desc>
14551	</param>
14552	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14553	<desc>
14554	Array of metrics that have been modified by the call to this method.
14555	</desc>
14556	</param>
14557	</method>
14558
14559	<method name="queryMetricsData">
14560	<desc>
14561	Queries collected metrics data for a set of objects.
14562
14563	The data itself and related metric information are returned in seven
14564	parallel and one flattened array of arrays. Elements of
14565	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14566	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14567	the same index describe one set of values corresponding to a single
14568	metric.
14569
14570	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14571	start and length of a sub-array is indicated by
14572	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14573	value for metric <tt>metricNames[i]</tt> is at
14574	<tt>returnData[returnIndices[i]]</tt>.
14575
14576	<note>
14577	@c Null or empty metric name array means all metrics. @c Null or
14578	empty object array means all existing objects. If metric name array
14579	contains a single element and object array contains many, the single
14580	metric name array element is applied to each object array element to
14581	form metric/object pairs.
14582	</note>
14583	<note>
14584	Data collection continues behind the scenes after call to @c
14585	queryMetricsData. The return data can be seen as the snapshot of the
14586	current state at the time of @c queryMetricsData call. The internally
14587	kept metric values are not cleared by the call. This makes possible
14588	querying different subsets of metrics or aggregates with subsequent
14589	calls. If periodic querying is needed it is highly suggested to query
14590	the values with @c interval*count period to avoid confusion. This way
14591	a completely new set of data values will be provided by each query.
14592	</note>
14593	</desc>
14594	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14595	<desc>
14596	Metric name filter. Comma-separated list of metrics with wildcard
14597	support.
14598	</desc>
14599	</param>
14600	<param name="objects" type="$unknown" dir="in" safearray="yes">
14601	<desc>
14602	Set of objects to query metrics for.
14603	</desc>
14604	</param>
14605	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14606	<desc>
14607	Names of metrics returned in @c returnData.
14608	</desc>
14609	</param>
14610	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14611	<desc>
14612	Objects associated with metrics returned in @c returnData.
14613	</desc>
14614	</param>
14615	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14616	<desc>
14617	Units of measurement for each returned metric.
14618	</desc>
14619	</param>
14620	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14621	<desc>
14622	Divisor that should be applied to return values in order to get
14623	floating point values. For example:
14624	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14625	will retrieve the floating point value of i-th sample of the first
14626	metric.
14627	</desc>
14628	</param>
14629	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14630	<desc>
14631	Sequence numbers of the first elements of value sequences of
14632	particular metrics returned in @c returnData. For aggregate metrics
14633	it is the sequence number of the sample the aggregate started
14634	calculation from.
14635	</desc>
14636	</param>
14637	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14638	<desc>
14639	Indices of the first elements of value sequences of particular
14640	metrics returned in @c returnData.
14641	</desc>
14642	</param>
14643	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14644	<desc>
14645	Lengths of value sequences of particular metrics.
14646	</desc>
14647	</param>
14648	<param name="returnData" type="long" dir="return" safearray="yes">
14649	<desc>
14650	Flattened array of all metric data containing sequences of values for
14651	each metric.
14652	</desc>
14653	</param>
14654	</method>
14655
14656	</interface>
14657
14658	<enum
14659	name="NATAliasMode"
14660	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14661	>
14662	<desc></desc>
14663	<const name="AliasLog" value="0x1">
14664	<desc></desc>
14665	</const>
14666	<const name="AliasProxyOnly" value="0x02">
14667	<desc></desc>
14668	</const>
14669	<const name="AliasUseSamePorts" value="0x04">
14670	<desc></desc>
14671	</const>
14672	</enum>
14673
14674	<enum
14675	name="NATProtocol"
14676	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14677	>
14678	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14679	<const name="UDP" value="0">
14680	<desc>Port-forwarding uses UDP protocol.</desc>
14681	</const>
14682	<const name="TCP" value="1">
14683	<desc>Port-forwarding uses TCP protocol.</desc>
14684	</const>
14685	</enum>
14686
14687	<interface
14688	name="INATEngine" extends="$unknown"
14689	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14690	wsmap="managed"
14691	>
14692	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14693	allows for changing NAT behavior such as port-forwarding rules. This interface is
14694	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14695	<attribute name="network" type="wstring">
14696	<desc>The network attribute of the NAT engine (the same value is used with built-in
14697	DHCP server to fill corresponding fields of DHCP leases).</desc>
14698	</attribute>
14699	<attribute name="hostIP" type="wstring">
14700	<desc>IP of host interface to bind all opened sockets to.
14701	<note>Changing this does not change binding of port forwarding.</note>
14702	</desc>
14703	</attribute>
14704	<attribute name="tftpPrefix" type="wstring">
14705	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14706	the corresponding fields of DHCP leases.</desc>
14707	</attribute>
14708	<attribute name="tftpBootFile" type="wstring">
14709	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14710	the corresponding fields of DHCP leases.</desc>
14711	</attribute>
14712	<attribute name="tftpNextServer" type="wstring">
14713	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14714	the corresponding fields of DHCP leases.
14715	<note>The preferred form is IPv4 addresses.</note>
14716	</desc>
14717	</attribute>
14718	<attribute name="aliasMode" type="unsigned long">
14719	<desc></desc>
14720	</attribute>
14721	<attribute name="dnsPassDomain" type="boolean">
14722	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14723	</attribute>
14724	<attribute name="dnsProxy" type="boolean">
14725	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14726	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14727	</attribute>
14728	<attribute name="dnsUseHostResolver" type="boolean">
14729	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14730	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14731	</attribute>
14732	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14733	<desc>Array of NAT port-forwarding rules in string representation, in the following
14734	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14735	</attribute>
14736	<method name="setNetworkSettings">
14737	<desc>Sets network configuration of the NAT engine.</desc>
14738	<param name="mtu" type="unsigned long" dir="in">
14739	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14740	</param>
14741	<param name="sockSnd" type="unsigned long" dir="in">
14742	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14743	</param>
14744	<param name="sockRcv" type="unsigned long" dir="in">
14745	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14746	</param>
14747	<param name="TcpWndSnd" type="unsigned long" dir="in">
14748	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14749	establishing a new TCP connection.</desc>
14750	</param>
14751	<param name="TcpWndRcv" type="unsigned long" dir="in">
14752	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14753	establishing a new TCP connection.</desc>
14754	</param>
14755	</method>
14756	<method name="getNetworkSettings">
14757	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14758	for parameter descriptions.</desc>
14759	<param name="mtu" type="unsigned long" dir="out" />
14760	<param name="sockSnd" type="unsigned long" dir="out" />
14761	<param name="sockRcv" type="unsigned long" dir="out" />
14762	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14763	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14764	</method>
14765	<method name="addRedirect">
14766	<desc>Adds a new NAT port-forwarding rule.</desc>
14767	<param name="name" type="wstring" dir="in">
14768	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14769	auto-generates one using the other parameters.</desc>
14770	</param>
14771	<param name="proto" type="NATProtocol" dir="in">
14772	<desc>Protocol handled with the rule.</desc>
14773	</param>
14774	<param name="hostIp" type="wstring" dir="in">
14775	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14776	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14777	</param>
14778	<param name="hostPort" type="unsigned short" dir="in">
14779	<desc>The port number to listen on.</desc>
14780	</param>
14781	<param name="guestIp" type="wstring" dir="in">
14782	<desc>The IP address of the guest which the NAT engine will forward matching packets
14783	to. An empty IP address is acceptable, in which case the NAT engine will forward
14784	packets to the first DHCP lease (x.x.x.15).</desc>
14785	</param>
14786	<param name="guestPort" type="unsigned short" dir="in">
14787	<desc>The port number to forward.</desc>
14788	</param>
14789	</method>
14790	<method name="removeRedirect">
14791	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14792	<param name="name" type="wstring" dir="in">
14793	<desc>The name of the rule to delete.</desc>
14794	</param>
14795	</method>
14796	</interface>
14797
14798	<!--
14799	// IExtPackManager
14800	/////////////////////////////////////////////////////////////////////////
14801	-->
14802
14803	<interface
14804	name="IExtPackPlugIn" extends="$unknown"
14805	uuid="58000040-e718-4746-bbce-4b86d96da461"
14806	wsmap="suppress"
14807	>
14808	<desc>
14809	Interface for keeping information about a plug-in that ships with an
14810	extension pack.
14811	</desc>
14812	<attribute name="name" type="wstring" readonly="yes">
14813	<desc>The plug-in name.</desc>
14814	</attribute>
14815	<attribute name="description" type="wstring" readonly="yes">
14816	<desc>The plug-in description.</desc>
14817	</attribute>
14818	<attribute name="frontend" type="wstring" readonly="yes">
14819	<desc>
14820	The name of the frontend or component name this plug-in plugs into.
14821	</desc>
14822	</attribute>
14823	<attribute name="modulePath" type="wstring" readonly="yes">
14824	<desc> The module path. </desc>
14825	</attribute>
14826	</interface>
14827
14828	<interface
14829	name="IExtPackBase" extends="$unknown"
14830	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
14831	wsmap="suppress"
14832	>
14833	<desc>
14834	Interface for querying information about an extension pack as well as
14835	accessing COM objects within it.
14836	</desc>
14837	<attribute name="name" type="wstring" readonly="yes">
14838	<desc>The extension pack name. This is unique.</desc>
14839	</attribute>
14840	<attribute name="description" type="wstring" readonly="yes">
14841	<desc>The extension pack description.</desc>
14842	</attribute>
14843	<attribute name="version" type="wstring" readonly="yes">
14844	<desc>
14845	The extension pack version string. This is on the same form as
14846	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14847	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14848	or "1.2.3_BETA1-r45678-OSE"
14849	</desc>
14850	</attribute>
14851	<attribute name="revision" type="unsigned long" readonly="yes">
14852	<desc>The extension pack internal revision number.</desc>
14853	</attribute>
14854	<attribute name="VRDEModule" type="wstring" readonly="yes">
14855	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14856	</attribute>
14857	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14858	<desc>Plug-ins provided by this extension pack.</desc>
14859	</attribute>
14860	<attribute name="usable" type="boolean" readonly="yes">
14861	<desc>
14862	Indicates whether the extension pack is usable or not.
14863
14864	There are a number of reasons why an extension pack might be unusable,
14865	typical examples would be broken installation/file or that it is
14866	incompatible with the current VirtualBox version.
14867	</desc>
14868	</attribute>
14869	<attribute name="whyUnusable" type="wstring" readonly="yes">
14870	<desc>
14871	String indicating why the extension pack is not usable. This is an
14872	empty string if usable and always a non-empty string if not usable.
14873	</desc>
14874	</attribute>
14875	<attribute name="showLicense" type="boolean" readonly="yes">
14876	<desc>Whether to show the license before installation</desc>
14877	</attribute>
14878	<attribute name="license" type="wstring" readonly="yes">
14879	<desc>
14880	The default HTML license text for the extension pack. Same as
14881	calling <link to="#queryLicense">queryLicense</link> with
14882	preferredLocale and preferredLanguage as empty strings and format set
14883	to html.
14884	</desc>
14885	</attribute>
14886
14887	<method name="queryLicense">
14888	<desc>
14889	Full feature version of the license attribute.
14890	</desc>
14891	<param name="preferredLocale" type="wstring" dir="in">
14892	<desc>
14893	The preferred license locale. Pass an empty string to get the default
14894	license.
14895	</desc>
14896	</param>
14897	<param name="preferredLanguage" type="wstring" dir="in">
14898	<desc>
14899	The preferred license language. Pass an empty string to get the
14900	default language for the locale.
14901	</desc>
14902	</param>
14903	<param name="format" type="wstring" dir="in">
14904	<desc>
14905	The license format: html, rtf or txt. If a license is present there
14906	will always be an HTML of it, the rich text format (RTF) and plain
14907	text (txt) versions are optional. If
14908	</desc>
14909	</param>
14910	<param name="licenseText" type="wstring" dir="return">
14911	<desc>The license text.</desc>
14912	</param>
14913	</method>
14914
14915	</interface>
14916
14917	<interface
14918	name="IExtPack" extends="IExtPackBase"
14919	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
14920	wsmap="suppress"
14921	>
14922	<desc>
14923	Interface for querying information about an extension pack as well as
14924	accessing COM objects within it.
14925	</desc>
14926	<method name="queryObject">
14927	<desc>
14928	Queries the IUnknown interface to an object in the extension pack
14929	main module. This allows plug-ins and others to talk directly to an
14930	extension pack.
14931	</desc>
14932	<param name="objUuid" type="wstring" dir="in">
14933	<desc>The object ID. What exactly this is </desc>
14934	</param>
14935	<param name="returnInterface" type="$unknown" dir="return">
14936	<desc>The queried interface.</desc>
14937	</param>
14938	</method>
14939	</interface>
14940
14941	<interface
14942	name="IExtPackFile" extends="IExtPackBase"
14943	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
14944	wsmap="suppress"
14945	>
14946	<desc>
14947	Extension pack file (aka tarball, .vbox-extpack) representation returned
14948	by IExtPackManager::openExtPackFile. This provides the base extension
14949	pack information with the addition of the file name. It also provides an
14950	alternative to IExtPackManager::install.
14951	</desc>
14952	<attribute name="filePath" type="wstring" readonly="yes">
14953	<desc>
14954	The path to the extension pack file.
14955	</desc>
14956	</attribute>
14957
14958	<method name="install">
14959	<desc>
14960	Install the extension pack.
14961	</desc>
14962	<param name="replace" type="boolean" dir="in">
14963	<desc>
14964	Set this to automatically uninstall any existing extension pack with
14965	the same name as the one being installed.
14966	</desc>
14967	</param>
14968	<param name="displayInfo" type="wstring" dir="in">
14969	<desc>
14970	Platform specific display information. Reserved for future hacks.
14971	</desc>
14972	</param>
14973	<param name="progess" type="IProgress" dir="return">
14974	<desc>
14975	Progress object for the operation.
14976	</desc>
14977	</param>
14978	</method>
14979	</interface>
14980
14981	<interface
14982	name="IExtPackManager" extends="$unknown"
14983	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
14984	wsmap="suppress"
14985	>
14986	<desc>
14987	Interface for managing VirtualBox Extension Packs.
14988
14989	TODO: Describe extension packs, how they are managed and how to create
14990	one.
14991	</desc>
14992
14993	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
14994	<desc>
14995	List of the installed extension packs.
14996	</desc>
14997	</attribute>
14998
14999	<method name="find">
15000	<desc>
15001	Returns the extension pack with the specified name if found.
15002
15003	<result name="VBOX_E_OBJECT_NOT_FOUND">
15004	No extension pack matching @a name was found.
15005	</result>
15006	</desc>
15007	<param name="name" type="wstring" dir="in">
15008	<desc>The name of the extension pack to locate.</desc>
15009	</param>
15010	<param name="returnData" type="IExtPack" dir="return">
15011	<desc>The extension pack if found.</desc>
15012	</param>
15013	</method>
15014
15015	<method name="openExtPackFile">
15016	<desc>
15017	Attempts to open an extension pack file in preparation for
15018	installation.
15019	</desc>
15020	<param name="path" type="wstring" dir="in">
15021	<desc>The path of the extension pack tarball.</desc>
15022	</param>
15023	<param name="file" type="IExtPackFile" dir="return">
15024	<desc>The interface of the extension pack file object.</desc>
15025	</param>
15026	</method>
15027
15028	<method name="uninstall">
15029	<desc>Uninstalls an extension pack, removing all related files.</desc>
15030	<param name="name" type="wstring" dir="in">
15031	<desc>The name of the extension pack to uninstall.</desc>
15032	</param>
15033	<param name="forcedRemoval" type="boolean" dir="in">
15034	<desc>
15035	Forced removal of the extension pack. This means that the uninstall
15036	hook will not be called.
15037	</desc>
15038	</param>
15039	<param name="displayInfo" type="wstring" dir="in">
15040	<desc>
15041	Platform specific display information. Reserved for future hacks.
15042	</desc>
15043	</param>
15044	<param name="progess" type="IProgress" dir="return">
15045	<desc>
15046	Progress object for the operation.
15047	</desc>
15048	</param>
15049	</method>
15050
15051	<method name="cleanup">
15052	<desc>Cleans up failed installs and uninstalls</desc>
15053	</method>
15054
15055	<method name="QueryAllPlugInsForFrontend">
15056	<desc>
15057	Gets the path to all the plug-in modules for a given frontend.
15058
15059	This is a convenience method that is intended to simplify the plug-in
15060	loading process for a frontend.
15061	</desc>
15062	<param name="frontendName" type="wstring" dir="in">
15063	<desc>The name of the frontend or component.</desc>
15064	</param>
15065	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15066	<desc>Array containing the plug-in modules (full paths).</desc>
15067	</param>
15068	</method>
15069
15070	<method name="IsExtPackUsable">
15071	<desc>Check if the given extension pack is loaded and usable.</desc>
15072	<param name="name" type="wstring" dir="in">
15073	<desc>The name of the extension pack to check for.</desc>
15074	</param>
15075	<param name="usable" type="boolean" dir="return">
15076	<desc>Is the given extension pack loaded and usable.</desc>
15077	</param>
15078	</method>
15079
15080	</interface>
15081
15082	<!--
15083	// BandwidthGroupType
15084	/////////////////////////////////////////////////////////////////////////
15085	-->
15086	<enum
15087	name="BandwidthGroupType"
15088	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15089
15090	<desc>
15091	Type of a bandwidth control group.
15092	</desc>
15093
15094	<const name="Null" value="0">
15095	<desc>
15096	Null type, must be first.
15097	</desc>
15098	</const>
15099
15100	<const name="Disk" value="1">
15101	<desc>
15102	The bandwidth group controls disk I/O.
15103	</desc>
15104	</const>
15105
15106	<const name="Network" value="2">
15107	<desc>
15108	The bandwidth group controls network I/O.
15109	</desc>
15110	</const>
15111
15112	</enum>
15113
15114	<!--
15115	// IBandwidthGroup
15116	/////////////////////////////////////////////////////////////////////////
15117	-->
15118	<interface
15119	name="IBandwidthGroup" extends="$unknown"
15120	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15121	wsmap="managed"
15122	>
15123	<desc>Represents one bandwidth group.</desc>
15124
15125	<attribute name="name" type="wstring" readonly="yes">
15126	<desc>Name of the group.</desc>
15127	</attribute>
15128
15129	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15130	<desc>Type of the group.</desc>
15131	</attribute>
15132
15133	<attribute name="reference" type="unsigned long" readonly="yes">
15134	<desc>How many devices/medium attachements use this group.</desc>
15135	</attribute>
15136
15137	<attribute name="maxMbPerSec" type="unsigned long">
15138	<desc>The maximum number of MB which can be transfered by all
15139	entities attached to this group during one second.</desc>
15140	</attribute>
15141
15142	</interface>
15143
15144	<!--
15145	// IBandwidthControl
15146	/////////////////////////////////////////////////////////////////////////
15147	-->
15148	<interface
15149	name="IBandwidthControl" extends="$unknown"
15150	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15151	wsmap="managed"
15152	>
15153	<desc>
15154	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15155	This includes network and disk I/O.
15156	</desc>
15157
15158	<attribute name="numGroups" type="unsigned long" readonly="yes">
15159	<desc>
15160	The current number of existing bandwidth groups managed.
15161	</desc>
15162	</attribute>
15163
15164	<method name="CreateBandwidthGroup">
15165	<desc>
15166	Creates a new bandwidth group.
15167	</desc>
15168
15169	<param name="name" type="wstring" dir="in">
15170	<desc>Name of the bandwidth group.</desc>
15171	</param>
15172	<param name="type" type="BandwidthGroupType" dir="in">
15173	<desc>The type of the bandwidth group (network or disk).</desc>
15174	</param>
15175	<param name="maxBytesPerSec" type="unsigned long" dir="in">
15176	<desc>The maximum number of bytes which can be transfered by all
15177	entities attached to this group during one second.</desc>
15178	</param>
15179	</method>
15180
15181	<method name="DeleteBandwidthGroup">
15182	<desc>
15183	Deletes a new bandwidth group.
15184	</desc>
15185
15186	<param name="name" type="wstring" dir="in">
15187	<desc>Name of the bandwidth group to delete.</desc>
15188	</param>
15189	</method>
15190
15191	<method name="GetBandwidthGroup" const="yes">
15192	<desc>
15193	Get a bandwidth group by name.
15194	</desc>
15195
15196	<param name="name" type="wstring" dir="in">
15197	<desc>Name of the bandwidth group to get.</desc>
15198	</param>
15199	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15200	<desc>Where to store the bandwidth group on success.</desc>
15201	</param>
15202	</method>
15203
15204	<method name="GetAllBandwidthGroups" const="yes">
15205	<desc>
15206	Get all managed bandwidth groups.
15207	</desc>
15208
15209	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15210	<desc>The array of managed bandwidth groups.</desc>
15211	</param>
15212	</method>
15213	</interface>
15214
15215	<!--
15216	// IVirtualBoxClient
15217	/////////////////////////////////////////////////////////////////////////
15218	-->
15219
15220	<interface
15221	name="IVirtualBoxClient" extends="$unknown"
15222	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15223	wsmap="suppress"
15224	>
15225	<desc>
15226	Convenience interface for client applications. Treat this as a
15227	singleton, i.e. never create more than one instance of this interface.
15228
15229	At the moment only available for clients of the local API (not usable
15230	via the webservice). Once the session logic is redesigned this might
15231	change.
15232	</desc>
15233
15234	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15235	<desc>
15236	Reference to the server-side API root object.
15237	</desc>
15238	</attribute>
15239
15240	<attribute name="session" type="ISession" readonly="yes">
15241	<desc>
15242	Create a new session object and return the reference to it.
15243	</desc>
15244	</attribute>
15245
15246	<attribute name="eventSource" type="IEventSource" readonly="yes">
15247	<desc>
15248	Event source for VirtualBoxClient events.
15249	</desc>
15250	</attribute>
15251
15252	</interface>
15253
15254	<!--
15255	// Events
15256	/////////////////////////////////////////////////////////////////////////
15257	-->
15258	<enum
15259	name="VBoxEventType"
15260	uuid="e71c487f-755e-46e9-a476-dd6a5d134597"
15261	>
15262
15263	<desc>
15264	Type of an event.
15265	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15266	</desc>
15267
15268	<const name="Invalid" value="0">
15269	<desc>
15270	Invalid event, must be first.
15271	</desc>
15272	</const>
15273
15274	<const name="Any" value="1">
15275	<desc>
15276	Wildcard for all events.
15277	Events of this type are never delivered, and only used in
15278	registerListener() call to simplify registration.
15279	</desc>
15280	</const>
15281
15282	<const name="Vetoable" value="2">
15283	<desc>
15284	Wildcard for all vetoable events. Events of this type are never delivered, and only
15285	used in registerListener() call to simplify registration.
15286	</desc>
15287	</const>
15288
15289	<const name="MachineEvent" value="3">
15290	<desc>
15291	Wildcard for all machine events. Events of this type are never delivered, and only used in
15292	registerListener() call to simplify registration.
15293	</desc>
15294	</const>
15295
15296	<const name="SnapshotEvent" value="4">
15297	<desc>
15298	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15299	registerListener() call to simplify registration.
15300	</desc>
15301	</const>
15302
15303	<const name="InputEvent" value="5">
15304	<desc>
15305	Wildcard for all input device (keyboard, mouse) events.
15306	Events of this type are never delivered, and only used in
15307	registerListener() call to simplify registration.
15308	</desc>
15309	</const>
15310
15311	<const name="LastWildcard" value="31">
15312	<desc>
15313	Last wildcard.
15314	</desc>
15315	</const>
15316
15317	<const name="OnMachineStateChanged" value="32">
15318	<desc>
15319	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15320	</desc>
15321	</const>
15322	<const name="OnMachineDataChanged" value="33">
15323	<desc>
15324	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15325	</desc>
15326	</const>
15327	<const name="OnExtraDataChanged" value="34">
15328	<desc>
15329	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15330	</desc>
15331	</const>
15332	<const name="OnExtraDataCanChange" value="35">
15333	<desc>
15334	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15335	</desc>
15336	</const>
15337	<const name="OnMediumRegistered" value="36">
15338	<desc>
15339	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15340	</desc>
15341	</const>
15342	<const name="OnMachineRegistered" value="37">
15343	<desc>
15344	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15345	</desc>
15346	</const>
15347	<const name="OnSessionStateChanged" value="38">
15348	<desc>
15349	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15350	</desc>
15351	</const>
15352	<const name="OnSnapshotTaken" value="39">
15353	<desc>
15354	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15355	</desc>
15356	</const>
15357	<const name="OnSnapshotDeleted" value="40">
15358	<desc>
15359	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15360	</desc>
15361	</const>
15362	<const name="OnSnapshotChanged" value="41">
15363	<desc>
15364	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15365	</desc>
15366	</const>
15367	<const name="OnGuestPropertyChanged" value="42">
15368	<desc>
15369	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15370	</desc>
15371	</const>
15372	<!-- Console events -->
15373	<const name="OnMousePointerShapeChanged" value="43">
15374	<desc>
15375	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15376	</desc>
15377	</const>
15378	<const name="OnMouseCapabilityChanged" value="44">
15379	<desc>
15380	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15381	</desc>
15382	</const>
15383	<const name="OnKeyboardLedsChanged" value="45">
15384	<desc>
15385	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15386	</desc>
15387	</const>
15388	<const name="OnStateChanged" value="46">
15389	<desc>
15390	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15391	</desc>
15392	</const>
15393	<const name="OnAdditionsStateChanged" value="47">
15394	<desc>
15395	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15396	</desc>
15397	</const>
15398	<const name="OnNetworkAdapterChanged" value="48">
15399	<desc>
15400	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15401	</desc>
15402	</const>
15403	<const name="OnSerialPortChanged" value="49">
15404	<desc>
15405	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15406	</desc>
15407	</const>
15408	<const name="OnParallelPortChanged" value="50">
15409	<desc>
15410	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15411	</desc>
15412	</const>
15413	<const name="OnStorageControllerChanged" value="51">
15414	<desc>
15415	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15416	</desc>
15417	</const>
15418	<const name="OnMediumChanged" value="52">
15419	<desc>
15420	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15421	</desc>
15422	</const>
15423	<const name="OnVRDEServerChanged" value="53">
15424	<desc>
15425	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15426	</desc>
15427	</const>
15428	<const name="OnUSBControllerChanged" value="54">
15429	<desc>
15430	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15431	</desc>
15432	</const>
15433	<const name="OnUSBDeviceStateChanged" value="55">
15434	<desc>
15435	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15436	</desc>
15437	</const>
15438	<const name="OnSharedFolderChanged" value="56">
15439	<desc>
15440	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15441	</desc>
15442	</const>
15443	<const name="OnRuntimeError" value="57">
15444	<desc>
15445	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15446	</desc>
15447	</const>
15448	<const name="OnCanShowWindow" value="58">
15449	<desc>
15450	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15451	</desc>
15452	</const>
15453	<const name="OnShowWindow" value="59">
15454	<desc>
15455	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15456	</desc>
15457	</const>
15458	<const name="OnCPUChanged" value="60">
15459	<desc>
15460	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15461	</desc>
15462	</const>
15463	<const name="OnVRDEServerInfoChanged" value="61">
15464	<desc>
15465	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15466	</desc>
15467	</const>
15468	<const name="OnEventSourceChanged" value="62">
15469	<desc>
15470	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15471	</desc>
15472	</const>
15473	<const name="OnCPUExecutionCapChanged" value="63">
15474	<desc>
15475	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15476	</desc>
15477	</const>
15478	<const name="OnGuestKeyboard" value="64">
15479	<desc>
15480	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15481	</desc>
15482	</const>
15483	<const name="OnGuestMouse" value="65">
15484	<desc>
15485	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15486	</desc>
15487	</const>
15488	<const name="OnNATRedirect" value="66">
15489	<desc>
15490	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15491	</desc>
15492	</const>
15493	<const name="OnHostPciDevicePlug" value="67">
15494	<desc>
15495	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15496	</desc>
15497	</const>
15498	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15499	<desc>
15500	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15501	</desc>
15502	</const>
15503	<const name="OnBandwidthGroupChanged" value="69">
15504	<desc>
15505	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15506	</desc>
15507	</const>
15508	<const name="OnGuestMonitorChanged" value="70">
15509	<desc>
15510	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15511	</desc>
15512	</const>
15513
15514	<!-- Last event marker -->
15515	<const name="Last" value="71">
15516	<desc>
15517	Must be last event, used for iterations and structures relying on numerical event values.
15518	</desc>
15519	</const>
15520
15521	</enum>
15522
15523	<interface
15524	name="IEventSource" extends="$unknown"
15525	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15526	wsmap="managed"
15527	>
15528	<desc>
15529	Event source. Generally, any object which could generate events can be an event source,
15530	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15531	an event source can work with listeners in either active or passive mode. In active mode it is up to
15532	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15533	event source keeps track of pending events for each listener and returns available events on demand.
15534
15535	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15536	</desc>
15537
15538	<method name="createListener">
15539	<desc>
15540	Creates a new listener object, useful for passive mode.
15541	</desc>
15542	<param name="listener" type="IEventListener" dir="return"/>
15543	</method>
15544
15545	<method name="createAggregator">
15546	<desc>
15547	Creates an aggregator event source, collecting events from multiple sources.
15548	This way a single listener can listen for events coming from multiple sources,
15549	using a single blocking getEvent() on the returned aggregator.
15550	</desc>
15551	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15552	<desc>
15553	Subordinate event source this one aggregatres.
15554	</desc>
15555	</param>
15556	<param name="result" type="IEventSource" dir="return">
15557	<desc>
15558	Event source aggregating passed sources.
15559	</desc>
15560	</param>
15561	</method>
15562
15563	<method name="registerListener">
15564	<desc>
15565	Register an event listener.
15566
15567	<note>
15568	To avoid system overload, the VirtualBox server process checks if passive event
15569	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15570	current implementation, if more than 500 pending events are detected for a passive
15571	event listener, it is forcefully unregistered by the system, and further
15572	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15573	</note>
15574	</desc>
15575	<param name="listener" type="IEventListener" dir="in">
15576	<desc>Listener to register.</desc>
15577	</param>
15578	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15579	<desc>
15580	Event types listener is interested in. One can use wildcards like -
15581	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15582	than one event.
15583	</desc>
15584	</param>
15585	<param name="active" type="boolean" dir="in">
15586	<desc>
15587	Which mode this listener is operating in.
15588	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15589	In passive mode, an internal event queue is created for this this IEventListener.
15590	For each event coming in, it is added to queues for all interested registered passive
15591	listeners. It is then up to the external code to call the listener's
15592	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15593	external code must call <link to="#eventProcessed" />.
15594	</desc>
15595	</param>
15596	</method>
15597
15598	<method name="unregisterListener">
15599	<desc>
15600	Unregister an event listener. If listener is passive, and some waitable events are still
15601	in queue they are marked as processed automatically.
15602	</desc>
15603	<param name="listener" type="IEventListener" dir="in">
15604	<desc>Listener to unregister.</desc>
15605	</param>
15606	</method>
15607
15608	<method name="fireEvent">
15609	<desc>
15610	Fire an event for this source.
15611	</desc>
15612	<param name="event" type="IEvent" dir="in">
15613	<desc>Event to deliver.</desc>
15614	</param>
15615	<param name="timeout" type="long" dir="in">
15616	<desc>
15617	Maximum time to wait for event processing (if event is waitable), in ms;
15618	0 = no wait, -1 = indefinite wait.
15619	</desc>
15620	</param>
15621	<param name="result" type="boolean" dir="return">
15622	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15623	</param>
15624	</method>
15625
15626	<method name="getEvent">
15627	<desc>
15628	Get events from this peer's event queue (for passive mode). Calling this method
15629	regularly is required for passive event listeners to avoid system overload;
15630	see <link to="IEventSource::registerListener" /> for details.
15631
15632	<result name="VBOX_E_OBJECT_NOT_FOUND">
15633	Listener is not registered, or autounregistered.
15634	</result>
15635	</desc>
15636	<param name="listener" type="IEventListener" dir="in">
15637	<desc>Which listener to get data for.</desc>
15638	</param>
15639	<param name="timeout" type="long" dir="in">
15640	<desc>
15641	Maximum time to wait for events, in ms;
15642	0 = no wait, -1 = indefinite wait.
15643	</desc>
15644	</param>
15645	<param name="event" type="IEvent" dir="return">
15646	<desc>Event retrieved, or null if none available.</desc>
15647	</param>
15648	</method>
15649
15650	<method name="eventProcessed">
15651	<desc>
15652	Must be called for waitable events after a particular listener finished its
15653	event processing. When all listeners of a particular event have called this
15654	method, the system will then call <link to="IEvent::setProcessed" />.
15655	</desc>
15656	<param name="listener" type="IEventListener" dir="in">
15657	<desc>Which listener processed event.</desc>
15658	</param>
15659	<param name="event" type="IEvent" dir="in">
15660	<desc>Which event.</desc>
15661	</param>
15662	</method>
15663
15664	</interface>
15665
15666	<interface
15667	name="IEventListener" extends="$unknown"
15668	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15669	wsmap="managed"
15670	>
15671	<desc>
15672	Event listener. An event listener can work in either active or passive mode, depending on the way
15673	it was registered.
15674	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15675	</desc>
15676
15677	<method name="handleEvent">
15678	<desc>
15679	Handle event callback for active listeners. It is not called for passive listeners. After
15680	calling handleEvent() on all active listeners and having received acknowledgement from all
15681	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15682	IEvent::waitProcessed() will return immediately.
15683	</desc>
15684	<param name="event" type="IEvent" dir="in">
15685	<desc>Event available.</desc>
15686	</param>
15687	</method>
15688
15689	</interface>
15690
15691	<interface
15692	name="IEvent" extends="$unknown"
15693	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15694	wsmap="managed"
15695	>
15696	<desc>
15697	Abstract parent interface for VirtualBox events. Actual events will typically implement
15698	a more specific interface which derives from this (see below).
15699
15700	<b>Introduction to VirtualBox events</b>
15701
15702	Generally speaking, an event (represented by this interface) signals that something
15703	happened, while an event listener (see <link to="IEventListener" />) represents an
15704	entity that is interested in certain events. In order for this to work with
15705	unidirectional protocols (i.e. web services), the concepts of passive and active
15706	listener are used.
15707
15708	Event consumers can register themselves as listeners, providing an array of
15709	events they are interested in (see <link to="IEventSource::registerListener" />).
15710	When an event triggers, the listener is notified about the event. The exact
15711	mechanism of the notification depends on whether the listener was registered as
15712	an active or passive listener:
15713
15714	<ul>
15715	<li>An active listener is very similar to a callback: it is a function invoked
15716	by the API. As opposed to the callbacks that were used in the API before
15717	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15718	</li>
15719
15720	<li>Passive listeners are somewhat trickier to implement, but do not require
15721	a client function to be callable, which is not an option with scripting
15722	languages or web service clients. Internally the <link to="IEventSource" />
15723	implementation maintains an event queue for each passive listener, and
15724	newly arrived events are put in this queue. When the listener calls
15725	<link to="IEventSource::getEvent"/>, first element from its internal event
15726	queue is returned. When the client completes processing of an event,
15727	the <link to="IEventSource::eventProcessed" /> function must be called,
15728	acknowledging that the event was processed. It supports implementing
15729	waitable events. On passive listener unregistration, all events from its
15730	queue are auto-acknowledged.
15731	</li>
15732	</ul>
15733
15734	Waitable events are useful in situations where the event generator wants to track
15735	delivery or a party wants to wait until all listeners have completed the event. A
15736	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15737	listeners might veto a certain action, and thus the event producer has to make
15738	sure that all listeners have processed the event and not vetoed before taking
15739	the action.
15740
15741	A given event may have both passive and active listeners at the same time.
15742
15743	<b>Using events</b>
15744
15745	Any VirtualBox object capable of producing externally visible events provides an
15746	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15747	This event source object is notified by VirtualBox once something has happened, so
15748	consumers may register event listeners with this event source. To register a listener,
15749	an object implementing the <link to="IEventListener" /> interface must be provided.
15750	For active listeners, such an object is typically created by the consumer, while for
15751	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15752	note that a listener created with @c createListener() must not be used as an active listener.
15753
15754	Once created, the listener must be registered to listen for the desired events
15755	(see <link to="IEventSource::registerListener" />), providing an array of
15756	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15757	event IDs or wildcards matching multiple event IDs.
15758
15759	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15760	called automatically when the event is triggered, while passive listeners have to call
15761	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15762	an event processing loop.
15763
15764	The IEvent interface is an abstract parent interface for all such VirtualBox events
15765	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15766	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15767	then cast to the appropriate specific interface using @c QueryInterface().
15768	</desc>
15769
15770	<attribute name="type" readonly="yes" type="VBoxEventType">
15771	<desc>
15772	Event type.
15773	</desc>
15774	</attribute>
15775
15776	<attribute name="source" readonly="yes" type="IEventSource">
15777	<desc>
15778	Source of this event.
15779	</desc>
15780	</attribute>
15781
15782	<attribute name="waitable" readonly="yes" type="boolean">
15783	<desc>
15784	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15785	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15786	as no additional overhead associated with waitability imposed.
15787	Waitable events are needed when one need to be able to wait for particular event processed,
15788	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15789	until all consumers confirmed events.
15790	</desc>
15791	</attribute>
15792
15793	<method name="setProcessed">
15794	<desc>
15795	Internal method called by the system when all listeners of a particular event have called
15796	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15797	</desc>
15798	</method>
15799
15800	<method name="waitProcessed">
15801	<desc>
15802	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15803	described semantics, for non-waitable returns true immediately.
15804	</desc>
15805	<param name="timeout" type="long" dir="in">
15806	<desc>
15807	Maximum time to wait for event processeing, in ms;
15808	0 = no wait, -1 = indefinite wait.
15809	</desc>
15810	</param>
15811	<param name="result" type="boolean" dir="return">
15812	<desc>If this event was processed before timeout.</desc>
15813	</param>
15814	</method>
15815	</interface>
15816
15817
15818	<interface
15819	name="IReusableEvent" extends="IEvent"
15820	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15821	wsmap="managed"
15822	>
15823	<desc>Base abstract interface for all reusable events.</desc>
15824
15825	<attribute name="generation" readonly="yes" type="unsigned long">
15826	<desc>Current generation of event, incremented on reuse.</desc>
15827	</attribute>
15828
15829	<method name="reuse">
15830	<desc>
15831	Marks an event as reused, increments 'generation', fields shall no
15832	longer be considered valid.
15833	</desc>
15834	</method>
15835	</interface>
15836
15837	<interface
15838	name="IMachineEvent" extends="IEvent"
15839	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15840	wsmap="managed" id="MachineEvent"
15841	>
15842	<desc>Base abstract interface for all machine events.</desc>
15843
15844	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15845	<desc>ID of the machine this event relates to.</desc>
15846	</attribute>
15847
15848	</interface>
15849
15850	<interface
15851	name="IMachineStateChangedEvent" extends="IMachineEvent"
15852	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15853	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15854	>
15855	<desc>Machine state change event.</desc>
15856
15857	<attribute name="state" readonly="yes" type="MachineState">
15858	<desc>New execution state.</desc>
15859	</attribute>
15860	</interface>
15861
15862	<interface
15863	name="IMachineDataChangedEvent" extends="IMachineEvent"
15864	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15865	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15866	>
15867	<desc>
15868	Any of the settings of the given machine has changed.
15869	</desc>
15870	</interface>
15871
15872	<interface
15873	name="IMediumRegisteredEvent" extends="IEvent"
15874	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15875	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15876	>
15877	<desc>
15878	The given medium was registered or unregistered
15879	within this VirtualBox installation.
15880	</desc>
15881
15882	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
15883	<desc>ID of the medium this event relates to.</desc>
15884	</attribute>
15885
15886	<attribute name="mediumType" readonly="yes" type="DeviceType">
15887	<desc>Type of the medium this event relates to.</desc>
15888	</attribute>
15889
15890	<attribute name="registered" type="boolean" readonly="yes">
15891	<desc>
15892	If @c true, the medium was registered, otherwise it was
15893	unregistered.
15894	</desc>
15895	</attribute>
15896	</interface>
15897
15898	<interface
15899	name="IMachineRegisteredEvent" extends="IMachineEvent"
15900	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
15901	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
15902	>
15903	<desc>
15904	The given machine was registered or unregistered
15905	within this VirtualBox installation.
15906	</desc>
15907
15908	<attribute name="registered" type="boolean" readonly="yes">
15909	<desc>
15910	If @c true, the machine was registered, otherwise it was
15911	unregistered.
15912	</desc>
15913	</attribute>
15914	</interface>
15915
15916	<interface
15917	name="ISessionStateChangedEvent" extends="IMachineEvent"
15918	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
15919	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
15920	>
15921	<desc>
15922	The state of the session for the given machine was changed.
15923	<see>IMachine::sessionState</see>
15924	</desc>
15925
15926	<attribute name="state" type="SessionState" readonly="yes">
15927	<desc>
15928	New session state.
15929	</desc>
15930	</attribute>
15931	</interface>
15932
15933	<interface
15934	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
15935	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
15936	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
15937	>
15938	<desc>
15939	Notification when a guest property has changed.
15940	</desc>
15941
15942	<attribute name="name" readonly="yes" type="wstring">
15943	<desc>
15944	The name of the property that has changed.
15945	</desc>
15946	</attribute>
15947
15948	<attribute name="value" readonly="yes" type="wstring">
15949	<desc>
15950	The new property value.
15951	</desc>
15952	</attribute>
15953
15954	<attribute name="flags" readonly="yes" type="wstring">
15955	<desc>
15956	The new property flags.
15957	</desc>
15958	</attribute>
15959
15960	</interface>
15961
15962	<interface
15963	name="ISnapshotEvent" extends="IMachineEvent"
15964	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
15965	wsmap="managed" id="SnapshotEvent"
15966	>
15967	<desc>Base interface for all snapshot events.</desc>
15968
15969	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
15970	<desc>ID of the snapshot this event relates to.</desc>
15971	</attribute>
15972
15973	</interface>
15974
15975	<interface
15976	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
15977	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
15978	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
15979	>
15980	<desc>
15981	A new snapshot of the machine has been taken.
15982	<see>ISnapshot</see>
15983	</desc>
15984	</interface>
15985
15986	<interface
15987	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
15988	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
15989	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
15990	>
15991	<desc>
15992	Snapshot of the given machine has been deleted.
15993
15994	<note>
15995	This notification is delivered <b>after</b> the snapshot
15996	object has been uninitialized on the server (so that any
15997	attempt to call its methods will return an error).
15998	</note>
15999
16000	<see>ISnapshot</see>
16001	</desc>
16002	</interface>
16003
16004	<interface
16005	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16006	uuid="07541941-8079-447a-a33e-47a69c7980db"
16007	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16008	>
16009	<desc>
16010	Snapshot properties (name and/or description) have been changed.
16011	<see>ISnapshot</see>
16012	</desc>
16013	</interface>
16014
16015	<interface
16016	name="IMousePointerShapeChangedEvent" extends="IEvent"
16017	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16018	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16019	>
16020	<desc>
16021	Notification when the guest mouse pointer shape has
16022	changed. The new shape data is given.
16023	</desc>
16024
16025	<attribute name="visible" type="boolean" readonly="yes">
16026	<desc>
16027	Flag whether the pointer is visible.
16028	</desc>
16029	</attribute>
16030	<attribute name="alpha" type="boolean" readonly="yes">
16031	<desc>
16032	Flag whether the pointer has an alpha channel.
16033	</desc>
16034	</attribute>
16035	<attribute name="xhot" type="unsigned long" readonly="yes">
16036	<desc>
16037	The pointer hot spot X coordinate.
16038	</desc>
16039	</attribute>
16040	<attribute name="yhot" type="unsigned long" readonly="yes">
16041	<desc>
16042	The pointer hot spot Y coordinate.
16043	</desc>
16044	</attribute>
16045	<attribute name="width" type="unsigned long" readonly="yes">
16046	<desc>
16047	Width of the pointer shape in pixels.
16048	</desc>
16049	</attribute>
16050	<attribute name="height" type="unsigned long" readonly="yes">
16051	<desc>
16052	Height of the pointer shape in pixels.
16053	</desc>
16054	</attribute>
16055	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16056	<desc>
16057	Shape buffer arrays.
16058
16059	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16060	followed by a 32-bpp XOR (color) mask.
16061
16062	For pointers without alpha channel the XOR mask pixels are 32
16063	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16064	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16065
16066	An AND mask is used for pointers with alpha channel, so if the
16067	callback does not support alpha, the pointer could be
16068	displayed as a normal color pointer.
16069
16070	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16071	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16072	height</tt>. The padding bits at the end of each scanline are
16073	undefined.
16074
16075	The XOR mask follows the AND mask on the next 4-byte aligned
16076	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16077	Bytes in the gap between the AND and the XOR mask are undefined.
16078	The XOR mask scanlines have no gap between them and the size of
16079	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16080
16081	<note>
16082	If @a shape is 0, only the pointer visibility is changed.
16083	</note>
16084	</desc>
16085	</attribute>
16086	</interface>
16087
16088	<interface
16089	name="IMouseCapabilityChangedEvent" extends="IEvent"
16090	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
16091	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
16092	>
16093	<desc>
16094	Notification when the mouse capabilities reported by the
16095	guest have changed. The new capabilities are passed.
16096	</desc>
16097	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16098	<desc>
16099	Supports absolute coordinates.
16100	</desc>
16101	</attribute>
16102	<attribute name="supportsRelative" type="boolean" readonly="yes">
16103	<desc>
16104	Supports relative coordinates.
16105	</desc>
16106	</attribute>
16107	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16108	<desc>
16109	If host cursor is needed.
16110	</desc>
16111	</attribute>
16112	</interface>
16113
16114	<interface
16115	name="IKeyboardLedsChangedEvent" extends="IEvent"
16116	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16117	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16118	>
16119	<desc>
16120	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16121	to alter the state of the keyboard LEDs.
16122	</desc>
16123	<attribute name="numLock" type="boolean" readonly="yes">
16124	<desc>
16125	NumLock status.
16126	</desc>
16127	</attribute>
16128	<attribute name="capsLock" type="boolean" readonly="yes">
16129	<desc>
16130	CapsLock status.
16131	</desc>
16132	</attribute>
16133	<attribute name="scrollLock" type="boolean" readonly="yes">
16134	<desc>
16135	ScrollLock status.
16136	</desc>
16137	</attribute>
16138	</interface>
16139
16140	<interface
16141	name="IStateChangedEvent" extends="IEvent"
16142	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16143	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16144	>
16145	<desc>
16146	Notification when the execution state of the machine has changed.
16147	The new state is given.
16148	</desc>
16149	<attribute name="state" type="MachineState" readonly="yes">
16150	<desc>
16151	New machine state.
16152	</desc>
16153	</attribute>
16154	</interface>
16155
16156	<interface
16157	name="IAdditionsStateChangedEvent" extends="IEvent"
16158	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16159	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16160	>
16161	<desc>
16162	Notification when a Guest Additions property changes.
16163	Interested callees should query IGuest attributes to
16164	find out what has changed.
16165	</desc>
16166	</interface>
16167
16168	<interface
16169	name="INetworkAdapterChangedEvent" extends="IEvent"
16170	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16171	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16172	>
16173	<desc>
16174	Notification when a property of one of the
16175	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16176	changes. Interested callees should use INetworkAdapter methods and
16177	attributes to find out what has changed.
16178	</desc>
16179	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16180	<desc>
16181	Network adapter that is subject to change.
16182	</desc>
16183	</attribute>
16184	</interface>
16185
16186	<interface
16187	name="ISerialPortChangedEvent" extends="IEvent"
16188	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16189	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16190	>
16191	<desc>
16192	Notification when a property of one of the
16193	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16194	Interested callees should use ISerialPort methods and attributes
16195	to find out what has changed.
16196	</desc>
16197	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16198	<desc>
16199	Serial port that is subject to change.
16200	</desc>
16201	</attribute>
16202	</interface>
16203
16204	<interface
16205	name="IParallelPortChangedEvent" extends="IEvent"
16206	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16207	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16208	>
16209	<desc>
16210	Notification when a property of one of the
16211	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16212	changes. Interested callees should use ISerialPort methods and
16213	attributes to find out what has changed.
16214	</desc>
16215	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16216	<desc>
16217	Parallel port that is subject to change.
16218	</desc>
16219	</attribute>
16220	</interface>
16221
16222	<interface
16223	name="IStorageControllerChangedEvent" extends="IEvent"
16224	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16225	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16226	>
16227	<desc>
16228	Notification when a
16229	<link to="IMachine::mediumAttachments">medium attachment</link>
16230	changes.
16231	</desc>
16232	</interface>
16233
16234	<interface
16235	name="IMediumChangedEvent" extends="IEvent"
16236	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16237	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16238	>
16239	<desc>
16240	Notification when a
16241	<link to="IMachine::mediumAttachments">medium attachment</link>
16242	changes.
16243	</desc>
16244	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16245	<desc>
16246	Medium attachment that is subject to change.
16247	</desc>
16248	</attribute>
16249	</interface>
16250
16251	<interface
16252	name="ICPUChangedEvent" extends="IEvent"
16253	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16254	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16255	>
16256	<desc>
16257	Notification when a CPU changes.
16258	</desc>
16259	<attribute name="cpu" type="unsigned long" readonly="yes">
16260	<desc>
16261	The CPU which changed.
16262	</desc>
16263	</attribute>
16264	<attribute name="add" type="boolean" readonly="yes">
16265	<desc>
16266	Flag whether the CPU was added or removed.
16267	</desc>
16268	</attribute>
16269	</interface>
16270
16271	<interface
16272	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16273	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16274	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16275	>
16276	<desc>
16277	Notification when the CPU execution cap changes.
16278	</desc>
16279	<attribute name="executionCap" type="unsigned long" readonly="yes">
16280	<desc>
16281	The new CPU execution cap value. (1-100)
16282	</desc>
16283	</attribute>
16284	</interface>
16285
16286	<interface
16287	name="IGuestKeyboardEvent" extends="IEvent"
16288	uuid="88394258-7006-40d4-b339-472ee3801844"
16289	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16290	>
16291	<desc>
16292	Notification when guest keyboard event happens.
16293	</desc>
16294	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16295	<desc>
16296	Array of scancodes.
16297	</desc>
16298	</attribute>
16299	</interface>
16300
16301	<interface
16302	name="IGuestMouseEvent" extends="IReusableEvent"
16303	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16304	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16305	>
16306	<desc>
16307	Notification when guest mouse event happens.
16308	</desc>
16309
16310	<attribute name="absolute" type="boolean" readonly="yes">
16311	<desc>
16312	If this event is relative or absolute.
16313	</desc>
16314	</attribute>
16315
16316	<attribute name="x" type="long" readonly="yes">
16317	<desc>
16318	New X position, or X delta.
16319	</desc>
16320	</attribute>
16321
16322	<attribute name="y" type="long" readonly="yes">
16323	<desc>
16324	New Y position, or Y delta.
16325	</desc>
16326	</attribute>
16327
16328	<attribute name="z" type="long" readonly="yes">
16329	<desc>
16330	Z delta.
16331	</desc>
16332	</attribute>
16333
16334	<attribute name="w" type="long" readonly="yes">
16335	<desc>
16336	W delta.
16337	</desc>
16338	</attribute>
16339
16340	<attribute name="buttons" type="long" readonly="yes">
16341	<desc>
16342	Button state bitmask.
16343	</desc>
16344	</attribute>
16345
16346	</interface>
16347
16348
16349	<interface
16350	name="IVRDEServerChangedEvent" extends="IEvent"
16351	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16352	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16353	>
16354	<desc>
16355	Notification when a property of the
16356	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16357	Interested callees should use IVRDEServer methods and attributes to
16358	find out what has changed.
16359	</desc>
16360	</interface>
16361
16362	<interface
16363	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16364	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16365	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16366	>
16367	<desc>
16368	Notification when the status of the VRDE server changes. Interested callees
16369	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16370	attributes to find out what is the current status.
16371	</desc>
16372	</interface>
16373
16374	<interface
16375	name="IUSBControllerChangedEvent" extends="IEvent"
16376	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16377	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16378	>
16379	<desc>
16380	Notification when a property of the virtual
16381	<link to="IMachine::USBController">USB controller</link> changes.
16382	Interested callees should use IUSBController methods and attributes to
16383	find out what has changed.
16384	</desc>
16385	</interface>
16386
16387	<interface
16388	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16389	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16390	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16391	>
16392	<desc>
16393	Notification when a USB device is attached to or detached from
16394	the virtual USB controller.
16395
16396	This notification is sent as a result of the indirect
16397	request to attach the device because it matches one of the
16398	machine USB filters, or as a result of the direct request
16399	issued by <link to="IConsole::attachUSBDevice"/> or
16400	<link to="IConsole::detachUSBDevice"/>.
16401
16402	This notification is sent in case of both a succeeded and a
16403	failed request completion. When the request succeeds, the
16404	@a error parameter is @c null, and the given device has been
16405	already added to (when @a attached is @c true) or removed from
16406	(when @a attached is @c false) the collection represented by
16407	<link to="IConsole::USBDevices"/>. On failure, the collection
16408	doesn't change and the @a error parameter represents the error
16409	message describing the failure.
16410	</desc>
16411	<attribute name="device" type="IUSBDevice" readonly="yes">
16412	<desc>
16413	Device that is subject to state change.
16414	</desc>
16415	</attribute>
16416	<attribute name="attached" type="boolean" readonly="yes">
16417	<desc>
16418	@c true if the device was attached and @c false otherwise.
16419	</desc>
16420	</attribute>
16421	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16422	<desc>
16423	@c null on success or an error message object on failure.
16424	</desc>
16425	</attribute>
16426	</interface>
16427
16428	<interface
16429	name="ISharedFolderChangedEvent" extends="IEvent"
16430	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16431	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16432	>
16433	<desc>
16434	Notification when a shared folder is added or removed.
16435	The @a scope argument defines one of three scopes:
16436	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16437	(<link to="Scope_Global">Global</link>),
16438	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16439	the machine (<link to="Scope_Machine">Machine</link>) or <link
16440	to="IConsole::sharedFolders">transient shared folders</link> of the
16441	machine (<link to="Scope_Session">Session</link>). Interested callees
16442	should use query the corresponding collections to find out what has
16443	changed.
16444	</desc>
16445	<attribute name="scope" type="Scope" readonly="yes">
16446	<desc>
16447	Scope of the notification.
16448	</desc>
16449	</attribute>
16450	</interface>
16451
16452	<interface
16453	name="IRuntimeErrorEvent" extends="IEvent"
16454	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16455	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16456	>
16457	<desc>
16458	Notification when an error happens during the virtual
16459	machine execution.
16460
16461	There are three kinds of runtime errors:
16462	<ul>
16463	<li><i>fatal</i></li>
16464	<li><i>non-fatal with retry</i></li>
16465	<li><i>non-fatal warnings</i></li>
16466	</ul>
16467
16468	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16469	to @c true. In case of fatal errors, the virtual machine
16470	execution is always paused before calling this notification, and
16471	the notification handler is supposed either to immediately save
16472	the virtual machine state using <link to="IConsole::saveState"/>
16473	or power it off using <link to="IConsole::powerDown"/>.
16474	Resuming the execution can lead to unpredictable results.
16475
16476	<b>Non-fatal</b> errors and warnings are indicated by the
16477	@a fatal parameter set to @c false. If the virtual machine
16478	is in the Paused state by the time the error notification is
16479	received, it means that the user can <i>try to resume</i> the machine
16480	execution after attempting to solve the problem that caused the
16481	error. In this case, the notification handler is supposed
16482	to show an appropriate message to the user (depending on the
16483	value of the @a id parameter) that offers several actions such
16484	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16485	wants to retry, the notification handler should continue
16486	the machine execution using the <link to="IConsole::resume"/>
16487	call. If the machine execution is not Paused during this
16488	notification, then it means this notification is a <i>warning</i>
16489	(for example, about a fatal condition that can happen very soon);
16490	no immediate action is required from the user, the machine
16491	continues its normal execution.
16492
16493	Note that in either case the notification handler
16494	<b>must not</b> perform any action directly on a thread
16495	where this notification is called. Everything it is allowed to
16496	do is to post a message to another thread that will then talk
16497	to the user and take the corresponding action.
16498
16499	Currently, the following error identifiers are known:
16500	<ul>
16501	<li><tt>"HostMemoryLow"</tt></li>
16502	<li><tt>"HostAudioNotResponding"</tt></li>
16503	<li><tt>"VDIStorageFull"</tt></li>
16504	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16505	</ul>
16506	</desc>
16507	<attribute name="fatal" type="boolean" readonly="yes">
16508	<desc>
16509	Whether the error is fatal or not.
16510	</desc>
16511	</attribute>
16512	<attribute name="id" type="wstring" readonly="yes">
16513	<desc>
16514	Error identifier.
16515	</desc>
16516	</attribute>
16517	<attribute name="message" type="wstring" readonly="yes">
16518	<desc>
16519	Optional error message.
16520	</desc>
16521	</attribute>
16522	</interface>
16523
16524
16525	<interface
16526	name="IEventSourceChangedEvent" extends="IEvent"
16527	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16528	waitable="yes"
16529	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16530	>
16531	<desc>
16532	Notification when an event source state changes (listener added or removed).
16533	</desc>
16534
16535	<attribute name="listener" type="IEventListener" readonly="yes">
16536	<desc>
16537	Event listener which has changed.
16538	</desc>
16539	</attribute>
16540
16541	<attribute name="add" type="boolean" readonly="yes">
16542	<desc>
16543	Flag whether listener was added or removed.
16544	</desc>
16545	</attribute>
16546	</interface>
16547
16548	<interface
16549	name="IExtraDataChangedEvent" extends="IEvent"
16550	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16551	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16552	>
16553	<desc>
16554	Notification when machine specific or global extra data
16555	has changed.
16556	</desc>
16557	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16558	<desc>
16559	ID of the machine this event relates to.
16560	Null for global extra data changes.
16561	</desc>
16562	</attribute>
16563	<attribute name="key" type="wstring" readonly="yes">
16564	<desc>
16565	Extra data key that has changed.
16566	</desc>
16567	</attribute>
16568	<attribute name="value" type="wstring" readonly="yes">
16569	<desc>
16570	Extra data value for the given key.
16571	</desc>
16572	</attribute>
16573	</interface>
16574
16575	<interface
16576	name="IVetoEvent" extends="IEvent"
16577	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16578	wsmap="managed"
16579	>
16580	<desc>Base abstract interface for veto events.</desc>
16581
16582	<method name="addVeto">
16583	<desc>
16584	Adds a veto on this event.
16585	</desc>
16586	<param name="reason" type="wstring" dir="in">
16587	<desc>
16588	Reason for veto, could be null or empty string.
16589	</desc>
16590	</param>
16591	</method>
16592
16593	<method name="isVetoed">
16594	<desc>
16595	If this event was vetoed.
16596	</desc>
16597	<param name="result" type="boolean" dir="return">
16598	<desc>
16599	Reason for veto.
16600	</desc>
16601	</param>
16602	</method>
16603
16604	<method name="getVetos">
16605	<desc>
16606	Current veto reason list, if size is 0 - no veto.
16607	</desc>
16608	<param name="result" type="wstring" dir="return" safearray="yes">
16609	<desc>
16610	Array of reasons for veto provided by different event handlers.
16611	</desc>
16612	</param>
16613	</method>
16614
16615	</interface>
16616
16617	<interface
16618	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16619	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16620	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16621	waitable="true"
16622	>
16623	<desc>
16624	Notification when someone tries to change extra data for
16625	either the given machine or (if @c null) global extra data.
16626	This gives the chance to veto against changes.
16627	</desc>
16628	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16629	<desc>
16630	ID of the machine this event relates to.
16631	Null for global extra data changes.
16632	</desc>
16633	</attribute>
16634	<attribute name="key" type="wstring" readonly="yes">
16635	<desc>
16636	Extra data key that has changed.
16637	</desc>
16638	</attribute>
16639	<attribute name="value" type="wstring" readonly="yes">
16640	<desc>
16641	Extra data value for the given key.
16642	</desc>
16643	</attribute>
16644	</interface>
16645
16646	<interface
16647	name="ICanShowWindowEvent" extends="IVetoEvent"
16648	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16649	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16650	waitable="true"
16651	>
16652	<desc>
16653	Notification when a call to
16654	<link to="IMachine::canShowConsoleWindow"/> is made by a
16655	front-end to check if a subsequent call to
16656	<link to="IMachine::showConsoleWindow"/> can succeed.
16657
16658	The callee should give an answer appropriate to the current
16659	machine state using event veto. This answer must
16660	remain valid at least until the next
16661	<link to="IConsole::state">machine state</link> change.
16662	</desc>
16663	</interface>
16664
16665	<interface
16666	name="IShowWindowEvent" extends="IEvent"
16667	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16668	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16669	waitable="true"
16670	>
16671	<desc>
16672	Notification when a call to
16673	<link to="IMachine::showConsoleWindow"/>
16674	requests the console window to be activated and brought to
16675	foreground on the desktop of the host PC.
16676
16677	This notification should cause the VM console process to
16678	perform the requested action as described above. If it is
16679	impossible to do it at a time of this notification, this
16680	method should return a failure.
16681
16682	Note that many modern window managers on many platforms
16683	implement some sort of focus stealing prevention logic, so
16684	that it may be impossible to activate a window without the
16685	help of the currently active application (which is supposedly
16686	an initiator of this notification). In this case, this method
16687	must return a non-zero identifier that represents the
16688	top-level window of the VM console process. The caller, if it
16689	represents a currently active process, is responsible to use
16690	this identifier (in a platform-dependent manner) to perform
16691	actual window activation.
16692
16693	This method must set @a winId to zero if it has performed all
16694	actions necessary to complete the request and the console
16695	window is now active and in foreground, to indicate that no
16696	further action is required on the caller's side.
16697	</desc>
16698	<attribute name="winId" type="long long">
16699	<desc>
16700	Platform-dependent identifier of the top-level VM console
16701	window, or zero if this method has performed all actions
16702	necessary to implement the <i>show window</i> semantics for
16703	the given platform and/or this VirtualBox front-end.
16704	</desc>
16705	</attribute>
16706	</interface>
16707
16708	<interface
16709	name="INATRedirectEvent" extends="IMachineEvent"
16710	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16711	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16712	>
16713	<desc>
16714	Notification when NAT redirect rule added or removed.
16715	</desc>
16716	<attribute name="slot" type="unsigned long" readonly="yes">
16717	<desc>
16718	Adapter which NAT attached to.
16719	</desc>
16720	</attribute>
16721	<attribute name="remove" type="boolean" readonly="yes">
16722	<desc>
16723	Whether rule remove or add.
16724	</desc>
16725	</attribute>
16726	<attribute name="name" type="wstring" readonly="yes">
16727	<desc>
16728	Name of the rule.
16729	</desc>
16730	</attribute>
16731	<attribute name="proto" type="NATProtocol" readonly="yes">
16732	<desc>
16733	Protocol (TCP or UDP) of the redirect rule.
16734	</desc>
16735	</attribute>
16736	<attribute name="hostIp" type="wstring" readonly="yes">
16737	<desc>
16738	Host ip address to bind socket on.
16739	</desc>
16740	</attribute>
16741	<attribute name="hostPort" type="long" readonly="yes">
16742	<desc>
16743	Host port to bind socket on.
16744	</desc>
16745	</attribute>
16746	<attribute name="guestIp" type="wstring" readonly="yes">
16747	<desc>
16748	Guest ip address to redirect to.
16749	</desc>
16750	</attribute>
16751	<attribute name="guestPort" type="long" readonly="yes">
16752	<desc>
16753	Guest port to redirect to.
16754	</desc>
16755	</attribute>
16756	</interface>
16757
16758	<interface
16759	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16760	waitable="yes"
16761	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
16762	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16763	>
16764	<desc>
16765	Notification when host PCI device is plugged/unplugged. Plugging
16766	usually takes place on VM startup, unplug - when
16767	IMachine::DetachHostPciDevice is called.
16768
16769	<see>IMachine::DetachHostPciDevice</see>
16770
16771	</desc>
16772
16773	<attribute name="plugged" type="boolean" readonly="yes">
16774	<desc>
16775	If device successfully plugged or unplugged.
16776	</desc>
16777	</attribute>
16778
16779	<attribute name="success" type="boolean" readonly="yes">
16780	<desc>
16781	If operation was successful, if false - 'message' attribute
16782	may be of interest.
16783	</desc>
16784	</attribute>
16785
16786	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16787	<desc>
16788	Attachment info for this device.
16789	</desc>
16790	</attribute>
16791
16792	<attribute name="message" type="wstring" readonly="yes">
16793	<desc>
16794	Optional error message.
16795	</desc>
16796	</attribute>
16797
16798	</interface>
16799
16800	<interface
16801	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
16802	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
16803	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
16804	>
16805	<desc>
16806	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16807	unexpected circumstances) or available again.
16808	</desc>
16809
16810	<attribute name="available" type="boolean" readonly="yes">
16811	<desc>
16812	Whether VBoxSVC is available now.
16813	</desc>
16814	</attribute>
16815	</interface>
16816
16817	<interface
16818	name="IBandwidthGroupChangedEvent" extends="IEvent"
16819	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16820	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16821	>
16822	<desc>
16823	Notification when one of the bandwidth groups changed
16824	</desc>
16825	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16826	<desc>
16827	The changed bandwidth group.
16828	</desc>
16829	</attribute>
16830	</interface>
16831
16832	<enum
16833	name="GuestMonitorChangedEventType"
16834	uuid="ef172985-7e36-4297-95be-e46396968d66"
16835	>
16836
16837	<desc>
16838	How the guest monitor has been changed.
16839	</desc>
16840
16841	<const name="Enabled" value="0">
16842	<desc>
16843	The guest monitor has been enabled by the guest.
16844	</desc>
16845	</const>
16846
16847	<const name="Disabled" value="1">
16848	<desc>
16849	The guest monitor has been disabled by the guest.
16850	</desc>
16851	</const>
16852
16853	<const name="NewOrigin" value="2">
16854	<desc>
16855	The guest monitor origin has changed in the guest.
16856	</desc>
16857	</const>
16858	</enum>
16859
16860	<interface
16861	name="IGuestMonitorChangedEvent" extends="IEvent"
16862	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
16863	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
16864	>
16865	<desc>
16866	Notification when the guest enables one of its monitors.
16867	</desc>
16868
16869	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
16870	<desc>
16871	What was changed for this guest monitor.
16872	</desc>
16873	</attribute>
16874
16875	<attribute name="screenId" type="unsigned long" readonly="yes">
16876	<desc>
16877	The monitor which was changed.
16878	</desc>
16879	</attribute>
16880
16881	<attribute name="originX" type="unsigned long" readonly="yes">
16882	<desc>
16883	Physical X origin relative to the primary screen.
16884	Valid for Enabled and NewOrigin.
16885	</desc>
16886	</attribute>
16887
16888	<attribute name="originY" type="unsigned long" readonly="yes">
16889	<desc>
16890	Physical Y origin relative to the primary screen.
16891	Valid for Enabled and NewOrigin.
16892	</desc>
16893	</attribute>
16894
16895	<attribute name="width" type="unsigned long" readonly="yes">
16896	<desc>
16897	Width of the screen.
16898	Valid for Enabled.
16899	</desc>
16900	</attribute>
16901
16902	<attribute name="height" type="unsigned long" readonly="yes">
16903	<desc>
16904	Height of the screen.
16905	Valid for Enabled.
16906	</desc>
16907	</attribute>
16908
16909	</interface>
16910
16911	<module name="VBoxSVC" context="LocalServer">
16912	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
16913	namespace="virtualbox.org">
16914	<interface name="IVirtualBox" default="yes"/>
16915	</class>
16916	</module>
16917
16918	<module name="VBoxC" context="InprocServer" threadingModel="Free">
16919	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
16920	namespace="virtualbox.org">
16921	<interface name="IVirtualBoxClient" default="yes"/>
16922	</class>
16923
16924	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
16925	namespace="virtualbox.org">
16926	<interface name="ISession" default="yes"/>
16927	</class>
16928	</module>
16929
16930	</library>
16931
16932	</idl>
16933
16934	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format