VirtualBox.xidl@ 35970

Last change on this file since 35970 was 35970, checked in by vboxsync, 14 years ago
Build fix.
Property svn:eol-style set to `native`
File size: 614.4 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	<result name="VBOX_E_FILE_ERROR">
1875	Invalid medium storage file location or could not find the medium
1876	at the specified location.
1877	</result>
1878	<result name="VBOX_E_IPRT_ERROR">
1879	Could not get medium storage format.
1880	</result>
1881	<result name="E_INVALIDARG">
1882	Invalid medium storage format.
1883	</result>
1884	<result name="VBOX_E_INVALID_OBJECT_STATE">
1885	Medium has already been added to a media registry.
1886	</result>
1887	</desc>
1888	<param name="location" type="wstring" dir="in">
1889	<desc>
1890	Location of the storage unit that contains medium data in one of
1891	the supported storage formats.
1892	</desc>
1893	</param>
1894	<param name="deviceType" type="DeviceType" dir="in">
1895	<desc>
1896	Must be one of "HardDisk", "DVD" or "Floppy".
1897	</desc>
1898	</param>
1899	<param name="accessMode" type="AccessMode" dir="in">
1900	<desc>Whether to open the image in read/write or read-only mode. For
1901	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1902	</param>
1903	<param name="medium" type="IMedium" dir="return">
1904	<desc>Opened medium object.</desc>
1905	</param>
1906	</method>
1907
1908	<method name="findMedium">
1909	<desc>
1910	Returns a medium of the given type that uses the given fully qualified
1911	location or UUID to store medium data.
1912
1913	The given medium must be known to this VirtualBox installation, i.e.
1914	it must be previously created by <link to="#createHardDisk"/> or opened
1915	by <link to="#openMedium"/>.
1916
1917	The search is done by comparing the value of the @a location argument to
1918	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1919	attributes of each known medium.
1920
1921	On case sensitive file systems, a case sensitive comparison is performed,
1922	otherwise the case of symbols in the file path is ignored.
1923
1924	<result name="VBOX_E_OBJECT_NOT_FOUND">
1925	No medium object matching @a location found.
1926	</result>
1927	</desc>
1928	<param name="location" type="wstring" dir="in">
1929	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1930	</param>
1931	<param name="type" type="DeviceType" dir="in">
1932	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1933	</param>
1934	<param name="medium" type="IMedium" dir="return">
1935	<desc>Medium object, if found.</desc>
1936	</param>
1937	</method>
1938
1939	<method name="getGuestOSType">
1940	<desc>
1941	Returns an object describing the specified guest OS type.
1942
1943	The requested guest OS type is specified using a string which is a
1944	mnemonic identifier of the guest operating system, such as
1945	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1946	particular virtual machine can be read or set using the
1947	<link to="IMachine::OSTypeId"/> attribute.
1948
1949	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1950	available guest OS type objects. Each object has an
1951	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1952	the guest OS this object describes.
1953
1954	<result name="E_INVALIDARG">
1955	@a id is not a valid Guest OS type.
1956	</result>
1957
1958	</desc>
1959	<param name="id" type="uuid" mod="string" dir="in">
1960	<desc>Guest OS type ID string.</desc>
1961	</param>
1962	<param name="type" type="IGuestOSType" dir="return">
1963	<desc>Guest OS type object.</desc>
1964	</param>
1965	</method>
1966
1967	<method name="createSharedFolder">
1968	<desc>
1969	Creates a new global shared folder by associating the given logical
1970	name with the given host path, adds it to the collection of shared
1971	folders and starts sharing it. Refer to the description of
1972	<link to="ISharedFolder"/> to read more about logical names.
1973	<note>
1974	In the current implementation, this operation is not
1975	implemented.
1976	</note>
1977	</desc>
1978	<param name="name" type="wstring" dir="in">
1979	<desc>Unique logical name of the shared folder.</desc>
1980	</param>
1981	<param name="hostPath" type="wstring" dir="in">
1982	<desc>Full path to the shared folder in the host file system.</desc>
1983	</param>
1984	<param name="writable" type="boolean" dir="in">
1985	<desc>Whether the share is writable or readonly</desc>
1986	</param>
1987	<param name="automount" type="boolean" dir="in">
1988	<desc>Whether the share gets automatically mounted by the guest
1989	or not.</desc>
1990	</param>
1991	</method>
1992
1993	<method name="removeSharedFolder">
1994	<desc>
1995	Removes the global shared folder with the given name previously
1996	created by <link to="#createSharedFolder"/> from the collection of
1997	shared folders and stops sharing it.
1998	<note>
1999	In the current implementation, this operation is not
2000	implemented.
2001	</note>
2002	</desc>
2003	<param name="name" type="wstring" dir="in">
2004	<desc>Logical name of the shared folder to remove.</desc>
2005	</param>
2006	</method>
2007
2008	<method name="getExtraDataKeys">
2009	<desc>
2010	Returns an array representing the global extra data keys which currently
2011	have values defined.
2012	</desc>
2013	<param name="value" type="wstring" dir="return" safearray="yes">
2014	<desc>Array of extra data keys.</desc>
2015	</param>
2016	</method>
2017
2018	<method name="getExtraData">
2019	<desc>
2020	Returns associated global extra data.
2021
2022	If the requested data @a key does not exist, this function will
2023	succeed and return an empty string in the @a value argument.
2024
2025	<result name="VBOX_E_FILE_ERROR">
2026	Settings file not accessible.
2027	</result>
2028	<result name="VBOX_E_XML_ERROR">
2029	Could not parse the settings file.
2030	</result>
2031
2032	</desc>
2033	<param name="key" type="wstring" dir="in">
2034	<desc>Name of the data key to get.</desc>
2035	</param>
2036	<param name="value" type="wstring" dir="return">
2037	<desc>Value of the requested data key.</desc>
2038	</param>
2039	</method>
2040
2041	<method name="setExtraData">
2042	<desc>
2043	Sets associated global extra data.
2044
2045	If you pass @c null or empty string as a key @a value, the given @a key
2046	will be deleted.
2047
2048	<note>
2049	Before performing the actual data change, this method will ask all
2050	registered event listener using the
2051	<link to="IExtraDataCanChangeEvent"/>
2052	notification for a permission. If one of the listeners refuses the
2053	new value, the change will not be performed.
2054	</note>
2055	<note>
2056	On success, the
2057	<link to="IExtraDataChangedEvent"/> notification
2058	is called to inform all registered listeners about a successful data
2059	change.
2060	</note>
2061
2062	<result name="VBOX_E_FILE_ERROR">
2063	Settings file not accessible.
2064	</result>
2065	<result name="VBOX_E_XML_ERROR">
2066	Could not parse the settings file.
2067	</result>
2068	<result name="E_ACCESSDENIED">
2069	Modification request refused.
2070	</result>
2071
2072	</desc>
2073	<param name="key" type="wstring" dir="in">
2074	<desc>Name of the data key to set.</desc>
2075	</param>
2076	<param name="value" type="wstring" dir="in">
2077	<desc>Value to assign to the key.</desc>
2078	</param>
2079	</method>
2080
2081	<!--method name="createDHCPServerForInterface">
2082	<desc>
2083	Creates a dhcp server settings to be used for the given interface
2084	<result name="E_INVALIDARG">
2085	Host network interface @a name already exists.
2086	</result>
2087	</desc>
2088	<param name="interface" type="IHostNetworkInterface" dir="in">
2089	<desc>Network Interface</desc>
2090	</param>
2091	<param name="server" type="IDHCPServer" dir="out">
2092	<desc>Dhcp server settings</desc>
2093	</param>
2094	</method-->
2095
2096	<method name="createDHCPServer">
2097	<desc>
2098	Creates a dhcp server settings to be used for the given internal network name
2099	<result name="E_INVALIDARG">
2100	Host network interface @a name already exists.
2101	</result>
2102	</desc>
2103	<param name="name" type="wstring" dir="in">
2104	<desc>server name</desc>
2105	</param>
2106	<param name="server" type="IDHCPServer" dir="return">
2107	<desc>Dhcp server settings</desc>
2108	</param>
2109	</method>
2110
2111	<method name="findDHCPServerByNetworkName">
2112	<desc>
2113	Searches a dhcp server settings to be used for the given internal network name
2114	<result name="E_INVALIDARG">
2115	Host network interface @a name already exists.
2116	</result>
2117
2118	</desc>
2119	<param name="name" type="wstring" dir="in">
2120	<desc>server name</desc>
2121	</param>
2122	<param name="server" type="IDHCPServer" dir="return">
2123	<desc>Dhcp server settings</desc>
2124	</param>
2125	</method>
2126
2127	<!--method name="findDHCPServerForInterface">
2128	<desc>
2129	Searches a dhcp server settings to be used for the given interface
2130	<result name="E_INVALIDARG">
2131	Host network interface @a name already exists.
2132	</result>
2133	</desc>
2134	<param name="interface" type="IHostNetworkInterface" dir="in">
2135	<desc>Network Interface</desc>
2136	</param>
2137	<param name="server" type="IDHCPServer" dir="out">
2138	<desc>Dhcp server settings</desc>
2139	</param>
2140	</method-->
2141
2142	<method name="removeDHCPServer">
2143	<desc>
2144	Removes the dhcp server settings
2145	<result name="E_INVALIDARG">
2146	Host network interface @a name already exists.
2147	</result>
2148	</desc>
2149	<param name="server" type="IDHCPServer" dir="in">
2150	<desc>Dhcp server settings to be removed</desc>
2151	</param>
2152	</method>
2153
2154
2155	<method name="checkFirmwarePresent">
2156	<desc>
2157	Check if this VirtualBox installation has a firmware
2158	of the given type available, either system-wide or per-user.
2159	Optionally, this may return a hint where this firmware can be
2160	downloaded from.
2161	</desc>
2162	<param name="firmwareType" type="FirmwareType" dir="in">
2163	<desc>
2164	Type of firmware to check.
2165	</desc>
2166	</param>
2167	<param name="version" type="wstring" dir="in">
2168	<desc>Expected version number, usually empty string (presently ignored).</desc>
2169	</param>
2170
2171	<param name="url" type="wstring" dir="out">
2172	<desc>
2173	Suggested URL to download this firmware from.
2174	</desc>
2175	</param>
2176
2177	<param name="file" type="wstring" dir="out">
2178	<desc>
2179	Filename of firmware, only valid if result == TRUE.
2180	</desc>
2181	</param>
2182
2183	<param name="result" type="boolean" dir="return">
2184	<desc>If firmware of this type and version is available.</desc>
2185	</param>
2186	</method>
2187
2188	</interface>
2189
2190	<!--
2191	// IVFSExplorer
2192	/////////////////////////////////////////////////////////////////////////
2193	-->
2194
2195	<enum
2196	name="VFSType"
2197	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2198	>
2199	<desc>
2200	Virtual file systems supported by VFSExplorer.
2201	</desc>
2202
2203	<const name="File" value="1" />
2204	<const name="Cloud" value="2" />
2205	<const name="S3" value="3" />
2206	<const name="WebDav" value="4" />
2207	</enum>
2208
2209	<enum
2210	name="VFSFileType"
2211	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2212	>
2213	<desc>
2214	File types known by VFSExplorer.
2215	</desc>
2216
2217	<const name="Unknown" value="1" />
2218	<const name="Fifo" value="2" />
2219	<const name="DevChar" value="3" />
2220	<const name="Directory" value="4" />
2221	<const name="DevBlock" value="5" />
2222	<const name="File" value="6" />
2223	<const name="SymLink" value="7" />
2224	<const name="Socket" value="8" />
2225	<const name="WhiteOut" value="9" />
2226	</enum>
2227
2228	<interface
2229	name="IVFSExplorer" extends="$unknown"
2230	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2231	wsmap="managed"
2232	>
2233	<desc>
2234	The VFSExplorer interface unifies access to different file system
2235	types. This includes local file systems as well remote file systems like
2236	S3. For a list of supported types see <link to="VFSType" />.
2237	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2238	</desc>
2239
2240	<attribute name="path" type="wstring" readonly="yes">
2241	<desc>Returns the current path in the virtual file system.</desc>
2242	</attribute>
2243
2244	<attribute name="type" type="VFSType" readonly="yes">
2245	<desc>Returns the file system type which is currently in use.</desc>
2246	</attribute>
2247
2248	<method name="update">
2249	<desc>Updates the internal list of files/directories from the
2250	current directory level. Use <link to="#entryList" /> to get the full list
2251	after a call to this method.</desc>
2252
2253	<param name="aProgress" type="IProgress" dir="return">
2254	<desc>Progress object to track the operation completion.</desc>
2255	</param>
2256	</method>
2257
2258	<method name="cd">
2259	<desc>Change the current directory level.</desc>
2260
2261	<param name="aDir" type="wstring" dir="in">
2262	<desc>The name of the directory to go in.</desc>
2263	</param>
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="cdUp">
2271	<desc>Go one directory upwards from the current directory level.</desc>
2272
2273	<param name="aProgress" type="IProgress" dir="return">
2274	<desc>Progress object to track the operation completion.</desc>
2275	</param>
2276	</method>
2277
2278	<method name="entryList">
2279	<desc>Returns a list of files/directories after a call to <link
2280	to="#update" />. The user is responsible for keeping this internal
2281	list up do date.</desc>
2282
2283	<param name="aNames" type="wstring" safearray="yes" dir="out">
2284	<desc>The list of names for the entries.</desc>
2285	</param>
2286
2287	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2288	<desc>The list of types for the entries.</desc>
2289	</param>
2290
2291	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2292	<desc>The list of sizes (in bytes) for the entries.</desc>
2293	</param>
2294
2295	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2296	<desc>The list of file modes (in octal form) for the entries.</desc>
2297	</param>
2298	</method>
2299
2300	<method name="exists">
2301	<desc>Checks if the given file list exists in the current directory
2302	level.</desc>
2303
2304	<param name="aNames" type="wstring" safearray="yes" dir="in">
2305	<desc>The names to check.</desc>
2306	</param>
2307
2308	<param name="aExists" type="wstring" safearray="yes" dir="return">
2309	<desc>The names which exist.</desc>
2310	</param>
2311	</method>
2312
2313	<method name="remove">
2314	<desc>Deletes the given files in the current directory level.</desc>
2315
2316	<param name="aNames" type="wstring" safearray="yes" dir="in">
2317	<desc>The names to remove.</desc>
2318	</param>
2319
2320	<param name="aProgress" type="IProgress" dir="return">
2321	<desc>Progress object to track the operation completion.</desc>
2322	</param>
2323	</method>
2324
2325	</interface>
2326
2327	<!--
2328	// IAppliance
2329	/////////////////////////////////////////////////////////////////////////
2330	-->
2331
2332	<interface
2333	name="IAppliance" extends="$unknown"
2334	uuid="7b148032-4124-4f46-b56a-b48ac1273f5a"
2335	wsmap="managed"
2336	>
2337	<desc>
2338	Represents a platform-independent appliance in OVF format. An instance of this is returned
2339	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2340	virtual machines within an appliance with VirtualBox.
2341
2342	The OVF standard suggests two different physical file formats:
2343
2344	<ol>
2345	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2346	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2347	this descriptor file references other files such as disk images, as OVF appliances typically
2348	do, those additional files must be in the same directory as the descriptor file.</li>
2349
2350	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2351	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2352	files and optionally other files.
2353
2354	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2355	be added with a later version.</li>
2356	</ol>
2357
2358	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2359	<link to="IMachine" /> involves the following sequence of API calls:
2360
2361	<ol>
2362	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2363	</li>
2364
2365	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2366	would like to import. So long as this file is syntactically valid, this will succeed
2367	and fill the appliance object with the parsed data from the OVF file.
2368	</li>
2369
2370	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2371	contents of the IAppliance attributes accordingly. These can be inspected by a
2372	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2373	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2374	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2375	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2376	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2377	The GUI can then give the user the option to confirm and/or change these suggestions.
2378	</li>
2379
2380	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2381	virtual system (machine) to override the suggestions made by the interpret() routine.
2382	</li>
2383
2384	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2385	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2386	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2387	can be found in the <link to="#machines" /> array attribute.
2388	</li>
2389	</ol>
2390
2391	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2392
2393	<ol>
2394	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2395	an empty IAppliance object.
2396	</li>
2397
2398	<li>For each machine you would like to export, call <link to="IMachine::export" />
2399	with the IAppliance object you just created. Each such call creates one instance of
2400	<link to="IVirtualSystemDescription" /> inside the appliance.
2401	</li>
2402
2403	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2404	virtual system (machine) to override the suggestions made by the export() routine.
2405	</li>
2406
2407	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2408	file written.</li>
2409	</ol>
2410
2411	</desc>
2412
2413	<attribute name="path" type="wstring" readonly="yes">
2414	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2415	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2416	<link to="#write" /> (for export).
2417	This attribute is empty until one of these methods has been called.
2418	</desc>
2419	</attribute>
2420
2421	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2422	<desc>
2423	Array of virtual disk definitions. One such description exists for each
2424	disk definition in the OVF; each string array item represents one such piece of
2425	disk information, with the information fields separated by tab (\\t) characters.
2426
2427	The caller should be prepared for additional fields being appended to
2428	this string in future versions of VirtualBox and therefore check for
2429	the number of tabs in the strings returned.
2430
2431	In the current version, the following eight fields are returned per string
2432	in the array:
2433
2434	<ol>
2435	<li>Disk ID (unique string identifier given to disk)</li>
2436
2437	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2438
2439	<li>Populated size (optional unsigned integer indicating the current size of the
2440	disk; can be approximate; -1 if unspecified)</li>
2441
2442	<li>Format (string identifying the disk format, typically
2443	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2444
2445	<li>Reference (where to find the disk image, typically a file name; if empty,
2446	then the disk should be created on import)</li>
2447
2448	<li>Image size (optional unsigned integer indicating the size of the image,
2449	which need not necessarily be the same as the values specified above, since
2450	the image may be compressed or sparse; -1 if not specified)</li>
2451
2452	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2453	presently unsupported and always -1)</li>
2454
2455	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2456	</ol>
2457	</desc>
2458	</attribute>
2459
2460	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2461	<desc> Array of virtual system descriptions. One such description is created
2462	for each virtual system (machine) found in the OVF.
2463	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2464	(for export) has been called.
2465	</desc>
2466	</attribute>
2467
2468	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2469	<desc>
2470	Contains the UUIDs of the machines created from the information in this appliances. This is only
2471	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2472	succeeded.
2473	</desc>
2474	</attribute>
2475
2476	<method name="read">
2477	<desc>
2478	Reads an OVF file into the appliance object.
2479
2480	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2481	mere fact that this method returns successfully does not mean that VirtualBox supports all
2482	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2483	</desc>
2484	<param name="file" type="wstring" dir="in">
2485	<desc>
2486	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2487	on whether the appliance is distributed as a set of files or as a single file, respectively).
2488	</desc>
2489	</param>
2490	<param name="aProgress" type="IProgress" dir="return">
2491	<desc>Progress object to track the operation completion.</desc>
2492	</param>
2493	</method>
2494
2495	<method name="interpret">
2496	<desc>
2497	Interprets the OVF data that was read when the appliance was constructed. After
2498	calling this method, one can inspect the
2499	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2500	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2501	the appliance.
2502
2503	Calling this method is the second step of importing an appliance into VirtualBox;
2504	see <link to="IAppliance" /> for an overview.
2505
2506	After calling this method, one should call <link to="#getWarnings" /> to find out
2507	if problems were encountered during the processing which might later lead to
2508	errors.
2509	</desc>
2510	</method>
2511
2512	<method name="importMachines">
2513	<desc>
2514	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2515	and other interfaces that match the information contained in the appliance as
2516	closely as possible, as represented by the import instructions in the
2517	<link to="#virtualSystemDescriptions" /> array.
2518
2519	Calling this method is the final step of importing an appliance into VirtualBox;
2520	see <link to="IAppliance" /> for an overview.
2521
2522	Since importing the appliance will most probably involve copying and converting
2523	disk images, which can take a long time, this method operates asynchronously and
2524	returns an IProgress object to allow the caller to monitor the progress.
2525
2526	After the import succeeded, the UUIDs of the IMachine instances created can be
2527	retrieved from the <link to="#machines" /> array attribute.
2528	</desc>
2529
2530	<param name="aProgress" type="IProgress" dir="return">
2531	<desc>Progress object to track the operation completion.</desc>
2532	</param>
2533	</method>
2534
2535	<method name="createVFSExplorer">
2536	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2537
2538	<param name="aUri" type="wstring" dir="in">
2539	<desc>The URI describing the file system to use.</desc>
2540	</param>
2541
2542	<param name="aExplorer" type="IVFSExplorer" dir="return">
2543	<desc></desc>
2544	</param>
2545	</method>
2546
2547	<method name="write">
2548	<desc>
2549	Writes the contents of the appliance exports into a new OVF file.
2550
2551	Calling this method is the final step of exporting an appliance from VirtualBox;
2552	see <link to="IAppliance" /> for an overview.
2553
2554	Since exporting the appliance will most probably involve copying and converting
2555	disk images, which can take a long time, this method operates asynchronously and
2556	returns an IProgress object to allow the caller to monitor the progress.
2557	</desc>
2558	<param name="format" type="wstring" dir="in">
2559	<desc>
2560	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2561	future versions of VirtualBox may support additional formats.
2562	</desc>
2563	</param>
2564	<param name="manifest" type="boolean" dir="in">
2565	<desc>
2566	Indicate if the optional manifest file (.mf) should be written. The manifest file
2567	is used for integrity checks prior import.
2568	</desc>
2569	</param>
2570	<param name="path" type="wstring" dir="in">
2571	<desc>
2572	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2573	on whether the appliance is distributed as a set of files or as a single file, respectively).
2574	</desc>
2575	</param>
2576	<param name="progress" type="IProgress" dir="return">
2577	<desc>Progress object to track the operation completion.</desc>
2578	</param>
2579	</method>
2580
2581	<method name="getWarnings">
2582	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2583
2584	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2585	<desc></desc>
2586	</param>
2587	</method>
2588
2589	</interface>
2590
2591	<enum
2592	name="VirtualSystemDescriptionType"
2593	uuid="c0f8f135-3a1d-417d-afa6-b38b95a91f90"
2594	>
2595	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2596	a configuration value.</desc>
2597
2598	<const name="Ignore" value="1" />
2599	<const name="OS" value="2" />
2600	<const name="Name" value="3" />
2601	<const name="Product" value="4" />
2602	<const name="Vendor" value="5" />
2603	<const name="Version" value="6" />
2604	<const name="ProductUrl" value="7" />
2605	<const name="VendorUrl" value="8" />
2606	<const name="Description" value="9" />
2607	<const name="License" value="10" />
2608	<const name="Miscellaneous" value="11" />
2609	<const name="CPU" value="12" />
2610	<const name="Memory" value="13" />
2611	<const name="HardDiskControllerIDE" value="14" />
2612	<const name="HardDiskControllerSATA" value="15" />
2613	<const name="HardDiskControllerSCSI" value="16" />
2614	<const name="HardDiskControllerSAS" value="17" />
2615	<const name="HardDiskImage" value="18" />
2616	<const name="Floppy" value="19" />
2617	<const name="CDROM" value="20" />
2618	<const name="NetworkAdapter" value="21" />
2619	<const name="USBController" value="22" />
2620	<const name="SoundCard" value="23" />
2621
2622	</enum>
2623
2624	<enum
2625	name="VirtualSystemDescriptionValueType"
2626	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2627	>
2628	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2629	type to fetch.</desc>
2630
2631	<const name="Reference" value="1" />
2632	<const name="Original" value="2" />
2633	<const name="Auto" value="3" />
2634	<const name="ExtraConfig" value="4" />
2635
2636	</enum>
2637
2638	<interface
2639	name="IVirtualSystemDescription" extends="$unknown"
2640	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2641	wsmap="managed"
2642	>
2643
2644	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2645	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2646	<link to="IAppliance::interpret" /> has been called, that array contains information
2647	about how the virtual systems described in the OVF should best be imported into
2648	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2649	import an OVF into VirtualBox.
2650	</desc>
2651
2652	<attribute name="count" type="unsigned long" readonly="yes">
2653	<desc>Return the number of virtual system description entries.</desc>
2654	</attribute>
2655
2656	<method name="getDescription">
2657	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2658	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2659
2660	The list below identifies the value sets that are possible depending on the
2661	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2662	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2663	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2664	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2665	the @a aExtraConfigValues[] array item may also be used.
2666
2667	<ul>
2668	<li>
2669	"OS": the guest operating system type. There must be exactly one such array item on import. The
2670	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2671	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2672	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2673	</li>
2674	<li>
2675	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2676	if none is present on import, then an automatic name will be created from the operating system
2677	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2678	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2679	<link to="IMachine" /> name that does not exist yet.
2680	</li>
2681	<li>
2682	"Description": an arbitrary description.
2683	</li>
2684	<li>
2685	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2686	code to display such a license for agreement; the Main API does not enforce any such policy.
2687	</li>
2688	<li>
2689	Miscellaneous: reserved for future use.
2690	</li>
2691	<li>
2692	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2693	</li>
2694	<li>
2695	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2696	is present on import, then VirtualBox will set a meaningful default based on the operating system
2697	type.
2698	</li>
2699	<li>
2700	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2701	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2702	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2703	writes into the OVF.
2704	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2705	type can use to specify which hard disk controller a virtual disk should be connected to.
2706	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2707	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2708	its virtual machines supports four channels (primary master, primary slave, secondary master,
2709	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2710	</li>
2711	<li>
2712	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2713	has no value in @a aOvfValues[] or @a aVBoxValues[].
2714	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2715	</li>
2716	<li>
2717	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2718	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2719	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2720	whereas VirtualBox considers it a class of storage controllers of its own; see
2721	<link to="StorageControllerType" />).
2722	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2723	</li>
2724	<li>
2725	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2726	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2727
2728	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2729	a path since the image file should be in the same location as the OVF file itself), whereas the
2730	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2731	hard disk image. This means that on import the image will be copied and converted from the
2732	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2733
2734	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2735	format: "controller=<index>;channel=<c>"
2736	In this string, <index> must be an integer specifying the hard disk controller to connect
2737	the image to. That number must be the index of an array item with one of the hard disk controller
2738	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2739	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2740	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2741	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2742	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2743	</li>
2744	<li>
2745	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2746	attachment information as with "HardDiskImage" items.
2747	</li>
2748	<li>
2749	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2750	attachment information as with "HardDiskImage" items.
2751	</li>
2752	<li>
2753	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2754	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2755	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2756	</li>
2757	<li>
2758	"USBController": a USB controller. There can be at most one such item. If and only if such an
2759	item ispresent, USB support will be enabled for the new virtual machine.
2760	</li>
2761	<li>
2762	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2763	present, sound support will be enabled for the new virtual machine. Note that the virtual
2764	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2765	may be different from the virtual soundcard expected by the appliance.
2766	</li>
2767	</ul>
2768
2769	</desc>
2770
2771	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2772	<desc></desc>
2773	</param>
2774
2775	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2776	<desc></desc>
2777	</param>
2778
2779	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2780	<desc></desc>
2781	</param>
2782
2783	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2784	<desc></desc>
2785	</param>
2786
2787	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2788	<desc></desc>
2789	</param>
2790
2791	</method>
2792
2793	<method name="getDescriptionByType">
2794	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2795	should be returned.</desc>
2796
2797	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2798	<desc></desc>
2799	</param>
2800
2801	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2802	<desc></desc>
2803	</param>
2804
2805	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2806	<desc></desc>
2807	</param>
2808
2809	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2810	<desc></desc>
2811	</param>
2812
2813	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2814	<desc></desc>
2815	</param>
2816
2817	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2818	<desc></desc>
2819	</param>
2820
2821	</method>
2822
2823	<method name="getValuesByType">
2824	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2825	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2826	values.</desc>
2827
2828	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2829	<desc></desc>
2830	</param>
2831
2832	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aValues" type="wstring" dir="return" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	</method>
2841
2842	<method name="setFinalValues">
2843	<desc>
2844	This method allows the appliance's user to change the configuration for the virtual
2845	system descriptions. For each array item returned from <link to="#getDescription" />,
2846	you must pass in one boolean value and one configuration value.
2847
2848	Each item in the boolean array determines whether the particular configuration item
2849	should be enabled.
2850	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2851	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2852	and SoundCard.
2853
2854	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2855	as returned in the aVBoxValues and aExtraConfigValues arrays from getDescription(),
2856	the configuration remains unchanged. Please see the documentation for getDescription()
2857	for valid configuration values for the individual array item types. If the
2858	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2859	</desc>
2860
2861	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2862	<desc></desc>
2863	</param>
2864
2865	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2866	<desc></desc>
2867	</param>
2868
2869	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2870	<desc></desc>
2871	</param>
2872	</method>
2873
2874	<method name="addDescription">
2875	<desc>
2876	This method adds an additional description entry to the stack of already
2877	available descriptions for this virtual system. This is handy for writing
2878	values which aren't directly supported by VirtualBox. One example would
2879	be the License type of <link to="VirtualSystemDescriptionType" />.
2880	</desc>
2881
2882	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2883	<desc></desc>
2884	</param>
2885
2886	<param name="aVBoxValue" type="wstring" dir="in">
2887	<desc></desc>
2888	</param>
2889
2890	<param name="aExtraConfigValue" type="wstring" dir="in">
2891	<desc></desc>
2892	</param>
2893	</method>
2894	</interface>
2895
2896
2897	<!--
2898	// IMachine
2899	/////////////////////////////////////////////////////////////////////////
2900	-->
2901
2902	<interface
2903	name="IInternalMachineControl" extends="$unknown"
2904	uuid="8e723ab0-812c-5662-dd8e-7ebc89637acf"
2905	internal="yes"
2906	wsmap="suppress"
2907	>
2908	<method name="setRemoveSavedStateFile">
2909	<desc>
2910	Updates the flag whether the saved state file is removed on a
2911	machine state change from Saved to PoweredOff.
2912	</desc>
2913	<param name="aRemove" type="boolean" dir="in"/>
2914	</method>
2915
2916	<method name="updateState">
2917	<desc>
2918	Updates the VM state.
2919	<note>
2920	This operation will also update the settings file with the correct
2921	information about the saved state file and delete this file from disk
2922	when appropriate.
2923	</note>
2924	</desc>
2925	<param name="state" type="MachineState" dir="in"/>
2926	</method>
2927
2928	<method name="getIPCId">
2929	<param name="id" type="wstring" dir="return"/>
2930	</method>
2931
2932	<method name="beginPowerUp">
2933	<desc>
2934	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2935	gives it the progress object that should be part of any pending
2936	<link to="IMachine::launchVMProcess"/> operations. The progress
2937	object may be called back to reflect an early cancelation, so some care
2938	have to be taken with respect to any cancelation callbacks. The console
2939	object will call <link to="IInternalMachineControl::endPowerUp"/>
2940	to signal the completion of the progress object.
2941	</desc>
2942	<param name="aProgress" type="IProgress" dir="in" />
2943	</method>
2944
2945	<method name="endPowerUp">
2946	<desc>
2947	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
2948	This method may query status information from the progress object it
2949	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
2950	it over to any in-progress <link to="IMachine::launchVMProcess"/>
2951	call in order to complete that progress object.
2952	</desc>
2953	<param name="result" type="long" dir="in"/>
2954	</method>
2955
2956	<method name="beginPoweringDown">
2957	<desc>
2958	Called by the VM process to inform the server it wants to
2959	stop the VM execution and power down.
2960	</desc>
2961	<param name="progress" type="IProgress" dir="out">
2962	<desc>
2963	Progress object created by VBoxSVC to wait until
2964	the VM is powered down.
2965	</desc>
2966	</param>
2967	</method>
2968
2969	<method name="endPoweringDown">
2970	<desc>
2971	Called by the VM process to inform the server that powering
2972	down previously requested by #beginPoweringDown is either
2973	successfully finished or there was a failure.
2974
2975	<result name="VBOX_E_FILE_ERROR">
2976	Settings file not accessible.
2977	</result>
2978	<result name="VBOX_E_XML_ERROR">
2979	Could not parse the settings file.
2980	</result>
2981
2982	</desc>
2983
2984	<param name="result" type="long" dir="in">
2985	<desc>@c S_OK to indicate success.
2986	</desc>
2987	</param>
2988	<param name="errMsg" type="wstring" dir="in">
2989	<desc>@c human readable error message in case of failure.
2990	</desc>
2991	</param>
2992	</method>
2993
2994	<method name="runUSBDeviceFilters">
2995	<desc>
2996	Asks the server to run USB devices filters of the associated
2997	machine against the given USB device and tell if there is
2998	a match.
2999	<note>
3000	Intended to be used only for remote USB devices. Local
3001	ones don't require to call this method (this is done
3002	implicitly by the Host and USBProxyService).
3003	</note>
3004	</desc>
3005	<param name="device" type="IUSBDevice" dir="in"/>
3006	<param name="matched" type="boolean" dir="out"/>
3007	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3008	</method>
3009
3010	<method name="captureUSBDevice">
3011	<desc>
3012	Requests a capture of the given host USB device.
3013	When the request is completed, the VM process will
3014	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3015	notification.
3016	</desc>
3017	<param name="id" type="uuid" mod="string" dir="in"/>
3018	</method>
3019
3020	<method name="detachUSBDevice">
3021	<desc>
3022	Notification that a VM is going to detach (@a done = @c false) or has
3023	already detached (@a done = @c true) the given USB device.
3024	When the @a done = @c true request is completed, the VM process will
3025	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3026	notification.
3027	<note>
3028	In the @a done = @c true case, the server must run its own filters
3029	and filters of all VMs but this one on the detached device
3030	as if it were just attached to the host computer.
3031	</note>
3032	</desc>
3033	<param name="id" type="uuid" mod="string" dir="in"/>
3034	<param name="done" type="boolean" dir="in"/>
3035	</method>
3036
3037	<method name="autoCaptureUSBDevices">
3038	<desc>
3039	Requests a capture all matching USB devices attached to the host.
3040	When the request is completed, the VM process will
3041	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3042	notification per every captured device.
3043	</desc>
3044	</method>
3045
3046	<method name="detachAllUSBDevices">
3047	<desc>
3048	Notification that a VM that is being powered down. The done
3049	parameter indicates whether which stage of the power down
3050	we're at. When @a done = @c false the VM is announcing its
3051	intentions, while when @a done = @c true the VM is reporting
3052	what it has done.
3053	<note>
3054	In the @a done = @c true case, the server must run its own filters
3055	and filters of all VMs but this one on all detach devices as
3056	if they were just attached to the host computer.
3057	</note>
3058	</desc>
3059	<param name="done" type="boolean" dir="in"/>
3060	</method>
3061
3062	<method name="onSessionEnd">
3063	<desc>
3064	Triggered by the given session object when the session is about
3065	to close normally.
3066	</desc>
3067	<param name="session" type="ISession" dir="in">
3068	<desc>Session that is being closed</desc>
3069	</param>
3070	<param name="progress" type="IProgress" dir="return">
3071	<desc>
3072	Used to wait until the corresponding machine is actually
3073	dissociated from the given session on the server.
3074	Returned only when this session is a direct one.
3075	</desc>
3076	</param>
3077	</method>
3078
3079	<method name="beginSavingState">
3080	<desc>
3081	Called by the VM process to inform the server it wants to
3082	save the current state and stop the VM execution.
3083	</desc>
3084	<param name="progress" type="IProgress" dir="out">
3085	<desc>
3086	Progress object created by VBoxSVC to wait until
3087	the state is saved.
3088	</desc>
3089	</param>
3090	<param name="stateFilePath" type="wstring" dir="out">
3091	<desc>
3092	File path the VM process must save the execution state to.
3093	</desc>
3094	</param>
3095	</method>
3096
3097	<method name="endSavingState">
3098	<desc>
3099	Called by the VM process to inform the server that saving
3100	the state previously requested by #beginSavingState is either
3101	successfully finished or there was a failure.
3102
3103	<result name="VBOX_E_FILE_ERROR">
3104	Settings file not accessible.
3105	</result>
3106	<result name="VBOX_E_XML_ERROR">
3107	Could not parse the settings file.
3108	</result>
3109
3110	</desc>
3111
3112	<param name="result" type="long" dir="in">
3113	<desc>@c S_OK to indicate success.
3114	</desc>
3115	</param>
3116	<param name="errMsg" type="wstring" dir="in">
3117	<desc>@c human readable error message in case of failure.
3118	</desc>
3119	</param>
3120	</method>
3121
3122	<method name="adoptSavedState">
3123	<desc>
3124	Gets called by IConsole::adoptSavedState.
3125	<result name="VBOX_E_FILE_ERROR">
3126	Invalid saved state file path.
3127	</result>
3128	</desc>
3129	<param name="savedStateFile" type="wstring" dir="in">
3130	<desc>Path to the saved state file to adopt.</desc>
3131	</param>
3132	</method>
3133
3134	<method name="beginTakingSnapshot">
3135	<desc>
3136	Called from the VM process to request from the server to perform the
3137	server-side actions of creating a snapshot (creating differencing images
3138	and the snapshot object).
3139
3140	<result name="VBOX_E_FILE_ERROR">
3141	Settings file not accessible.
3142	</result>
3143	<result name="VBOX_E_XML_ERROR">
3144	Could not parse the settings file.
3145	</result>
3146	</desc>
3147	<param name="initiator" type="IConsole" dir="in">
3148	<desc>The console object that initiated this call.</desc>
3149	</param>
3150	<param name="name" type="wstring" dir="in">
3151	<desc>Snapshot name.</desc>
3152	</param>
3153	<param name="description" type="wstring" dir="in">
3154	<desc>Snapshot description.</desc>
3155	</param>
3156	<param name="consoleProgress" type="IProgress" dir="in">
3157	<desc>
3158	Progress object created by the VM process tracking the
3159	snapshot's progress. This has the following sub-operations:
3160	<ul>
3161	<li>setting up (weight 1);</li>
3162	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3163	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3164	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3165	<li>finishing up (weight 1)</li>
3166	</ul>
3167	</desc>
3168	</param>
3169	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3170	<desc>
3171	Whether this is an online snapshot (i.e. the machine is running).
3172	</desc>
3173	</param>
3174	<param name="stateFilePath" type="wstring" dir="out">
3175	<desc>
3176	File path the VM process must save the execution state to.
3177	</desc>
3178	</param>
3179	</method>
3180
3181	<method name="endTakingSnapshot">
3182	<desc>
3183	Called by the VM process to inform the server that the snapshot
3184	previously requested by #beginTakingSnapshot is either
3185	successfully taken or there was a failure.
3186	</desc>
3187
3188	<param name="success" type="boolean" dir="in">
3189	<desc>@c true to indicate success and @c false otherwise</desc>
3190	</param>
3191	</method>
3192
3193	<method name="deleteSnapshot">
3194	<desc>
3195	Gets called by IConsole::deleteSnapshot.
3196	<result name="VBOX_E_INVALID_OBJECT_STATE">
3197	Snapshot has more than one child snapshot.
3198	</result>
3199	</desc>
3200	<param name="initiator" type="IConsole" dir="in">
3201	<desc>The console object that initiated this call.</desc>
3202	</param>
3203	<param name="id" type="uuid" mod="string" dir="in">
3204	<desc>UUID of the snapshot to delete.</desc>
3205	</param>
3206	<param name="machineState" type="MachineState" dir="out">
3207	<desc>New machine state after this operation is started.</desc>
3208	</param>
3209	<param name="progress" type="IProgress" dir="return">
3210	<desc>Progress object to track the operation completion.</desc>
3211	</param>
3212	</method>
3213
3214	<method name="finishOnlineMergeMedium">
3215	<desc>
3216	Gets called by IConsole::onlineMergeMedium.
3217	</desc>
3218	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3219	<desc>The medium attachment which needs to be cleaned up.</desc>
3220	</param>
3221	<param name="source" type="IMedium" dir="in">
3222	<desc>Merge source medium.</desc>
3223	</param>
3224	<param name="target" type="IMedium" dir="in">
3225	<desc>Merge target medium.</desc>
3226	</param>
3227	<param name="mergeForward" type="boolean" dir="in">
3228	<desc>Merge direction.</desc>
3229	</param>
3230	<param name="parentForTarget" type="IMedium" dir="in">
3231	<desc>For forward merges: new parent for target medium.</desc>
3232	</param>
3233	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3234	<desc>For backward merges: list of media which need their parent UUID
3235	updated.</desc>
3236	</param>
3237	</method>
3238
3239	<method name="restoreSnapshot">
3240	<desc>
3241	Gets called by IConsole::RestoreSnapshot.
3242	</desc>
3243	<param name="initiator" type="IConsole" dir="in">
3244	<desc>The console object that initiated this call.</desc>
3245	</param>
3246	<param name="snapshot" type="ISnapshot" dir="in">
3247	<desc>The snapshot to restore the VM state from.</desc>
3248	</param>
3249	<param name="machineState" type="MachineState" dir="out">
3250	<desc>New machine state after this operation is started.</desc>
3251	</param>
3252	<param name="progress" type="IProgress" dir="return">
3253	<desc>Progress object to track the operation completion.</desc>
3254	</param>
3255	</method>
3256
3257	<method name="pullGuestProperties">
3258	<desc>
3259	Get the list of the guest properties matching a set of patterns along
3260	with their values, time stamps and flags and give responsibility for
3261	managing properties to the console.
3262	</desc>
3263	<param name="name" type="wstring" dir="out" safearray="yes">
3264	<desc>
3265	The names of the properties returned.
3266	</desc>
3267	</param>
3268	<param name="value" type="wstring" dir="out" safearray="yes">
3269	<desc>
3270	The values of the properties returned. The array entries match the
3271	corresponding entries in the @a name array.
3272	</desc>
3273	</param>
3274	<param name="timestamp" type="long long" dir="out" safearray="yes">
3275	<desc>
3276	The time stamps of the properties returned. The array entries match
3277	the corresponding entries in the @a name array.
3278	</desc>
3279	</param>
3280	<param name="flags" type="wstring" dir="out" safearray="yes">
3281	<desc>
3282	The flags of the properties returned. The array entries match the
3283	corresponding entries in the @a name array.
3284	</desc>
3285	</param>
3286	</method>
3287
3288	<method name="pushGuestProperty">
3289	<desc>
3290	Update a single guest property in IMachine.
3291	</desc>
3292	<param name="name" type="wstring" dir="in">
3293	<desc>
3294	The name of the property to be updated.
3295	</desc>
3296	</param>
3297	<param name="value" type="wstring" dir="in">
3298	<desc>
3299	The value of the property.
3300	</desc>
3301	</param>
3302	<param name="timestamp" type="long long" dir="in">
3303	<desc>
3304	The timestamp of the property.
3305	</desc>
3306	</param>
3307	<param name="flags" type="wstring" dir="in">
3308	<desc>
3309	The flags of the property.
3310	</desc>
3311	</param>
3312	</method>
3313
3314	<method name="lockMedia">
3315	<desc>
3316	Locks all media attached to the machine for writing and parents of
3317	attached differencing media (if any) for reading. This operation is
3318	atomic so that if it fails no media is actually locked.
3319
3320	This method is intended to be called when the machine is in Starting or
3321	Restoring state. The locked media will be automatically unlocked when
3322	the machine is powered off or crashed.
3323	</desc>
3324	</method>
3325	<method name="unlockMedia">
3326	<desc>
3327	Unlocks all media previously locked using
3328	<link to="IInternalMachineControl::lockMedia"/>.
3329
3330	This method is intended to be used with teleportation so that it is
3331	possible to teleport between processes on the same machine.
3332	</desc>
3333	</method>
3334	</interface>
3335
3336	<interface
3337	name="IBIOSSettings" extends="$unknown"
3338	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3339	wsmap="managed"
3340	>
3341	<desc>
3342	The IBIOSSettings interface represents BIOS settings of the virtual
3343	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3344	</desc>
3345	<attribute name="logoFadeIn" type="boolean">
3346	<desc>Fade in flag for BIOS logo animation.</desc>
3347	</attribute>
3348
3349	<attribute name="logoFadeOut" type="boolean">
3350	<desc>Fade out flag for BIOS logo animation.</desc>
3351	</attribute>
3352
3353	<attribute name="logoDisplayTime" type="unsigned long">
3354	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3355	</attribute>
3356
3357	<attribute name="logoImagePath" type="wstring">
3358	<desc>
3359	Local file system path for external BIOS splash image. Empty string
3360	means the default image is shown on boot.
3361	</desc>
3362	</attribute>
3363
3364	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3365	<desc>Mode of the BIOS boot device menu.</desc>
3366	</attribute>
3367
3368	<attribute name="ACPIEnabled" type="boolean">
3369	<desc>ACPI support flag.</desc>
3370	</attribute>
3371
3372	<attribute name="IOAPICEnabled" type="boolean">
3373	<desc>
3374	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3375	and support IRQs above 15.
3376	</desc>
3377	</attribute>
3378
3379	<attribute name="timeOffset" type="long long">
3380	<desc>
3381	Offset in milliseconds from the host system time. This allows for
3382	guests running with a different system date/time than the host.
3383	It is equivalent to setting the system date/time in the BIOS except
3384	it is not an absolute value but a relative one. Guest Additions
3385	time synchronization honors this offset.
3386	</desc>
3387	</attribute>
3388
3389	<attribute name="PXEDebugEnabled" type="boolean">
3390	<desc>
3391	PXE debug logging flag. If set, VirtualBox will write extensive
3392	PXE trace information to the release log.
3393	</desc>
3394	</attribute>
3395
3396	</interface>
3397
3398	<enum
3399	name="CleanupMode"
3400	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3401	>
3402	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3403	</desc>
3404	<const name="UnregisterOnly" value="1">
3405	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3406	</const>
3407	<const name="DetachAllReturnNone" value="2">
3408	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3409	</const>
3410	<const name="DetachAllReturnHardDisksOnly" value="3">
3411	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3412	</const>
3413	<const name="Full" value="4">
3414	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3415	</const>
3416	</enum>
3417
3418	<interface
3419	name="IPciAddress" extends="$unknown"
3420	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3421	wsmap="struct"
3422	>
3423
3424	<desc>
3425	Address on the PCI bus.
3426	</desc>
3427
3428	<attribute name="bus" type="short">
3429	<desc>
3430	Bus number.
3431	</desc>
3432	</attribute>
3433
3434	<attribute name="device" type="short">
3435	<desc>
3436	Device number.
3437	</desc>
3438	</attribute>
3439
3440	<attribute name="devFunction" type="short">
3441	<desc>
3442	Device function number.
3443	</desc>
3444	</attribute>
3445
3446	<method name="asLong">
3447	<desc>
3448	Convert PCI address into long.
3449	</desc>
3450	<param name="result" type="long" dir="return" />
3451	</method>
3452
3453	<method name="fromLong">
3454	<desc>
3455	Make PCI address from long.
3456	</desc>
3457	<param name="number" type="long" dir="in" />
3458	</method>
3459	</interface>
3460
3461	<interface
3462	name="IPciDeviceAttachment" extends="$unknown"
3463	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3464	wsmap="struct"
3465	>
3466
3467	<desc>
3468	Information about PCI attachments.
3469	</desc>
3470
3471	<attribute name="name" type="wstring" readonly="yes">
3472	<desc>
3473	Device name.
3474	</desc>
3475	</attribute>
3476
3477	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3478	<desc>
3479	If this is physical or virtual device.
3480	</desc>
3481	</attribute>
3482
3483	<attribute name="hostAddress" type="long" readonly="yes">
3484	<desc>
3485	Address of device on the host, applicable only to host devices.
3486	</desc>
3487	</attribute>
3488
3489	<attribute name="guestAddress" type="long" readonly="yes">
3490	<desc>
3491	Address of device on the guest.
3492	</desc>
3493	</attribute>
3494
3495	</interface>
3496
3497
3498	<interface
3499	name="IMachine" extends="$unknown"
3500	uuid="662c175e-a69d-40b8-a77a-1d719d0ab062"
3501	wsmap="managed"
3502	>
3503	<desc>
3504	The IMachine interface represents a virtual machine, or guest, created
3505	in VirtualBox.
3506
3507	This interface is used in two contexts. First of all, a collection of
3508	objects implementing this interface is stored in the
3509	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3510	machines that are currently registered with this VirtualBox
3511	installation. Also, once a session has been opened for the given virtual
3512	machine (e.g. the virtual machine is running), the machine object
3513	associated with the open session can be queried from the session object;
3514	see <link to="ISession"/> for details.
3515
3516	The main role of this interface is to expose the settings of the virtual
3517	machine and provide methods to change various aspects of the virtual
3518	machine's configuration. For machine objects stored in the
3519	<link to="IVirtualBox::machines"/> collection, all attributes are
3520	read-only unless explicitly stated otherwise in individual attribute
3521	and method descriptions.
3522
3523	In order to change a machine setting, a session for this machine must be
3524	opened using one of the <link to="IMachine::lockMachine" /> or
3525	<link to="IMachine::launchVMProcess"/> methods. After the
3526	machine has been successfully locked for a session, a mutable machine object
3527	needs to be queried from the session object and then the desired settings
3528	changes can be applied to the returned object using IMachine attributes and
3529	methods. See the <link to="ISession"/> interface description for more
3530	information about sessions.
3531
3532	Note that IMachine does not provide methods to control virtual machine
3533	execution (such as start the machine, or power it down) -- these methods
3534	are grouped in a separate interface called <link to="IConsole" />.
3535
3536	<see>ISession, IConsole</see>
3537	</desc>
3538
3539	<attribute name="parent" type="IVirtualBox" readonly="yes">
3540	<desc>Associated parent object.</desc>
3541	</attribute>
3542
3543	<attribute name="accessible" type="boolean" readonly="yes">
3544	<desc>
3545	Whether this virtual machine is currently accessible or not.
3546
3547	A machine is always deemed accessible unless it is registered <i>and</i>
3548	its settings file cannot be read or parsed (either because the file itself
3549	is unavailable or has invalid XML contents).
3550
3551	Every time this property is read, the accessibility state of
3552	this machine is re-evaluated. If the returned value is @c false,
3553	the <link to="#accessError"/> property may be used to get the
3554	detailed error information describing the reason of
3555	inaccessibility, including XML error messages.
3556
3557	When the machine is inaccessible, only the following properties
3558	can be used on it:
3559	<ul>
3560	<li><link to="#parent"/></li>
3561	<li><link to="#id"/></li>
3562	<li><link to="#settingsFilePath"/></li>
3563	<li><link to="#accessible"/></li>
3564	<li><link to="#accessError"/></li>
3565	</ul>
3566
3567	An attempt to access any other property or method will return
3568	an error.
3569
3570	The only possible action you can perform on an inaccessible
3571	machine is to unregister it using the
3572	<link to="IMachine::unregister"/> call (or, to check
3573	for the accessibility state once more by querying this
3574	property).
3575
3576	<note>
3577	In the current implementation, once this property returns
3578	@c true, the machine will never become inaccessible
3579	later, even if its settings file cannot be successfully
3580	read/written any more (at least, until the VirtualBox
3581	server is restarted). This limitation may be removed in
3582	future releases.
3583	</note>
3584	</desc>
3585	</attribute>
3586
3587	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3588	<desc>
3589	Error information describing the reason of machine
3590	inaccessibility.
3591
3592	Reading this property is only valid after the last call to
3593	<link to="#accessible"/> returned @c false (i.e. the
3594	machine is currently inaccessible). Otherwise, a @c null
3595	IVirtualBoxErrorInfo object will be returned.
3596	</desc>
3597	</attribute>
3598
3599	<attribute name="name" type="wstring">
3600	<desc>
3601	Name of the virtual machine.
3602
3603	Besides being used for human-readable identification purposes
3604	everywhere in VirtualBox, the virtual machine name is also used
3605	as a name of the machine's settings file and as a name of the
3606	subdirectory this settings file resides in. Thus, every time you
3607	change the value of this property, the settings file will be
3608	renamed once you call <link to="#saveSettings"/> to confirm the
3609	change. The containing subdirectory will be also renamed, but
3610	only if it has exactly the same name as the settings file
3611	itself prior to changing this property (for backward compatibility
3612	with previous API releases). The above implies the following
3613	limitations:
3614	<ul>
3615	<li>The machine name cannot be empty.</li>
3616	<li>The machine name can contain only characters that are valid
3617	file name characters according to the rules of the file
3618	system used to store VirtualBox configuration.</li>
3619	<li>You cannot have two or more machines with the same name
3620	if they use the same subdirectory for storing the machine
3621	settings files.</li>
3622	<li>You cannot change the name of the machine if it is running,
3623	or if any file in the directory containing the settings file
3624	is being used by another running machine or by any other
3625	process in the host operating system at a time when
3626	<link to="#saveSettings"/> is called.
3627	</li>
3628	</ul>
3629	If any of the above limitations are hit, <link to="#saveSettings"/>
3630	will return an appropriate error message explaining the exact
3631	reason and the changes you made to this machine will not be saved.
3632
3633	Starting with VirtualBox 4.0, a “.vbox” extension of the settings
3634	file is recommended, but not enforced. (Previous versions always
3635	used a generic ".xml" extension.)
3636	</desc>
3637	</attribute>
3638
3639	<attribute name="description" type="wstring">
3640	<desc>
3641	Description of the virtual machine.
3642
3643	The description attribute can contain any text and is
3644	typically used to describe the hardware and software
3645	configuration of the virtual machine in detail (i.e. network
3646	settings, versions of the installed software and so on).
3647	</desc>
3648	</attribute>
3649
3650	<attribute name="id" type="uuid" mod="string" readonly="yes">
3651	<desc>UUID of the virtual machine.</desc>
3652	</attribute>
3653
3654	<attribute name="OSTypeId" type="wstring">
3655	<desc>
3656	User-defined identifier of the Guest OS type.
3657	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3658	an IGuestOSType object representing details about the given
3659	Guest OS type.
3660	<note>
3661	This value may differ from the value returned by
3662	<link to="IGuest::OSTypeId"/> if Guest Additions are
3663	installed to the guest OS.
3664	</note>
3665	</desc>
3666	</attribute>
3667
3668	<attribute name="HardwareVersion" type="wstring">
3669	<desc>Hardware version identifier. Internal use only for now.</desc>
3670	</attribute>
3671
3672	<attribute name="hardwareUUID" type="uuid" mod="string">
3673	<desc>
3674	The UUID presented to the guest via memory tables, hardware and guest
3675	properties. For most VMs this is the same as the @a id, but for VMs
3676	which have been cloned or teleported it may be the same as the source
3677	VM. This latter is because the guest shouldn't notice that it was
3678	cloned or teleported.
3679	</desc>
3680	</attribute>
3681
3682	<attribute name="CPUCount" type="unsigned long">
3683	<desc>Number of virtual CPUs in the VM.</desc>
3684	</attribute>
3685
3686	<attribute name="CPUHotPlugEnabled" type="boolean">
3687	<desc>
3688	This setting determines whether VirtualBox allows CPU
3689	hotplugging for this machine.</desc>
3690	</attribute>
3691
3692	<attribute name="CPUExecutionCap" type="unsigned long">
3693	<desc>
3694	Means to limit the number of CPU cycles a guest can use. The unit
3695	is percentage of host CPU cycles per second. The valid range
3696	is 1 - 100. 100 (the default) implies no limit.
3697	</desc>
3698	</attribute>
3699
3700	<attribute name="memorySize" type="unsigned long">
3701	<desc>System memory size in megabytes.</desc>
3702	</attribute>
3703
3704	<attribute name="memoryBalloonSize" type="unsigned long">
3705	<desc>Memory balloon size in megabytes.</desc>
3706	</attribute>
3707
3708	<attribute name="PageFusionEnabled" type="boolean">
3709	<desc>
3710	This setting determines whether VirtualBox allows page
3711	fusion for this machine (64 bits host only).
3712	</desc>
3713	</attribute>
3714
3715	<attribute name="VRAMSize" type="unsigned long">
3716	<desc>Video memory size in megabytes.</desc>
3717	</attribute>
3718
3719	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3720	<desc>
3721	This setting determines whether VirtualBox allows this machine to make
3722	use of the 3D graphics support available on the host.</desc>
3723	</attribute>
3724
3725	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3726	<desc>
3727	This setting determines whether VirtualBox allows this machine to make
3728	use of the 2D video acceleration support available on the host.</desc>
3729	</attribute>
3730
3731	<attribute name="monitorCount" type="unsigned long">
3732	<desc>
3733	Number of virtual monitors.
3734	<note>
3735	Only effective on Windows XP and later guests with
3736	Guest Additions installed.
3737	</note>
3738	</desc>
3739	</attribute>
3740
3741	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3742	<desc>Object containing all BIOS settings.</desc>
3743	</attribute>
3744
3745	<attribute name="firmwareType" type="FirmwareType">
3746	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3747	bootstrap in this VM.</desc>
3748	</attribute>
3749
3750	<attribute name="pointingHidType" type="PointingHidType">
3751	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3752	The default is typically "PS2Mouse" but can vary depending on the
3753	requirements of the guest operating system.</desc>
3754	</attribute>
3755
3756	<attribute name="keyboardHidType" type="KeyboardHidType">
3757	<desc>Type of keyboard HID used in this VM.
3758	The default is typically "PS2Keyboard" but can vary depending on the
3759	requirements of the guest operating system.</desc>
3760	</attribute>
3761
3762	<attribute name="hpetEnabled" type="boolean">
3763	<desc>This attribute controls if High Precision Event Timer (HPET) is
3764	enabled in this VM. Use this property if you want to provide guests
3765	with additional time source, or if guest requires HPET to function correctly.
3766	Default is false.</desc>
3767	</attribute>
3768
3769	<attribute name="chipsetType" type="ChipsetType">
3770	<desc>Chipset type used in this VM.</desc>
3771	</attribute>
3772
3773	<attribute name="snapshotFolder" type="wstring">
3774	<desc>
3775	Full path to the directory used to store snapshot data
3776	(differencing media and saved state files) of this machine.
3777
3778	The initial value of this property is
3779	<tt><</tt><link to="#settingsFilePath">
3780	path_to_settings_file</link><tt>>/<</tt>
3781	<link to="#id">machine_uuid</link>
3782	<tt>></tt>.
3783
3784	Currently, it is an error to try to change this property on
3785	a machine that has snapshots (because this would require to
3786	move possibly large files to a different location).
3787	A separate method will be available for this purpose later.
3788
3789	<note>
3790	Setting this property to @c null or to an empty string will restore
3791	the initial value.
3792	</note>
3793	<note>
3794	When setting this property, the specified path can be
3795	absolute (full path) or relative to the directory where the
3796	<link to="#settingsFilePath">machine settings file</link>
3797	is located. When reading this property, a full path is
3798	always returned.
3799	</note>
3800	<note>
3801	The specified path may not exist, it will be created
3802	when necessary.
3803	</note>
3804	</desc>
3805	</attribute>
3806
3807	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3808	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3809	</attribute>
3810
3811	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3812	<desc>Array of media attached to this machine.</desc>
3813	</attribute>
3814
3815	<attribute name="USBController" type="IUSBController" readonly="yes">
3816	<desc>
3817	Associated USB controller object.
3818
3819	<note>
3820	If USB functionality is not available in the given edition of
3821	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3822	</note>
3823	</desc>
3824	</attribute>
3825
3826	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3827	<desc>Associated audio adapter, always present.</desc>
3828	</attribute>
3829
3830	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3831	<desc>Array of storage controllers attached to this machine.</desc>
3832	</attribute>
3833
3834	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3835	<desc>
3836	Full name of the file containing machine settings data.
3837	</desc>
3838	</attribute>
3839
3840	<attribute name="settingsModified" type="boolean" readonly="yes">
3841	<desc>
3842	Whether the settings of this machine have been modified
3843	(but neither yet saved nor discarded).
3844	<note>
3845	Reading this property is only valid on instances returned
3846	by <link to="ISession::machine"/> and on new machines
3847	created by <link to="IVirtualBox::createMachine"/> or opened
3848	by <link to="IVirtualBox::openMachine"/> but not
3849	yet registered, or on unregistered machines after calling
3850	<link to="IMachine::unregister"/>. For all other
3851	cases, the settings can never be modified.
3852	</note>
3853	<note>
3854	For newly created unregistered machines, the value of this
3855	property is always @c true until <link to="#saveSettings"/>
3856	is called (no matter if any machine settings have been
3857	changed after the creation or not). For opened machines
3858	the value is set to @c false (and then follows to normal rules).
3859	</note>
3860	</desc>
3861	</attribute>
3862
3863	<attribute name="sessionState" type="SessionState" readonly="yes">
3864	<desc>Current session state for this machine.</desc>
3865	</attribute>
3866
3867	<attribute name="sessionType" type="wstring" readonly="yes">
3868	<desc>
3869	Type of the session. If <link to="#sessionState"/> is
3870	Spawning or Locked, this attribute contains the
3871	same value as passed to the
3872	<link to="IMachine::launchVMProcess"/> method in the
3873	@a type parameter. If the session was used with
3874	<link to="IMachine::lockMachine" />, or if
3875	<link to="#sessionState"/> is SessionClosed, the value of this
3876	attribute is an empty string.
3877	</desc>
3878	</attribute>
3879
3880	<attribute name="sessionPid" type="unsigned long" readonly="yes">
3881	<desc>
3882	Identifier of the session process. This attribute contains the
3883	platform-dependent identifier of the process whose session was
3884	used with <link to="IMachine::lockMachine" /> call. The returned
3885	value is only valid if <link to="#sessionState"/> is Locked or
3886	Unlocking by the time this property is read.
3887	</desc>
3888	</attribute>
3889
3890	<attribute name="state" type="MachineState" readonly="yes">
3891	<desc>Current execution state of this machine.</desc>
3892	</attribute>
3893
3894	<attribute name="lastStateChange" type="long long" readonly="yes">
3895	<desc>
3896	Time stamp of the last execution state change,
3897	in milliseconds since 1970-01-01 UTC.
3898	</desc>
3899	</attribute>
3900
3901	<attribute name="stateFilePath" type="wstring" readonly="yes">
3902	<desc>
3903	Full path to the file that stores the execution state of
3904	the machine when it is in the <link to="MachineState_Saved"/> state.
3905	<note>
3906	When the machine is not in the Saved state, this attribute is
3907	an empty string.
3908	</note>
3909	</desc>
3910	</attribute>
3911
3912	<attribute name="logFolder" type="wstring" readonly="yes">
3913	<desc>
3914	Full path to the folder that stores a set of rotated log files
3915	recorded during machine execution. The most recent log file is
3916	named <tt>VBox.log</tt>, the previous log file is
3917	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
3918	in the current version).
3919	</desc>
3920	</attribute>
3921
3922	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
3923	<desc>
3924	Current snapshot of this machine. This is @c null if the machine
3925	currently has no snapshots. If it is not @c null, then it was
3926	set by one of <link to="IConsole::takeSnapshot" />,
3927	<link to="IConsole::deleteSnapshot" />
3928	or <link to="IConsole::restoreSnapshot" />, depending on which
3929	was called last. See <link to="ISnapshot"/> for details.
3930	</desc>
3931	</attribute>
3932
3933	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
3934	<desc>
3935	Number of snapshots taken on this machine. Zero means the
3936	machine doesn't have any snapshots.
3937	</desc>
3938	</attribute>
3939
3940	<attribute name="currentStateModified" type="boolean" readonly="yes">
3941	<desc>
3942	Returns @c true if the current state of the machine is not
3943	identical to the state stored in the current snapshot.
3944
3945	The current state is identical to the current snapshot only
3946	directly after one of the following calls are made:
3947
3948	<ul>
3949	<li><link to="IConsole::restoreSnapshot"/>
3950	</li>
3951	<li><link to="IConsole::takeSnapshot"/> (issued on a
3952	"powered off" or "saved" machine, for which
3953	<link to="#settingsModified"/> returns @c false)
3954	</li>
3955	</ul>
3956
3957	The current state remains identical until one of the following
3958	happens:
3959	<ul>
3960	<li>settings of the machine are changed</li>
3961	<li>the saved state is deleted</li>
3962	<li>the current snapshot is deleted</li>
3963	<li>an attempt to execute the machine is made</li>
3964	</ul>
3965
3966	<note>
3967	For machines that don't have snapshots, this property is
3968	always @c false.
3969	</note>
3970	</desc>
3971	</attribute>
3972
3973	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
3974	<desc>
3975	Collection of shared folders for this machine (permanent shared
3976	folders). These folders are shared automatically at machine startup
3977	and available only to the guest OS installed within this machine.
3978
3979	New shared folders are added to the collection using
3980	<link to="#createSharedFolder"/>. Existing shared folders can be
3981	removed using <link to="#removeSharedFolder"/>.
3982	</desc>
3983	</attribute>
3984
3985	<attribute name="clipboardMode" type="ClipboardMode">
3986	<desc>
3987	Synchronization mode between the host OS clipboard
3988	and the guest OS clipboard.
3989	</desc>
3990	</attribute>
3991
3992	<attribute name="guestPropertyNotificationPatterns" type="wstring">
3993	<desc>
3994	A comma-separated list of simple glob patterns. Changes to guest
3995	properties whose name matches one of the patterns will generate an
3996	<link to="IGuestPropertyChangedEvent"/> signal.
3997	</desc>
3998	</attribute>
3999
4000	<attribute name="teleporterEnabled" type="boolean">
4001	<desc>
4002	When set to @a true, the virtual machine becomes a target teleporter
4003	the next time it is powered on. This can only set to @a true when the
4004	VM is in the @a PoweredOff or @a Aborted state.
4005
4006	<!-- This property is automatically set to @a false when the VM is powered
4007	on. (bird: This doesn't work yet ) -->
4008	</desc>
4009	</attribute>
4010
4011	<attribute name="teleporterPort" type="unsigned long">
4012	<desc>
4013	The TCP port the target teleporter will listen for incoming
4014	teleportations on.
4015
4016	0 means the port is automatically selected upon power on. The actual
4017	value can be read from this property while the machine is waiting for
4018	incoming teleportations.
4019	</desc>
4020	</attribute>
4021
4022	<attribute name="teleporterAddress" type="wstring">
4023	<desc>
4024	The address the target teleporter will listen on. If set to an empty
4025	string, it will listen on all addresses.
4026	</desc>
4027	</attribute>
4028
4029	<attribute name="teleporterPassword" type="wstring">
4030	<desc>
4031	The password to check for on the target teleporter. This is just a
4032	very basic measure to prevent simple hacks and operators accidentally
4033	beaming a virtual machine to the wrong place.
4034	</desc>
4035	</attribute>
4036
4037	<attribute name="faultToleranceState" type="FaultToleranceState">
4038	<desc>
4039	Fault tolerance state; disabled, source or target.
4040	This property can be changed at any time. If you change it for a running
4041	VM, then the fault tolerance address and port must be set beforehand.
4042	</desc>
4043	</attribute>
4044
4045	<attribute name="faultTolerancePort" type="unsigned long">
4046	<desc>
4047	The TCP port the fault tolerance source or target will use for
4048	communication.
4049	</desc>
4050	</attribute>
4051
4052	<attribute name="faultToleranceAddress" type="wstring">
4053	<desc>
4054	The address the fault tolerance source or target.
4055	</desc>
4056	</attribute>
4057
4058	<attribute name="faultTolerancePassword" type="wstring">
4059	<desc>
4060	The password to check for on the standby VM. This is just a
4061	very basic measure to prevent simple hacks and operators accidentally
4062	choosing the wrong standby VM.
4063	</desc>
4064	</attribute>
4065
4066	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4067	<desc>
4068	The interval in ms used for syncing the state between source and target.
4069	</desc>
4070	</attribute>
4071
4072	<attribute name="RTCUseUTC" type="boolean">
4073	<desc>
4074	When set to @a true, the RTC device of the virtual machine will run
4075	in UTC time, otherwise in local time. Especially Unix guests prefer
4076	the time in UTC.
4077	</desc>
4078	</attribute>
4079
4080	<attribute name="ioCacheEnabled" type="boolean">
4081	<desc>
4082	When set to @a true, the builtin I/O cache of the virtual machine
4083	will be enabled.
4084	</desc>
4085	</attribute>
4086
4087	<attribute name="ioCacheSize" type="unsigned long">
4088	<desc>
4089	Maximum size of the I/O cache in MB.
4090	</desc>
4091	</attribute>
4092
4093	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4094	<desc>
4095	Bandwidth control manager.
4096	</desc>
4097	</attribute>
4098
4099	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4100	<desc>Array of PCI devices assigned to this machine, to get list of all PCI devices
4101	attached to the machine use IConsole::attachedPciDevices attribute, as
4102	this attribute is intended to list only devices additional to what
4103	described in virtual hardware config. Usually, this list keeps host's
4104	physical devices assigned to the particular machine.
4105	</desc>
4106	</attribute>
4107
4108	<method name="lockMachine">
4109	<desc>
4110	Locks the machine for the given session to enable the caller
4111	to make changes to the machine or start the VM or control
4112	VM execution.
4113
4114	There are two ways to lock a machine for such uses:
4115
4116	<ul>
4117	<li>If you want to make changes to the machine settings,
4118	you must obtain an exclusive write lock on the machine
4119	by setting @a lockType to @c Write.
4120
4121	This will only succeed if no other process has locked
4122	the machine to prevent conflicting changes. Only after
4123	an exclusive write lock has been obtained using this method, one
4124	can change all VM settings or execute the VM in the process
4125	space of the session object. (Note that the latter is only of
4126	interest if you actually want to write a new front-end for
4127	virtual machines; but this API gets called internally by
4128	the existing front-ends such as VBoxHeadless and the VirtualBox
4129	GUI to acquire a write lock on the machine that they are running.)
4130
4131	On success, write-locking the machine for a session creates
4132	a second copy of the IMachine object. It is this second object
4133	upon which changes can be made; in VirtualBox terminology, the
4134	second copy is "mutable". It is only this second, mutable machine
4135	object upon which you can call methods that change the
4136	machine state. After having called this method, you can
4137	obtain this second, mutable machine object using the
4138	<link to="ISession::machine" /> attribute.
4139	</li>
4140	<li>If you only want to check the machine state or control
4141	machine execution without actually changing machine
4142	settings (e.g. to get access to VM statistics or take
4143	a snapshot or save the machine state), then set the
4144	@a lockType argument to @c Shared.
4145
4146	If no other session has obtained a lock, you will obtain an
4147	exclusive write lock as described above. However, if another
4148	session has already obtained such a lock, then a link to that
4149	existing session will be established which allows you
4150	to control that existing session.
4151
4152	To find out which type of lock was obtained, you can
4153	inspect <link to="ISession::type" />, which will have been
4154	set to either @c WriteLock or @c Shared.
4155	</li>
4156	</ul>
4157
4158	In either case, you can get access to the <link to="IConsole" />
4159	object which controls VM execution.
4160
4161	Also in all of the above cases, one must always call
4162	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4163	the machine's state will eventually be set to "Aborted".
4164
4165	To change settings on a machine, the following sequence is typically
4166	performed:
4167
4168	<ol>
4169	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4170
4171	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4172
4173	<li>Change the settings of the machine by invoking IMachine methods.</li>
4174
4175	<li>Call <link to="IMachine::saveSettings" />.</li>
4176
4177	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4178	</ol>
4179
4180	<result name="E_UNEXPECTED">
4181	Virtual machine not registered.
4182	</result>
4183	<result name="E_ACCESSDENIED">
4184	Process not started by OpenRemoteSession.
4185	</result>
4186	<result name="VBOX_E_INVALID_OBJECT_STATE">
4187	Session already open or being opened.
4188	</result>
4189	<result name="VBOX_E_VM_ERROR">
4190	Failed to assign machine to session.
4191	</result>
4192	</desc>
4193	<param name="session" type="ISession" dir="in">
4194	<desc>
4195	Session object for which the machine will be locked.
4196	</desc>
4197	</param>
4198	<param name="lockType" type="LockType" dir="in">
4199	<desc>
4200	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4201	If set to @c Shared, then either acquire an exclusive write lock or establish
4202	a link to an existing session.
4203	</desc>
4204	</param>
4205	</method>
4206
4207	<method name="launchVMProcess">
4208	<desc>
4209	Spawns a new process that will execute the virtual machine and obtains a shared
4210	lock on the machine for the calling session.
4211
4212	If launching the VM succeeds, the new VM process will create its own session
4213	and write-lock the machine for it, preventing conflicting changes from other
4214	processes. If the machine is already locked (because it is already running or
4215	because another session has a write lock), launching the VM process will therefore
4216	fail. Reversely, future attempts to obtain a write lock will also fail while the
4217	machine is running.
4218
4219	The caller's session object remains separate from the session opened by the new
4220	VM process. It receives its own <link to="IConsole" /> object which can be used
4221	to control machine execution, but it cannot be used to change all VM settings
4222	which would be available after a <link to="#lockMachine" /> call.
4223
4224	The caller must eventually release the session's shared lock by calling
4225	<link to="ISession::unlockMachine" /> on the local session object once this call
4226	has returned. However, the session's state (see <link to="ISession::state" />)
4227	will not return to "Unlocked" until the remote session has also unlocked
4228	the machine (i.e. the machine has stopped running).
4229
4230	Launching a VM process can take some time (a new VM is started in a new process,
4231	for which memory and other resources need to be set up). Because of this,
4232	an <link to="IProgress" /> object is returned to allow the caller to wait
4233	for this asynchronous operation to be completed. Until then, the caller's
4234	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4235	and <link to="ISession::console" /> attributes cannot be accessed.
4236	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4237	similar calls to wait for completion. Completion is signalled when the VM
4238	is powered on. If launching the VM fails, error messages can be queried
4239	via the progress object, if available.
4240
4241	The progress object will have at least 2 sub-operations. The first
4242	operation covers the period up to the new VM process calls powerUp.
4243	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4244	progress object. Because <link to="IConsole::powerUp"/> may require
4245	some extra sub-operations, the <link to="IProgress::operationCount"/>
4246	may change at the completion of operation.
4247
4248	For details on the teleportation progress operation, see
4249	<link to="IConsole::powerUp"/>.
4250
4251	The @a environment argument is a string containing definitions of
4252	environment variables in the following format:
4253	@code
4254	NAME[=VALUE]\n
4255	NAME[=VALUE]\n
4256	...
4257	@endcode
4258	where <tt>\\n</tt> is the new line character. These environment
4259	variables will be appended to the environment of the VirtualBox server
4260	process. If an environment variable exists both in the server process
4261	and in this list, the value from this list takes precedence over the
4262	server's variable. If the value of the environment variable is
4263	omitted, this variable will be removed from the resulting environment.
4264	If the environment string is @c null or empty, the server environment
4265	is inherited by the started process as is.
4266
4267	<result name="E_UNEXPECTED">
4268	Virtual machine not registered.
4269	</result>
4270	<result name="E_INVALIDARG">
4271	Invalid session type @a type.
4272	</result>
4273	<result name="VBOX_E_OBJECT_NOT_FOUND">
4274	No machine matching @a machineId found.
4275	</result>
4276	<result name="VBOX_E_INVALID_OBJECT_STATE">
4277	Session already open or being opened.
4278	</result>
4279	<result name="VBOX_E_IPRT_ERROR">
4280	Launching process for machine failed.
4281	</result>
4282	<result name="VBOX_E_VM_ERROR">
4283	Failed to assign machine to session.
4284	</result>
4285	</desc>
4286	<param name="session" type="ISession" dir="in">
4287	<desc>
4288	Client session object to which the VM process will be connected (this
4289	must be in "Unlocked" state).
4290	</desc>
4291	</param>
4292	<param name="type" type="wstring" dir="in">
4293	<desc>
4294	Front-end to use for the new VM process. The following are currently supported:
4295	<ul>
4296	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4297	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4298	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4299	</ul>
4300	</desc>
4301	</param>
4302	<param name="environment" type="wstring" dir="in">
4303	<desc>
4304	Environment to pass to the VM process.
4305	</desc>
4306	</param>
4307	<param name="progress" type="IProgress" dir="return">
4308	<desc>Progress object to track the operation completion.</desc>
4309	</param>
4310	</method>
4311
4312	<method name="setBootOrder">
4313	<desc>
4314	Puts the given device to the specified position in
4315	the boot order.
4316
4317	To indicate that no device is associated with the given position,
4318	<link to="DeviceType_Null"/> should be used.
4319
4320	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4321
4322	<result name="E_INVALIDARG">
4323	Boot @a position out of range.
4324	</result>
4325	<result name="E_NOTIMPL">
4326	Booting from USB @a device currently not supported.
4327	</result>
4328
4329	</desc>
4330	<param name="position" type="unsigned long" dir="in">
4331	<desc>
4332	Position in the boot order (@c 1 to the total number of
4333	devices the machine can boot from, as returned by
4334	<link to="ISystemProperties::maxBootPosition"/>).
4335	</desc>
4336	</param>
4337	<param name="device" type="DeviceType" dir="in">
4338	<desc>
4339	The type of the device used to boot at the given position.
4340	</desc>
4341	</param>
4342	</method>
4343
4344	<method name="getBootOrder" const="yes">
4345	<desc>
4346	Returns the device type that occupies the specified
4347	position in the boot order.
4348
4349	@todo [remove?]
4350	If the machine can have more than one device of the returned type
4351	(such as hard disks), then a separate method should be used to
4352	retrieve the individual device that occupies the given position.
4353
4354	If here are no devices at the given position, then
4355	<link to="DeviceType_Null"/> is returned.
4356
4357	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4358
4359	<result name="E_INVALIDARG">
4360	Boot @a position out of range.
4361	</result>
4362
4363	</desc>
4364	<param name="position" type="unsigned long" dir="in">
4365	<desc>
4366	Position in the boot order (@c 1 to the total number of
4367	devices the machine can boot from, as returned by
4368	<link to="ISystemProperties::maxBootPosition"/>).
4369	</desc>
4370	</param>
4371	<param name="device" type="DeviceType" dir="return">
4372	<desc>
4373	Device at the given position.
4374	</desc>
4375	</param>
4376	</method>
4377
4378	<method name="attachDevice">
4379	<desc>
4380	Attaches a device and optionally mounts a medium to the given storage
4381	controller (<link to="IStorageController" />, identified by @a name),
4382	at the indicated port and device.
4383
4384	This method is intended for managing storage devices in general while a
4385	machine is powered off. It can be used to attach and detach fixed
4386	and removable media. The following kind of media can be attached
4387	to a machine:
4388
4389	<ul>
4390	<li>For fixed and removable media, you can pass in a medium that was
4391	previously opened using <link to="IVirtualBox::openMedium" />.
4392	</li>
4393
4394	<li>Only for storage devices supporting removable media (such as
4395	DVDs and floppies), you can also specify a null pointer to
4396	indicate an empty drive or one of the medium objects listed
4397	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4398	arrays to indicate a host drive.
4399	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4400	to change the media while the machine is running.
4401	</li>
4402	</ul>
4403
4404	In a VM's default configuration of virtual machines, the secondary
4405	master of the IDE controller is used for a CD/DVD drive.
4406
4407	After calling this returns successfully, a new instance of
4408	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4409	attachments (see <link to="IMachine::mediumAttachments"/>).
4410
4411	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4412	information about attaching media.
4413
4414	The specified device slot must not have a device attached to it,
4415	or this method will fail.
4416
4417	<note>
4418	You cannot attach a device to a newly created machine until
4419	this machine's settings are saved to disk using
4420	<link to="#saveSettings"/>.
4421	</note>
4422	<note>
4423	If the medium is being attached indirectly, a new differencing medium
4424	will implicitly be created for it and attached instead. If the
4425	changes made to the machine settings (including this indirect
4426	attachment) are later cancelled using <link to="#discardSettings"/>,
4427	this implicitly created differencing medium will implicitly
4428	be deleted.
4429	</note>
4430
4431	<result name="E_INVALIDARG">
4432	SATA device, SATA port, IDE port or IDE slot out of range, or
4433	file or UUID not found.
4434	</result>
4435	<result name="VBOX_E_INVALID_OBJECT_STATE">
4436	Machine must be registered before media can be attached.
4437	</result>
4438	<result name="VBOX_E_INVALID_VM_STATE">
4439	Invalid machine state.
4440	</result>
4441	<result name="VBOX_E_OBJECT_IN_USE">
4442	A medium is already attached to this or another virtual machine.
4443	</result>
4444
4445	</desc>
4446	<param name="name" type="wstring" dir="in">
4447	<desc>Name of the storage controller to attach the device to.</desc>
4448	</param>
4449	<param name="controllerPort" type="long" dir="in">
4450	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4451	the primary controller and 1 specifies the secondary controller.
4452	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4453	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4454	</param>
4455	<param name="device" type="long" dir="in">
4456	<desc>Device slot in the given port to attach the device to. This is only
4457	relevant for IDE controllers, for which 0 specifies the master device and
4458	1 specifies the slave device. For all other controller types, this must
4459	be 0.</desc>
4460	</param>
4461	<param name="type" type="DeviceType" dir="in">
4462	<desc>Device type of the attached device. For media opened by
4463	<link to="IVirtualBox::openMedium" />, this must match the device type
4464	specified there.</desc>
4465	</param>
4466	<param name="medium" type="IMedium" dir="in">
4467	<desc>Medium to mount or NULL for an empty drive.</desc>
4468	</param>
4469	</method>
4470
4471	<method name="detachDevice">
4472	<desc>
4473	Detaches the device attached to a device slot of the specified bus.
4474
4475	Detaching the device from the virtual machine is deferred. This means
4476	that the medium remains associated with the machine when this method
4477	returns and gets actually de-associated only after a successful
4478	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4479	for more detailed information about attaching media.
4480
4481	<note>
4482	You cannot detach a device from a running machine.
4483	</note>
4484	<note>
4485	Detaching differencing media implicitly created by <link
4486	to="#attachDevice"/> for the indirect attachment using this
4487	method will <b>not</b> implicitly delete them. The
4488	<link to="IMedium::deleteStorage"/> operation should be
4489	explicitly performed by the caller after the medium is successfully
4490	detached and the settings are saved with
4491	<link to="#saveSettings"/>, if it is the desired action.
4492	</note>
4493
4494	<result name="VBOX_E_INVALID_VM_STATE">
4495	Attempt to detach medium from a running virtual machine.
4496	</result>
4497	<result name="VBOX_E_OBJECT_NOT_FOUND">
4498	No medium attached to given slot/bus.
4499	</result>
4500	<result name="VBOX_E_NOT_SUPPORTED">
4501	Medium format does not support storage deletion.
4502	</result>
4503
4504	</desc>
4505	<param name="name" type="wstring" dir="in">
4506	<desc>Name of the storage controller to detach the medium from.</desc>
4507	</param>
4508	<param name="controllerPort" type="long" dir="in">
4509	<desc>Port number to detach the medium from.</desc>
4510	</param>
4511	<param name="device" type="long" dir="in">
4512	<desc>Device slot number to detach the medium from.</desc>
4513	</param>
4514	</method>
4515
4516	<method name="passthroughDevice">
4517	<desc>
4518	Sets the passthrough mode of an existing DVD device. Changing the
4519	setting while the VM is running is forbidden. The setting is only used
4520	if at VM start the device is configured as a host DVD drive, in all
4521	other cases it is ignored. The device must already exist; see
4522	<link to="IMachine::attachDevice"/> for how to attach a new device.
4523
4524	The @a controllerPort and @a device parameters specify the device slot and
4525	have have the same meaning as with <link to="IMachine::attachDevice" />.
4526
4527	<result name="E_INVALIDARG">
4528	SATA device, SATA port, IDE port or IDE slot out of range.
4529	</result>
4530	<result name="VBOX_E_INVALID_OBJECT_STATE">
4531	Attempt to modify an unregistered virtual machine.
4532	</result>
4533	<result name="VBOX_E_INVALID_VM_STATE">
4534	Invalid machine state.
4535	</result>
4536
4537	</desc>
4538	<param name="name" type="wstring" dir="in">
4539	<desc>Name of the storage controller.</desc>
4540	</param>
4541	<param name="controllerPort" type="long" dir="in">
4542	<desc>Storage controller port.</desc>
4543	</param>
4544	<param name="device" type="long" dir="in">
4545	<desc>Device slot in the given port.</desc>
4546	</param>
4547	<param name="passthrough" type="boolean" dir="in">
4548	<desc>New value for the passthrough setting.</desc>
4549	</param>
4550	</method>
4551
4552	<method name="setBandwidthGroupForDevice">
4553	<desc>
4554	Sets the passthrough mode of an existing DVD device. Changing the
4555	setting while the VM is running is forbidden. The setting is only used
4556	if at VM start the device is configured as a host DVD drive, in all
4557	other cases it is ignored. The device must already exist; see
4558	<link to="IMachine::attachDevice"/> for how to attach a new device.
4559
4560	The @a controllerPort and @a device parameters specify the device slot and
4561	have have the same meaning as with <link to="IMachine::attachDevice" />.
4562
4563	<result name="E_INVALIDARG">
4564	SATA device, SATA port, IDE port or IDE slot out of range.
4565	</result>
4566	<result name="VBOX_E_INVALID_OBJECT_STATE">
4567	Attempt to modify an unregistered virtual machine.
4568	</result>
4569	<result name="VBOX_E_INVALID_VM_STATE">
4570	Invalid machine state.
4571	</result>
4572
4573	</desc>
4574	<param name="name" type="wstring" dir="in">
4575	<desc>Name of the storage controller.</desc>
4576	</param>
4577	<param name="controllerPort" type="long" dir="in">
4578	<desc>Storage controller port.</desc>
4579	</param>
4580	<param name="device" type="long" dir="in">
4581	<desc>Device slot in the given port.</desc>
4582	</param>
4583	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4584	<desc>New value for the bandwidth group or NULL for no group.</desc>
4585	</param>
4586	</method>
4587
4588	<method name="mountMedium">
4589	<desc>
4590	Mounts a medium (<link to="IMedium" />, identified
4591	by the given UUID @a id) to the given storage controller
4592	(<link to="IStorageController" />, identified by @a name),
4593	at the indicated port and device. The device must already exist;
4594	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4595
4596	This method is intended only for managing removable media, where the
4597	device is fixed but media is changeable at runtime (such as DVDs
4598	and floppies). It cannot be used for fixed media such as hard disks.
4599
4600	The @a controllerPort and @a device parameters specify the device slot and
4601	have have the same meaning as with <link to="IMachine::attachDevice" />.
4602
4603	The specified device slot can have a medium mounted, which will be
4604	unmounted first. Specifying a zero UUID (or an empty string) for
4605	@a medium does just an unmount.
4606
4607	See <link to="IMedium"/> for more detailed information about
4608	attaching media.
4609
4610	<result name="E_INVALIDARG">
4611	SATA device, SATA port, IDE port or IDE slot out of range.
4612	</result>
4613	<result name="VBOX_E_INVALID_OBJECT_STATE">
4614	Attempt to attach medium to an unregistered virtual machine.
4615	</result>
4616	<result name="VBOX_E_INVALID_VM_STATE">
4617	Invalid machine state.
4618	</result>
4619	<result name="VBOX_E_OBJECT_IN_USE">
4620	Medium already attached to this or another virtual machine.
4621	</result>
4622
4623	</desc>
4624	<param name="name" type="wstring" dir="in">
4625	<desc>Name of the storage controller to attach the medium to.</desc>
4626	</param>
4627	<param name="controllerPort" type="long" dir="in">
4628	<desc>Port to attach the medium to.</desc>
4629	</param>
4630	<param name="device" type="long" dir="in">
4631	<desc>Device slot in the given port to attach the medium to.</desc>
4632	</param>
4633	<param name="medium" type="IMedium" dir="in">
4634	<desc>Medium to mount or NULL for an empty drive.</desc>
4635	</param>
4636	<param name="force" type="boolean" dir="in">
4637	<desc>Allows to force unmount/mount of a medium which is locked by
4638	the device slot in the given port to attach the medium to.</desc>
4639	</param>
4640	</method>
4641
4642	<method name="getMedium" const="yes">
4643	<desc>
4644	Returns the virtual medium attached to a device slot of the specified
4645	bus.
4646
4647	Note that if the medium was indirectly attached by
4648	<link to="#mountMedium"/> to the given device slot then this
4649	method will return not the same object as passed to the
4650	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4651	more detailed information about mounting a medium.
4652
4653	<result name="VBOX_E_OBJECT_NOT_FOUND">
4654	No medium attached to given slot/bus.
4655	</result>
4656
4657	</desc>
4658	<param name="name" type="wstring" dir="in">
4659	<desc>Name of the storage controller the medium is attached to.</desc>
4660	</param>
4661	<param name="controllerPort" type="long" dir="in">
4662	<desc>Port to query.</desc>
4663	</param>
4664	<param name="device" type="long" dir="in">
4665	<desc>Device slot in the given port to query.</desc>
4666	</param>
4667	<param name="medium" type="IMedium" dir="return">
4668	<desc>Attached medium object.</desc>
4669	</param>
4670	</method>
4671
4672	<method name="getMediumAttachmentsOfController" const="yes">
4673	<desc>
4674	Returns an array of medium attachments which are attached to the
4675	the controller with the given name.
4676
4677	<result name="VBOX_E_OBJECT_NOT_FOUND">
4678	A storage controller with given name doesn't exist.
4679	</result>
4680	</desc>
4681	<param name="name" type="wstring" dir="in"/>
4682	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4683	</method>
4684
4685	<method name="getMediumAttachment" const="yes">
4686	<desc>
4687	Returns a medium attachment which corresponds to the controller with
4688	the given name, on the given port and device slot.
4689
4690	<result name="VBOX_E_OBJECT_NOT_FOUND">
4691	No attachment exists for the given controller/port/device combination.
4692	</result>
4693	</desc>
4694	<param name="name" type="wstring" dir="in"/>
4695	<param name="controllerPort" type="long" dir="in"/>
4696	<param name="device" type="long" dir="in"/>
4697	<param name="attachment" type="IMediumAttachment" dir="return"/>
4698	</method>
4699
4700	<method name="attachHostPciDevice">
4701	<desc>
4702	Attaches host PCI device with the given (host) PCI address to the
4703	PCI bus of the virtual machine. Please note, that this operation
4704	is two phase, as real attachment will happen when VM will start,
4705	and most information will be delivered as IHostPciDevicePlugEvent
4706	on IVirtualBox event source.
4707	<note>
4708	Not yet implemented.
4709	</note>
4710
4711	<see>IHostPciDevicePlugEvent</see>
4712
4713	<result name="VBOX_E_INVALID_VM_STATE">
4714	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4715	</result>
4716	<result name="VBOX_E_PDM_ERROR">
4717	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4718	</result>
4719	<result name="VBOX_E_NOT_SUPPORTED">
4720	Hardware or host OS doesn't allow PCI device passthrought.
4721	</result>
4722	</desc>
4723	<param name="hostAddress" type="long" dir="in">
4724	<desc>Address of the host PCI device.</desc>
4725	</param>
4726	<param name="desiredGuestAddress" type="long" dir="in">
4727	<desc>Desired position of this device on guest PCI bus.</desc>
4728	</param>
4729	<param name="tryToUnbind" type="boolean" dir="in">
4730	<desc>If VMM shall try to unbind existing drivers from the
4731	device before attaching it to the guest.</desc>
4732	</param>
4733	</method>
4734
4735	<method name="detachHostPciDevice">
4736	<desc>
4737	Detach host PCI device from the virtual machine.
4738	Also HostPciDevicePlugEvent on IVirtualBox event source
4739	will be delivered. As currently we don't support hot device
4740	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4741
4742	<note>
4743	Not yet implemented.
4744	</note>
4745
4746	<see>IHostPciDevicePlugEvent</see>
4747
4748	<result name="VBOX_E_INVALID_VM_STATE">
4749	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4750	</result>
4751	<result name="VBOX_E_OBJECT_NOT_FOUND">
4752	This host device is not attached to this machine.
4753	</result>
4754	<result name="VBOX_E_PDM_ERROR">
4755	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4756	</result>
4757	<result name="VBOX_E_NOT_SUPPORTED">
4758	Hardware or host OS doesn't allow PCI device passthrought.
4759	</result>
4760	</desc>
4761	<param name="hostAddress" type="long" dir="in">
4762	<desc>Address of the host PCI device.</desc>
4763	</param>
4764	</method>
4765
4766	<method name="getNetworkAdapter" const="yes">
4767	<desc>
4768	Returns the network adapter associated with the given slot.
4769	Slots are numbered sequentially, starting with zero. The total
4770	number of adapters per machine is defined by the
4771	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
4772	so the maximum slot number is one less than that property's value.
4773
4774	<result name="E_INVALIDARG">
4775	Invalid @a slot number.
4776	</result>
4777
4778	</desc>
4779	<param name="slot" type="unsigned long" dir="in"/>
4780	<param name="adapter" type="INetworkAdapter" dir="return"/>
4781	</method>
4782
4783	<method name="addStorageController">
4784	<desc>
4785	Adds a new storage controller (SCSI, SAS or SATA controller) to the
4786	machine and returns it as an instance of
4787	<link to="IStorageController" />.
4788
4789	@a name identifies the controller for subsequent calls such as
4790	<link to="#getStorageControllerByName" />,
4791	<link to="#getStorageControllerByInstance" />,
4792	<link to="#removeStorageController" />,
4793	<link to="#attachDevice" /> or <link to="#mountMedium" />.
4794
4795	After the controller has been added, you can set its exact
4796	type by setting the <link to="IStorageController::controllerType" />.
4797
4798	<result name="VBOX_E_OBJECT_IN_USE">
4799	A storage controller with given name exists already.
4800	</result>
4801	<result name="E_INVALIDARG">
4802	Invalid @a controllerType.
4803	</result>
4804	</desc>
4805	<param name="name" type="wstring" dir="in"/>
4806	<param name="connectionType" type="StorageBus" dir="in"/>
4807	<param name="controller" type="IStorageController" dir="return"/>
4808	</method>
4809
4810	<method name="getStorageControllerByName" const="yes">
4811	<desc>
4812	Returns a storage controller with the given name.
4813
4814	<result name="VBOX_E_OBJECT_NOT_FOUND">
4815	A storage controller with given name doesn't exist.
4816	</result>
4817	</desc>
4818	<param name="name" type="wstring" dir="in"/>
4819	<param name="storageController" type="IStorageController" dir="return"/>
4820	</method>
4821
4822	<method name="getStorageControllerByInstance" const="yes">
4823	<desc>
4824	Returns a storage controller with the given instance number.
4825
4826	<result name="VBOX_E_OBJECT_NOT_FOUND">
4827	A storage controller with given instance number doesn't exist.
4828	</result>
4829	</desc>
4830	<param name="instance" type="unsigned long" dir="in"/>
4831	<param name="storageController" type="IStorageController" dir="return"/>
4832	</method>
4833
4834	<method name="removeStorageController">
4835	<desc>
4836	Removes a storage controller from the machine.
4837
4838	<result name="VBOX_E_OBJECT_NOT_FOUND">
4839	A storage controller with given name doesn't exist.
4840	</result>
4841	</desc>
4842	<param name="name" type="wstring" dir="in"/>
4843	</method>
4844
4845	<method name="setStorageControllerBootable">
4846	<desc>
4847	Sets the bootable flag of the storage controller with the given name.
4848
4849	<result name="VBOX_E_OBJECT_NOT_FOUND">
4850	A storage controller with given name doesn't exist.
4851	</result>
4852	<result name="VBOX_E_OBJECT_IN_USE">
4853	Another storage controller is marked as bootable already.
4854	</result>
4855	</desc>
4856	<param name="name" type="wstring" dir="in"/>
4857	<param name="bootable" type="boolean" dir="in"/>
4858	</method>
4859
4860	<method name="getSerialPort" const="yes">
4861	<desc>
4862	Returns the serial port associated with the given slot.
4863	Slots are numbered sequentially, starting with zero. The total
4864	number of serial ports per machine is defined by the
4865	<link to="ISystemProperties::serialPortCount"/> property,
4866	so the maximum slot number is one less than that property's value.
4867
4868	<result name="E_INVALIDARG">
4869	Invalid @a slot number.
4870	</result>
4871
4872	</desc>
4873	<param name="slot" type="unsigned long" dir="in"/>
4874	<param name="port" type="ISerialPort" dir="return"/>
4875	</method>
4876
4877	<method name="getParallelPort" const="yes">
4878	<desc>
4879	Returns the parallel port associated with the given slot.
4880	Slots are numbered sequentially, starting with zero. The total
4881	number of parallel ports per machine is defined by the
4882	<link to="ISystemProperties::parallelPortCount"/> property,
4883	so the maximum slot number is one less than that property's value.
4884
4885	<result name="E_INVALIDARG">
4886	Invalid @a slot number.
4887	</result>
4888
4889	</desc>
4890	<param name="slot" type="unsigned long" dir="in"/>
4891	<param name="port" type="IParallelPort" dir="return"/>
4892	</method>
4893
4894	<method name="getExtraDataKeys">
4895	<desc>
4896	Returns an array representing the machine-specific extra data keys
4897	which currently have values defined.
4898	</desc>
4899	<param name="value" type="wstring" dir="return" safearray="yes">
4900	<desc>Array of extra data keys.</desc>
4901	</param>
4902	</method>
4903
4904	<method name="getExtraData">
4905	<desc>
4906	Returns associated machine-specific extra data.
4907
4908	If the requested data @a key does not exist, this function will
4909	succeed and return an empty string in the @a value argument.
4910
4911	<result name="VBOX_E_FILE_ERROR">
4912	Settings file not accessible.
4913	</result>
4914	<result name="VBOX_E_XML_ERROR">
4915	Could not parse the settings file.
4916	</result>
4917
4918	</desc>
4919	<param name="key" type="wstring" dir="in">
4920	<desc>Name of the data key to get.</desc>
4921	</param>
4922	<param name="value" type="wstring" dir="return">
4923	<desc>Value of the requested data key.</desc>
4924	</param>
4925	</method>
4926
4927	<method name="setExtraData">
4928	<desc>
4929	Sets associated machine-specific extra data.
4930
4931	If you pass @c null or an empty string as a key @a value, the given
4932	@a key will be deleted.
4933
4934	<note>
4935	Before performing the actual data change, this method will ask all
4936	registered listeners using the
4937	<link to="IExtraDataCanChangeEvent"/>
4938	notification for a permission. If one of the listeners refuses the
4939	new value, the change will not be performed.
4940	</note>
4941	<note>
4942	On success, the
4943	<link to="IExtraDataChangedEvent"/> notification
4944	is called to inform all registered listeners about a successful data
4945	change.
4946	</note>
4947	<note>
4948	This method can be called outside the machine session and therefore
4949	it's a caller's responsibility to handle possible race conditions
4950	when several clients change the same key at the same time.
4951	</note>
4952
4953	<result name="VBOX_E_FILE_ERROR">
4954	Settings file not accessible.
4955	</result>
4956	<result name="VBOX_E_XML_ERROR">
4957	Could not parse the settings file.
4958	</result>
4959
4960	</desc>
4961	<param name="key" type="wstring" dir="in">
4962	<desc>Name of the data key to set.</desc>
4963	</param>
4964	<param name="value" type="wstring" dir="in">
4965	<desc>Value to assign to the key.</desc>
4966	</param>
4967	</method>
4968
4969	<method name="getCPUProperty" const="yes">
4970	<desc>
4971	Returns the virtual CPU boolean value of the specified property.
4972
4973	<result name="E_INVALIDARG">
4974	Invalid property.
4975	</result>
4976
4977	</desc>
4978	<param name="property" type="CPUPropertyType" dir="in">
4979	<desc>
4980	Property type to query.
4981	</desc>
4982	</param>
4983	<param name="value" type="boolean" dir="return">
4984	<desc>
4985	Property value.
4986	</desc>
4987	</param>
4988	</method>
4989
4990	<method name="setCPUProperty">
4991	<desc>
4992	Sets the virtual CPU boolean value of the specified property.
4993
4994	<result name="E_INVALIDARG">
4995	Invalid property.
4996	</result>
4997
4998	</desc>
4999	<param name="property" type="CPUPropertyType" dir="in">
5000	<desc>
5001	Property type to query.
5002	</desc>
5003	</param>
5004	<param name="value" type="boolean" dir="in">
5005	<desc>
5006	Property value.
5007	</desc>
5008	</param>
5009	</method>
5010
5011	<method name="getCPUIDLeaf" const="yes">
5012	<desc>
5013	Returns the virtual CPU cpuid information for the specified leaf.
5014
5015	Currently supported index values for cpuid:
5016	Standard CPUID leafs: 0 - 0xA
5017	Extended CPUID leafs: 0x80000000 - 0x8000000A
5018
5019	See the Intel and AMD programmer's manuals for detailed information
5020	about the cpuid instruction and its leafs.
5021	<result name="E_INVALIDARG">
5022	Invalid id.
5023	</result>
5024
5025	</desc>
5026	<param name="id" type="unsigned long" dir="in">
5027	<desc>
5028	CPUID leaf index.
5029	</desc>
5030	</param>
5031	<param name="valEax" type="unsigned long" dir="out">
5032	<desc>
5033	CPUID leaf value for register eax.
5034	</desc>
5035	</param>
5036	<param name="valEbx" type="unsigned long" dir="out">
5037	<desc>
5038	CPUID leaf value for register ebx.
5039	</desc>
5040	</param>
5041	<param name="valEcx" type="unsigned long" dir="out">
5042	<desc>
5043	CPUID leaf value for register ecx.
5044	</desc>
5045	</param>
5046	<param name="valEdx" type="unsigned long" dir="out">
5047	<desc>
5048	CPUID leaf value for register edx.
5049	</desc>
5050	</param>
5051	</method>
5052
5053	<method name="setCPUIDLeaf">
5054	<desc>
5055	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5056	are not passed unmodified. VirtualBox clears features that it doesn't support.
5057
5058	Currently supported index values for cpuid:
5059	Standard CPUID leafs: 0 - 0xA
5060	Extended CPUID leafs: 0x80000000 - 0x8000000A
5061
5062	See the Intel and AMD programmer's manuals for detailed information
5063	about the cpuid instruction and its leafs.
5064
5065	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5066	random crashes inside VMs.
5067	<result name="E_INVALIDARG">
5068	Invalid id.
5069	</result>
5070
5071	</desc>
5072	<param name="id" type="unsigned long" dir="in">
5073	<desc>
5074	CPUID leaf index.
5075	</desc>
5076	</param>
5077	<param name="valEax" type="unsigned long" dir="in">
5078	<desc>
5079	CPUID leaf value for register eax.
5080	</desc>
5081	</param>
5082	<param name="valEbx" type="unsigned long" dir="in">
5083	<desc>
5084	CPUID leaf value for register ebx.
5085	</desc>
5086	</param>
5087	<param name="valEcx" type="unsigned long" dir="in">
5088	<desc>
5089	CPUID leaf value for register ecx.
5090	</desc>
5091	</param>
5092	<param name="valEdx" type="unsigned long" dir="in">
5093	<desc>
5094	CPUID leaf value for register edx.
5095	</desc>
5096	</param>
5097	</method>
5098
5099	<method name="removeCPUIDLeaf">
5100	<desc>
5101	Removes the virtual CPU cpuid leaf for the specified index
5102
5103	<result name="E_INVALIDARG">
5104	Invalid id.
5105	</result>
5106
5107	</desc>
5108	<param name="id" type="unsigned long" dir="in">
5109	<desc>
5110	CPUID leaf index.
5111	</desc>
5112	</param>
5113	</method>
5114
5115	<method name="removeAllCPUIDLeaves">
5116	<desc>
5117	Removes all the virtual CPU cpuid leaves
5118	</desc>
5119	</method>
5120
5121	<method name="getHWVirtExProperty" const="yes">
5122	<desc>
5123	Returns the value of the specified hardware virtualization boolean property.
5124
5125	<result name="E_INVALIDARG">
5126	Invalid property.
5127	</result>
5128
5129	</desc>
5130	<param name="property" type="HWVirtExPropertyType" dir="in">
5131	<desc>
5132	Property type to query.
5133	</desc>
5134	</param>
5135	<param name="value" type="boolean" dir="return">
5136	<desc>
5137	Property value.
5138	</desc>
5139	</param>
5140	</method>
5141
5142	<method name="setHWVirtExProperty">
5143	<desc>
5144	Sets a new value for the specified hardware virtualization boolean property.
5145
5146	<result name="E_INVALIDARG">
5147	Invalid property.
5148	</result>
5149
5150	</desc>
5151	<param name="property" type="HWVirtExPropertyType" dir="in">
5152	<desc>
5153	Property type to set.
5154	</desc>
5155	</param>
5156	<param name="value" type="boolean" dir="in">
5157	<desc>
5158	New property value.
5159	</desc>
5160	</param>
5161	</method>
5162
5163	<method name="saveSettings">
5164	<desc>
5165	Saves any changes to machine settings made since the session
5166	has been opened or a new machine has been created, or since the
5167	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5168	For registered machines, new settings become visible to all
5169	other VirtualBox clients after successful invocation of this
5170	method.
5171	<note>
5172	The method sends <link to="IMachineDataChangedEvent"/>
5173	notification event after the configuration has been successfully
5174	saved (only for registered machines).
5175	</note>
5176	<note>
5177	Calling this method is only valid on instances returned
5178	by <link to="ISession::machine"/> and on new machines
5179	created by <link to="IVirtualBox::createMachine"/> but not
5180	yet registered, or on unregistered machines after calling
5181	<link to="IMachine::unregister"/>.
5182	</note>
5183
5184	<result name="VBOX_E_FILE_ERROR">
5185	Settings file not accessible.
5186	</result>
5187	<result name="VBOX_E_XML_ERROR">
5188	Could not parse the settings file.
5189	</result>
5190	<result name="E_ACCESSDENIED">
5191	Modification request refused.
5192	</result>
5193
5194	</desc>
5195	</method>
5196
5197	<method name="discardSettings">
5198	<desc>
5199	Discards any changes to the machine settings made since the session
5200	has been opened or since the last call to <link to="#saveSettings"/>
5201	or <link to="#discardSettings"/>.
5202	<note>
5203	Calling this method is only valid on instances returned
5204	by <link to="ISession::machine"/> and on new machines
5205	created by <link to="IVirtualBox::createMachine"/> or
5206	opened by <link to="IVirtualBox::openMachine"/> but not
5207	yet registered, or on unregistered machines after calling
5208	<link to="IMachine::unregister"/>.
5209	</note>
5210
5211	<result name="VBOX_E_INVALID_VM_STATE">
5212	Virtual machine is not mutable.
5213	</result>
5214
5215	</desc>
5216	</method>
5217
5218	<method name="unregister">
5219	<desc>
5220	Unregisters a machine previously registered with
5221	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5222	cleanup before the machine is unregistered.
5223
5224	This method does not delete any files. It only changes the machine configuration and
5225	the list of registered machines in the VirtualBox object. To delete the files which
5226	belonged to the machine, including the XML file of the machine itself, call
5227	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5228	from this method.
5229
5230	How thoroughly this method cleans up the machine configuration before unregistering
5231	the machine depends on the @a cleanupMode argument.
5232
5233	<ul>
5234	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5235	cleanup will be performed. The call will fail if the machine is in "Saved" state
5236	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5237	It is the responsibility of the caller to delete all such configuration in this mode.
5238	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5239	which it replaces.</li>
5240	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5241	state or if it has snapshots or media attached. All media attached to the current machine
5242	state or in snapshots will be detached. No medium objects will be returned;
5243	all of the machine's media will remain open.</li>
5244	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5245	except that all the hard disk medium objects which were detached from the machine will
5246	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5247	API for closing and deletion.</li>
5248	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5249	that all media will be returned in the array, including removable media like DVDs and
5250	floppies. This might be useful if the user wants to inspect in detail which media were
5251	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5252	in that case because users will typically want to preserve ISO and RAW image files.</li>
5253	</ul>
5254
5255	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5256	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5257	deleted with all its saved states and hard disk images, but images for removable
5258	drives (such as ISO and RAW files) will remain on disk.
5259
5260	This API does not verify whether the media files returned in the array are still
5261	attached to other machines (i.e. shared between several machines). If such a shared
5262	image is passed to <link to="#delete" /> however, closing the image will fail there
5263	and the image will be silently skipped.
5264
5265	This API may, however, move media from this machine's media registry to other media
5266	registries (see <link to="IMedium" /> for details on media registries). For machines
5267	created with VirtualBox 4.0 or later, if media from this machine's media registry
5268	are also attached to another machine (shared attachments), each such medium will be
5269	moved to another machine's registry. This is because without this machine's media
5270	registry, the other machine cannot find its media any more and would become inaccessible.
5271
5272	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5273	before unregistering it. It may also silently call saveSettings() on other machines
5274	if media are moved to other machines' media registries.
5275
5276	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5277	is fired.
5278
5279	The call will fail if the machine is currently locked (see <link to="ISession" />).
5280
5281	<note>
5282	If the given machine is inaccessible (see <link to="#accessible"/>), it
5283	will be unregistered and fully uninitialized right afterwards. As a result,
5284	the returned machine object will be unusable and an attempt to call
5285	<b>any</b> method will return the "Object not ready" error.
5286	</note>
5287
5288	<result name="VBOX_E_INVALID_OBJECT_STATE">
5289	Machine is currently locked for a session.
5290	</result>
5291	</desc>
5292
5293	<param name="cleanupMode" type="CleanupMode" dir="in">
5294	<desc>How to clean up after the machine has been unregistered.</desc>
5295	</param>
5296	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5297	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5298	</param>
5299	</method>
5300
5301	<method name="delete">
5302	<desc>
5303	Deletes the files associated with this machine from disk. If medium objects are passed
5304	in with the @a aMedia argument, they are closed and, if closing was successful, their
5305	storage files are deleted as well. For convenience, this array of media files can be
5306	the same as the one returned from a previous <link to="#unregister" /> call.
5307
5308	This method must only be called on machines which are either write-locked (i.e. on instances
5309	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5310	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5311	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5312
5313	The following files will be deleted by this method:
5314	<ul>
5315	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5316	argument other than "UnregisterOnly", this will delete all saved state files that
5317	the machine had in use; possibly one if the machine was in "Saved" state and one
5318	for each online snapshot that the machine had.</li>
5319	<li>On each medium object passed in the @a aMedia array, this will call
5320	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5321	medium's storage on disk. Since the close() call will fail if the medium is still
5322	in use, e.g. because it is still attached to a second machine; in that case the
5323	storage will not be deleted.</li>
5324	<li>Finally, the machine's own XML file will be deleted.</li>
5325	</ul>
5326
5327	Since deleting large disk image files can be a time-consuming I/O operation, this
5328	method operates asynchronously and returns an IProgress object to allow the caller
5329	to monitor the progress. There will be one sub-operation for each file that is
5330	being deleted (saved state or medium storage file).
5331
5332	<note>
5333	<link to="#settingsModified"/> will return @c true after this
5334	method successfully returns.
5335	</note>
5336
5337	<result name="VBOX_E_INVALID_VM_STATE">
5338	Machine is registered but not write-locked.
5339	</result>
5340	<result name="VBOX_E_IPRT_ERROR">
5341	Could not delete the settings file.
5342	</result>
5343	</desc>
5344	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5345	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5346	</param>
5347	<param name="aProgress" type="IProgress" dir="return">
5348	<desc>Progress object to track the operation completion.</desc>
5349	</param>
5350	</method>
5351
5352	<method name="export">
5353	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5354	steps required to export VirtualBox machines to OVF.
5355	</desc>
5356
5357	<param name="aAppliance" type="IAppliance" dir="in">
5358	<desc>Appliance to export this machine to.</desc>
5359	</param>
5360	<param name="location" type="wstring" dir="in">
5361	<desc>The target location.</desc>
5362	</param>
5363	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5364	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5365	</param>
5366	</method >
5367
5368	<method name="findSnapshot">
5369	<desc>
5370	Returns a snapshot of this machine with the given name or UUID.
5371
5372	Returns a snapshot of this machine with the given UUID.
5373	A @c null argument can be used to obtain the first snapshot
5374	taken on this machine. To traverse the whole tree of snapshots
5375	starting from the root, inspect the root snapshot's
5376	<link to="ISnapshot::children" /> attribute and recurse over those children.
5377
5378	<result name="VBOX_E_OBJECT_NOT_FOUND">
5379	Virtual machine has no snapshots or snapshot not found.
5380	</result>
5381
5382	</desc>
5383	<param name="nameOrId" type="wstring" dir="in">
5384	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5385	</param>
5386	<param name="snapshot" type="ISnapshot" dir="return">
5387	<desc>Snapshot object with the given name.</desc>
5388	</param>
5389	</method>
5390
5391	<method name="createSharedFolder">
5392	<desc>
5393	Creates a new permanent shared folder by associating the given logical
5394	name with the given host path, adds it to the collection of shared
5395	folders and starts sharing it. Refer to the description of
5396	<link to="ISharedFolder"/> to read more about logical names.
5397
5398	<result name="VBOX_E_OBJECT_IN_USE">
5399	Shared folder already exists.
5400	</result>
5401	<result name="VBOX_E_FILE_ERROR">
5402	Shared folder @a hostPath not accessible.
5403	</result>
5404
5405	</desc>
5406	<param name="name" type="wstring" dir="in">
5407	<desc>Unique logical name of the shared folder.</desc>
5408	</param>
5409	<param name="hostPath" type="wstring" dir="in">
5410	<desc>Full path to the shared folder in the host file system.</desc>
5411	</param>
5412	<param name="writable" type="boolean" dir="in">
5413	<desc>Whether the share is writable or readonly.</desc>
5414	</param>
5415	<param name="automount" type="boolean" dir="in">
5416	<desc>Whether the share gets automatically mounted by the guest
5417	or not.</desc>
5418	</param>
5419	</method>
5420
5421	<method name="removeSharedFolder">
5422	<desc>
5423	Removes the permanent shared folder with the given name previously
5424	created by <link to="#createSharedFolder"/> from the collection of
5425	shared folders and stops sharing it.
5426
5427	<result name="VBOX_E_INVALID_VM_STATE">
5428	Virtual machine is not mutable.
5429	</result>
5430	<result name="VBOX_E_OBJECT_NOT_FOUND">
5431	Shared folder @a name does not exist.
5432	</result>
5433
5434	</desc>
5435	<param name="name" type="wstring" dir="in">
5436	<desc>Logical name of the shared folder to remove.</desc>
5437	</param>
5438	</method>
5439
5440	<method name="canShowConsoleWindow">
5441	<desc>
5442	Returns @c true if the VM console process can activate the
5443	console window and bring it to foreground on the desktop of
5444	the host PC.
5445	<note>
5446	This method will fail if a session for this machine is not
5447	currently open.
5448	</note>
5449
5450	<result name="VBOX_E_INVALID_VM_STATE">
5451	Machine session is not open.
5452	</result>
5453
5454	</desc>
5455	<param name="canShow" type="boolean" dir="return">
5456	<desc>
5457	@c true if the console window can be shown and @c false otherwise.
5458	</desc>
5459	</param>
5460	</method>
5461
5462	<method name="showConsoleWindow">
5463	<desc>
5464	Activates the console window and brings it to foreground on
5465	the desktop of the host PC. Many modern window managers on
5466	many platforms implement some sort of focus stealing
5467	prevention logic, so that it may be impossible to activate
5468	a window without the help of the currently active
5469	application. In this case, this method will return a non-zero
5470	identifier that represents the top-level window of the VM
5471	console process. The caller, if it represents a currently
5472	active process, is responsible to use this identifier (in a
5473	platform-dependent manner) to perform actual window
5474	activation.
5475	<note>
5476	This method will fail if a session for this machine is not
5477	currently open.
5478	</note>
5479
5480	<result name="VBOX_E_INVALID_VM_STATE">
5481	Machine session is not open.
5482	</result>
5483
5484	</desc>
5485	<param name="winId" type="long long" dir="return">
5486	<desc>
5487	Platform-dependent identifier of the top-level VM console
5488	window, or zero if this method has performed all actions
5489	necessary to implement the <i>show window</i> semantics for
5490	the given platform and/or VirtualBox front-end.
5491	</desc>
5492	</param>
5493	</method>
5494
5495	<method name="getGuestProperty" const="yes">
5496	<desc>
5497	Reads an entry from the machine's guest property store.
5498
5499	<result name="VBOX_E_INVALID_VM_STATE">
5500	Machine session is not open.
5501	</result>
5502
5503	</desc>
5504	<param name="name" type="wstring" dir="in">
5505	<desc>
5506	The name of the property to read.
5507	</desc>
5508	</param>
5509	<param name="value" type="wstring" dir="out">
5510	<desc>
5511	The value of the property. If the property does not exist then this
5512	will be empty.
5513	</desc>
5514	</param>
5515	<param name="timestamp" type="long long" dir="out">
5516	<desc>
5517	The time at which the property was last modified, as seen by the
5518	server process.
5519	</desc>
5520	</param>
5521	<param name="flags" type="wstring" dir="out">
5522	<desc>
5523	Additional property parameters, passed as a comma-separated list of
5524	"name=value" type entries.
5525	</desc>
5526	</param>
5527	</method>
5528
5529	<method name="getGuestPropertyValue" const="yes">
5530	<desc>
5531	Reads a value from the machine's guest property store.
5532
5533	<result name="VBOX_E_INVALID_VM_STATE">
5534	Machine session is not open.
5535	</result>
5536
5537	</desc>
5538	<param name="property" type="wstring" dir="in">
5539	<desc>
5540	The name of the property to read.
5541	</desc>
5542	</param>
5543	<param name="value" type="wstring" dir="return">
5544	<desc>
5545	The value of the property. If the property does not exist then this
5546	will be empty.
5547	</desc>
5548	</param>
5549	</method>
5550
5551	<method name="getGuestPropertyTimestamp" const="yes">
5552	<desc>
5553	Reads a property timestamp from the machine's guest property store.
5554
5555	<result name="VBOX_E_INVALID_VM_STATE">
5556	Machine session is not open.
5557	</result>
5558
5559	</desc>
5560	<param name="property" type="wstring" dir="in">
5561	<desc>
5562	The name of the property to read.
5563	</desc>
5564	</param>
5565	<param name="value" type="long long" dir="return">
5566	<desc>
5567	The timestamp. If the property does not exist then this will be
5568	empty.
5569	</desc>
5570	</param>
5571	</method>
5572
5573	<method name="setGuestProperty">
5574	<desc>
5575	Sets, changes or deletes an entry in the machine's guest property
5576	store.
5577
5578	<result name="E_ACCESSDENIED">
5579	Property cannot be changed.
5580	</result>
5581	<result name="E_INVALIDARG">
5582	Invalid @a flags.
5583	</result>
5584	<result name="VBOX_E_INVALID_VM_STATE">
5585	Virtual machine is not mutable or session not open.
5586	</result>
5587	<result name="VBOX_E_INVALID_OBJECT_STATE">
5588	Cannot set transient property when machine not running.
5589	</result>
5590
5591	</desc>
5592	<param name="property" type="wstring" dir="in">
5593	<desc>
5594	The name of the property to set, change or delete.
5595	</desc>
5596	</param>
5597	<param name="value" type="wstring" dir="in">
5598	<desc>
5599	The new value of the property to set, change or delete. If the
5600	property does not yet exist and value is non-empty, it will be
5601	created. If the value is @c null or empty, the property will be
5602	deleted if it exists.
5603	</desc>
5604	</param>
5605	<param name="flags" type="wstring" dir="in">
5606	<desc>
5607	Additional property parameters, passed as a comma-separated list of
5608	"name=value" type entries.
5609	</desc>
5610	</param>
5611	</method>
5612
5613	<method name="setGuestPropertyValue">
5614	<desc>
5615	Sets, changes or deletes a value in the machine's guest property
5616	store. The flags field will be left unchanged or created empty for a
5617	new property.
5618
5619	<result name="E_ACCESSDENIED">
5620	Property cannot be changed.
5621	</result>
5622	<result name="VBOX_E_INVALID_VM_STATE">
5623	Virtual machine is not mutable or session not open.
5624	</result>
5625	<result name="VBOX_E_INVALID_OBJECT_STATE">
5626	Cannot set transient property when machine not running.
5627	</result>
5628	</desc>
5629
5630	<param name="property" type="wstring" dir="in">
5631	<desc>
5632	The name of the property to set, change or delete.
5633	</desc>
5634	</param>
5635	<param name="value" type="wstring" dir="in">
5636	<desc>
5637	The new value of the property to set, change or delete. If the
5638	property does not yet exist and value is non-empty, it will be
5639	created. If the value is @c null or empty, the property will be
5640	deleted if it exists.
5641	</desc>
5642	</param>
5643	</method>
5644
5645	<method name="enumerateGuestProperties">
5646	<desc>
5647	Return a list of the guest properties matching a set of patterns along
5648	with their values, time stamps and flags.
5649	</desc>
5650	<param name="patterns" type="wstring" dir="in">
5651	<desc>
5652	The patterns to match the properties against, separated by '\|'
5653	characters. If this is empty or @c null, all properties will match.
5654	</desc>
5655	</param>
5656	<param name="name" type="wstring" dir="out" safearray="yes">
5657	<desc>
5658	The names of the properties returned.
5659	</desc>
5660	</param>
5661	<param name="value" type="wstring" dir="out" safearray="yes">
5662	<desc>
5663	The values of the properties returned. The array entries match the
5664	corresponding entries in the @a name array.
5665	</desc>
5666	</param>
5667	<param name="timestamp" type="long long" dir="out" safearray="yes">
5668	<desc>
5669	The time stamps of the properties returned. The array entries match
5670	the corresponding entries in the @a name array.
5671	</desc>
5672	</param>
5673	<param name="flags" type="wstring" dir="out" safearray="yes">
5674	<desc>
5675	The flags of the properties returned. The array entries match the
5676	corresponding entries in the @a name array.
5677	</desc>
5678	</param>
5679	</method>
5680
5681	<method name="querySavedGuestSize">
5682	<desc>
5683	Returns the guest dimensions from the saved state.
5684	</desc>
5685	<param name="screenId" type="unsigned long" dir="in">
5686	<desc>
5687	Saved guest screen to query info from.
5688	</desc>
5689	</param>
5690	<param name="width" type="unsigned long" dir="out">
5691	<desc>
5692	Guest width at the time of the saved state was taken.
5693	</desc>
5694	</param>
5695	<param name="height" type="unsigned long" dir="out">
5696	<desc>
5697	Guest height at the time of the saved state was taken.
5698	</desc>
5699	</param>
5700	</method>
5701
5702	<method name="querySavedThumbnailSize">
5703	<desc>
5704	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5705	</desc>
5706	<param name="screenId" type="unsigned long" dir="in">
5707	<desc>
5708	Saved guest screen to query info from.
5709	</desc>
5710	</param>
5711	<param name="size" type="unsigned long" dir="out">
5712	<desc>
5713	Size of buffer required to store the bitmap.
5714	</desc>
5715	</param>
5716	<param name="width" type="unsigned long" dir="out">
5717	<desc>
5718	Bitmap width.
5719	</desc>
5720	</param>
5721	<param name="height" type="unsigned long" dir="out">
5722	<desc>
5723	Bitmap height.
5724	</desc>
5725	</param>
5726	</method>
5727
5728	<method name="readSavedThumbnailToArray">
5729	<desc>
5730	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5731	</desc>
5732	<param name="screenId" type="unsigned long" dir="in">
5733	<desc>
5734	Saved guest screen to read from.
5735	</desc>
5736	</param>
5737	<param name="BGR" type="boolean" dir="in">
5738	<desc>
5739	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
5740	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
5741	</desc>
5742	</param>
5743	<param name="width" type="unsigned long" dir="out">
5744	<desc>
5745	Bitmap width.
5746	</desc>
5747	</param>
5748	<param name="height" type="unsigned long" dir="out">
5749	<desc>
5750	Bitmap height.
5751	</desc>
5752	</param>
5753	<param name="data" type="octet" safearray="yes" dir="return">
5754	<desc>
5755	Array with resulting bitmap data.
5756	</desc>
5757	</param>
5758	</method>
5759
5760	<method name="readSavedThumbnailPNGToArray">
5761	<desc>
5762	Thumbnail in PNG format is retrieved to an array of bytes.
5763	</desc>
5764	<param name="screenId" type="unsigned long" dir="in">
5765	<desc>
5766	Saved guest screen to read from.
5767	</desc>
5768	</param>
5769	<param name="width" type="unsigned long" dir="out">
5770	<desc>
5771	Image width.
5772	</desc>
5773	</param>
5774	<param name="height" type="unsigned long" dir="out">
5775	<desc>
5776	Image height.
5777	</desc>
5778	</param>
5779	<param name="data" type="octet" dir="return" safearray="yes">
5780	<desc>
5781	Array with resulting PNG data.
5782	</desc>
5783	</param>
5784	</method>
5785
5786	<method name="querySavedScreenshotPNGSize">
5787	<desc>
5788	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
5789	</desc>
5790	<param name="screenId" type="unsigned long" dir="in">
5791	<desc>
5792	Saved guest screen to query info from.
5793	</desc>
5794	</param>
5795	<param name="size" type="unsigned long" dir="out">
5796	<desc>
5797	Size of buffer required to store the PNG binary data.
5798	</desc>
5799	</param>
5800	<param name="width" type="unsigned long" dir="out">
5801	<desc>
5802	Image width.
5803	</desc>
5804	</param>
5805	<param name="height" type="unsigned long" dir="out">
5806	<desc>
5807	Image height.
5808	</desc>
5809	</param>
5810	</method>
5811
5812	<method name="readSavedScreenshotPNGToArray">
5813	<desc>
5814	Screenshot in PNG format is retrieved to an array of bytes.
5815	</desc>
5816	<param name="screenId" type="unsigned long" dir="in">
5817	<desc>
5818	Saved guest screen to read from.
5819	</desc>
5820	</param>
5821	<param name="width" type="unsigned long" dir="out">
5822	<desc>
5823	Image width.
5824	</desc>
5825	</param>
5826	<param name="height" type="unsigned long" dir="out">
5827	<desc>
5828	Image height.
5829	</desc>
5830	</param>
5831	<param name="data" type="octet" dir="return" safearray="yes">
5832	<desc>
5833	Array with resulting PNG data.
5834	</desc>
5835	</param>
5836	</method>
5837
5838	<method name="hotPlugCPU">
5839	<desc>
5840	Plugs a CPU into the machine.
5841	</desc>
5842	<param name="cpu" type="unsigned long" dir="in">
5843	<desc>
5844	The CPU id to insert.
5845	</desc>
5846	</param>
5847	</method>
5848
5849	<method name="hotUnplugCPU">
5850	<desc>
5851	Removes a CPU from the machine.
5852	</desc>
5853	<param name="cpu" type="unsigned long" dir="in">
5854	<desc>
5855	The CPU id to remove.
5856	</desc>
5857	</param>
5858	</method>
5859
5860	<method name="getCPUStatus">
5861	<desc>
5862	Returns the current status of the given CPU.
5863	</desc>
5864	<param name="cpu" type="unsigned long" dir="in">
5865	<desc>
5866	The CPU id to check for.
5867	</desc>
5868	</param>
5869	<param name="attached" type="boolean" dir="return">
5870	<desc>
5871	Status of the CPU.
5872	</desc>
5873	</param>
5874	</method>
5875
5876	<method name="queryLogFilename">
5877	<desc>
5878	Queries for the VM log file name of an given index. Returns an empty
5879	string if a log file with that index doesn't exists.
5880	</desc>
5881	<param name="idx" type="unsigned long" dir="in">
5882	<desc>
5883	Which log file name to query. 0=current log file.
5884	</desc>
5885	</param>
5886	<param name="filename" type="wstring" dir="return">
5887	<desc>
5888	On return the full path to the log file or an empty string on error.
5889	</desc>
5890	</param>
5891	</method>
5892
5893	<method name="readLog">
5894	<desc>
5895	Reads the VM log file. The chunk size is limited, so even if you
5896	ask for a big piece there might be less data returned.
5897	</desc>
5898	<param name="idx" type="unsigned long" dir="in">
5899	<desc>
5900	Which log file to read. 0=current log file.
5901	</desc>
5902	</param>
5903	<param name="offset" type="long long" dir="in">
5904	<desc>
5905	Offset in the log file.
5906	</desc>
5907	</param>
5908	<param name="size" type="long long" dir="in">
5909	<desc>
5910	Chunk size to read in the log file.
5911	</desc>
5912	</param>
5913	<param name="data" type="octet" dir="return" safearray="yes">
5914	<desc>
5915	Data read from the log file. A data size of 0 means end of file
5916	if the requested chunk size was not 0. This is the unprocessed
5917	file data, i.e. the line ending style depends on the platform of
5918	the system the server is running on.
5919	</desc>
5920	</param>
5921	</method>
5922	</interface>
5923
5924	<!--
5925	// IConsole
5926	/////////////////////////////////////////////////////////////////////////
5927	-->
5928
5929	<interface
5930	name="IVRDEServerInfo" extends="$unknown"
5931	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
5932	wsmap="struct"
5933	>
5934	<desc>
5935	Contains information about the remote desktop (VRDE) server capabilities and status.
5936	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
5937	</desc>
5938
5939	<attribute name="active" type="boolean" readonly="yes">
5940	<desc>
5941	Whether the remote desktop connection is active.
5942	</desc>
5943	</attribute>
5944
5945	<attribute name="port" type="long" readonly="yes">
5946	<desc>
5947	VRDE server port number. If this property is equal to <tt>0</tt>, then
5948	the VRDE server failed to start, usually because there are no free IP
5949	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
5950	server has not yet been started.
5951	</desc>
5952	</attribute>
5953
5954	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
5955	<desc>
5956	How many times a client connected.
5957	</desc>
5958	</attribute>
5959
5960	<attribute name="beginTime" type="long long" readonly="yes">
5961	<desc>
5962	When the last connection was established, in milliseconds since 1970-01-01 UTC.
5963	</desc>
5964	</attribute>
5965
5966	<attribute name="endTime" type="long long" readonly="yes">
5967	<desc>
5968	When the last connection was terminated or the current time, if
5969	connection is still active, in milliseconds since 1970-01-01 UTC.
5970	</desc>
5971	</attribute>
5972
5973	<attribute name="bytesSent" type="long long" readonly="yes">
5974	<desc>
5975	How many bytes were sent in last or current, if still active, connection.
5976	</desc>
5977	</attribute>
5978
5979	<attribute name="bytesSentTotal" type="long long" readonly="yes">
5980	<desc>
5981	How many bytes were sent in all connections.
5982	</desc>
5983	</attribute>
5984
5985	<attribute name="bytesReceived" type="long long" readonly="yes">
5986	<desc>
5987	How many bytes were received in last or current, if still active, connection.
5988	</desc>
5989	</attribute>
5990
5991	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
5992	<desc>
5993	How many bytes were received in all connections.
5994	</desc>
5995	</attribute>
5996
5997	<attribute name="user" type="wstring" readonly="yes">
5998	<desc>
5999	Login user name supplied by the client.
6000	</desc>
6001	</attribute>
6002
6003	<attribute name="domain" type="wstring" readonly="yes">
6004	<desc>
6005	Login domain name supplied by the client.
6006	</desc>
6007	</attribute>
6008
6009	<attribute name="clientName" type="wstring" readonly="yes">
6010	<desc>
6011	The client name supplied by the client.
6012	</desc>
6013	</attribute>
6014
6015	<attribute name="clientIP" type="wstring" readonly="yes">
6016	<desc>
6017	The IP address of the client.
6018	</desc>
6019	</attribute>
6020
6021	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6022	<desc>
6023	The client software version number.
6024	</desc>
6025	</attribute>
6026
6027	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6028	<desc>
6029	Public key exchange method used when connection was established.
6030	Values: 0 - RDP4 public key exchange scheme.
6031	1 - X509 certificates were sent to client.
6032	</desc>
6033	</attribute>
6034
6035	</interface>
6036
6037	<interface
6038	name="IConsole" extends="$unknown"
6039	uuid="515e8e8d-f932-4d8e-9f32-79a52aead882"
6040	wsmap="managed"
6041	>
6042	<desc>
6043	The IConsole interface represents an interface to control virtual
6044	machine execution.
6045
6046	A console object gets created when a machine has been locked for a
6047	particular session (client process) using <link to="IMachine::lockMachine" />
6048	or <link to="IMachine::launchVMProcess"/>. The console object can
6049	then be found in the session's <link to="ISession::console" /> attribute.
6050
6051	Methods of the IConsole interface allow the caller to query the current
6052	virtual machine execution state, pause the machine or power it down, save
6053	the machine state or take a snapshot, attach and detach removable media
6054	and so on.
6055
6056	<see>ISession</see>
6057	</desc>
6058
6059	<attribute name="machine" type="IMachine" readonly="yes">
6060	<desc>
6061	Machine object for this console session.
6062	<note>
6063	This is a convenience property, it has the same value as
6064	<link to="ISession::machine"/> of the corresponding session
6065	object.
6066	</note>
6067	</desc>
6068	</attribute>
6069
6070	<attribute name="state" type="MachineState" readonly="yes">
6071	<desc>
6072	Current execution state of the machine.
6073	<note>
6074	This property always returns the same value as the corresponding
6075	property of the IMachine object for this console session.
6076	For the process that owns (executes) the VM, this is the
6077	preferable way of querying the VM state, because no IPC
6078	calls are made.
6079	</note>
6080	</desc>
6081	</attribute>
6082
6083	<attribute name="guest" type="IGuest" readonly="yes">
6084	<desc>Guest object.</desc>
6085	</attribute>
6086
6087	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6088	<desc>
6089	Virtual keyboard object.
6090	<note>
6091	If the machine is not running, any attempt to use
6092	the returned object will result in an error.
6093	</note>
6094	</desc>
6095	</attribute>
6096
6097	<attribute name="mouse" type="IMouse" readonly="yes">
6098	<desc>
6099	Virtual mouse object.
6100	<note>
6101	If the machine is not running, any attempt to use
6102	the returned object will result in an error.
6103	</note>
6104	</desc>
6105	</attribute>
6106
6107	<attribute name="display" type="IDisplay" readonly="yes">
6108	<desc>Virtual display object.
6109	<note>
6110	If the machine is not running, any attempt to use
6111	the returned object will result in an error.
6112	</note>
6113	</desc>
6114	</attribute>
6115
6116	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6117	<desc>Debugging interface.</desc>
6118	</attribute>
6119
6120	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6121	<desc>
6122	Collection of USB devices currently attached to the virtual
6123	USB controller.
6124	<note>
6125	The collection is empty if the machine is not running.
6126	</note>
6127	</desc>
6128	</attribute>
6129
6130	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6131	<desc>
6132	List of USB devices currently attached to the remote VRDE client.
6133	Once a new device is physically attached to the remote host computer,
6134	it appears in this list and remains there until detached.
6135	</desc>
6136	</attribute>
6137
6138	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6139	<desc>
6140	Collection of shared folders for the current session. These folders
6141	are called transient shared folders because they are available to the
6142	guest OS running inside the associated virtual machine only for the
6143	duration of the session (as opposed to
6144	<link to="IMachine::sharedFolders"/> which represent permanent shared
6145	folders). When the session is closed (e.g. the machine is powered down),
6146	these folders are automatically discarded.
6147
6148	New shared folders are added to the collection using
6149	<link to="#createSharedFolder"/>. Existing shared folders can be
6150	removed using <link to="#removeSharedFolder"/>.
6151	</desc>
6152	</attribute>
6153
6154	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6155	<desc>
6156	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6157	</desc>
6158	</attribute>
6159
6160	<attribute name="eventSource" type="IEventSource" readonly="yes">
6161	<desc>
6162	Event source for console events.
6163	</desc>
6164	</attribute>
6165
6166	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6167	<desc>Array of PCI devices attached to this machine.</desc>
6168	</attribute>
6169
6170	<method name="powerUp">
6171	<desc>
6172	Starts the virtual machine execution using the current machine
6173	state (that is, its current execution state, current settings and
6174	current storage devices).
6175
6176	<note>
6177	This method is only useful for front-ends that want to actually
6178	execute virtual machines in their own process (like the VirtualBox
6179	or VBoxSDL front-ends). Unless you are intending to write such a
6180	front-end, do not call this method. If you simply want to
6181	start virtual machine execution using one of the existing front-ends
6182	(for example the VirtualBox GUI or headless server), use
6183	<link to="IMachine::launchVMProcess"/> instead; these
6184	front-ends will power up the machine automatically for you.
6185	</note>
6186
6187	If the machine is powered off or aborted, the execution will
6188	start from the beginning (as if the real hardware were just
6189	powered on).
6190
6191	If the machine is in the <link to="MachineState_Saved"/> state,
6192	it will continue its execution the point where the state has
6193	been saved.
6194
6195	If the machine <link to="IMachine::teleporterEnabled"/> property is
6196	enabled on the machine being powered up, the machine will wait for an
6197	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6198	state. The returned progress object will have at least three
6199	operations where the last three are defined as: (1) powering up and
6200	starting TCP server, (2) waiting for incoming teleportations, and
6201	(3) perform teleportation. These operations will be reflected as the
6202	last three operations of the progress objected returned by
6203	<link to="IMachine::launchVMProcess"/> as well.
6204
6205	<see>#saveState</see>
6206
6207	<result name="VBOX_E_INVALID_VM_STATE">
6208	Virtual machine already running.
6209	</result>
6210	<result name="VBOX_E_HOST_ERROR">
6211	Host interface does not exist or name not set.
6212	</result>
6213	<result name="VBOX_E_FILE_ERROR">
6214	Invalid saved state file.
6215	</result>
6216	</desc>
6217	<param name="progress" type="IProgress" dir="return">
6218	<desc>Progress object to track the operation completion.</desc>
6219	</param>
6220	</method>
6221
6222	<method name="powerUpPaused">
6223	<desc>
6224	Identical to powerUp except that the VM will enter the
6225	<link to="MachineState_Paused"/> state, instead of
6226	<link to="MachineState_Running"/>.
6227
6228	<see>#powerUp</see>
6229	<result name="VBOX_E_INVALID_VM_STATE">
6230	Virtual machine already running.
6231	</result>
6232	<result name="VBOX_E_HOST_ERROR">
6233	Host interface does not exist or name not set.
6234	</result>
6235	<result name="VBOX_E_FILE_ERROR">
6236	Invalid saved state file.
6237	</result>
6238	</desc>
6239	<param name="progress" type="IProgress" dir="return">
6240	<desc>Progress object to track the operation completion.</desc>
6241	</param>
6242	</method>
6243
6244	<method name="powerDown">
6245	<desc>
6246	Initiates the power down procedure to stop the virtual machine
6247	execution.
6248
6249	The completion of the power down procedure is tracked using the returned
6250	IProgress object. After the operation is complete, the machine will go
6251	to the PoweredOff state.
6252	<result name="VBOX_E_INVALID_VM_STATE">
6253	Virtual machine must be Running, Paused or Stuck to be powered down.
6254	</result>
6255	</desc>
6256	<param name="progress" type="IProgress" dir="return">
6257	<desc>Progress object to track the operation completion.</desc>
6258	</param>
6259	</method>
6260
6261	<method name="reset">
6262	<desc>Resets the virtual machine.
6263	<result name="VBOX_E_INVALID_VM_STATE">
6264	Virtual machine not in Running state.
6265	</result>
6266	<result name="VBOX_E_VM_ERROR">
6267	Virtual machine error in reset operation.
6268	</result>
6269	</desc>
6270	</method>
6271
6272	<method name="pause">
6273	<desc>Pauses the virtual machine execution.
6274	<result name="VBOX_E_INVALID_VM_STATE">
6275	Virtual machine not in Running state.
6276	</result>
6277	<result name="VBOX_E_VM_ERROR">
6278	Virtual machine error in suspend operation.
6279	</result>
6280	</desc>
6281	</method>
6282
6283	<method name="resume">
6284	<desc>Resumes the virtual machine execution.
6285	<result name="VBOX_E_INVALID_VM_STATE">
6286	Virtual machine not in Paused state.
6287	</result>
6288	<result name="VBOX_E_VM_ERROR">
6289	Virtual machine error in resume operation.
6290	</result>
6291	</desc>
6292	</method>
6293
6294	<method name="powerButton">
6295	<desc>Sends the ACPI power button event to the guest.
6296	<result name="VBOX_E_INVALID_VM_STATE">
6297	Virtual machine not in Running state.
6298	</result>
6299	<result name="VBOX_E_PDM_ERROR">
6300	Controlled power off failed.
6301	</result>
6302	</desc>
6303	</method>
6304
6305	<method name="sleepButton">
6306	<desc>Sends the ACPI sleep button event to the guest.
6307	<result name="VBOX_E_INVALID_VM_STATE">
6308	Virtual machine not in Running state.
6309	</result>
6310	<result name="VBOX_E_PDM_ERROR">
6311	Sending sleep button event failed.
6312	</result>
6313	</desc>
6314	</method>
6315
6316	<method name="getPowerButtonHandled">
6317	<desc>Checks if the last power button event was handled by guest.
6318	<result name="VBOX_E_PDM_ERROR">
6319	Checking if the event was handled by the guest OS failed.
6320	</result>
6321	</desc>
6322	<param name="handled" type="boolean" dir="return"/>
6323	</method>
6324
6325	<method name="getGuestEnteredACPIMode">
6326	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6327	G1 (sleeping). If this method returns @c false, the guest will
6328	most likely not respond to external ACPI events.
6329	<result name="VBOX_E_INVALID_VM_STATE">
6330	Virtual machine not in Running state.
6331	</result>
6332	</desc>
6333	<param name="entered" type="boolean" dir="return"/>
6334	</method>
6335
6336	<method name="saveState">
6337	<desc>
6338	Saves the current execution state of a running virtual machine
6339	and stops its execution.
6340
6341	After this operation completes, the machine will go to the
6342	Saved state. Next time it is powered up, this state will
6343	be restored and the machine will continue its execution from
6344	the place where it was saved.
6345
6346	This operation differs from taking a snapshot to the effect
6347	that it doesn't create new differencing media. Also, once
6348	the machine is powered up from the state saved using this method,
6349	the saved state is deleted, so it will be impossible to return
6350	to this state later.
6351
6352	<note>
6353	On success, this method implicitly calls
6354	<link to="IMachine::saveSettings"/> to save all current machine
6355	settings (including runtime changes to the DVD medium, etc.).
6356	Together with the impossibility to change any VM settings when it is
6357	in the Saved state, this guarantees adequate hardware
6358	configuration of the machine when it is restored from the saved
6359	state file.
6360	</note>
6361
6362	<note>
6363	The machine must be in the Running or Paused state, otherwise
6364	the operation will fail.
6365	</note>
6366	<result name="VBOX_E_INVALID_VM_STATE">
6367	Virtual machine state neither Running nor Paused.
6368	</result>
6369	<result name="VBOX_E_FILE_ERROR">
6370	Failed to create directory for saved state file.
6371	</result>
6372
6373	<see><link to="#takeSnapshot"/></see>
6374	</desc>
6375	<param name="progress" type="IProgress" dir="return">
6376	<desc>Progress object to track the operation completion.</desc>
6377	</param>
6378	</method>
6379
6380	<method name="adoptSavedState">
6381	<desc>
6382	Associates the given saved state file to the virtual machine.
6383
6384	On success, the machine will go to the Saved state. Next time it is
6385	powered up, it will be restored from the adopted saved state and
6386	continue execution from the place where the saved state file was
6387	created.
6388
6389	The specified saved state file path may be absolute or relative to the
6390	folder the VM normally saves the state to (usually,
6391	<link to="IMachine::snapshotFolder"/>).
6392
6393	<note>
6394	It's a caller's responsibility to make sure the given saved state
6395	file is compatible with the settings of this virtual machine that
6396	represent its virtual hardware (memory size, storage disk configuration
6397	etc.). If there is a mismatch, the behavior of the virtual machine
6398	is undefined.
6399	</note>
6400	<result name="VBOX_E_INVALID_VM_STATE">
6401	Virtual machine state neither PoweredOff nor Aborted.
6402	</result>
6403	</desc>
6404	<param name="savedStateFile" type="wstring" dir="in">
6405	<desc>Path to the saved state file to adopt.</desc>
6406	</param>
6407	</method>
6408
6409	<method name="discardSavedState">
6410	<desc>
6411	Forcibly resets the machine to "Powered Off" state if it is
6412	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6413	Next time the machine is powered up, a clean boot will occur.
6414	<note>
6415	This operation is equivalent to resetting or powering off
6416	the machine without doing a proper shutdown of the guest
6417	operating system; as with resetting a running phyiscal
6418	computer, it can can lead to data loss.
6419	</note>
6420	If @a fRemoveFile is @c true, the file in the machine directory
6421	into which the machine state was saved is also deleted. If
6422	this is @c false, then the state can be recovered and later
6423	re-inserted into a machine using <link to="#adoptSavedState" />.
6424	The location of the file can be found in the
6425	<link to="IMachine::stateFilePath" /> attribute.
6426	<result name="VBOX_E_INVALID_VM_STATE">
6427	Virtual machine not in state Saved.
6428	</result>
6429	</desc>
6430	<param name="fRemoveFile" type="boolean" dir="in" >
6431	<desc>Whether to also remove the saved state file.</desc>
6432	</param>
6433	</method>
6434
6435	<method name="getDeviceActivity">
6436	<desc>
6437	Gets the current activity type of a given device or device group.
6438	<result name="E_INVALIDARG">
6439	Invalid device type.
6440	</result>
6441	</desc>
6442	<param name="type" type="DeviceType" dir="in"/>
6443	<param name="activity" type="DeviceActivity" dir="return"/>
6444	</method>
6445
6446	<method name="attachUSBDevice">
6447	<desc>
6448	Attaches a host USB device with the given UUID to the
6449	USB controller of the virtual machine.
6450
6451	The device needs to be in one of the following states:
6452	<link to="USBDeviceState_Busy"/>,
6453	<link to="USBDeviceState_Available"/> or
6454	<link to="USBDeviceState_Held"/>,
6455	otherwise an error is immediately returned.
6456
6457	When the device state is
6458	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6459	be returned if the host computer refuses to release it for some reason.
6460
6461	<see>IUSBController::deviceFilters, USBDeviceState</see>
6462	<result name="VBOX_E_INVALID_VM_STATE">
6463	Virtual machine state neither Running nor Paused.
6464	</result>
6465	<result name="VBOX_E_PDM_ERROR">
6466	Virtual machine does not have a USB controller.
6467	</result>
6468	</desc>
6469	<param name="id" type="uuid" mod="string" dir="in">
6470	<desc>UUID of the host USB device to attach.</desc>
6471	</param>
6472	</method>
6473
6474	<method name="detachUSBDevice">
6475	<desc>
6476	Detaches an USB device with the given UUID from the USB controller
6477	of the virtual machine.
6478
6479	After this method succeeds, the VirtualBox server re-initiates
6480	all USB filters as if the device were just physically attached
6481	to the host, but filters of this machine are ignored to avoid
6482	a possible automatic re-attachment.
6483
6484	<see>IUSBController::deviceFilters, USBDeviceState</see>
6485
6486	<result name="VBOX_E_PDM_ERROR">
6487	Virtual machine does not have a USB controller.
6488	</result>
6489	<result name="E_INVALIDARG">
6490	USB device not attached to this virtual machine.
6491	</result>
6492	</desc>
6493	<param name="id" type="uuid" mod="string" dir="in">
6494	<desc>UUID of the USB device to detach.</desc>
6495	</param>
6496	<param name="device" type="IUSBDevice" dir="return">
6497	<desc>Detached USB device.</desc>
6498	</param>
6499	</method>
6500
6501	<method name="findUSBDeviceByAddress">
6502	<desc>
6503	Searches for a USB device with the given host address.
6504
6505	<result name="VBOX_E_OBJECT_NOT_FOUND">
6506	Given @c name does not correspond to any USB device.
6507	</result>
6508
6509	<see>IUSBDevice::address</see>
6510	</desc>
6511	<param name="name" type="wstring" dir="in">
6512	<desc>
6513	Address of the USB device (as assigned by the host) to
6514	search for.
6515	</desc>
6516	</param>
6517	<param name="device" type="IUSBDevice" dir="return">
6518	<desc>Found USB device object.</desc>
6519	</param>
6520	</method>
6521
6522	<method name="findUSBDeviceById">
6523	<desc>
6524	Searches for a USB device with the given UUID.
6525
6526	<result name="VBOX_E_OBJECT_NOT_FOUND">
6527	Given @c id does not correspond to any USB device.
6528	</result>
6529
6530	<see>IUSBDevice::id</see>
6531	</desc>
6532	<param name="id" type="uuid" mod="string" dir="in">
6533	<desc>UUID of the USB device to search for.</desc>
6534	</param>
6535	<param name="device" type="IUSBDevice" dir="return">
6536	<desc>Found USB device object.</desc>
6537	</param>
6538	</method>
6539
6540	<method name="createSharedFolder">
6541	<desc>
6542	Creates a transient new shared folder by associating the given logical
6543	name with the given host path, adds it to the collection of shared
6544	folders and starts sharing it. Refer to the description of
6545	<link to="ISharedFolder"/> to read more about logical names.
6546
6547	<result name="VBOX_E_INVALID_VM_STATE">
6548	Virtual machine in Saved state or currently changing state.
6549	</result>
6550	<result name="VBOX_E_FILE_ERROR">
6551	Shared folder already exists or not accessible.
6552	</result>
6553	</desc>
6554	<param name="name" type="wstring" dir="in">
6555	<desc>Unique logical name of the shared folder.</desc>
6556	</param>
6557	<param name="hostPath" type="wstring" dir="in">
6558	<desc>Full path to the shared folder in the host file system.</desc>
6559	</param>
6560	<param name="writable" type="boolean" dir="in">
6561	<desc>Whether the share is writable or readonly</desc>
6562	</param>
6563	<param name="automount" type="boolean" dir="in">
6564	<desc>Whether the share gets automatically mounted by the guest
6565	or not.</desc>
6566	</param>
6567	</method>
6568
6569	<method name="removeSharedFolder">
6570	<desc>
6571	Removes a transient shared folder with the given name previously
6572	created by <link to="#createSharedFolder"/> from the collection of
6573	shared folders and stops sharing it.
6574	<result name="VBOX_E_INVALID_VM_STATE">
6575	Virtual machine in Saved state or currently changing state.
6576	</result>
6577	<result name="VBOX_E_FILE_ERROR">
6578	Shared folder does not exists.
6579	</result>
6580	</desc>
6581	<param name="name" type="wstring" dir="in">
6582	<desc>Logical name of the shared folder to remove.</desc>
6583	</param>
6584	</method>
6585
6586	<method name="takeSnapshot">
6587	<desc>
6588	Saves the current execution state
6589	and all settings of the machine and creates differencing images
6590	for all normal (non-independent) media.
6591	See <link to="ISnapshot" /> for an introduction to snapshots.
6592
6593	This method can be called for a PoweredOff, Saved (see
6594	<link to="#saveState"/>), Running or
6595	Paused virtual machine. When the machine is PoweredOff, an
6596	offline snapshot is created. When the machine is Running a live
6597	snapshot is created, and an online snapshot is is created when Paused.
6598
6599	The taken snapshot is always based on the
6600	<link to="IMachine::currentSnapshot">current snapshot</link>
6601	of the associated virtual machine and becomes a new current snapshot.
6602
6603	<note>
6604	This method implicitly calls <link to="IMachine::saveSettings"/> to
6605	save all current machine settings before taking an offline snapshot.
6606	</note>
6607
6608	<result name="VBOX_E_INVALID_VM_STATE">
6609	Virtual machine currently changing state.
6610	</result>
6611	</desc>
6612	<param name="name" type="wstring" dir="in">
6613	<desc>Short name for the snapshot.</desc>
6614	</param>
6615	<param name="description" type="wstring" dir="in">
6616	<desc>Optional description of the snapshot.</desc>
6617	</param>
6618	<param name="progress" type="IProgress" dir="return">
6619	<desc>Progress object to track the operation completion.</desc>
6620	</param>
6621	</method>
6622
6623	<method name="deleteSnapshot">
6624	<desc>
6625	Starts deleting the specified snapshot asynchronously.
6626	See <link to="ISnapshot" /> for an introduction to snapshots.
6627
6628	The execution state and settings of the associated machine stored in
6629	the snapshot will be deleted. The contents of all differencing media of
6630	this snapshot will be merged with the contents of their dependent child
6631	media to keep the medium chain valid (in other words, all changes
6632	represented by media being deleted will be propagated to their child
6633	medium). After that, this snapshot's differencing medium will be
6634	deleted. The parent of this snapshot will become a new parent for all
6635	its child snapshots.
6636
6637	If the deleted snapshot is the current one, its parent snapshot will
6638	become a new current snapshot. The current machine state is not directly
6639	affected in this case, except that currently attached differencing
6640	media based on media of the deleted snapshot will be also merged as
6641	described above.
6642
6643	If the deleted snapshot is the first or current snapshot, then the
6644	respective IMachine attributes will be adjusted. Deleting the current
6645	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6646	to make all current machine settings permanent.
6647
6648	Deleting a snapshot has the following preconditions:
6649
6650	<ul>
6651	<li>Child media of all normal media of the deleted snapshot
6652	must be accessible (see <link to="IMedium::state"/>) for this
6653	operation to succeed. In particular, this means that all virtual
6654	machines whose media are directly or indirectly based on the
6655	media of deleted snapshot must be powered off.</li>
6656
6657	<li>You cannot delete the snapshot if a medium attached to it has
6658	more than once child medium (differencing images) because otherwise
6659	merging would be impossible. This might be the case if there is
6660	more than one child snapshot or differencing images were created
6661	for other reason (e.g. implicitly because of multiple machine
6662	attachments).</li>
6663	</ul>
6664
6665
6666	The virtual machine's <link to="IMachine::state">state</link> is
6667	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6668	"DeletingSnapshotPaused" while this operation is in progress.
6669
6670	<note>
6671	Merging medium contents can be very time and disk space
6672	consuming, if these media are big in size and have many
6673	children. However, if the snapshot being deleted is the last
6674	(head) snapshot on the branch, the operation will be rather
6675	quick.
6676	</note>
6677	<result name="VBOX_E_INVALID_VM_STATE">
6678	The running virtual machine prevents deleting this snapshot. This
6679	happens only in very specific situations, usually snapshots can be
6680	deleted without trouble while a VM is running. The error message
6681	text explains the reason for the failure.
6682	</result>
6683	</desc>
6684	<param name="id" type="uuid" mod="string" dir="in">
6685	<desc>UUID of the snapshot to delete.</desc>
6686	</param>
6687	<param name="progress" type="IProgress" dir="return">
6688	<desc>Progress object to track the operation completion.</desc>
6689	</param>
6690	</method>
6691
6692	<method name="restoreSnapshot">
6693	<desc>
6694	Starts resetting the machine's current state to the state contained
6695	in the given snapshot, asynchronously. All current settings of the
6696	machine will be reset and changes stored in differencing media
6697	will be lost.
6698	See <link to="ISnapshot" /> for an introduction to snapshots.
6699
6700	After this operation is successfully completed, new empty differencing
6701	media are created for all normal media of the machine.
6702
6703	If the given snapshot is an online snapshot, the machine will go to
6704	the <link to="MachineState_Saved"> saved state</link>, so that the
6705	next time it is powered on, the execution state will be restored
6706	from the state of the snapshot.
6707
6708	<note>
6709	The machine must not be running, otherwise the operation will fail.
6710	</note>
6711
6712	<note>
6713	If the machine state is <link to="MachineState_Saved">Saved</link>
6714	prior to this operation, the saved state file will be implicitly
6715	deleted (as if <link to="IConsole::discardSavedState"/> were
6716	called).
6717	</note>
6718
6719	<result name="VBOX_E_INVALID_VM_STATE">
6720	Virtual machine is running.
6721	</result>
6722	</desc>
6723	<param name="snapshot" type="ISnapshot" dir="in">
6724	<desc>The snapshot to restore the VM state from.</desc>
6725	</param>
6726	<param name="progress" type="IProgress" dir="return">
6727	<desc>Progress object to track the operation completion.</desc>
6728	</param>
6729	</method>
6730
6731	<method name="teleport">
6732	<desc>
6733	Teleport the VM to a different host machine or process.
6734
6735	TODO explain the details.
6736
6737	<result name="VBOX_E_INVALID_VM_STATE">
6738	Virtual machine not running or paused.
6739	</result>
6740	</desc>
6741	<param name="hostname" type="wstring" dir="in">
6742	<desc>The name or IP of the host to teleport to.</desc>
6743	</param>
6744	<param name="tcpport" type="unsigned long" dir="in">
6745	<desc>The TCP port to connect to (1..65535).</desc>
6746	</param>
6747	<param name="password" type="wstring" dir="in">
6748	<desc>The password.</desc>
6749	</param>
6750	<param name="maxDowntime" type="unsigned long" dir="in">
6751	<desc>
6752	The maximum allowed downtime given as milliseconds. 0 is not a valid
6753	value. Recommended value: 250 ms.
6754
6755	The higher the value is, the greater the chance for a successful
6756	teleportation. A small value may easily result in the teleportation
6757	process taking hours and eventually fail.
6758
6759	<note>
6760	The current implementation treats this a guideline, not as an
6761	absolute rule.
6762	</note>
6763	</desc>
6764	</param>
6765	<param name="progress" type="IProgress" dir="return">
6766	<desc>Progress object to track the operation completion.</desc>
6767	</param>
6768	</method>
6769
6770	</interface>
6771
6772	<!--
6773	// IHost
6774	/////////////////////////////////////////////////////////////////////////
6775	-->
6776
6777	<enum
6778	name="HostNetworkInterfaceMediumType"
6779	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
6780	>
6781	<desc>
6782	Type of encapsulation. Ethernet encapsulation includes both wired and
6783	wireless Ethernet connections.
6784	<see>IHostNetworkInterface</see>
6785	</desc>
6786
6787	<const name="Unknown" value="0">
6788	<desc>
6789	The type of interface cannot be determined.
6790	</desc>
6791	</const>
6792	<const name="Ethernet" value="1">
6793	<desc>
6794	Ethernet frame encapsulation.
6795	</desc>
6796	</const>
6797	<const name="PPP" value="2">
6798	<desc>
6799	Point-to-point protocol encapsulation.
6800	</desc>
6801	</const>
6802	<const name="SLIP" value="3">
6803	<desc>
6804	Serial line IP encapsulation.
6805	</desc>
6806	</const>
6807	</enum>
6808
6809	<enum
6810	name="HostNetworkInterfaceStatus"
6811	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
6812	>
6813	<desc>
6814	Current status of the interface.
6815	<see>IHostNetworkInterface</see>
6816	</desc>
6817
6818	<const name="Unknown" value="0">
6819	<desc>
6820	The state of interface cannot be determined.
6821	</desc>
6822	</const>
6823	<const name="Up" value="1">
6824	<desc>
6825	The interface is fully operational.
6826	</desc>
6827	</const>
6828	<const name="Down" value="2">
6829	<desc>
6830	The interface is not functioning.
6831	</desc>
6832	</const>
6833	</enum>
6834
6835	<enum
6836	name="HostNetworkInterfaceType"
6837	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
6838	>
6839	<desc>
6840	Network interface type.
6841	</desc>
6842	<const name="Bridged" value="1"/>
6843	<const name="HostOnly" value="2"/>
6844	</enum>
6845
6846	<interface
6847	name="IHostNetworkInterface" extends="$unknown"
6848	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
6849	wsmap="managed"
6850	>
6851	<desc>
6852	Represents one of host's network interfaces. IP V6 address and network
6853	mask are strings of 32 hexdecimal digits grouped by four. Groups are
6854	separated by colons.
6855	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
6856	</desc>
6857	<attribute name="name" type="wstring" readonly="yes">
6858	<desc>Returns the host network interface name.</desc>
6859	</attribute>
6860
6861	<attribute name="id" type="uuid" mod="string" readonly="yes">
6862	<desc>Returns the interface UUID.</desc>
6863	</attribute>
6864
6865	<attribute name="networkName" type="wstring" readonly="yes">
6866	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
6867	</attribute>
6868
6869	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
6870	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
6871	</attribute>
6872
6873	<attribute name="IPAddress" type="wstring" readonly="yes">
6874	<desc>Returns the IP V4 address of the interface.</desc>
6875	</attribute>
6876
6877	<attribute name="networkMask" type="wstring" readonly="yes">
6878	<desc>Returns the network mask of the interface.</desc>
6879	</attribute>
6880
6881	<attribute name="IPV6Supported" type="boolean" readonly="yes">
6882	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
6883	</attribute>
6884
6885	<attribute name="IPV6Address" type="wstring" readonly="yes">
6886	<desc>Returns the IP V6 address of the interface.</desc>
6887	</attribute>
6888
6889	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
6890	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
6891	</attribute>
6892
6893	<attribute name="hardwareAddress" type="wstring" readonly="yes">
6894	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
6895	</attribute>
6896
6897	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
6898	<desc>Type of protocol encapsulation used.</desc>
6899	</attribute>
6900
6901	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
6902	<desc>Status of the interface.</desc>
6903	</attribute>
6904
6905	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
6906	<desc>specifies the host interface type.</desc>
6907	</attribute>
6908
6909	<method name="enableStaticIpConfig">
6910	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
6911	<param name="IPAddress" type="wstring" dir="in">
6912	<desc>
6913	IP address.
6914	</desc>
6915	</param>
6916	<param name="networkMask" type="wstring" dir="in">
6917	<desc>
6918	network mask.
6919	</desc>
6920	</param>
6921	</method>
6922
6923	<method name="enableStaticIpConfigV6">
6924	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
6925	<param name="IPV6Address" type="wstring" dir="in">
6926	<desc>
6927	IP address.
6928	</desc>
6929	</param>
6930	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
6931	<desc>
6932	network mask.
6933	</desc>
6934	</param>
6935	</method>
6936
6937	<method name="enableDynamicIpConfig">
6938	<desc>enables the dynamic IP configuration.</desc>
6939	</method>
6940
6941	<method name="dhcpRediscover">
6942	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
6943	</method>
6944
6945	</interface>
6946
6947	<interface
6948	name="IHost" extends="$unknown"
6949	uuid="35b004f4-7806-4009-bfa8-d1308adba7e5"
6950	wsmap="managed"
6951	>
6952	<desc>
6953	The IHost interface represents the physical machine that this VirtualBox
6954	installation runs on.
6955
6956	An object implementing this interface is returned by the
6957	<link to="IVirtualBox::host" /> attribute. This interface contains
6958	read-only information about the host's physical hardware (such as what
6959	processors and disks are available, what the host operating system is,
6960	and so on) and also allows for manipulating some of the host's hardware,
6961	such as global USB device filters and host interface networking.
6962
6963	</desc>
6964	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
6965	<desc>List of DVD drives available on the host.</desc>
6966	</attribute>
6967
6968	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
6969	<desc>List of floppy drives available on the host.</desc>
6970	</attribute>
6971
6972	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6973	<desc>
6974	List of USB devices currently attached to the host.
6975	Once a new device is physically attached to the host computer,
6976	it appears in this list and remains there until detached.
6977
6978	<note>
6979	If USB functionality is not available in the given edition of
6980	VirtualBox, this method will set the result code to @c E_NOTIMPL.
6981	</note>
6982	</desc>
6983	</attribute>
6984
6985	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
6986	<desc>
6987	List of USB device filters in action.
6988	When a new device is physically attached to the host computer,
6989	filters from this list are applied to it (in order they are stored
6990	in the list). The first matched filter will determine the
6991	<link to="IHostUSBDeviceFilter::action">action</link>
6992	performed on the device.
6993
6994	Unless the device is ignored by these filters, filters of all
6995	currently running virtual machines
6996	(<link to="IUSBController::deviceFilters"/>) are applied to it.
6997
6998	<note>
6999	If USB functionality is not available in the given edition of
7000	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7001	</note>
7002
7003	<see>IHostUSBDeviceFilter, USBDeviceState</see>
7004	</desc>
7005	</attribute>
7006
7007	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7008	<desc>List of host network interfaces currently defined on the host.</desc>
7009	</attribute>
7010
7011	<attribute name="processorCount" type="unsigned long" readonly="yes">
7012	<desc>Number of (logical) CPUs installed in the host system.</desc>
7013	</attribute>
7014
7015	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7016	<desc>Number of (logical) CPUs online in the host system.</desc>
7017	</attribute>
7018
7019	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7020	<desc>Number of physical processor cores installed in the host system.</desc>
7021	</attribute>
7022
7023	<method name="getProcessorSpeed">
7024	<desc>Query the (approximate) maximum speed of a specified host CPU in
7025	Megahertz.
7026	</desc>
7027	<param name="cpuId" type="unsigned long" dir="in">
7028	<desc>
7029	Identifier of the CPU.
7030	</desc>
7031	</param>
7032	<param name="speed" type="unsigned long" dir="return">
7033	<desc>
7034	Speed value. 0 is returned if value is not known or @a cpuId is
7035	invalid.
7036	</desc>
7037	</param>
7038	</method>
7039
7040	<method name="getProcessorFeature">
7041	<desc>Query whether a CPU feature is supported or not.</desc>
7042	<param name="feature" type="ProcessorFeature" dir="in">
7043	<desc>
7044	CPU Feature identifier.
7045	</desc>
7046	</param>
7047	<param name="supported" type="boolean" dir="return">
7048	<desc>
7049	Feature is supported or not.
7050	</desc>
7051	</param>
7052	</method>
7053
7054	<method name="getProcessorDescription">
7055	<desc>Query the model string of a specified host CPU.
7056	</desc>
7057	<param name="cpuId" type="unsigned long" dir="in">
7058	<desc>
7059	Identifier of the CPU.
7060	<note>
7061	The current implementation might not necessarily return the
7062	description for this exact CPU.
7063	</note>
7064	</desc>
7065	</param>
7066	<param name="description" type="wstring" dir="return">
7067	<desc>
7068	Model string. An empty string is returned if value is not known or
7069	@a cpuId is invalid.
7070	</desc>
7071	</param>
7072	</method>
7073
7074	<method name="getProcessorCPUIDLeaf">
7075	<desc>
7076	Returns the CPU cpuid information for the specified leaf.
7077	</desc>
7078	<param name="cpuId" type="unsigned long" dir="in">
7079	<desc>
7080	Identifier of the CPU. The CPU most be online.
7081	<note>
7082	The current implementation might not necessarily return the
7083	description for this exact CPU.
7084	</note>
7085	</desc>
7086	</param>
7087	<param name="leaf" type="unsigned long" dir="in">
7088	<desc>
7089	CPUID leaf index (eax).
7090	</desc>
7091	</param>
7092	<param name="subLeaf" type="unsigned long" dir="in">
7093	<desc>
7094	CPUID leaf sub index (ecx). This currently only applies to cache
7095	information on Intel CPUs. Use 0 if retrieving values for
7096	<link to="IMachine::setCPUIDLeaf"/>.
7097	</desc>
7098	</param>
7099	<param name="valEax" type="unsigned long" dir="out">
7100	<desc>
7101	CPUID leaf value for register eax.
7102	</desc>
7103	</param>
7104	<param name="valEbx" type="unsigned long" dir="out">
7105	<desc>
7106	CPUID leaf value for register ebx.
7107	</desc>
7108	</param>
7109	<param name="valEcx" type="unsigned long" dir="out">
7110	<desc>
7111	CPUID leaf value for register ecx.
7112	</desc>
7113	</param>
7114	<param name="valEdx" type="unsigned long" dir="out">
7115	<desc>
7116	CPUID leaf value for register edx.
7117	</desc>
7118	</param>
7119	</method>
7120
7121	<attribute name="memorySize" type="unsigned long" readonly="yes">
7122	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7123	</attribute>
7124
7125	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7126	<desc>Available system memory in the host system.</desc>
7127	</attribute>
7128
7129	<attribute name="operatingSystem" type="wstring" readonly="yes">
7130	<desc>Name of the host system's operating system.</desc>
7131	</attribute>
7132
7133	<attribute name="OSVersion" type="wstring" readonly="yes">
7134	<desc>Host operating system's version string.</desc>
7135	</attribute>
7136
7137	<attribute name="UTCTime" type="long long" readonly="yes">
7138	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7139	</attribute>
7140
7141	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7142	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7143	</attribute>
7144
7145	<method name="createHostOnlyNetworkInterface">
7146	<desc>
7147	Creates a new adapter for Host Only Networking.
7148	<result name="E_INVALIDARG">
7149	Host network interface @a name already exists.
7150	</result>
7151	</desc>
7152	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7153	<desc>
7154	Created host interface object.
7155	</desc>
7156	</param>
7157	<param name="progress" type="IProgress" dir="return">
7158	<desc>
7159	Progress object to track the operation completion.
7160	</desc>
7161	</param>
7162	</method>
7163
7164	<method name="removeHostOnlyNetworkInterface">
7165	<desc>
7166	Removes the given Host Only Networking interface.
7167	<result name="VBOX_E_OBJECT_NOT_FOUND">
7168	No host network interface matching @a id found.
7169	</result>
7170	</desc>
7171	<param name="id" type="uuid" mod="string" dir="in">
7172	<desc>
7173	Adapter GUID.
7174	</desc>
7175	</param>
7176	<param name="progress" type="IProgress" dir="return">
7177	<desc>
7178	Progress object to track the operation completion.
7179	</desc>
7180	</param>
7181	</method>
7182
7183	<method name="createUSBDeviceFilter">
7184	<desc>
7185	Creates a new USB device filter. All attributes except
7186	the filter name are set to empty (any match),
7187	<i>active</i> is @c false (the filter is not active).
7188
7189	The created filter can be added to the list of filters using
7190	<link to="#insertUSBDeviceFilter"/>.
7191
7192	<see>#USBDeviceFilters</see>
7193	</desc>
7194	<param name="name" type="wstring" dir="in">
7195	<desc>
7196	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7197	</desc>
7198	</param>
7199	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7200	<desc>Created filter object.</desc>
7201	</param>
7202	</method>
7203
7204	<method name="insertUSBDeviceFilter">
7205	<desc>
7206	Inserts the given USB device to the specified position
7207	in the list of filters.
7208
7209	Positions are numbered starting from @c 0. If the specified
7210	position is equal to or greater than the number of elements in
7211	the list, the filter is added at the end of the collection.
7212
7213	<note>
7214	Duplicates are not allowed, so an attempt to insert a
7215	filter already in the list is an error.
7216	</note>
7217	<note>
7218	If USB functionality is not available in the given edition of
7219	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7220	</note>
7221
7222	<see>#USBDeviceFilters</see>
7223
7224	<result name="VBOX_E_INVALID_OBJECT_STATE">
7225	USB device filter is not created within this VirtualBox instance.
7226	</result>
7227	<result name="E_INVALIDARG">
7228	USB device filter already in list.
7229	</result>
7230
7231	</desc>
7232	<param name="position" type="unsigned long" dir="in">
7233	<desc>Position to insert the filter to.</desc>
7234	</param>
7235	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7236	<desc>USB device filter to insert.</desc>
7237	</param>
7238	</method>
7239
7240	<method name="removeUSBDeviceFilter">
7241	<desc>
7242	Removes a USB device filter from the specified position in the
7243	list of filters.
7244
7245	Positions are numbered starting from @c 0. Specifying a
7246	position equal to or greater than the number of elements in
7247	the list will produce an error.
7248
7249	<note>
7250	If USB functionality is not available in the given edition of
7251	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7252	</note>
7253
7254	<see>#USBDeviceFilters</see>
7255
7256	<result name="E_INVALIDARG">
7257	USB device filter list empty or invalid @a position.
7258	</result>
7259
7260	</desc>
7261	<param name="position" type="unsigned long" dir="in">
7262	<desc>Position to remove the filter from.</desc>
7263	</param>
7264	</method>
7265
7266	<method name="findHostDVDDrive">
7267	<desc>
7268	Searches for a host DVD drive with the given @c name.
7269
7270	<result name="VBOX_E_OBJECT_NOT_FOUND">
7271	Given @c name does not correspond to any host drive.
7272	</result>
7273
7274	</desc>
7275	<param name="name" type="wstring" dir="in">
7276	<desc>Name of the host drive to search for</desc>
7277	</param>
7278	<param name="drive" type="IMedium" dir="return">
7279	<desc>Found host drive object</desc>
7280	</param>
7281	</method>
7282
7283	<method name="findHostFloppyDrive">
7284	<desc>
7285	Searches for a host floppy drive with the given @c name.
7286
7287	<result name="VBOX_E_OBJECT_NOT_FOUND">
7288	Given @c name does not correspond to any host floppy drive.
7289	</result>
7290
7291	</desc>
7292	<param name="name" type="wstring" dir="in">
7293	<desc>Name of the host floppy drive to search for</desc>
7294	</param>
7295	<param name="drive" type="IMedium" dir="return">
7296	<desc>Found host floppy drive object</desc>
7297	</param>
7298	</method>
7299
7300	<method name="findHostNetworkInterfaceByName">
7301	<desc>
7302	Searches through all host network interfaces for an interface with
7303	the given @c name.
7304	<note>
7305	The method returns an error if the given @c name does not
7306	correspond to any host network interface.
7307	</note>
7308	</desc>
7309	<param name="name" type="wstring" dir="in">
7310	<desc>Name of the host network interface to search for.</desc>
7311	</param>
7312	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7313	<desc>Found host network interface object.</desc>
7314	</param>
7315	</method>
7316	<method name="findHostNetworkInterfaceById">
7317	<desc>
7318	Searches through all host network interfaces for an interface with
7319	the given GUID.
7320	<note>
7321	The method returns an error if the given GUID does not
7322	correspond to any host network interface.
7323	</note>
7324	</desc>
7325	<param name="id" type="uuid" mod="string" dir="in">
7326	<desc>GUID of the host network interface to search for.</desc>
7327	</param>
7328	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7329	<desc>Found host network interface object.</desc>
7330	</param>
7331	</method>
7332	<method name="findHostNetworkInterfacesOfType">
7333	<desc>
7334	Searches through all host network interfaces and returns a list of interfaces of the specified type
7335	</desc>
7336	<param name="type" type="HostNetworkInterfaceType" dir="in">
7337	<desc>type of the host network interfaces to search for.</desc>
7338	</param>
7339	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7340	<desc>Found host network interface objects.</desc>
7341	</param>
7342	</method>
7343
7344	<method name="findUSBDeviceById">
7345	<desc>
7346	Searches for a USB device with the given UUID.
7347
7348	<result name="VBOX_E_OBJECT_NOT_FOUND">
7349	Given @c id does not correspond to any USB device.
7350	</result>
7351
7352	<see>IHostUSBDevice::id</see>
7353	</desc>
7354	<param name="id" type="uuid" mod="string" dir="in">
7355	<desc>UUID of the USB device to search for.</desc>
7356	</param>
7357	<param name="device" type="IHostUSBDevice" dir="return">
7358	<desc>Found USB device object.</desc>
7359	</param>
7360	</method>
7361
7362	<method name="findUSBDeviceByAddress">
7363	<desc>
7364	Searches for a USB device with the given host address.
7365
7366	<result name="VBOX_E_OBJECT_NOT_FOUND">
7367	Given @c name does not correspond to any USB device.
7368	</result>
7369
7370	<see>IHostUSBDevice::address</see>
7371	</desc>
7372	<param name="name" type="wstring" dir="in">
7373	<desc>
7374	Address of the USB device (as assigned by the host) to
7375	search for.
7376	</desc>
7377	</param>
7378	<param name="device" type="IHostUSBDevice" dir="return">
7379	<desc>Found USB device object.</desc>
7380	</param>
7381	</method>
7382
7383	</interface>
7384
7385	<!--
7386	// ISystemProperties
7387	/////////////////////////////////////////////////////////////////////////
7388	-->
7389
7390	<interface
7391	name="ISystemProperties"
7392	extends="$unknown"
7393	uuid="2f89cdfe-2d10-43d4-b37f-61760f877f29"
7394	wsmap="managed"
7395	>
7396	<desc>
7397	The ISystemProperties interface represents global properties of the given
7398	VirtualBox installation.
7399
7400	These properties define limits and default values for various attributes
7401	and parameters. Most of the properties are read-only, but some can be
7402	changed by a user.
7403	</desc>
7404
7405	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7406	<desc>Minimum guest system memory in Megabytes.</desc>
7407	</attribute>
7408
7409	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7410	<desc>Maximum guest system memory in Megabytes.</desc>
7411	</attribute>
7412
7413	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7414	<desc>Minimum guest video memory in Megabytes.</desc>
7415	</attribute>
7416
7417	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7418	<desc>Maximum guest video memory in Megabytes.</desc>
7419	</attribute>
7420
7421	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7422	<desc>Minimum CPU count.</desc>
7423	</attribute>
7424
7425	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7426	<desc>Maximum CPU count.</desc>
7427	</attribute>
7428
7429	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7430	<desc>Maximum of monitors which could be connected.</desc>
7431	</attribute>
7432
7433	<attribute name="infoVDSize" type="long long" readonly="yes">
7434	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7435	does not reflect the limits of any virtual disk image format.</desc>
7436	</attribute>
7437
7438	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7439	<desc>
7440	Maximum number of serial ports associated with every
7441	<link to="IMachine"/> instance.
7442	</desc>
7443	</attribute>
7444
7445	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7446	<desc>
7447	Maximum number of parallel ports associated with every
7448	<link to="IMachine"/> instance.
7449	</desc>
7450	</attribute>
7451
7452	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7453	<desc>
7454	Maximum device position in the boot order. This value corresponds
7455	to the total number of devices a machine can boot from, to make it
7456	possible to include all possible devices to the boot list.
7457	<see><link to="IMachine::setBootOrder"/></see>
7458	</desc>
7459	</attribute>
7460
7461	<attribute name="defaultMachineFolder" type="wstring">
7462	<desc>
7463	Full path to the default directory used to create new or open
7464	existing machines when a machine settings file name contains no
7465	path.
7466
7467	Starting with VirtualBox 4.0, by default, this attribute contains
7468	the full path of folder named "VirtualBox VMs" in the user's
7469	home directory, which depends on the host platform.
7470
7471	When setting this attribute, a full path must be specified.
7472	Setting this property to @c null or an empty string or the
7473	special value "Machines" (for compatibility reasons) will restore
7474	that default value.
7475
7476	If the folder specified herein does not exist, it will be created
7477	automatically as needed.
7478
7479	<see>
7480	<link to="IVirtualBox::createMachine"/>,
7481	<link to="IVirtualBox::openMachine"/>
7482	</see>
7483	</desc>
7484	</attribute>
7485
7486	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7487	<desc>
7488	List of all medium storage formats supported by this VirtualBox
7489	installation.
7490
7491	Keep in mind that the medium format identifier
7492	(<link to="IMediumFormat::id"/>) used in other API calls like
7493	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7494	medium format is a case-insensitive string. This means that, for
7495	example, all of the following strings:
7496	<pre>
7497	"VDI"
7498	"vdi"
7499	"VdI"</pre>
7500	refer to the same medium format.
7501
7502	Note that the virtual medium framework is backend-based, therefore
7503	the list of supported formats depends on what backends are currently
7504	installed.
7505
7506	<see>
7507	<link to="IMediumFormat"/>,
7508	</see>
7509	</desc>
7510	</attribute>
7511
7512	<attribute name="defaultHardDiskFormat" type="wstring">
7513	<desc>
7514	Identifier of the default medium format used by VirtualBox.
7515
7516	The medium format set by this attribute is used by VirtualBox
7517	when the medium format was not specified explicitly. One example is
7518	<link to="IVirtualBox::createHardDisk"/> with the empty
7519	format argument. A more complex example is implicit creation of
7520	differencing media when taking a snapshot of a virtual machine:
7521	this operation will try to use a format of the parent medium first
7522	and if this format does not support differencing media the default
7523	format specified by this argument will be used.
7524
7525	The list of supported medium formats may be obtained by the
7526	<link to="#mediumFormats"/> call. Note that the default medium
7527	format must have a capability to create differencing media;
7528	otherwise operations that create media implicitly may fail
7529	unexpectedly.
7530
7531	The initial value of this property is <tt>"VDI"</tt> in the current
7532	version of the VirtualBox product, but may change in the future.
7533
7534	<note>
7535	Setting this property to @c null or empty string will restore the
7536	initial value.
7537	</note>
7538
7539	<see>
7540	<link to="#mediumFormats"/>,
7541	<link to="IMediumFormat::id"/>,
7542	<link to="IVirtualBox::createHardDisk"/>
7543	</see>
7544	</desc>
7545	</attribute>
7546
7547	<attribute name="freeDiskSpaceWarning" type="long long">
7548	<desc>Issue a warning if the free disk space is below (or in some disk
7549	intensive operation is expected to go below) the given size in
7550	bytes.</desc>
7551	</attribute>
7552
7553	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7554	<desc>Issue a warning if the free disk space is below (or in some disk
7555	intensive operation is expected to go below) the given percentage.</desc>
7556	</attribute>
7557
7558	<attribute name="freeDiskSpaceError" type="long long">
7559	<desc>Issue an error if the free disk space is below (or in some disk
7560	intensive operation is expected to go below) the given size in
7561	bytes.</desc>
7562	</attribute>
7563
7564	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7565	<desc>Issue an error if the free disk space is below (or in some disk
7566	intensive operation is expected to go below) the given percentage.</desc>
7567	</attribute>
7568
7569	<attribute name="VRDEAuthLibrary" type="wstring">
7570	<desc>
7571	Library that provides authentication for Remote Desktop clients. The library
7572	is used if a virtual machine's authentication type is set to "external"
7573	in the VM RemoteDisplay configuration.
7574
7575	The system library extension (".DLL" or ".so") must be omitted.
7576	A full path can be specified; if not, then the library must reside on the
7577	system's default library path.
7578
7579	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7580	of that name in one of the default VirtualBox library directories.
7581
7582	For details about VirtualBox authentication libraries and how to implement
7583	them, please refer to the VirtualBox manual.
7584
7585	<note>
7586	Setting this property to @c null or empty string will restore the
7587	initial value.
7588	</note>
7589	</desc>
7590	</attribute>
7591
7592	<attribute name="webServiceAuthLibrary" type="wstring">
7593	<desc>
7594	Library that provides authentication for webservice clients. The library
7595	is used if a virtual machine's authentication type is set to "external"
7596	in the VM RemoteDisplay configuration and will be called from
7597	within the <link to="IWebsessionManager::logon" /> implementation.
7598
7599	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7600	there is no per-VM setting for this, as the webservice is a global
7601	resource (if it is running). Only for this setting (for the webservice),
7602	setting this value to a literal <tt>"null"</tt> string disables authentication,
7603	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7604	no matter what user name and password are supplied.
7605
7606	The initial value of this property is <tt>"VBoxAuth"</tt>,
7607	meaning that the webservice will use the same authentication
7608	library that is used by default for VRDE (again, see
7609	<link to="ISystemProperties::VRDEAuthLibrary" />).
7610	The format and calling convention of authentication libraries
7611	is the same for the webservice as it is for VRDE.
7612
7613	<note>
7614	Setting this property to @c null or empty string will restore the
7615	initial value.
7616	</note>
7617	</desc>
7618	</attribute>
7619
7620	<attribute name="defaultVRDEExtPack" type="wstring">
7621	<desc>
7622	The name of the extension pack providing the default VRDE.
7623
7624	This attribute is for choosing between multiple extension packs
7625	providing VRDE. If only one is installed, it will automatically be the
7626	default one. The attribute value can be empty if no VRDE extension
7627	pack is installed.
7628
7629	For details about VirtualBox Remote Desktop Extension and how to
7630	implement one, please refer to the VirtualBox SDK.
7631	</desc>
7632	</attribute>
7633
7634	<attribute name="LogHistoryCount" type="unsigned long">
7635	<desc>
7636	This value specifies how many old release log files are kept.
7637	</desc>
7638	</attribute>
7639
7640	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
7641	<desc>This value hold the default audio driver for the current
7642	system.</desc>
7643	</attribute>
7644
7645
7646	<method name="getMaxNetworkAdapters">
7647	<desc>
7648	Maximum total number of network adapters associated with every
7649	<link to="IMachine"/> instance.
7650	</desc>
7651
7652	<param name="chipset" type="ChipsetType" dir="in">
7653	<desc>The chipset type to get the value for.</desc>
7654	</param>
7655
7656
7657	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7658	<desc>The maximum total number of network adapters allowed.</desc>
7659	</param>
7660
7661	</method>
7662
7663	<method name="getMaxNetworkAdaptersOfType">
7664	<desc>
7665	Maximum number of network adapters of a given attachment type,
7666	associated with every <link to="IMachine"/> instance.
7667	</desc>
7668
7669	<param name="chipset" type="ChipsetType" dir="in">
7670	<desc>The chipset type to get the value for.</desc>
7671	</param>
7672
7673	<param name="type" type="NetworkAttachmentType" dir="in">
7674	<desc>Type of attachment.</desc>
7675	</param>
7676
7677	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
7678	<desc>The maximum number of network adapters allowed for
7679	particular chipset and attachment type.</desc>
7680	</param>
7681
7682	</method>
7683
7684
7685	<method name="getMaxDevicesPerPortForStorageBus">
7686	<desc>Returns the maximum number of devices which can be attached to a port
7687	for the given storage bus.</desc>
7688
7689	<param name="bus" type="StorageBus" dir="in">
7690	<desc>The storage bus type to get the value for.</desc>
7691	</param>
7692
7693	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
7694	<desc>The maximum number of devices which can be attached to the port for the given
7695	storage bus.</desc>
7696	</param>
7697	</method>
7698
7699	<method name="getMinPortCountForStorageBus">
7700	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
7701
7702	<param name="bus" type="StorageBus" dir="in">
7703	<desc>The storage bus type to get the value for.</desc>
7704	</param>
7705
7706	<param name="minPortCount" type="unsigned long" dir="return">
7707	<desc>The minimum number of ports for the given storage bus.</desc>
7708	</param>
7709	</method>
7710
7711	<method name="getMaxPortCountForStorageBus">
7712	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
7713
7714	<param name="bus" type="StorageBus" dir="in">
7715	<desc>The storage bus type to get the value for.</desc>
7716	</param>
7717
7718	<param name="maxPortCount" type="unsigned long" dir="return">
7719	<desc>The maximum number of ports for the given storage bus.</desc>
7720	</param>
7721	</method>
7722
7723	<method name="getMaxInstancesOfStorageBus">
7724	<desc>Returns the maximum number of storage bus instances which
7725	can be configured for each VM. This corresponds to the number of
7726	storage controllers one can have. Value may depend on chipset type
7727	used.</desc>
7728
7729	<param name="chipset" type="ChipsetType" dir="in">
7730	<desc>The chipset type to get the value for.</desc>
7731	</param>
7732
7733	<param name="bus" type="StorageBus" dir="in">
7734	<desc>The storage bus type to get the value for.</desc>
7735	</param>
7736
7737	<param name="maxInstances" type="unsigned long" dir="return">
7738	<desc>The maximum number of instances for the given storage bus.</desc>
7739	</param>
7740	</method>
7741
7742	<method name="getDeviceTypesForStorageBus">
7743	<desc>Returns list of all the supported device types
7744	(<link to="DeviceType"/>) for the given type of storage
7745	bus.</desc>
7746
7747	<param name="bus" type="StorageBus" dir="in">
7748	<desc>The storage bus type to get the value for.</desc>
7749	</param>
7750
7751	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
7752	<desc>The list of all supported device types for the given storage bus.</desc>
7753	</param>
7754	</method>
7755
7756	<method name="getDefaultIoCacheSettingForStorageController">
7757	<desc>Returns the default I/O cache setting for the
7758	given storage controller</desc>
7759
7760	<param name="controllerType" type="StorageControllerType" dir="in">
7761	<desc>The storage controller to the setting for.</desc>
7762	</param>
7763
7764	<param name="enabled" type="boolean" dir="return">
7765	<desc>Returned flag indicating the default value</desc>
7766	</param>
7767	</method>
7768	</interface>
7769
7770	<!--
7771	// IGuest
7772	/////////////////////////////////////////////////////////////////////////
7773	-->
7774
7775	<interface
7776	name="IGuestOSType" extends="$unknown"
7777	uuid="432c1546-1354-4abf-bf08-878a32a373f5"
7778	wsmap="struct"
7779	>
7780	<desc>
7781	</desc>
7782
7783	<attribute name="familyId" type="wstring" readonly="yes">
7784	<desc>Guest OS family identifier string.</desc>
7785	</attribute>
7786
7787	<attribute name="familyDescription" type="wstring" readonly="yes">
7788	<desc>Human readable description of the guest OS family.</desc>
7789	</attribute>
7790
7791	<attribute name="id" type="wstring" readonly="yes">
7792	<desc>Guest OS identifier string.</desc>
7793	</attribute>
7794
7795	<attribute name="description" type="wstring" readonly="yes">
7796	<desc>Human readable description of the guest OS.</desc>
7797	</attribute>
7798
7799	<attribute name="is64Bit" type="boolean" readonly="yes">
7800	<desc>Returns @c true if the given OS is 64-bit</desc>
7801	</attribute>
7802
7803	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
7804	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
7805	</attribute>
7806
7807	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
7808	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
7809	</attribute>
7810
7811	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
7812	<desc>Recommended RAM size in Megabytes.</desc>
7813	</attribute>
7814
7815	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
7816	<desc>Recommended video RAM size in Megabytes.</desc>
7817	</attribute>
7818
7819	<attribute name="recommendedHDD" type="long long" readonly="yes">
7820	<desc>Recommended hard disk size in bytes.</desc>
7821	</attribute>
7822
7823	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
7824	<desc>Returns recommended network adapter for this OS type.</desc>
7825	</attribute>
7826
7827	<attribute name="recommendedPae" type="boolean" readonly="yes">
7828	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
7829	</attribute>
7830
7831	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
7832	<desc>Recommended storage controller type for DVD/CD drives.</desc>
7833	</attribute>
7834
7835	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
7836	<desc>Recommended storage bus type for DVD/CD drives.</desc>
7837	</attribute>
7838
7839	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
7840	<desc>Recommended storage controller type for HD drives.</desc>
7841	</attribute>
7842
7843	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
7844	<desc>Recommended storage bus type for HD drives.</desc>
7845	</attribute>
7846
7847	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
7848	<desc>Recommended firmware type.</desc>
7849	</attribute>
7850
7851	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
7852	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
7853	</attribute>
7854
7855	<attribute name="recommendedHpet" type="boolean" readonly="yes">
7856	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
7857	</attribute>
7858
7859	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
7860	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
7861	</attribute>
7862
7863	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
7864	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
7865	</attribute>
7866
7867	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
7868	<desc>Recommended chipset type.</desc>
7869	</attribute>
7870
7871	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
7872	<desc>Recommended audio type.</desc>
7873	</attribute>
7874
7875	</interface>
7876
7877	<enum
7878	name="AdditionsFacilityType"
7879	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
7880	>
7881	<desc>
7882	Guest Additions facility IDs.
7883	</desc>
7884
7885	<const name="None" value="0">
7886	<desc>No/invalid facility.</desc>
7887	</const>
7888	<const name="VBoxGuestDriver" value="20">
7889	<desc>VirtualBox base driver (VBoxGuest).</desc>
7890	</const>
7891	<const name="VBoxService" value="100">
7892	<desc>VirtualBox system service (VBoxService).</desc>
7893	</const>
7894	<const name="VBoxTrayClient" value="101">
7895	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
7896	</const>
7897	<const name="Seamless" value="1000">
7898	<desc>Seamless guest desktop integration.</desc>
7899	</const>
7900	<const name="Graphics" value="1100">
7901	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
7902	are not immediately acted on and guest display resizes are probably not initiated by
7903	the guest additions.
7904	</desc>
7905	</const>
7906	<const name="All" value="2147483646">
7907	<desc>All facilities selected.</desc>
7908	</const>
7909	</enum>
7910
7911	<enum
7912	name="AdditionsFacilityClass"
7913	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
7914	>
7915	<desc>
7916	Guest Additions facility classes.
7917	</desc>
7918
7919	<const name="None" value="0">
7920	<desc>No/invalid class.</desc>
7921	</const>
7922	<const name="Driver" value="10">
7923	<desc>Driver.</desc>
7924	</const>
7925	<const name="Service" value="30">
7926	<desc>System service.</desc>
7927	</const>
7928	<const name="Program" value="50">
7929	<desc>Program.</desc>
7930	</const>
7931	<const name="Feature" value="100">
7932	<desc>Feature.</desc>
7933	</const>
7934	<const name="ThirdParty" value="999">
7935	<desc>Third party.</desc>
7936	</const>
7937	<const name="All" value="2147483646">
7938	<desc>All facility classes selected.</desc>
7939	</const>
7940	</enum>
7941
7942	<enum
7943	name="AdditionsFacilityStatus"
7944	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
7945	>
7946	<desc>
7947	Guest Additions facility states.
7948	</desc>
7949
7950	<const name="Inactive" value="0">
7951	<desc>Facility is not active.</desc>
7952	</const>
7953	<const name="Paused" value="1">
7954	<desc>Facility has been paused.</desc>
7955	</const>
7956	<const name="PreInit" value="20">
7957	<desc>Facility is preparing to initialize.</desc>
7958	</const>
7959	<const name="Init" value="30">
7960	<desc>Facility is initializing.</desc>
7961	</const>
7962	<const name="Active" value="50">
7963	<desc>Facility is up and running.</desc>
7964	</const>
7965	<const name="Terminating" value="100">
7966	<desc>Facility is shutting down.</desc>
7967	</const>
7968	<const name="Terminated" value="101">
7969	<desc>Facility successfully shut down.</desc>
7970	</const>
7971	<const name="Failed" value="800">
7972	<desc>Facility failed to start.</desc>
7973	</const>
7974	<const name="Unknown" value="999">
7975	<desc>Facility status is unknown.</desc>
7976	</const>
7977	</enum>
7978
7979	<interface
7980	name="IAdditionsFacility" extends="$unknown"
7981	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
7982	wsmap="struct"
7983	>
7984	<desc>
7985	Structure representing a Guest Additions facility.
7986	</desc>
7987
7988	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
7989	<desc>Additions facility class.</desc>
7990	</attribute>
7991
7992	<attribute name="lastUpdated" type="long long" readonly="yes">
7993	<desc>Timestamp of last updated status.</desc>
7994	</attribute>
7995
7996	<attribute name="name" type="wstring" readonly="yes">
7997	<desc>Additions facility name.</desc>
7998	</attribute>
7999
8000	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8001	<desc>Additions facility status.</desc>
8002	</attribute>
8003
8004	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8005	<desc>Additions facility type.</desc>
8006	</attribute>
8007	</interface>
8008
8009	<enum
8010	name="AdditionsRunLevelType"
8011	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8012	>
8013	<desc>
8014	Guest Additions run level type.
8015	</desc>
8016
8017	<const name="None" value="0">
8018	<desc>Guest Additions are not loaded.</desc>
8019	</const>
8020	<const name="System" value="1">
8021	<desc>Guest drivers are loaded.</desc>
8022	</const>
8023	<const name="Userland" value="2">
8024	<desc>Common components (such as application services) are loaded.</desc>
8025	</const>
8026	<const name="Desktop" value="3">
8027	<desc>Per-user desktop components are loaded.</desc>
8028	</const>
8029	</enum>
8030
8031	<enum
8032	name="AdditionsUpdateFlag"
8033	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8034	>
8035	<desc>
8036	Guest Additions update flags.
8037	</desc>
8038
8039	<const name="None" value="0">
8040	<desc>No flag set.</desc>
8041	</const>
8042	<const name="WaitForUpdateStartOnly" value="1">
8043	<desc>Only wait for the update process being started and do not
8044	wait while peforming the actual update.</desc>
8045	</const>
8046	</enum>
8047
8048	<enum
8049	name="ExecuteProcessFlag"
8050	uuid="3258e8a5-ba0c-43d5-86b5-cf91405fddc0"
8051	>
8052	<desc>
8053	Guest process execution flags.
8054	</desc>
8055
8056	<const name="None" value="0">
8057	<desc>No flag set.</desc>
8058	</const>
8059
8060	<const name="WaitForProcessStartOnly" value="1">
8061	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8062	process itself then uses an infinite timeout.</desc>
8063	</const>
8064
8065	<const name="IgnoreOrphanedProcesses" value="2">
8066	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8067	</const>
8068
8069	<const name="Hidden" value="4">
8070	<desc>Don't show the started process according to the guest OS guidelines.</desc>
8071	</const>
8072	</enum>
8073
8074	<enum
8075	name="ProcessInputFlag"
8076	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8077	>
8078	<desc>
8079	Guest process input flags.
8080	</desc>
8081
8082	<const name="None" value="0">
8083	<desc>No flag set.</desc>
8084	</const>
8085	<const name="EndOfFile" value="1">
8086	<desc>End of file (input) reached.</desc>
8087	</const>
8088	</enum>
8089
8090	<enum
8091	name="CopyFileFlag"
8092	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8093	>
8094	<desc>
8095	Host/Guest copy flags. At the moment none of these flags
8096	are implemented.
8097	</desc>
8098
8099	<const name="None" value="0">
8100	<desc>No flag set.</desc>
8101	</const>
8102
8103	<const name="Recursive" value="1">
8104	<desc>Copy directories recursively.</desc>
8105	</const>
8106
8107	<const name="Update" value="2">
8108	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8109	</const>
8110
8111	<const name="FollowLinks" value="4">
8112	<desc>Follow symbolic links.</desc>
8113	</const>
8114	</enum>
8115
8116	<enum
8117	name="CreateDirectoryFlag"
8118	uuid="26ff5bdd-c81f-4304-857b-b8be5e3f9cd6"
8119	>
8120	<desc>
8121	Directory creation flags.
8122	</desc>
8123
8124	<const name="None" value="0">
8125	<desc>No flag set.</desc>
8126	</const>
8127
8128	<const name="Parents" value="1">
8129	<desc>No error if existing, make parent directories as needed.</desc>
8130	</const>
8131	</enum>
8132
8133	<interface
8134	name="IGuest" extends="$unknown"
8135	uuid="4db4f806-0a20-4772-9419-14563b662f93"
8136	wsmap="managed"
8137	>
8138	<desc>
8139	The IGuest interface represents information about the operating system
8140	running inside the virtual machine. Used in
8141	<link to="IConsole::guest"/>.
8142
8143	IGuest provides information about the guest operating system, whether
8144	Guest Additions are installed and other OS-specific virtual machine
8145	properties.
8146	</desc>
8147
8148	<attribute name="OSTypeId" type="wstring" readonly="yes">
8149	<desc>
8150	Identifier of the Guest OS type as reported by the Guest
8151	Additions.
8152	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8153	an IGuestOSType object representing details about the given
8154	Guest OS type.
8155	<note>
8156	If Guest Additions are not installed, this value will be
8157	the same as <link to="IMachine::OSTypeId"/>.
8158	</note>
8159	</desc>
8160	</attribute>
8161
8162	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8163	<desc>
8164	Current run level of the Guest Additions.
8165	</desc>
8166	</attribute>
8167
8168	<attribute name="additionsVersion" type="wstring" readonly="yes">
8169	<desc>
8170	Version of the Guest Additions including the revision (3 decimal numbers
8171	separated by dots + revision number) installed on the guest or empty
8172	when the Additions are not installed.
8173	</desc>
8174	</attribute>
8175
8176	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8177	<desc>
8178	Array of current known facilities. Only returns facilities where a status is known,
8179	e.g. facilities with an unknown status will not be returned.
8180	</desc>
8181	</attribute>
8182
8183	<attribute name="memoryBalloonSize" type="unsigned long">
8184	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8185	</attribute>
8186
8187	<attribute name="statisticsUpdateInterval" type="unsigned long">
8188	<desc>Interval to update guest statistics in seconds.</desc>
8189	</attribute>
8190
8191	<method name="internalGetStatistics">
8192	<desc>
8193	Internal method; do not use as it might change at any time.
8194	</desc>
8195	<param name="cpuUser" type="unsigned long" dir="out">
8196	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8197	</param>
8198	<param name="cpuKernel" type="unsigned long" dir="out">
8199	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8200	</param>
8201	<param name="cpuIdle" type="unsigned long" dir="out">
8202	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8203	</param>
8204	<param name="memTotal" type="unsigned long" dir="out">
8205	<desc>Total amount of physical guest RAM.</desc>
8206	</param>
8207	<param name="memFree" type="unsigned long" dir="out">
8208	<desc>Free amount of physical guest RAM.</desc>
8209	</param>
8210	<param name="memBalloon" type="unsigned long" dir="out">
8211	<desc>Amount of ballooned physical guest RAM.</desc>
8212	</param>
8213	<param name="memShared" type="unsigned long" dir="out">
8214	<desc>Amount of shared physical guest RAM.</desc>
8215	</param>
8216	<param name="memCache" type="unsigned long" dir="out">
8217	<desc>Total amount of guest (disk) cache memory.</desc>
8218	</param>
8219	<param name="pagedTotal" type="unsigned long" dir="out">
8220	<desc>Total amount of space in the page file.</desc>
8221	</param>
8222	<param name="memAllocTotal" type="unsigned long" dir="out">
8223	<desc>Total amount of memory allocated by the hypervisor.</desc>
8224	</param>
8225	<param name="memFreeTotal" type="unsigned long" dir="out">
8226	<desc>Total amount of free memory available in the hypervisor.</desc>
8227	</param>
8228	<param name="memBalloonTotal" type="unsigned long" dir="out">
8229	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8230	</param>
8231	<param name="memSharedTotal" type="unsigned long" dir="out">
8232	<desc>Total amount of shared memory in the hypervisor.</desc>
8233	</param>
8234	</method>
8235
8236	<method name="getFacilityStatus">
8237	<desc>
8238	Get the current status of a Guest Additions facility.
8239	</desc>
8240	<param name="facility" type="AdditionsFacilityType" dir="in">
8241	<desc>Facility to check status for.</desc>
8242	</param>
8243	<param name="timestamp" type="long long" dir="out">
8244	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8245	</param>
8246	<param name="status" type="AdditionsFacilityStatus" dir="return">
8247	<desc>The current (latest) facility status.</desc>
8248	</param>
8249	</method>
8250
8251	<method name="getAdditionsStatus">
8252	<desc>
8253	Retrieve the current status of a certain Guest Additions run level.
8254
8255	<result name="VBOX_E_NOT_SUPPORTED">
8256	Wrong status level specified.
8257	</result>
8258
8259	</desc>
8260	<param name="level" type="AdditionsRunLevelType" dir="in">
8261	<desc>Status level to check</desc>
8262	</param>
8263	<param name="active" type="boolean" dir="return">
8264	<desc>Flag whether the status level has been reached or not</desc>
8265	</param>
8266	</method>
8267
8268	<method name="setCredentials">
8269	<desc>
8270	Store login credentials that can be queried by guest operating
8271	systems with Additions installed. The credentials are transient
8272	to the session and the guest may also choose to erase them. Note
8273	that the caller cannot determine whether the guest operating system
8274	has queried or made use of the credentials.
8275
8276	<result name="VBOX_E_VM_ERROR">
8277	VMM device is not available.
8278	</result>
8279
8280	</desc>
8281	<param name="userName" type="wstring" dir="in">
8282	<desc>User name string, can be empty</desc>
8283	</param>
8284	<param name="password" type="wstring" dir="in">
8285	<desc>Password string, can be empty</desc>
8286	</param>
8287	<param name="domain" type="wstring" dir="in">
8288	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8289	</param>
8290	<param name="allowInteractiveLogon" type="boolean" dir="in">
8291	<desc>
8292	Flag whether the guest should alternatively allow the user to
8293	interactively specify different credentials. This flag might
8294	not be supported by all versions of the Additions.
8295	</desc>
8296	</param>
8297	</method>
8298
8299	<method name="executeProcess">
8300	<desc>
8301	Executes an existing program inside the guest VM.
8302
8303	<result name="VBOX_E_IPRT_ERROR">
8304	Could not execute process.
8305	</result>
8306
8307	</desc>
8308	<param name="execName" type="wstring" dir="in">
8309	<desc>
8310	Full path name of the command to execute on the guest; the
8311	commands has to exists in the guest VM in order to be executed.
8312	</desc>
8313	</param>
8314	<param name="flags" type="unsigned long" dir="in">
8315	<desc>
8316	<link to="ExecuteProcessFlag"/> flags.
8317	</desc>
8318	</param>
8319	<param name="arguments" type="wstring" safearray="yes" dir="in">
8320	<desc>
8321	Array of arguments passed to the execution command.
8322	</desc>
8323	</param>
8324	<param name="environment" type="wstring" safearray="yes" dir="in">
8325	<desc>
8326	Environment variables that can be set while the command is being
8327	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
8328	variable just set its name ("NAME") without a value.
8329	</desc>
8330	</param>
8331	<param name="userName" type="wstring" dir="in">
8332	<desc>
8333	User name under which the command will be executed; has to exist
8334	and have the appropriate rights to execute programs in the VM.
8335	</desc>
8336	</param>
8337	<param name="password" type="wstring" dir="in">
8338	<desc>
8339	Password of the user account specified.
8340	</desc>
8341	</param>
8342	<param name="timeoutMS" type="unsigned long" dir="in">
8343	<desc>
8344	The maximum timeout value (in msec) to wait for finished program
8345	execution. Pass 0 for an infinite timeout.
8346	</desc>
8347	</param>
8348	<param name="pid" type="unsigned long" dir="out">
8349	<desc>
8350	The PID (process ID) of the started command for later reference.
8351	</desc>
8352	</param>
8353	<param name="progress" type="IProgress" dir="return">
8354	<desc>Progress object to track the operation completion.</desc>
8355	</param>
8356	</method>
8357
8358	<method name="getProcessOutput">
8359	<desc>
8360	Retrieves output of a formerly started process.
8361
8362	<result name="VBOX_E_IPRT_ERROR">
8363	Could not retrieve output.
8364	</result>
8365
8366	</desc>
8367	<param name="pid" type="unsigned long" dir="in">
8368	<desc>
8369	Process id returned by earlier executeProcess() call.
8370	</desc>
8371	</param>
8372	<param name="flags" type="unsigned long" dir="in">
8373	<desc>
8374	Flags describing which output to retrieve.
8375	</desc>
8376	</param>
8377	<param name="timeoutMS" type="unsigned long" dir="in">
8378	<desc>
8379	The maximum timeout value (in msec) to wait for output
8380	data. Pass 0 for an infinite timeout.
8381	</desc>
8382	</param>
8383	<param name="size" type="long long" dir="in">
8384	<desc>
8385	Size in bytes to read in the buffer.
8386	</desc>
8387	</param>
8388	<param name="data" type="octet" dir="return" safearray="yes">
8389	<desc>
8390	Buffer for retrieving the actual output. A data size of 0 means end of file
8391	if the requested size was not 0. This is the unprocessed
8392	output data, i.e. the line ending style depends on the platform of
8393	the system the server is running on.
8394	</desc>
8395	</param>
8396	</method>
8397
8398	<method name="getProcessStatus">
8399	<desc>
8400	Retrieves status, exit code and the exit reason of a formerly started process.
8401
8402	<result name="VBOX_E_IPRT_ERROR">
8403	Process with specified PID was not found.
8404	</result>
8405
8406	</desc>
8407	<param name="pid" type="unsigned long" dir="in">
8408	<desc>
8409	Process id returned by earlier executeProcess() call.
8410	</desc>
8411	</param>
8412	<param name="exitcode" type="unsigned long" dir="out">
8413	<desc>
8414	The exit code (if available).
8415	</desc>
8416	</param>
8417	<param name="flags" type="unsigned long" dir="out">
8418	<desc>
8419	Additional flags of process status. Not used at the moment and
8420	must be set to 0.
8421	</desc>
8422	</param>
8423	<param name="reason" type="unsigned long" dir="return">
8424	<desc>
8425	The current process status.
8426	</desc>
8427	</param>
8428	</method>
8429
8430	<method name="copyToGuest">
8431	<desc>
8432	Copies files/directories from host to the guest.
8433
8434	<result name="VBOX_E_IPRT_ERROR">
8435	Error while copying.
8436	</result>
8437
8438	</desc>
8439	<param name="source" type="wstring" dir="in">
8440	<desc>
8441	Source file on the host to copy.
8442	</desc>
8443	</param>
8444	<param name="dest" type="wstring" dir="in">
8445	<desc>
8446	Destination path on the guest.
8447	</desc>
8448	</param>
8449	<param name="userName" type="wstring" dir="in">
8450	<desc>
8451	User name under which the copy command will be executed; the
8452	user has to exist and have the appropriate rights to write to
8453	the destination path.
8454	</desc>
8455	</param>
8456	<param name="password" type="wstring" dir="in">
8457	<desc>
8458	Password of the user account specified.
8459	</desc>
8460	</param>
8461	<param name="flags" type="unsigned long" dir="in">
8462	<desc>
8463	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
8464	</desc>
8465	</param>
8466	<param name="progress" type="IProgress" dir="return">
8467	<desc>Progress object to track the operation completion.</desc>
8468	</param>
8469	</method>
8470
8471	<method name="createDirectory">
8472	<desc>
8473	Creates a directory on the guest.
8474
8475	<result name="VBOX_E_IPRT_ERROR">
8476	Error while creating directory.
8477	</result>
8478
8479	</desc>
8480	<param name="directory" type="wstring" dir="in">
8481	<desc>
8482	Directory to create.
8483	</desc>
8484	</param>
8485	<param name="userName" type="wstring" dir="in">
8486	<desc>
8487	User name under which the directory creation will be executed; the
8488	user has to exist and have the appropriate rights to create the
8489	desired directory.
8490	</desc>
8491	</param>
8492	<param name="password" type="wstring" dir="in">
8493	<desc>
8494	Password of the user account specified.
8495	</desc>
8496	</param>
8497	<param name="mode" type="unsigned long" dir="in">
8498	<desc>
8499	File mode.
8500	</desc>
8501	</param>
8502	<param name="flags" type="unsigned long" dir="in">
8503	<desc>
8504	<link to="CreateDirectoryFlag"/> flags.
8505	</desc>
8506	</param>
8507	<param name="progress" type="IProgress" dir="return">
8508	<desc>Progress object to track the operation completion.</desc>
8509	</param>
8510	</method>
8511
8512	<method name="setProcessInput">
8513	<desc>
8514	Sends input into a formerly started process.
8515
8516	<result name="VBOX_E_IPRT_ERROR">
8517	Could not send input.
8518	</result>
8519
8520	</desc>
8521	<param name="pid" type="unsigned long" dir="in">
8522	<desc>
8523	Process id returned by earlier executeProcess() call.
8524	</desc>
8525	</param>
8526	<param name="flags" type="unsigned long" dir="in">
8527	<desc>
8528	<link to="ProcessInputFlag"/> flags.
8529	</desc>
8530	</param>
8531	<param name="timeoutMS" type="unsigned long" dir="in">
8532	<desc>
8533	The maximum timeout value (in msec) to wait for getting the
8534	data transfered to the guest. Pass 0 for an infinite timeout.
8535	</desc>
8536	</param>
8537	<param name="data" type="octet" dir="in" safearray="yes">
8538	<desc>
8539	Buffer of input data to send to the started process to.
8540	</desc>
8541	</param>
8542	<param name="written" type="unsigned long" dir="return">
8543	<desc>
8544	Number of bytes written.
8545	</desc>
8546	</param>
8547	</method>
8548
8549	<method name="updateGuestAdditions">
8550	<desc>
8551	Updates already installed Guest Additions in a VM
8552	(Windows guests only).
8553
8554	<result name="VBOX_E_IPRT_ERROR">
8555	Error while updating.
8556	</result>
8557
8558	</desc>
8559	<param name="source" type="wstring" dir="in">
8560	<desc>
8561	Path to the Guest Additions .ISO file to use for the upate.
8562	</desc>
8563	</param>
8564	<param name="flags" type="unsigned long" dir="in">
8565	<desc>
8566	<link to="AdditionsUpdateFlag"/> flags.
8567	</desc>
8568	</param>
8569	<param name="progress" type="IProgress" dir="return">
8570	<desc>Progress object to track the operation completion.</desc>
8571	</param>
8572	</method>
8573
8574	</interface>
8575
8576
8577	<!--
8578	// IProgress
8579	/////////////////////////////////////////////////////////////////////////
8580	-->
8581
8582	<interface
8583	name="IProgress" extends="$unknown"
8584	uuid="A163C98F-8635-4AA8-B770-A9941737F3EF"
8585	wsmap="managed"
8586	>
8587	<desc>
8588	The IProgress interface is used to track and control
8589	asynchronous tasks within VirtualBox.
8590
8591	An instance of this is returned every time VirtualBox starts
8592	an asynchronous task (in other words, a separate thread) which
8593	continues to run after a method call returns. For example,
8594	<link to="IConsole::saveState" />, which saves the state of
8595	a running virtual machine, can take a long time to complete.
8596	To be able to display a progress bar, a user interface such as
8597	the VirtualBox graphical user interface can use the IProgress
8598	object returned by that method.
8599
8600	Note that IProgress is a "read-only" interface in the sense
8601	that only the VirtualBox internals behind the Main API can
8602	create and manipulate progress objects, whereas client code
8603	can only use the IProgress object to monitor a task's
8604	progress and, if <link to="#cancelable" /> is @c true,
8605	cancel the task by calling <link to="#cancel" />.
8606
8607	A task represented by IProgress consists of either one or
8608	several sub-operations that run sequentially, one by one (see
8609	<link to="#operation" /> and <link to="#operationCount" />).
8610	Every operation is identified by a number (starting from 0)
8611	and has a separate description.
8612
8613	You can find the individual percentage of completion of the current
8614	operation in <link to="#operationPercent" /> and the
8615	percentage of completion of the task as a whole
8616	in <link to="#percent" />.
8617
8618	Similarly, you can wait for the completion of a particular
8619	operation via <link to="#waitForOperationCompletion" /> or
8620	for the completion of the whole task via
8621	<link to="#waitForCompletion" />.
8622	</desc>
8623
8624	<attribute name="id" type="uuid" mod="string" readonly="yes">
8625	<desc>ID of the task.</desc>
8626	</attribute>
8627
8628	<attribute name="description" type="wstring" readonly="yes">
8629	<desc>Description of the task.</desc>
8630	</attribute>
8631
8632	<attribute name="initiator" type="$unknown" readonly="yes">
8633	<desc>Initiator of the task.</desc>
8634	</attribute>
8635
8636	<attribute name="cancelable" type="boolean" readonly="yes">
8637	<desc>Whether the task can be interrupted.</desc>
8638	</attribute>
8639
8640	<attribute name="percent" type="unsigned long" readonly="yes">
8641	<desc>
8642	Current progress value of the task as a whole, in percent.
8643	This value depends on how many operations are already complete.
8644	Returns 100 if <link to="#completed" /> is @c true.
8645	</desc>
8646	</attribute>
8647
8648	<attribute name="timeRemaining" type="long" readonly="yes">
8649	<desc>
8650	Estimated remaining time until the task completes, in
8651	seconds. Returns 0 once the task has completed; returns -1
8652	if the remaining time cannot be computed, in particular if
8653	the current progress is 0.
8654
8655	Even if a value is returned, the estimate will be unreliable
8656	for low progress values. It will become more reliable as the
8657	task progresses; it is not recommended to display an ETA
8658	before at least 20% of a task have completed.
8659	</desc>
8660	</attribute>
8661
8662	<attribute name="completed" type="boolean" readonly="yes">
8663	<desc>Whether the task has been completed.</desc>
8664	</attribute>
8665
8666	<attribute name="canceled" type="boolean" readonly="yes">
8667	<desc>Whether the task has been canceled.</desc>
8668	</attribute>
8669
8670	<attribute name="resultCode" type="long" readonly="yes">
8671	<desc>
8672	Result code of the progress task.
8673	Valid only if <link to="#completed"/> is @c true.
8674	</desc>
8675	</attribute>
8676
8677	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
8678	<desc>
8679	Extended information about the unsuccessful result of the
8680	progress operation. May be @c null if no extended information
8681	is available.
8682	Valid only if <link to="#completed"/> is @c true and
8683	<link to="#resultCode"/> indicates a failure.
8684	</desc>
8685	</attribute>
8686
8687	<attribute name="operationCount" type="unsigned long" readonly="yes">
8688	<desc>
8689	Number of sub-operations this task is divided into.
8690	Every task consists of at least one suboperation.
8691	</desc>
8692	</attribute>
8693
8694	<attribute name="operation" type="unsigned long" readonly="yes">
8695	<desc>Number of the sub-operation being currently executed.</desc>
8696	</attribute>
8697
8698	<attribute name="operationDescription" type="wstring" readonly="yes">
8699	<desc>
8700	Description of the sub-operation being currently executed.
8701	</desc>
8702	</attribute>
8703
8704	<attribute name="operationPercent" type="unsigned long" readonly="yes">
8705	<desc>Progress value of the current sub-operation only, in percent.</desc>
8706	</attribute>
8707
8708	<attribute name="operationWeight" type="unsigned long" readonly="yes">
8709	<desc>Weight value of the current sub-operation only.</desc>
8710	</attribute>
8711
8712	<attribute name="timeout" type="unsigned long">
8713	<desc>
8714	When non-zero, this specifies the number of milliseconds after which
8715	the operation will automatically be canceled. This can only be set on
8716	cancelable objects.
8717	</desc>
8718	</attribute>
8719
8720	<method name="setCurrentOperationProgress">
8721	<desc>Internal method, not to be called externally.</desc>
8722	<param name="percent" type="unsigned long" dir="in" />
8723	</method>
8724	<method name="setNextOperation">
8725	<desc>Internal method, not to be called externally.</desc>
8726	<param name="nextOperationDescription" type="wstring" dir="in" />
8727	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
8728	</method>
8729
8730	<method name="waitForCompletion">
8731	<desc>
8732	Waits until the task is done (including all sub-operations)
8733	with a given timeout in milliseconds; specify -1 for an indefinite wait.
8734
8735	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
8736	thread are not processed while waiting. Neglecting event queues may
8737	have dire consequences (degrade performance, resource hogs,
8738	deadlocks, etc.), this is specially so for the main thread on
8739	platforms using XPCOM. Callers are adviced wait for short periods
8740	and service their event queues between calls, or to create a worker
8741	thread to do the waiting.
8742
8743	<result name="VBOX_E_IPRT_ERROR">
8744	Failed to wait for task completion.
8745	</result>
8746	</desc>
8747
8748	<param name="timeout" type="long" dir="in">
8749	<desc>
8750	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8751	</desc>
8752	</param>
8753	</method>
8754
8755	<method name="waitForOperationCompletion">
8756	<desc>
8757	Waits until the given operation is done with a given timeout in
8758	milliseconds; specify -1 for an indefinite wait.
8759
8760	See <link to="#waitForCompletion"> for event queue considerations.</link>
8761
8762	<result name="VBOX_E_IPRT_ERROR">
8763	Failed to wait for operation completion.
8764	</result>
8765
8766	</desc>
8767	<param name="operation" type="unsigned long" dir="in">
8768	<desc>
8769	Number of the operation to wait for.
8770	Must be less than <link to="#operationCount"/>.
8771	</desc>
8772	</param>
8773	<param name="timeout" type="long" dir="in">
8774	<desc>
8775	Maximum time in milliseconds to wait or -1 to wait indefinitely.
8776	</desc>
8777	</param>
8778	</method>
8779
8780	<method name="cancel">
8781	<desc>
8782	Cancels the task.
8783	<note>
8784	If <link to="#cancelable"/> is @c false, then this method will fail.
8785	</note>
8786
8787	<result name="VBOX_E_INVALID_OBJECT_STATE">
8788	Operation cannot be canceled.
8789	</result>
8790
8791	</desc>
8792	</method>
8793
8794	</interface>
8795
8796	<!--
8797	// ISnapshot
8798	/////////////////////////////////////////////////////////////////////////
8799	-->
8800
8801	<interface
8802	name="ISnapshot" extends="$unknown"
8803	uuid="1a2d0551-58a4-4107-857e-ef414fc42ffc"
8804	wsmap="managed"
8805	>
8806	<desc>
8807	The ISnapshot interface represents a snapshot of the virtual
8808	machine.
8809
8810	Together with the differencing media that are created
8811	when a snapshot is taken, a machine can be brought back to
8812	the exact state it was in when the snapshot was taken.
8813
8814	The ISnapshot interface has no methods, only attributes; snapshots
8815	are controlled through methods of the <link to="IConsole" /> interface
8816	which also manage the media associated with the snapshot.
8817	The following operations exist:
8818
8819	<ul>
8820	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
8821	by creating new, empty differencing images for the machine's
8822	media and saving the VM settings and (if the VM is running)
8823	the current VM state in the snapshot.
8824
8825	The differencing images will then receive all data written to
8826	the machine's media, while their parent (base) images
8827	remain unmodified after the snapshot has been taken (see
8828	<link to="IMedium" /> for details about differencing images).
8829	This simplifies restoring a machine to the state of a snapshot:
8830	only the differencing images need to be deleted.
8831
8832	The current machine state is not changed by taking a snapshot
8833	except that <link to="IMachine::currentSnapshot" /> is set to
8834	the newly created snapshot, which is also added to the machine's
8835	snapshots tree.
8836	</li>
8837
8838	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
8839	the state of a previous snapshot by deleting the differencing
8840	image of each of the machine's media and setting the machine's
8841	settings and state to the state that was saved in the snapshot (if any).
8842
8843	This destroys the machine's current state. After calling this,
8844	<link to="IMachine::currentSnapshot" /> points to the snapshot
8845	that was restored.
8846	</li>
8847
8848	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
8849	without affecting the current machine state.
8850
8851	This does not change the current machine state, but instead frees the
8852	resources allocated when the snapshot was taken: the settings and machine
8853	state file are deleted (if any), and the snapshot's differencing image for
8854	each of the machine's media gets merged with its parent image.
8855
8856	Neither the current machine state nor other snapshots are affected
8857	by this operation, except that parent media will be modified
8858	to contain the disk data associated with the snapshot being deleted.
8859
8860	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
8861	attribute is set to the current snapshot's parent or NULL if it
8862	has no parent. Otherwise the attribute is unchanged.
8863	</li>
8864	</ul>
8865
8866	Each snapshot contains a copy of virtual machine's settings (hardware
8867	configuration etc.). This copy is contained in an immutable (read-only)
8868	instance of <link to="IMachine" /> which is available from the snapshot's
8869	<link to="#machine" /> attribute. When restoring the snapshot, these
8870	settings are copied back to the original machine.
8871
8872	In addition, if the machine was running when the
8873	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
8874	the current VM state is saved in the snapshot (similarly to what happens
8875	when a VM's state is saved). The snapshot is then said to be <i>online</i>
8876	because when restoring it, the VM will be running.
8877
8878	If the machine was in <link to="MachineState_Saved">saved</link> saved,
8879	the snapshot receives a copy of the execution state file
8880	(<link to="IMachine::stateFilePath"/>).
8881
8882	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
8883	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
8884	it then contains a so-called "zero execution state", representing a
8885	machine that is powered off.
8886	</desc>
8887
8888	<attribute name="id" type="uuid" mod="string" readonly="yes">
8889	<desc>UUID of the snapshot.</desc>
8890	</attribute>
8891
8892	<attribute name="name" type="wstring">
8893	<desc>Short name of the snapshot.
8894	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8895	be called implicitly.</note>
8896	</desc>
8897	</attribute>
8898
8899	<attribute name="description" type="wstring">
8900	<desc>Optional description of the snapshot.
8901	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
8902	be called implicitly.</note>
8903	</desc>
8904	</attribute>
8905
8906	<attribute name="timeStamp" type="long long" readonly="yes">
8907	<desc>
8908	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
8909	</desc>
8910	</attribute>
8911
8912	<attribute name="online" type="boolean" readonly="yes">
8913	<desc>
8914	@c true if this snapshot is an online snapshot and @c false otherwise.
8915
8916	When this attribute is @c true, the
8917	<link to="IMachine::stateFilePath"/> attribute of the
8918	<link to="#machine"/> object associated with this snapshot
8919	will point to the saved state file. Otherwise, it will be
8920	an empty string.
8921	</desc>
8922	</attribute>
8923
8924	<attribute name="machine" type="IMachine" readonly="yes">
8925	<desc>
8926	Virtual machine this snapshot is taken on. This object
8927	stores all settings the machine had when taking this snapshot.
8928	<note>
8929	The returned machine object is immutable, i.e. no
8930	any settings can be changed.
8931	</note>
8932	</desc>
8933	</attribute>
8934
8935	<attribute name="parent" type="ISnapshot" readonly="yes">
8936	<desc>
8937	Parent snapshot (a snapshot this one is based on), or
8938	@c null if the snapshot has no parent (i.e. is the first snapshot).
8939	</desc>
8940	</attribute>
8941
8942	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
8943	<desc>
8944	Child snapshots (all snapshots having this one as a parent).
8945	By inspecting this attribute starting with a machine's root snapshot
8946	(which can be obtained by calling <link to="IMachine::findSnapshot" />
8947	with a @c null UUID), a machine's snapshots tree can be iterated over.
8948	</desc>
8949	</attribute>
8950
8951	</interface>
8952
8953
8954	<!--
8955	// IMedium
8956	/////////////////////////////////////////////////////////////////////////
8957	-->
8958
8959	<enum
8960	name="MediumState"
8961	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
8962	>
8963	<desc>
8964	Virtual medium state.
8965	<see>IMedium</see>
8966	</desc>
8967
8968	<const name="NotCreated" value="0">
8969	<desc>
8970	Associated medium storage does not exist (either was not created yet or
8971	was deleted).
8972	</desc>
8973	</const>
8974	<const name="Created" value="1">
8975	<desc>
8976	Associated storage exists and accessible; this gets set if the
8977	accessibility check performed by <link to="IMedium::refreshState" />
8978	was successful.
8979	</desc>
8980	</const>
8981	<const name="LockedRead" value="2">
8982	<desc>
8983	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
8984	no data modification is possible.
8985	</desc>
8986	</const>
8987	<const name="LockedWrite" value="3">
8988	<desc>
8989	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
8990	no concurrent data reading or modification is possible.
8991	</desc>
8992	</const>
8993	<const name="Inaccessible" value="4">
8994	<desc>
8995	Medium accessibility check (see <link to="IMedium::refreshState" />) has
8996	not yet been performed, or else, associated medium storage is not
8997	accessible. In the first case, <link to="IMedium::lastAccessError"/>
8998	is empty, in the second case, it describes the error that occurred.
8999	</desc>
9000	</const>
9001	<const name="Creating" value="5">
9002	<desc>
9003	Associated medium storage is being created.
9004	</desc>
9005	</const>
9006	<const name="Deleting" value="6">
9007	<desc>
9008	Associated medium storage is being deleted.
9009	</desc>
9010	</const>
9011	</enum>
9012
9013	<enum
9014	name="MediumType"
9015	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
9016	>
9017	<desc>
9018	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
9019	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
9020	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
9021	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
9022	</desc>
9023
9024	<const name="Normal" value="0">
9025	<desc>
9026	Normal medium (attached directly or indirectly, preserved
9027	when taking snapshots).
9028	</desc>
9029	</const>
9030	<const name="Immutable" value="1">
9031	<desc>
9032	Immutable medium (attached indirectly, changes are wiped out
9033	the next time the virtual machine is started).
9034	</desc>
9035	</const>
9036	<const name="Writethrough" value="2">
9037	<desc>
9038	Write through medium (attached directly, ignored when
9039	taking snapshots).
9040	</desc>
9041	</const>
9042	<const name="Shareable" value="3">
9043	<desc>
9044	Allow using this medium concurrently by several machines.
9045	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
9046	</desc>
9047	</const>
9048	<const name="Readonly" value="4">
9049	<desc>
9050	A readonly medium, which can of course be used by several machines.
9051	<note>Present and accepted since VirtualBox 4.0.</note>
9052	</desc>
9053	</const>
9054	<const name="MultiAttach" value="5">
9055	<desc>
9056	A medium which is is indirectly attached, so that one base medium can
9057	be used for several VMs which have their own differencing medium to
9058	store their modifications. In some sense a variant of Immutable
9059	with unset AutoReset flag in each differencing medium.
9060	<note>Present and accepted since VirtualBox 4.0.</note>
9061	</desc>
9062	</const>
9063	</enum>
9064
9065	<enum
9066	name="MediumVariant"
9067	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
9068	>
9069	<desc>
9070	Virtual medium image variant. More than one flag may be set.
9071	<see>IMedium</see>
9072	</desc>
9073
9074	<const name="Standard" value="0">
9075	<desc>
9076	No particular variant requested, results in using the backend default.
9077	</desc>
9078	</const>
9079	<const name="VmdkSplit2G" value="0x01">
9080	<desc>
9081	VMDK image split in chunks of less than 2GByte.
9082	</desc>
9083	</const>
9084	<const name="VmdkStreamOptimized" value="0x04">
9085	<desc>
9086	VMDK streamOptimized image. Special import/export format which is
9087	read-only/append-only.
9088	</desc>
9089	</const>
9090	<const name="VmdkESX" value="0x08">
9091	<desc>
9092	VMDK format variant used on ESX products.
9093	</desc>
9094	</const>
9095	<const name="Fixed" value="0x10000">
9096	<desc>
9097	Fixed image. Only allowed for base images.
9098	</desc>
9099	</const>
9100	<const name="Diff" value="0x20000">
9101	<desc>
9102	Differencing image. Only allowed for child images.
9103	</desc>
9104	</const>
9105	</enum>
9106
9107	<interface
9108	name="IMediumAttachment" extends="$unknown"
9109	uuid="aa4b4840-934f-454d-9a28-23e8f4235edf"
9110	wsmap="struct"
9111	>
9112	<desc>
9113	The IMediumAttachment interface links storage media to virtual machines.
9114	For each medium (<link to="IMedium"/>) which has been attached to a
9115	storage controller (<link to="IStorageController"/>) of a machine
9116	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
9117	method, one instance of IMediumAttachment is added to the machine's
9118	<link to="IMachine::mediumAttachments"/> array attribute.
9119
9120	Each medium attachment specifies the storage controller as well as a
9121	port and device number and the IMedium instance representing a virtual
9122	hard disk or floppy or DVD image.
9123
9124	For removable media (DVDs or floppies), there are two additional
9125	options. For one, the IMedium instance can be @c null to represent
9126	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
9127	secondly, the medium can be one of the pseudo-media for host drives
9128	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
9129
9130	<h3>Attaching Hard Disks</h3>
9131
9132	Hard disks are attached to virtual machines using the
9133	<link to="IMachine::attachDevice"/> method and detached using the
9134	<link to="IMachine::detachDevice"/> method. Depending on a medium's
9135	type (see <link to="IMedium::type" />), hard disks are attached either
9136	<i>directly</i> or <i>indirectly</i>.
9137
9138	When a hard disk is being attached directly, it is associated with the
9139	virtual machine and used for hard disk operations when the machine is
9140	running. When a hard disk is being attached indirectly, a new differencing
9141	hard disk linked to it is implicitly created and this differencing hard
9142	disk is associated with the machine and used for hard disk operations.
9143	This also means that if <link to="IMachine::attachDevice"/> performs
9144	a direct attachment then the same hard disk will be returned in response
9145	to the subsequent <link to="IMachine::getMedium"/> call; however if
9146	an indirect attachment is performed then
9147	<link to="IMachine::getMedium"/> will return the implicitly created
9148	differencing hard disk, not the original one passed to <link
9149	to="IMachine::attachDevice"/>. In detail:
9150
9151	<ul>
9152	<li><b>Normal base</b> hard disks that do not have children (i.e.
9153	differencing hard disks linked to them) and that are not already
9154	attached to virtual machines in snapshots are attached <b>directly</b>.
9155	Otherwise, they are attached <b>indirectly</b> because having
9156	dependent children or being part of the snapshot makes it impossible
9157	to modify hard disk contents without breaking the integrity of the
9158	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
9159	quickly determine the kind of the attachment for the given hard
9160	disk. Note that if a normal base hard disk is to be indirectly
9161	attached to a virtual machine with snapshots then a special
9162	procedure called <i>smart attachment</i> is performed (see below).</li>
9163	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
9164	they are attached <b>directly</b> if they do not have children and are
9165	not attached to virtual machines in snapshots, and <b>indirectly</b>
9166	otherwise. Note that the smart attachment procedure is never performed
9167	for differencing hard disks.</li>
9168	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
9169	they are designed to be non-writable. If an immutable hard disk is
9170	attached to a virtual machine with snapshots then a special
9171	procedure called smart attachment is performed (see below).</li>
9172	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
9173	also as designed. This also means that writethrough hard disks cannot
9174	have other hard disks linked to them at all.</li>
9175	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
9176	also as designed. This also means that shareable hard disks cannot
9177	have other hard disks linked to them at all. They behave almost
9178	like writethrough hard disks, except that shareable hard disks can
9179	be attached to several virtual machines which are running, allowing
9180	concurrent accesses. You need special cluster software running in
9181	the virtual machines to make use of such disks.</li>
9182	</ul>
9183
9184	Note that the same hard disk, regardless of its type, may be attached to
9185	more than one virtual machine at a time. In this case, the machine that is
9186	started first gains exclusive access to the hard disk and attempts to
9187	start other machines having this hard disk attached will fail until the
9188	first machine is powered down.
9189
9190	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
9191	that the given hard disk remains associated with the given machine after a
9192	successful <link to="IMachine::detachDevice"/> call until
9193	<link to="IMachine::saveSettings"/> is called to save all changes to
9194	machine settings to disk. This deferring is necessary to guarantee that
9195	the hard disk configuration may be restored at any time by a call to
9196	<link to="IMachine::discardSettings"/> before the settings
9197	are saved (committed).
9198
9199	Note that if <link to="IMachine::discardSettings"/> is called after
9200	indirectly attaching some hard disks to the machine but before a call to
9201	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
9202	all differencing hard disks implicitly created by
9203	<link to="IMachine::attachDevice"/> for these indirect attachments.
9204	Such implicitly created hard disks will also be immediately deleted when
9205	detached explicitly using the <link to="IMachine::detachDevice"/>
9206	call if it is made before <link to="IMachine::saveSettings"/>. This
9207	implicit deletion is safe because newly created differencing hard
9208	disks do not contain any user data.
9209
9210	However, keep in mind that detaching differencing hard disks that were
9211	implicitly created by <link to="IMachine::attachDevice"/>
9212	before the last <link to="IMachine::saveSettings"/> call will
9213	<b>not</b> implicitly delete them as they may already contain some data
9214	(for example, as a result of virtual machine execution). If these hard
9215	disks are no more necessary, the caller can always delete them explicitly
9216	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
9217	from this machine by the <link to="IMachine::saveSettings"/> call.
9218
9219	<h3>Smart Attachment</h3>
9220
9221	When normal base or immutable hard disks are indirectly attached to a
9222	virtual machine then some additional steps are performed to make sure the
9223	virtual machine will have the most recent "view" of the hard disk being
9224	attached. These steps include walking through the machine's snapshots
9225	starting from the current one and going through ancestors up to the first
9226	snapshot. Hard disks attached to the virtual machine in all
9227	of the encountered snapshots are checked whether they are descendants of
9228	the given normal base or immutable hard disk. The first found child (which
9229	is the differencing hard disk) will be used instead of the normal base or
9230	immutable hard disk as a parent for creating a new differencing hard disk
9231	that will be actually attached to the machine. And only if no descendants
9232	are found or if the virtual machine does not have any snapshots then the
9233	normal base or immutable hard disk will be used itself as a parent for
9234	this differencing hard disk.
9235
9236	It is easier to explain what smart attachment does using the
9237	following example:
9238	<pre>
9239	BEFORE attaching B.vdi: AFTER attaching B.vdi:
9240
9241	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
9242	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
9243	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
9244	Snapshot 4 (none) Snapshot 4 (none)
9245	CurState (none) CurState (D3->D2.vdi)
9246
9247	NOT
9248	...
9249	CurState (D3->B.vdi)
9250	</pre>
9251	The first column is the virtual machine configuration before the base hard
9252	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
9253	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
9254	mean that the hard disk that is actually attached to the machine is a
9255	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
9256	another hard disk, <tt>B.vdi</tt>.
9257
9258	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
9259	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
9260	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
9261	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
9262	it cannot be attached directly and needs an indirect attachment (i.e.
9263	implicit creation of a new differencing hard disk). Due to the smart
9264	attachment procedure, the new differencing hard disk
9265	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
9266	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
9267	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
9268	machine.
9269
9270	Note that if there is more than one descendant hard disk of the given base
9271	hard disk found in a snapshot, and there is an exact device, channel and
9272	bus match, then this exact match will be used. Otherwise, the youngest
9273	descendant will be picked up.
9274
9275	There is one more important aspect of the smart attachment procedure which
9276	is not related to snapshots at all. Before walking through the snapshots
9277	as described above, the backup copy of the current list of hard disk
9278	attachment is searched for descendants. This backup copy is created when
9279	the hard disk configuration is changed for the first time after the last
9280	<link to="IMachine::saveSettings"/> call and used by
9281	<link to="IMachine::discardSettings"/> to undo the recent hard disk
9282	changes. When such a descendant is found in this backup copy, it will be
9283	simply re-attached back, without creating a new differencing hard disk for
9284	it. This optimization is necessary to make it possible to re-attach the
9285	base or immutable hard disk to a different bus, channel or device slot
9286	without losing the contents of the differencing hard disk actually
9287	attached to the machine in place of it.
9288
9289	</desc>
9290
9291	<attribute name="medium" type="IMedium" readonly="yes">
9292	<desc>Medium object associated with this attachment; it
9293	can be @c null for removable devices.</desc>
9294	</attribute>
9295
9296	<attribute name="controller" type="wstring" readonly="yes">
9297	<desc>Name of the storage controller of this attachment; this
9298	refers to one of the controllers in <link to="IMachine::storageControllers" />
9299	by name.</desc>
9300	</attribute>
9301
9302	<attribute name="port" type="long" readonly="yes">
9303	<desc>Port number of this attachment.
9304	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9305	</desc>
9306	</attribute>
9307
9308	<attribute name="device" type="long" readonly="yes">
9309	<desc>Device slot number of this attachment.
9310	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
9311	</desc>
9312	</attribute>
9313
9314	<attribute name="type" type="DeviceType" readonly="yes">
9315	<desc>Device type of this attachment.</desc>
9316	</attribute>
9317
9318	<attribute name="passthrough" type="boolean" readonly="yes">
9319	<desc>Pass I/O requests through to a device on the host.</desc>
9320	</attribute>
9321
9322	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
9323	<desc>The bandwidth group this medium attachment is assigned to.</desc>
9324	</attribute>
9325
9326	</interface>
9327
9328	<interface
9329	name="IMedium" extends="$unknown"
9330	uuid="9edda847-1279-4b0a-9af7-9d66251ccc18"
9331	wsmap="managed"
9332	>
9333	<desc>
9334	The IMedium interface represents virtual storage for a machine's
9335	hard disks, CD/DVD or floppy drives. It will typically represent
9336	a disk image on the host, for example a VDI or VMDK file representing
9337	a virtual hard disk, or an ISO or RAW file representing virtual
9338	removable media, but can also point to a network location (e.g.
9339	for iSCSI targets).
9340
9341	Instances of IMedium are connected to virtual machines by way of medium
9342	attachments, which link the storage medium to a particular device slot
9343	of a storage controller of the virtual machine.
9344	In the VirtualBox API, virtual storage is therefore always represented
9345	by the following chain of object links:
9346
9347	<ul>
9348	<li><link to="IMachine::storageControllers"/> contains an array of
9349	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
9350	these are instances of <link to="IStorageController"/>).</li>
9351	<li><link to="IMachine::mediumAttachments"/> contains an array of
9352	medium attachments (instances of <link to="IMediumAttachment"/>
9353	created by <link to="IMachine::attachDevice" />),
9354	each containing a storage controller from the above array, a
9355	port/device specification, and an instance of IMedium representing
9356	the medium storage (image file).
9357
9358	For removable media, the storage medium is optional; a medium
9359	attachment with no medium represents a CD/DVD or floppy drive
9360	with no medium inserted. By contrast, hard disk attachments
9361	will always have an IMedium object attached.</li>
9362	<li>Each IMedium in turn points to a storage unit (such as a file
9363	on the host computer or a network resource) that holds actual
9364	data. This location is represented by the <link to="#location"/>
9365	attribute.</li>
9366	</ul>
9367
9368	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
9369	new hard disk media can be created with the VirtualBox API using the
9370	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
9371	disks (see below) are usually implicitly created by VirtualBox as
9372	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
9373	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
9374	should be created with external tools and then opened from within VirtualBox.
9375
9376	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
9377	drive. In that case the <link to="#id" /> attribute contains the UUID of
9378	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
9379
9380	<h3>Media registries</h3>
9381
9382	When a medium has been opened or created using one of the aforementioned
9383	APIs, it becomes "known" to VirtualBox. Known media can be attached
9384	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
9385	They also appear in the global
9386	<link to="IVirtualBox::hardDisks" />,
9387	<link to="IVirtualBox::DVDImages" /> and
9388	<link to="IVirtualBox::floppyImages" /> arrays.
9389
9390	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
9391	in the VirtualBox.xml file, which was shared between all machines and made
9392	transporting machines and their media from one host to another difficult.
9393
9394	Starting with VirtualBox 4.0, media are only added to a registry when they are
9395	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
9396	backwards compatibility, which registry a medium is added to depends on which
9397	VirtualBox version created a machine:
9398
9399	<ul>
9400	<li>If the medium has first been attached to a machine which was created by
9401	VirtualBox 4.0 or later, it is added to that machine's media registry in
9402	the machine XML settings file. This way all information about a machine's
9403	media attachments is contained in a single file and can be transported
9404	easily.</li>
9405	<li>For older media attachments (i.e. if the medium was first attached to a
9406	machine which was created with a VirtualBox version before 4.0), media
9407	continue to be registered in the global VirtualBox settings file, for
9408	backwards compatibility.</li>
9409	</ul>
9410
9411	See <link to="IVirtualBox::openMedium" /> for more information.
9412
9413	Media are removed from media registries by the <link to="#close"/>,
9414	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
9415
9416	<h3>Accessibility checks</h3>
9417
9418	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
9419	method is called explicitly on a medium. This is done to make the VirtualBox object
9420	ready for serving requests as fast as possible and let the end-user
9421	application decide if it needs to check media accessibility right away or not.
9422
9423	As a result, when VirtualBox starts up (e.g. the VirtualBox
9424	object gets created for the first time), all known media are in the
9425	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
9426	attribute is an empty string because no actual accessibility check has
9427	been made yet.
9428
9429	After calling <link to="#refreshState" />, a medium is considered
9430	<i>accessible</i> if its storage unit can be read. In that case, the
9431	<link to="#state"/> attribute has a value of "Created". If the storage
9432	unit cannot be read (for example, because it is located on a disconnected
9433	network resource, or was accidentally deleted outside VirtualBox),
9434	the medium is considered <i>inaccessible</i>, which is indicated by the
9435	"Inaccessible" state. The exact reason why the medium is inaccessible can be
9436	obtained by reading the <link to="#lastAccessError"/> attribute.
9437
9438	<h3>Medium types</h3>
9439
9440	There are five types of medium behavior which are stored in the
9441	<link to="#type"/> attribute (see <link to="MediumType" />) and
9442	which define the medium's behavior with attachments and snapshots.
9443
9444	All media can be also divided in two groups: <i>base</i> media and
9445	<i>differencing</i> media. A base medium contains all sectors of the
9446	medium data in its own storage and therefore can be used independently.
9447	In contrast, a differencing medium is a "delta" to some other medium and
9448	contains only those sectors which differ from that other medium, which is
9449	then called a <i>parent</i>. The differencing medium is said to be
9450	<i>linked to</i> that parent. The parent may be itself a differencing
9451	medium, thus forming a chain of linked media. The last element in that
9452	chain must always be a base medium. Note that several differencing
9453	media may be linked to the same parent medium.
9454
9455	Differencing media can be distinguished from base media by querying the
9456	<link to="#parent"/> attribute: base media do not have parents they would
9457	depend on, so the value of this attribute is always @c null for them.
9458	Using this attribute, it is possible to walk up the medium tree (from the
9459	child medium to its parent). It is also possible to walk down the tree
9460	using the <link to="#children"/> attribute.
9461
9462	Note that the type of all differencing media is "normal"; all other
9463	values are meaningless for them. Base media may be of any type.
9464
9465	<h3>Automatic composition of the file name part</h3>
9466
9467	Another extension to the <link to="IMedium::location"/> attribute is that
9468	there is a possibility to cause VirtualBox to compose a unique value for
9469	the file name part of the location using the UUID of the hard disk. This
9470	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
9471	e.g. before the storage unit is created, and works as follows. You set the
9472	value of the <link to="IMedium::location"/> attribute to a location
9473	specification which only contains the path specification but not the file
9474	name part and ends with either a forward slash or a backslash character.
9475	In response, VirtualBox will generate a new UUID for the hard disk and
9476	compose the file name using the following pattern:
9477	<pre>
9478	<path>/{<uuid>}.<ext>
9479	</pre>
9480	where <tt><path></tt> is the supplied path specification,
9481	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
9482	is the default extension for the storage format of this hard disk. After
9483	that, you may call any of the methods that create a new hard disk storage
9484	unit and they will use the generated UUID and file name.
9485	</desc>
9486
9487	<attribute name="id" type="uuid" mod="string" readonly="yes">
9488	<desc>
9489	UUID of the medium. For a newly created medium, this value is a randomly
9490	generated UUID.
9491
9492	<note>
9493	For media in one of MediumState_NotCreated, MediumState_Creating or
9494	MediumState_Deleting states, the value of this property is undefined
9495	and will most likely be an empty UUID.
9496	</note>
9497	</desc>
9498	</attribute>
9499
9500	<attribute name="description" type="wstring">
9501	<desc>
9502	Optional description of the medium. For a newly created medium the value
9503	of this attribute is an empty string.
9504
9505	Medium types that don't support this attribute will return E_NOTIMPL in
9506	attempt to get or set this attribute's value.
9507
9508	<note>
9509	For some storage types, reading this attribute may return an outdated
9510	(last known) value when <link to="#state"/> is <link
9511	to="MediumState_Inaccessible"/> or <link
9512	to="MediumState_LockedWrite"/> because the value of this attribute is
9513	stored within the storage unit itself. Also note that changing the
9514	attribute value is not possible in such case, as well as when the
9515	medium is the <link to="MediumState_LockedRead"/> state.
9516	</note>
9517	</desc>
9518	</attribute>
9519
9520	<attribute name="state" type="MediumState" readonly="yes">
9521	<desc>
9522	Returns the current medium state, which is the last state set by
9523	the accessibility check performed by <link to="#refreshState"/>.
9524	If that method has not yet been called on the medium, the state
9525	is "Inaccessible"; as opposed to truly inaccessible media, the
9526	value of <link to="#lastAccessError"/> will be an empty string in
9527	that case.
9528
9529	<note>As of version 3.1, this no longer performs an accessibility check
9530	automatically; call <link to="#refreshState"/> for that.
9531	</note>
9532	</desc>
9533	</attribute>
9534
9535	<attribute name="variant" type="unsigned long" readonly="yes">
9536	<desc>
9537	Returns the storage format variant information for this medium
9538	as a combination of the flags described at <link to="MediumVariant" />.
9539	Before <link to="#refreshState"/> is called this method returns
9540	an undefined value.
9541	</desc>
9542	</attribute>
9543
9544	<attribute name="location" type="wstring">
9545	<desc>
9546	Location of the storage unit holding medium data.
9547
9548	The format of the location string is medium type specific. For medium
9549	types using regular files in a host's file system, the location
9550	string is the full file name.
9551
9552	Some medium types may support changing the storage unit location by
9553	simply changing the value of this property. If this operation is not
9554	supported, the implementation will return E_NOTIMPL in attempt to set
9555	this attribute's value.
9556
9557	When setting a value of the location attribute which is a regular file
9558	in the host's file system, the given file name may be either relative to
9559	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
9560	absolute. Note that if the given location specification does not contain
9561	the file extension part then a proper default extension will be
9562	automatically appended by the implementation depending on the medium type.
9563	</desc>
9564	</attribute>
9565
9566	<attribute name="name" type="wstring" readonly="yes">
9567	<desc>
9568	Name of the storage unit holding medium data.
9569
9570	The returned string is a short version of the <link to="#location"/>
9571	attribute that is suitable for representing the medium in situations
9572	where the full location specification is too long (such as lists
9573	and comboboxes in GUI frontends). This string is also used by frontends
9574	to sort the media list alphabetically when needed.
9575
9576	For example, for locations that are regular files in the host's file
9577	system, the value of this attribute is just the file name (+ extension),
9578	without the path specification.
9579
9580	Note that as opposed to the <link to="#location"/> attribute, the name
9581	attribute will not necessary be unique for a list of media of the
9582	given type and format.
9583	</desc>
9584	</attribute>
9585
9586	<attribute name="deviceType" type="DeviceType" readonly="yes">
9587	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
9588	medium.</desc>
9589	</attribute>
9590
9591	<attribute name="hostDrive" type="boolean" readonly="yes">
9592	<desc>True if this corresponds to a drive on the host.</desc>
9593	</attribute>
9594
9595	<attribute name="size" type="long long" readonly="yes">
9596	<desc>
9597	Physical size of the storage unit used to hold medium data (in bytes).
9598
9599	<note>
9600	For media whose <link to="#state"/> is <link
9601	to="MediumState_Inaccessible"/>, the value of this property is the
9602	last known size. For <link to="MediumState_NotCreated"/> media,
9603	the returned value is zero.
9604	</note>
9605	</desc>
9606	</attribute>
9607
9608	<attribute name="format" type="wstring" readonly="yes">
9609	<desc>
9610	Storage format of this medium.
9611
9612	The value of this attribute is a string that specifies a backend used
9613	to store medium data. The storage format is defined when you create a
9614	new medium or automatically detected when you open an existing medium,
9615	and cannot be changed later.
9616
9617	The list of all storage formats supported by this VirtualBox
9618	installation can be obtained using
9619	<link to="ISystemProperties::mediumFormats"/>.
9620	</desc>
9621	</attribute>
9622
9623	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
9624	<desc>
9625	Storage medium format object corresponding to this medium.
9626
9627	The value of this attribute is a reference to the medium format object
9628	that specifies the backend properties used to store medium data. The
9629	storage format is defined when you create a new medium or automatically
9630	detected when you open an existing medium, and cannot be changed later.
9631
9632	<note>@c null is returned if there is no associated medium format
9633	object. This can e.g. happen for medium objects representing host
9634	drives and other special medium objects.</note>
9635	</desc>
9636	</attribute>
9637
9638	<attribute name="type" type="MediumType">
9639	<desc>
9640	Type (role) of this medium.
9641
9642	The following constraints apply when changing the value of this
9643	attribute:
9644	<ul>
9645	<li>If a medium is attached to a virtual machine (either in the
9646	current state or in one of the snapshots), its type cannot be
9647	changed.
9648	</li>
9649	<li>As long as the medium has children, its type cannot be set
9650	to <link to="MediumType_Writethrough"/>.
9651	</li>
9652	<li>The type of all differencing media is
9653	<link to="MediumType_Normal"/> and cannot be changed.
9654	</li>
9655	</ul>
9656
9657	The type of a newly created or opened medium is set to
9658	<link to="MediumType_Normal"/>, except for DVD and floppy media,
9659	which have a type of <link to="MediumType_Writethrough"/>.
9660	</desc>
9661	</attribute>
9662
9663	<attribute name="parent" type="IMedium" readonly="yes">
9664	<desc>
9665	Parent of this medium (the medium this medium is directly based
9666	on).
9667
9668	Only differencing media have parents. For base (non-differencing)
9669	media, @c null is returned.
9670	</desc>
9671	</attribute>
9672
9673	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
9674	<desc>
9675	Children of this medium (all differencing media directly based
9676	on this medium). A @c null array is returned if this medium
9677	does not have any children.
9678	</desc>
9679	</attribute>
9680
9681	<attribute name="base" type="IMedium" readonly="yes">
9682	<desc>
9683	Base medium of this medium.
9684
9685	If this is a differencing medium, its base medium is the medium
9686	the given medium branch starts from. For all other types of media, this
9687	property returns the medium object itself (i.e. the same object this
9688	property is read on).
9689	</desc>
9690	</attribute>
9691
9692	<attribute name="readOnly" type="boolean" readonly="yes">
9693	<desc>
9694	Returns @c true if this medium is read-only and @c false otherwise.
9695
9696	A medium is considered to be read-only when its contents cannot be
9697	modified without breaking the integrity of other parties that depend on
9698	this medium such as its child media or snapshots of virtual machines
9699	where this medium is attached to these machines. If there are no
9700	children and no such snapshots then there is no dependency and the
9701	medium is not read-only.
9702
9703	The value of this attribute can be used to determine the kind of the
9704	attachment that will take place when attaching this medium to a
9705	virtual machine. If the value is @c false then the medium will
9706	be attached directly. If the value is @c true then the medium
9707	will be attached indirectly by creating a new differencing child
9708	medium for that. See the interface description for more information.
9709
9710	Note that all <link to="MediumType_Immutable">Immutable</link> media
9711	are always read-only while all
9712	<link to="MediumType_Writethrough">Writethrough</link> media are
9713	always not.
9714
9715	<note>
9716	The read-only condition represented by this attribute is related to
9717	the medium type and usage, not to the current
9718	<link to="IMedium::state">medium state</link> and not to the read-only
9719	state of the storage unit.
9720	</note>
9721	</desc>
9722	</attribute>
9723
9724	<attribute name="logicalSize" type="long long" readonly="yes">
9725	<desc>
9726	Logical size of this medium (in bytes), as reported to the
9727	guest OS running inside the virtual machine this medium is
9728	attached to. The logical size is defined when the medium is created
9729	and cannot be changed later.
9730
9731	<note>
9732	Reading this property on a differencing medium will return the size
9733	of its <link to="#base"/> medium.
9734	</note>
9735	<note>
9736	For media whose state is <link to="#state"/> is <link
9737	to="MediumState_Inaccessible"/>, the value of this property is the
9738	last known logical size. For <link to="MediumState_NotCreated"/>
9739	media, the returned value is zero.
9740	</note>
9741	</desc>
9742	</attribute>
9743
9744	<attribute name="autoReset" type="boolean">
9745	<desc>
9746	Whether this differencing medium will be automatically reset each
9747	time a virtual machine it is attached to is powered up. This
9748	attribute is automatically set to @c true for the last
9749	differencing image of an "immutable" medium (see
9750	<link to="MediumType" />).
9751
9752	See <link to="#reset"/> for more information about resetting
9753	differencing media.
9754
9755	<note>
9756	Reading this property on a base (non-differencing) medium will
9757	always @c false. Changing the value of this property in this
9758	case is not supported.
9759	</note>
9760
9761	<result name="VBOX_E_NOT_SUPPORTED">
9762	This is not a differencing medium (when changing the attribute
9763	value).
9764	</result>
9765	</desc>
9766	</attribute>
9767
9768	<attribute name="lastAccessError" type="wstring" readonly="yes">
9769	<desc>
9770	Text message that represents the result of the last accessibility
9771	check performed by <link to="#refreshState"/>.
9772
9773	An empty string is returned if the last accessibility check
9774	was successful or has not yet been called. As a result, if
9775	<link to="#state" /> is "Inaccessible" and this attribute is empty,
9776	then <link to="#refreshState"/> has yet to be called; this is the
9777	default value of media after VirtualBox initialization.
9778	A non-empty string indicates a failure and should normally describe
9779	a reason of the failure (for example, a file read error).
9780	</desc>
9781	</attribute>
9782
9783	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
9784	<desc>
9785	Array of UUIDs of all machines this medium is attached to.
9786
9787	A @c null array is returned if this medium is not attached to any
9788	machine or to any machine's snapshot.
9789
9790	<note>
9791	The returned array will include a machine even if this medium is not
9792	attached to that machine in the current state but attached to it in
9793	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
9794	details.
9795	</note>
9796	</desc>
9797	</attribute>
9798
9799	<method name="setIDs">
9800	<desc>
9801	Changes the UUID and parent UUID for a hard disk medium.
9802	</desc>
9803	<param name="setImageId" type="boolean" dir="in">
9804	<desc>
9805	Select whether a new image UUID is set or not.
9806	</desc>
9807	</param>
9808	<param name="imageId" type="uuid" mod="string" dir="in">
9809	<desc>
9810	New UUID for the image. If an empty string is passed, then a new
9811	UUID is automatically created, provided that @a setImageId is @c true.
9812	Specifying a zero UUID is not allowed.
9813	</desc>
9814	</param>
9815	<param name="setParentId" type="boolean" dir="in">
9816	<desc>
9817	Select whether a new parent UUID is set or not.
9818	</desc>
9819	</param>
9820	<param name="parentId" type="uuid" mod="string" dir="in">
9821	<desc>
9822	New parent UUID for the image. If an empty string is passed, then a
9823	new UUID is automatically created, provided @a setParentId is
9824	@c true. A zero UUID is valid.
9825	</desc>
9826	</param>
9827	<result name="E_INVALIDARG">
9828	Invalid parameter combination.
9829	</result>
9830	<result name="VBOX_E_NOT_SUPPORTED">
9831	Medium is not a hard disk medium.
9832	</result>
9833	</method>
9834
9835	<method name="refreshState">
9836	<desc>
9837	If the current medium state (see <link to="MediumState"/>) is one of
9838	"Created", "Inaccessible" or "LockedRead", then this performs an
9839	accessibility check on the medium and sets the value of the <link to="#state"/>
9840	attribute accordingly; that value is also returned for convenience.
9841
9842	For all other state values, this does not perform a refresh but returns
9843	the state only.
9844
9845	The refresh, if performed, may take a long time (several seconds or even
9846	minutes, depending on the storage unit location and format) because it performs an
9847	accessibility check of the storage unit. This check may cause a significant
9848	delay if the storage unit of the given medium is, for example, a file located
9849	on a network share which is not currently accessible due to connectivity
9850	problems. In that case, the call will not return until a timeout
9851	interval defined by the host OS for this operation expires. For this reason,
9852	it is recommended to never read this attribute on the main UI thread to avoid
9853	making the UI unresponsive.
9854
9855	If the last known state of the medium is "Created" and the accessibility
9856	check fails, then the state would be set to "Inaccessible", and
9857	<link to="#lastAccessError"/> may be used to get more details about the
9858	failure. If the state of the medium is "LockedRead", then it remains the
9859	same, and a non-empty value of <link to="#lastAccessError"/> will
9860	indicate a failed accessibility check in this case.
9861
9862	Note that not all medium states are applicable to all medium types.
9863	</desc>
9864	<param name="state" type="MediumState" dir="return">
9865	<desc>
9866	New medium state.
9867	</desc>
9868	</param>
9869	</method>
9870
9871	<method name="getSnapshotIds">
9872	<desc>
9873	Returns an array of UUIDs of all snapshots of the given machine where
9874	this medium is attached to.
9875
9876	If the medium is attached to the machine in the current state, then the
9877	first element in the array will always be the ID of the queried machine
9878	(i.e. the value equal to the @c machineId argument), followed by
9879	snapshot IDs (if any).
9880
9881	If the medium is not attached to the machine in the current state, then
9882	the array will contain only snapshot IDs.
9883
9884	The returned array may be @c null if this medium is not attached
9885	to the given machine at all, neither in the current state nor in one of
9886	the snapshots.
9887	</desc>
9888	<param name="machineId" type="uuid" mod="string" dir="in">
9889	<desc>
9890	UUID of the machine to query.
9891	</desc>
9892	</param>
9893	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
9894	<desc>
9895	Array of snapshot UUIDs of the given machine using this medium.
9896	</desc>
9897	</param>
9898	</method>
9899
9900	<method name="lockRead">
9901	<desc>
9902	Locks this medium for reading.
9903
9904	A read lock is shared: many clients can simultaneously lock the
9905	same medium for reading unless it is already locked for writing (see
9906	<link to="#lockWrite"/>) in which case an error is returned.
9907
9908	When the medium is locked for reading, it cannot be modified
9909	from within VirtualBox. This means that any method that changes
9910	the properties of this medium or contents of the storage unit
9911	will return an error (unless explicitly stated otherwise). That
9912	includes an attempt to start a virtual machine that wants to
9913	write to the the medium.
9914
9915	When the virtual machine is started up, it locks for reading all
9916	media it uses in read-only mode. If some medium cannot be locked
9917	for reading, the startup procedure will fail.
9918	A medium is typically locked for reading while it is used by a running
9919	virtual machine but has a depending differencing image that receives
9920	the actual write operations. This way one base medium can have
9921	multiple child differencing images which can be written to
9922	simultaneously. Read-only media such as DVD and floppy images are
9923	also locked for reading only (so they can be in use by multiple
9924	machines simultaneously).
9925
9926	A medium is also locked for reading when it is the source of a
9927	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
9928
9929	The medium locked for reading must be unlocked using the <link
9930	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
9931	can be nested and must be followed by the same number of paired
9932	<link to="#unlockRead"/> calls.
9933
9934	This method sets the medium state (see <link to="#state"/>) to
9935	"LockedRead" on success. The medium's previous state must be
9936	one of "Created", "Inaccessible" or "LockedRead".
9937
9938	Locking an inaccessible medium is not an error; this method performs
9939	a logical lock that prevents modifications of this medium through
9940	the VirtualBox API, not a physical file-system lock of the underlying
9941	storage unit.
9942
9943	This method returns the current state of the medium
9944	<i>before</i> the operation.
9945
9946	<result name="VBOX_E_INVALID_OBJECT_STATE">
9947	Invalid medium state (e.g. not created, locked, inaccessible,
9948	creating, deleting).
9949	</result>
9950
9951	</desc>
9952	<param name="state" type="MediumState" dir="return">
9953	<desc>
9954	State of the medium after the operation.
9955	</desc>
9956	</param>
9957	</method>
9958
9959	<method name="unlockRead">
9960	<desc>
9961	Cancels the read lock previously set by <link to="#lockRead"/>.
9962
9963	For both success and failure, this method returns the current state
9964	of the medium <i>after</i> the operation.
9965
9966	See <link to="#lockRead"/> for more details.
9967
9968	<result name="VBOX_E_INVALID_OBJECT_STATE">
9969	Medium not locked for reading.
9970	</result>
9971
9972	</desc>
9973	<param name="state" type="MediumState" dir="return">
9974	<desc>
9975	State of the medium after the operation.
9976	</desc>
9977	</param>
9978	</method>
9979
9980	<method name="lockWrite">
9981	<desc>
9982	Locks this medium for writing.
9983
9984	A write lock, as opposed to <link to="#lockRead"/>, is
9985	exclusive: there may be only one client holding a write lock,
9986	and there may be no read locks while the write lock is held.
9987	As a result, read-locking fails if a write lock is held, and
9988	write-locking fails if either a read or another write lock is held.
9989
9990	When a medium is locked for writing, it cannot be modified
9991	from within VirtualBox, and it is not guaranteed that the values
9992	of its properties are up-to-date. Any method that changes the
9993	properties of this medium or contents of the storage unit will
9994	return an error (unless explicitly stated otherwise).
9995
9996	When a virtual machine is started up, it locks for writing all
9997	media it uses to write data to. If any medium could not be locked
9998	for writing, the startup procedure will fail. If a medium has
9999	differencing images, then while the machine is running, only
10000	the last ("leaf") differencing image is locked for writing,
10001	whereas its parents are locked for reading only.
10002
10003	A medium is also locked for writing when it is the target of a
10004	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10005
10006	The medium locked for writing must be unlocked using the <link
10007	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
10008
10009	This method sets the medium state (see <link to="#state"/>) to
10010	"LockedWrite" on success. The medium's previous state must be
10011	either "Created" or "Inaccessible".
10012
10013	Locking an inaccessible medium is not an error; this method performs
10014	a logical lock that prevents modifications of this medium through
10015	the VirtualBox API, not a physical file-system lock of the underlying
10016	storage unit.
10017
10018	For both, success and failure, this method returns the current
10019	state of the medium <i>before</i> the operation.
10020
10021	<result name="VBOX_E_INVALID_OBJECT_STATE">
10022	Invalid medium state (e.g. not created, locked, inaccessible,
10023	creating, deleting).
10024	</result>
10025
10026	</desc>
10027	<param name="state" type="MediumState" dir="return">
10028	<desc>
10029	State of the medium after the operation.
10030	</desc>
10031	</param>
10032	</method>
10033
10034	<method name="unlockWrite">
10035	<desc>
10036	Cancels the write lock previously set by <link to="#lockWrite"/>.
10037
10038	For both success and failure, this method returns the current
10039	state of the medium <i>after</i> the operation.
10040
10041	See <link to="#lockWrite"/> for more details.
10042
10043	<result name="VBOX_E_INVALID_OBJECT_STATE">
10044	Medium not locked for writing.
10045	</result>
10046
10047	</desc>
10048	<param name="state" type="MediumState" dir="return">
10049	<desc>
10050	State of the medium after the operation.
10051	</desc>
10052	</param>
10053	</method>
10054
10055	<method name="close">
10056	<desc>
10057	Closes this medium.
10058
10059	The medium must not be attached to any known virtual machine
10060	and must not have any known child media, otherwise the
10061	operation will fail.
10062
10063	When the medium is successfully closed, it is removed from
10064	the list of registered media, but its storage unit is not
10065	deleted. In particular, this means that this medium can
10066	later be opened again using the <link to="IVirtualBox::openMedium"/>
10067	call.
10068
10069	Note that after this method successfully returns, the given medium
10070	object becomes uninitialized. This means that any attempt
10071	to call any of its methods or attributes will fail with the
10072	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
10073
10074	<result name="VBOX_E_INVALID_OBJECT_STATE">
10075	Invalid medium state (other than not created, created or
10076	inaccessible).
10077	</result>
10078	<result name="VBOX_E_OBJECT_IN_USE">
10079	Medium attached to virtual machine.
10080	</result>
10081	<result name="VBOX_E_FILE_ERROR">
10082	Settings file not accessible.
10083	</result>
10084	<result name="VBOX_E_XML_ERROR">
10085	Could not parse the settings file.
10086	</result>
10087
10088	</desc>
10089	</method>
10090
10091	<!-- storage methods -->
10092
10093	<method name="getProperty">
10094	<desc>
10095	Returns the value of the custom medium property with the given name.
10096
10097	The list of all properties supported by the given medium format can
10098	be obtained with <link to="IMediumFormat::describeProperties"/>.
10099
10100	Note that if this method returns an empty string in @a value, the
10101	requested property is supported but currently not assigned any value.
10102
10103	<result name="VBOX_E_OBJECT_NOT_FOUND">
10104	Requested property does not exist (not supported by the format).
10105	</result>
10106	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10107	</desc>
10108	<param name="name" type="wstring" dir="in">
10109	<desc>Name of the property to get.</desc>
10110	</param>
10111	<param name="value" type="wstring" dir="return">
10112	<desc>Current property value.</desc>
10113	</param>
10114	</method>
10115
10116	<method name="setProperty">
10117	<desc>
10118	Sets the value of the custom medium property with the given name.
10119
10120	The list of all properties supported by the given medium format can
10121	be obtained with <link to="IMediumFormat::describeProperties"/>.
10122
10123	Note that setting the property value to @c null or an empty string is
10124	equivalent to deleting the existing value. A default value (if it is
10125	defined for this property) will be used by the format backend in this
10126	case.
10127
10128	<result name="VBOX_E_OBJECT_NOT_FOUND">
10129	Requested property does not exist (not supported by the format).
10130	</result>
10131	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
10132	</desc>
10133	<param name="name" type="wstring" dir="in">
10134	<desc>Name of the property to set.</desc>
10135	</param>
10136	<param name="value" type="wstring" dir="in">
10137	<desc>Property value to set.</desc>
10138	</param>
10139	</method>
10140
10141	<method name="getProperties">
10142	<desc>
10143	Returns values for a group of properties in one call.
10144
10145	The names of the properties to get are specified using the @a names
10146	argument which is a list of comma-separated property names or
10147	an empty string if all properties are to be returned. Note that currently
10148	the value of this argument is ignored and the method always returns all
10149	existing properties.
10150
10151	The list of all properties supported by the given medium format can
10152	be obtained with <link to="IMediumFormat::describeProperties"/>.
10153
10154	The method returns two arrays, the array of property names corresponding
10155	to the @a names argument and the current values of these properties.
10156	Both arrays have the same number of elements with each elemend at the
10157	given index in the first array corresponds to an element at the same
10158	index in the second array.
10159
10160	Note that for properties that do not have assigned values,
10161	an empty string is returned at the appropriate index in the
10162	@a returnValues array.
10163
10164	</desc>
10165	<param name="names" type="wstring" dir="in">
10166	<desc>
10167	Names of properties to get.
10168	</desc>
10169	</param>
10170	<param name="returnNames" type="wstring" safearray="yes" dir="out">
10171	<desc>Names of returned properties.</desc>
10172	</param>
10173	<param name="returnValues" type="wstring" safearray="yes" dir="return">
10174	<desc>Values of returned properties.</desc>
10175	</param>
10176	</method>
10177
10178	<method name="setProperties">
10179	<desc>
10180	Sets values for a group of properties in one call.
10181
10182	The names of the properties to set are passed in the @a names
10183	array along with the new values for them in the @a values array. Both
10184	arrays have the same number of elements with each elemend at the given
10185	index in the first array corresponding to an element at the same index
10186	in the second array.
10187
10188	If there is at least one property name in @a names that is not valid,
10189	the method will fail before changing the values of any other properties
10190	from the @a names array.
10191
10192	Using this method over <link to="#setProperty"/> is preferred if you
10193	need to set several properties at once since it will result into less
10194	IPC calls.
10195
10196	The list of all properties supported by the given medium format can
10197	be obtained with <link to="IMediumFormat::describeProperties"/>.
10198
10199	Note that setting the property value to @c null or an empty string is
10200	equivalent to deleting the existing value. A default value (if it is
10201	defined for this property) will be used by the format backend in this
10202	case.
10203	</desc>
10204	<param name="names" type="wstring" safearray="yes" dir="in">
10205	<desc>Names of properties to set.</desc>
10206	</param>
10207	<param name="values" type="wstring" safearray="yes" dir="in">
10208	<desc>Values of properties to set.</desc>
10209	</param>
10210	</method>
10211
10212	<!-- storage methods -->
10213
10214	<method name="createBaseStorage">
10215	<desc>
10216	Starts creating a hard disk storage unit (fixed/dynamic, according
10217	to the variant flags) in in the background. The previous storage unit
10218	created for this object, if any, must first be deleted using
10219	<link to="#deleteStorage"/>, otherwise the operation will fail.
10220
10221	Before the operation starts, the medium is placed in
10222	<link to="MediumState_Creating"/> state. If the create operation
10223	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
10224	state.
10225
10226	After the returned progress object reports that the operation has
10227	successfully completed, the medium state will be set to <link
10228	to="MediumState_Created"/>, the medium will be remembered by this
10229	VirtualBox installation and may be attached to virtual machines.
10230
10231	<result name="VBOX_E_NOT_SUPPORTED">
10232	The variant of storage creation operation is not supported. See <link
10233	to="IMediumFormat::capabilities"/>.
10234	</result>
10235	</desc>
10236	<param name="logicalSize" type="long long" dir="in">
10237	<desc>Maximum logical size of the medium in bytes.</desc>
10238	</param>
10239	<param name="variant" type="unsigned long" dir="in">
10240	<desc>Exact image variant which should be created (as a combination of
10241	<link to="MediumVariant" /> flags).</desc>
10242	</param>
10243	<param name="progress" type="IProgress" dir="return">
10244	<desc>Progress object to track the operation completion.</desc>
10245	</param>
10246	</method>
10247
10248	<method name="deleteStorage">
10249	<desc>
10250	Starts deleting the storage unit of this medium.
10251
10252	The medium must not be attached to any known virtual machine and must
10253	not have any known child media, otherwise the operation will fail.
10254	It will also fail if there is no storage unit to delete or if deletion
10255	is already in progress, or if the medium is being in use (locked for
10256	read or for write) or inaccessible. Therefore, the only valid state for
10257	this operation to succeed is <link to="MediumState_Created"/>.
10258
10259	Before the operation starts, the medium is placed in
10260	<link to="MediumState_Deleting"/> state and gets removed from the list
10261	of remembered hard disks (media registry). If the delete operation
10262	fails, the medium will be remembered again and placed back to
10263	<link to="MediumState_Created"/> state.
10264
10265	After the returned progress object reports that the operation is
10266	complete, the medium state will be set to
10267	<link to="MediumState_NotCreated"/> and you will be able to use one of
10268	the storage creation methods to create it again.
10269
10270	<see>#close()</see>
10271
10272	<result name="VBOX_E_OBJECT_IN_USE">
10273	Medium is attached to a virtual machine.
10274	</result>
10275	<result name="VBOX_E_NOT_SUPPORTED">
10276	Storage deletion is not allowed because neither of storage creation
10277	operations are supported. See
10278	<link to="IMediumFormat::capabilities"/>.
10279	</result>
10280
10281	<note>
10282	If the deletion operation fails, it is not guaranteed that the storage
10283	unit still exists. You may check the <link to="IMedium::state"/> value
10284	to answer this question.
10285	</note>
10286	</desc>
10287	<param name="progress" type="IProgress" dir="return">
10288	<desc>Progress object to track the operation completion.</desc>
10289	</param>
10290	</method>
10291
10292	<!-- diff methods -->
10293
10294	<method name="createDiffStorage">
10295	<desc>
10296	Starts creating an empty differencing storage unit based on this
10297	medium in the format and at the location defined by the @a target
10298	argument.
10299
10300	The target medium must be in <link to="MediumState_NotCreated"/>
10301	state (i.e. must not have an existing storage unit). Upon successful
10302	completion, this operation will set the type of the target medium to
10303	<link to="MediumType_Normal"/> and create a storage unit necessary to
10304	represent the differencing medium data in the given format (according
10305	to the storage format of the target object).
10306
10307	After the returned progress object reports that the operation is
10308	successfully complete, the target medium gets remembered by this
10309	VirtualBox installation and may be attached to virtual machines.
10310
10311	<note>
10312	The medium will be set to <link to="MediumState_LockedRead"/>
10313	state for the duration of this operation.
10314	</note>
10315	<result name="VBOX_E_OBJECT_IN_USE">
10316	Medium not in @c NotCreated state.
10317	</result>
10318	</desc>
10319	<param name="target" type="IMedium" dir="in">
10320	<desc>Target medium.</desc>
10321	</param>
10322	<param name="variant" type="unsigned long" dir="in">
10323	<desc>Exact image variant which should be created (as a combination of
10324	<link to="MediumVariant" /> flags).</desc>
10325	</param>
10326	<param name="progress" type="IProgress" dir="return">
10327	<desc>Progress object to track the operation completion.</desc>
10328	</param>
10329	</method>
10330
10331	<method name="mergeTo">
10332	<desc>
10333	Starts merging the contents of this medium and all intermediate
10334	differencing media in the chain to the given target medium.
10335
10336	The target medium must be either a descendant of this medium or
10337	its ancestor (otherwise this method will immediately return a failure).
10338	It follows that there are two logical directions of the merge operation:
10339	from ancestor to descendant (<i>forward merge</i>) and from descendant to
10340	ancestor (<i>backward merge</i>). Let us consider the following medium
10341	chain:
10342
10343	<pre>Base <- Diff_1 <- Diff_2</pre>
10344
10345	Here, calling this method on the <tt>Base</tt> medium object with
10346	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
10347	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
10348	merge. Note that in both cases the contents of the resulting medium
10349	will be the same, the only difference is the medium object that takes
10350	the result of the merge operation. In case of the forward merge in the
10351	above example, the result will be written to <tt>Diff_2</tt>; in case of
10352	the backward merge, the result will be written to <tt>Base</tt>. In
10353	other words, the result of the operation is always stored in the target
10354	medium.
10355
10356	Upon successful operation completion, the storage units of all media in
10357	the chain between this (source) medium and the target medium, including
10358	the source medium itself, will be automatically deleted and the
10359	relevant medium objects (including this medium) will become
10360	uninitialized. This means that any attempt to call any of
10361	their methods or attributes will fail with the
10362	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
10363	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
10364	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
10365	Note that <tt>Diff_2</tt> in this case will become a base medium
10366	itself since it will no longer be based on any other medium.
10367
10368	Considering the above, all of the following conditions must be met in
10369	order for the merge operation to succeed:
10370	<ul>
10371	<li>
10372	Neither this (source) medium nor any intermediate
10373	differencing medium in the chain between it and the target
10374	medium is attached to any virtual machine.
10375	</li>
10376	<li>
10377	Neither the source medium nor the target medium is an
10378	<link to="MediumType_Immutable"/> medium.
10379	</li>
10380	<li>
10381	The part of the medium tree from the source medium to the
10382	target medium is a linear chain, i.e. all medium in this
10383	chain have exactly one child which is the next medium in this
10384	chain. The only exception from this rule is the target medium in
10385	the forward merge operation; it is allowed to have any number of
10386	child media because the merge operation will not change its
10387	logical contents (as it is seen by the guest OS or by children).
10388	</li>
10389	<li>
10390	None of the involved media are in
10391	<link to="MediumState_LockedRead"/> or
10392	<link to="MediumState_LockedWrite"/> state.
10393	</li>
10394	</ul>
10395
10396	<note>
10397	This (source) medium and all intermediates will be placed to <link
10398	to="MediumState_Deleting"/> state and the target medium will be
10399	placed to <link to="MediumState_LockedWrite"/> state and for the
10400	duration of this operation.
10401	</note>
10402	</desc>
10403	<param name="target" type="IMedium" dir="in">
10404	<desc>Target medium.</desc>
10405	</param>
10406	<param name="progress" type="IProgress" dir="return">
10407	<desc>Progress object to track the operation completion.</desc>
10408	</param>
10409	</method>
10410
10411	<!-- clone method -->
10412
10413	<method name="cloneTo">
10414	<desc>
10415	Starts creating a clone of this medium in the format and at the
10416	location defined by the @a target argument.
10417
10418	The target medium must be either in <link to="MediumState_NotCreated"/>
10419	state (i.e. must not have an existing storage unit) or in
10420	<link to="MediumState_Created"/> state (i.e. created and not locked, and
10421	big enough to hold the data or else the copy will be partial). Upon
10422	successful completion, the cloned medium will contain exactly the
10423	same sector data as the medium being cloned, except that in the
10424	first case a new UUID for the clone will be randomly generated, and in
10425	the second case the UUID will remain unchanged.
10426
10427	The @a parent argument defines which medium will be the parent
10428	of the clone. Passing a @c null reference indicates that the clone will
10429	be a base image, i.e. completely independent. It is possible to specify
10430	an arbitrary medium for this parameter, including the parent of the
10431	medium which is being cloned. Even cloning to a child of the source
10432	medium is possible. Note that when cloning to an existing image, the
10433	@a parent irgument is ignored.
10434
10435	After the returned progress object reports that the operation is
10436	successfully complete, the target medium gets remembered by this
10437	VirtualBox installation and may be attached to virtual machines.
10438
10439	<note>
10440	This medium will be placed to <link to="MediumState_LockedRead"/>
10441	state for the duration of this operation.
10442	</note>
10443	<result name="E_NOTIMPL">
10444	The specified cloning variant is not supported at the moment.
10445	</result>
10446	</desc>
10447	<param name="target" type="IMedium" dir="in">
10448	<desc>Target medium.</desc>
10449	</param>
10450	<param name="variant" type="unsigned long" dir="in">
10451	<desc>Exact image variant which should be created (as a combination of
10452	<link to="MediumVariant" /> flags).</desc>
10453	</param>
10454	<param name="parent" type="IMedium" dir="in">
10455	<desc>Parent of the cloned medium.</desc>
10456	</param>
10457	<param name="progress" type="IProgress" dir="return">
10458	<desc>Progress object to track the operation completion.</desc>
10459	</param>
10460	</method>
10461
10462	<!-- other methods -->
10463
10464	<method name="compact">
10465	<desc>
10466	Starts compacting of this medium. This means that the medium is
10467	transformed into a possibly more compact storage representation.
10468	This potentially creates temporary images, which can require a
10469	substantial amount of additional disk space.
10470
10471	This medium will be placed to <link to="MediumState_LockedWrite"/>
10472	state and all its parent media (if any) will be placed to
10473	<link to="MediumState_LockedRead"/> state for the duration of this
10474	operation.
10475
10476	Please note that the results can be either returned straight away,
10477	or later as the result of the background operation via the object
10478	returned via the @a progress parameter.
10479
10480	<result name="VBOX_E_NOT_SUPPORTED">
10481	Medium format does not support compacting (but potentially
10482	needs it).
10483	</result>
10484	</desc>
10485	<param name="progress" type="IProgress" dir="return">
10486	<desc>Progress object to track the operation completion.</desc>
10487	</param>
10488	</method>
10489
10490	<method name="resize">
10491	<desc>
10492	Starts resizing this medium. This means that the nominal size of the
10493	medium is set to the new value. Both increasing and decreasing the
10494	size is possible, and there are no safety checks, since VirtualBox
10495	does not make any assumptions about the medium contents.
10496
10497	Resizing usually needs additional disk space, and possibly also
10498	some temporary disk space. Note that resize does not create a full
10499	temporary copy of the medium, so the additional disk space requirement
10500	is usually much lower than using the clone operation.
10501
10502	This medium will be placed to <link to="MediumState_LockedWrite"/>
10503	state for the duration of this operation.
10504
10505	Please note that the results can be either returned straight away,
10506	or later as the result of the background operation via the object
10507	returned via the @a progress parameter.
10508
10509	<result name="VBOX_E_NOT_SUPPORTED">
10510	Medium format does not support resizing.
10511	</result>
10512	</desc>
10513	<param name="logicalSize" type="long long" dir="in">
10514	<desc>New nominal capacity of the medium in bytes.</desc>
10515	</param>
10516	<param name="progress" type="IProgress" dir="return">
10517	<desc>Progress object to track the operation completion.</desc>
10518	</param>
10519	</method>
10520
10521	<method name="reset">
10522	<desc>
10523	Starts erasing the contents of this differencing medium.
10524
10525	This operation will reset the differencing medium to its initial
10526	state when it does not contain any sector data and any read operation is
10527	redirected to its parent medium. This automatically gets called
10528	during VM power-up for every medium whose <link to="#autoReset" />
10529	attribute is @c true.
10530
10531	The medium will be write-locked for the duration of this operation (see
10532	<link to="#lockWrite" />).
10533
10534	<result name="VBOX_E_NOT_SUPPORTED">
10535	This is not a differencing medium.
10536	</result>
10537	<result name="VBOX_E_INVALID_OBJECT_STATE">
10538	Medium is not in <link to="MediumState_Created"/> or
10539	<link to="MediumState_Inaccessible"/> state.
10540	</result>
10541	</desc>
10542	<param name="progress" type="IProgress" dir="return">
10543	<desc>Progress object to track the operation completion.</desc>
10544	</param>
10545	</method>
10546
10547	</interface>
10548
10549
10550	<!--
10551	// IMediumFormat
10552	/////////////////////////////////////////////////////////////////////////
10553	-->
10554
10555	<enum
10556	name="DataType"
10557	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
10558	>
10559	<const name="Int32" value="0"/>
10560	<const name="Int8" value="1"/>
10561	<const name="String" value="2"/>
10562	</enum>
10563
10564	<enum
10565	name="DataFlags"
10566	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
10567	>
10568	<const name="None" value="0x00"/>
10569	<const name="Mandatory" value="0x01"/>
10570	<const name="Expert" value="0x02"/>
10571	<const name="Array" value="0x04"/>
10572	<const name="FlagMask" value="0x07"/>
10573	</enum>
10574
10575	<enum
10576	name="MediumFormatCapabilities"
10577	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
10578	>
10579	<desc>
10580	Medium format capability flags.
10581	</desc>
10582
10583	<const name="Uuid" value="0x01">
10584	<desc>
10585	Supports UUIDs as expected by VirtualBox code.
10586	</desc>
10587	</const>
10588
10589	<const name="CreateFixed" value="0x02">
10590	<desc>
10591	Supports creating fixed size images, allocating all space instantly.
10592	</desc>
10593	</const>
10594
10595	<const name="CreateDynamic" value="0x04">
10596	<desc>
10597	Supports creating dynamically growing images, allocating space on
10598	demand.
10599	</desc>
10600	</const>
10601
10602	<const name="CreateSplit2G" value="0x08">
10603	<desc>
10604	Supports creating images split in chunks of a bit less than 2 GBytes.
10605	</desc>
10606	</const>
10607
10608	<const name="Differencing" value="0x10">
10609	<desc>
10610	Supports being used as a format for differencing media (see <link
10611	to="IMedium::createDiffStorage"/>).
10612	</desc>
10613	</const>
10614
10615	<const name="Asynchronous" value="0x20">
10616	<desc>
10617	Supports asynchronous I/O operations for at least some configurations.
10618	</desc>
10619	</const>
10620
10621	<const name="File" value="0x40">
10622	<desc>
10623	The format backend operates on files (the <link to="IMedium::location"/>
10624	attribute of the medium specifies a file used to store medium
10625	data; for a list of supported file extensions see
10626	<link to="IMediumFormat::describeFileExtensions"/>).
10627	</desc>
10628	</const>
10629
10630	<const name="Properties" value="0x80">
10631	<desc>
10632	The format backend uses the property interface to configure the storage
10633	location and properties (the <link to="IMediumFormat::describeProperties"/>
10634	method is used to get access to properties supported by the given medium format).
10635	</desc>
10636	</const>
10637
10638	<const name="TcpNetworking" value="0x100">
10639	<desc>
10640	The format backend uses the TCP networking interface for network access.
10641	</desc>
10642	</const>
10643
10644	<const name="VFS" value="0x200">
10645	<desc>
10646	The format backend supports virtual filesystem functionality.
10647	</desc>
10648	</const>
10649
10650	<const name="CapabilityMask" value="0x3FF"/>
10651	</enum>
10652
10653	<interface
10654	name="IMediumFormat" extends="$unknown"
10655	uuid="4e9a873f-0599-434a-8345-619ef3fb3111"
10656	wsmap="managed"
10657	>
10658	<desc>
10659	The IMediumFormat interface represents a medium format.
10660
10661	Each medium format has an associated backend which is used to handle
10662	media stored in this format. This interface provides information
10663	about the properties of the associated backend.
10664
10665	Each medium format is identified by a string represented by the
10666	<link to="#id"/> attribute. This string is used in calls like
10667	<link to="IVirtualBox::createHardDisk"/> to specify the desired
10668	format.
10669
10670	The list of all supported medium formats can be obtained using
10671	<link to="ISystemProperties::mediumFormats"/>.
10672
10673	<see>IMedium</see>
10674	</desc>
10675
10676	<attribute name="id" type="wstring" readonly="yes">
10677	<desc>
10678	Identifier of this format.
10679
10680	The format identifier is a non-@c null non-empty ASCII string. Note that
10681	this string is case-insensitive. This means that, for example, all of
10682	the following strings:
10683	<pre>
10684	"VDI"
10685	"vdi"
10686	"VdI"</pre>
10687	refer to the same medium format.
10688
10689	This string is used in methods of other interfaces where it is necessary
10690	to specify a medium format, such as
10691	<link to="IVirtualBox::createHardDisk"/>.
10692	</desc>
10693	</attribute>
10694
10695	<attribute name="name" type="wstring" readonly="yes">
10696	<desc>
10697	Human readable description of this format.
10698
10699	Mainly for use in file open dialogs.
10700	</desc>
10701	</attribute>
10702
10703	<attribute name="capabilities" type="unsigned long" readonly="yes">
10704	<desc>
10705	Capabilities of the format as a set of bit flags.
10706
10707	For the meaning of individual capability flags see
10708	<link to="MediumFormatCapabilities"/>.
10709	</desc>
10710	</attribute>
10711
10712	<method name="describeFileExtensions">
10713	<desc>
10714	Returns two arrays describing the supported file extensions.
10715
10716	The first array contains the supported extensions and the seconds one
10717	the type each extension supports. Both have the same size.
10718
10719	Note that some backends do not work on files, so this array may be
10720	empty.
10721
10722	<see>IMediumFormat::capabilities</see>
10723	</desc>
10724	<param name="extensions" type="wstring" safearray="yes" dir="out">
10725	<desc>The array of supported extensions.</desc>
10726	</param>
10727	<param name="type" type="DeviceType" safearray="yes" dir="out">
10728	<desc>The array which indicates the device type for every given extension.</desc>
10729	</param>
10730	</method>
10731
10732	<method name="describeProperties">
10733	<desc>
10734	Returns several arrays describing the properties supported by this
10735	format.
10736
10737	An element with the given index in each array describes one
10738	property. Thus, the number of elements in each returned array is the
10739	same and corresponds to the number of supported properties.
10740
10741	The returned arrays are filled in only if the
10742	<link to="MediumFormatCapabilities_Properties"/> flag is set.
10743	All arguments must be non-@c null.
10744
10745	<see>DataType</see>
10746	<see>DataFlags</see>
10747	</desc>
10748
10749	<param name="names" type="wstring" safearray="yes" dir="out">
10750	<desc>Array of property names.</desc>
10751	</param>
10752	<param name="description" type="wstring" safearray="yes" dir="out">
10753	<desc>Array of property descriptions.</desc>
10754	</param>
10755	<param name="types" type="DataType" safearray="yes" dir="out">
10756	<desc>Array of property types.</desc>
10757	</param>
10758	<param name="flags" type="unsigned long" safearray="yes" dir="out">
10759	<desc>Array of property flags.</desc>
10760	</param>
10761	<param name="defaults" type="wstring" safearray="yes" dir="out">
10762	<desc>Array of default property values.</desc>
10763	</param>
10764	</method>
10765
10766	</interface>
10767
10768
10769	<!--
10770	// IKeyboard
10771	/////////////////////////////////////////////////////////////////////////
10772	-->
10773
10774	<interface
10775	name="IKeyboard" extends="$unknown"
10776	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
10777	wsmap="managed"
10778	>
10779	<desc>
10780	The IKeyboard interface represents the virtual machine's keyboard. Used
10781	in <link to="IConsole::keyboard"/>.
10782
10783	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
10784	to the virtual machine.
10785
10786	</desc>
10787	<method name="putScancode">
10788	<desc>Sends a scancode to the keyboard.
10789
10790	<result name="VBOX_E_IPRT_ERROR">
10791	Could not send scan code to virtual keyboard.
10792	</result>
10793
10794	</desc>
10795	<param name="scancode" type="long" dir="in"/>
10796	</method>
10797
10798	<method name="putScancodes">
10799	<desc>Sends an array of scancodes to the keyboard.
10800
10801	<result name="VBOX_E_IPRT_ERROR">
10802	Could not send all scan codes to virtual keyboard.
10803	</result>
10804
10805	</desc>
10806	<param name="scancodes" type="long" dir="in" safearray="yes"/>
10807	<param name="codesStored" type="unsigned long" dir="return"/>
10808	</method>
10809
10810	<method name="putCAD">
10811	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
10812	function is nothing special, it is just a convenience function
10813	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
10814
10815	<result name="VBOX_E_IPRT_ERROR">
10816	Could not send all scan codes to virtual keyboard.
10817	</result>
10818
10819	</desc>
10820	</method>
10821
10822	<attribute name="eventSource" type="IEventSource" readonly="yes">
10823	<desc>
10824	Event source for keyboard events.
10825	</desc>
10826	</attribute>
10827
10828	</interface>
10829
10830
10831	<!--
10832	// IMouse
10833	/////////////////////////////////////////////////////////////////////////
10834	-->
10835
10836	<enum
10837	name="MouseButtonState"
10838	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
10839	>
10840	<desc>
10841	Mouse button state.
10842	</desc>
10843
10844	<const name="LeftButton" value="0x01"/>
10845	<const name="RightButton" value="0x02"/>
10846	<const name="MiddleButton" value="0x04"/>
10847	<const name="WheelUp" value="0x08"/>
10848	<const name="WheelDown" value="0x10"/>
10849	<const name="XButton1" value="0x20"/>
10850	<const name="XButton2" value="0x40"/>
10851	<const name="MouseStateMask" value="0x7F"/>
10852	</enum>
10853
10854	<interface
10855	name="IMouse" extends="$unknown"
10856	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
10857	wsmap="managed"
10858	>
10859	<desc>
10860	The IMouse interface represents the virtual machine's mouse. Used in
10861	<link to="IConsole::mouse"/>.
10862
10863	Through this interface, the virtual machine's virtual mouse can be
10864	controlled.
10865	</desc>
10866
10867	<attribute name="absoluteSupported" type="boolean" readonly="yes">
10868	<desc>
10869	Whether the guest OS supports absolute mouse pointer positioning
10870	or not.
10871	<note>
10872	You can use the <link to="IMouseCapabilityChangedEvent"/>
10873	event to be instantly informed about changes of this attribute
10874	during virtual machine execution.
10875	</note>
10876	<see><link to="#putMouseEventAbsolute"/></see>
10877	</desc>
10878	</attribute>
10879
10880	<attribute name="relativeSupported" type="boolean" readonly="yes">
10881	<desc>
10882	Whether the guest OS supports relative mouse pointer positioning
10883	or not.
10884	<note>
10885	You can use the <link to="IMouseCapabilityChangedEvent"/>
10886	event to be instantly informed about changes of this attribute
10887	during virtual machine execution.
10888	</note>
10889	<see><link to="#putMouseEvent"/></see>
10890	</desc>
10891	</attribute>
10892
10893	<attribute name="needsHostCursor" type="boolean" readonly="yes">
10894	<desc>
10895	Whether the guest OS can currently switch to drawing it's own mouse
10896	cursor on demand.
10897	<note>
10898	You can use the <link to="IMouseCapabilityChangedEvent"/>
10899	event to be instantly informed about changes of this attribute
10900	during virtual machine execution.
10901	</note>
10902	<see><link to="#putMouseEvent"/></see>
10903	</desc>
10904	</attribute>
10905
10906	<method name="putMouseEvent">
10907	<desc>
10908	Initiates a mouse event using relative pointer movements
10909	along x and y axis.
10910
10911	<result name="E_ACCESSDENIED">
10912	Console not powered up.
10913	</result>
10914	<result name="VBOX_E_IPRT_ERROR">
10915	Could not send mouse event to virtual mouse.
10916	</result>
10917
10918	</desc>
10919
10920	<param name="dx" type="long" dir="in">
10921	<desc>
10922	Amount of pixels the mouse should move to the right.
10923	Negative values move the mouse to the left.
10924	</desc>
10925	</param>
10926	<param name="dy" type="long" dir="in">
10927	<desc>
10928	Amount of pixels the mouse should move downwards.
10929	Negative values move the mouse upwards.
10930	</desc>
10931	</param>
10932	<param name="dz" type="long" dir="in">
10933	<desc>
10934	Amount of mouse wheel moves.
10935	Positive values describe clockwise wheel rotations,
10936	negative values describe counterclockwise rotations.
10937	</desc>
10938	</param>
10939	<param name="dw" type="long" dir="in">
10940	<desc>
10941	Amount of horizontal mouse wheel moves.
10942	Positive values describe a movement to the left,
10943	negative values describe a movement to the right.
10944	</desc>
10945	</param>
10946	<param name="buttonState" type="long" dir="in">
10947	<desc>
10948	The current state of mouse buttons. Every bit represents
10949	a mouse button as follows:
10950	<table>
10951	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
10952	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
10953	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
10954	</table>
10955	A value of <tt>1</tt> means the corresponding button is pressed.
10956	otherwise it is released.
10957	</desc>
10958	</param>
10959	</method>
10960
10961	<method name="putMouseEventAbsolute">
10962	<desc>
10963	Positions the mouse pointer using absolute x and y coordinates.
10964	These coordinates are expressed in pixels and
10965	start from <tt>[1,1]</tt> which corresponds to the top left
10966	corner of the virtual display.
10967
10968	<result name="E_ACCESSDENIED">
10969	Console not powered up.
10970	</result>
10971	<result name="VBOX_E_IPRT_ERROR">
10972	Could not send mouse event to virtual mouse.
10973	</result>
10974
10975	<note>
10976	This method will have effect only if absolute mouse
10977	positioning is supported by the guest OS.
10978	</note>
10979
10980	<see><link to="#absoluteSupported"/></see>
10981	</desc>
10982
10983	<param name="x" type="long" dir="in">
10984	<desc>
10985	X coordinate of the pointer in pixels, starting from @c 1.
10986	</desc>
10987	</param>
10988	<param name="y" type="long" dir="in">
10989	<desc>
10990	Y coordinate of the pointer in pixels, starting from @c 1.
10991	</desc>
10992	</param>
10993	<param name="dz" type="long" dir="in">
10994	<desc>
10995	Amount of mouse wheel moves.
10996	Positive values describe clockwise wheel rotations,
10997	negative values describe counterclockwise rotations.
10998	</desc>
10999	</param>
11000	<param name="dw" type="long" dir="in">
11001	<desc>
11002	Amount of horizontal mouse wheel moves.
11003	Positive values describe a movement to the left,
11004	negative values describe a movement to the right.
11005	</desc>
11006	</param>
11007	<param name="buttonState" type="long" dir="in">
11008	<desc>
11009	The current state of mouse buttons. Every bit represents
11010	a mouse button as follows:
11011	<table>
11012	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
11013	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
11014	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
11015	</table>
11016	A value of @c 1 means the corresponding button is pressed.
11017	otherwise it is released.
11018	</desc>
11019	</param>
11020	</method>
11021
11022	<attribute name="eventSource" type="IEventSource" readonly="yes">
11023	<desc>
11024	Event source for mouse events.
11025	</desc>
11026	</attribute>
11027
11028	</interface>
11029
11030	<!--
11031	// IDisplay
11032	/////////////////////////////////////////////////////////////////////////
11033	-->
11034
11035	<enum
11036	name="FramebufferPixelFormat"
11037	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
11038	>
11039	<desc>
11040	Format of the video memory buffer. Constants represented by this enum can
11041	be used to test for particular values of <link
11042	to="IFramebuffer::pixelFormat"/>. See also <link
11043	to="IFramebuffer::requestResize"/>.
11044
11045	See also www.fourcc.org for more information about FOURCC pixel formats.
11046	</desc>
11047
11048	<const name="Opaque" value="0">
11049	<desc>
11050	Unknown buffer format (the user may not assume any particular format of
11051	the buffer).
11052	</desc>
11053	</const>
11054	<const name="FOURCC_RGB" value="0x32424752">
11055	<desc>
11056	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
11057	bit layout).
11058	</desc>
11059	</const>
11060	</enum>
11061
11062	<interface
11063	name="IFramebuffer" extends="$unknown"
11064	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
11065	wsmap="suppress"
11066	>
11067	<attribute name="address" type="octet" mod="ptr" readonly="yes">
11068	<desc>Address of the start byte of the frame buffer.</desc>
11069	</attribute>
11070
11071	<attribute name="width" type="unsigned long" readonly="yes">
11072	<desc>Frame buffer width, in pixels.</desc>
11073	</attribute>
11074
11075	<attribute name="height" type="unsigned long" readonly="yes">
11076	<desc>Frame buffer height, in pixels.</desc>
11077	</attribute>
11078
11079	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
11080	<desc>
11081	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
11082	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
11083	are: 8, 15, 16, 24 and 32.
11084	</desc>
11085	</attribute>
11086
11087	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
11088	<desc>
11089	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
11090	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
11091	size of the scan line must be aligned to 32 bits.
11092	</desc>
11093	</attribute>
11094
11095	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
11096	<desc>
11097	Frame buffer pixel format. It's either one of the values defined by <link
11098	to="FramebufferPixelFormat"/> or a raw FOURCC code.
11099	<note>
11100	This attribute must never return <link
11101	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
11102	<link to="#address"/> points to must be always known.
11103	</note>
11104	</desc>
11105	</attribute>
11106
11107	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
11108	<desc>
11109	Defines whether this frame buffer uses the virtual video card's memory
11110	buffer (guest VRAM) directly or not. See <link
11111	to="IFramebuffer::requestResize"/> for more information.
11112	</desc>
11113	</attribute>
11114
11115	<attribute name="heightReduction" type="unsigned long" readonly="yes">
11116	<desc>
11117	Hint from the frame buffer about how much of the standard
11118	screen height it wants to use for itself. This information is
11119	exposed to the guest through the VESA BIOS and VMMDev interface
11120	so that it can use it for determining its video mode table. It
11121	is not guaranteed that the guest respects the value.
11122	</desc>
11123	</attribute>
11124
11125	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
11126	<desc>
11127	An alpha-blended overlay which is superposed over the frame buffer.
11128	The initial purpose is to allow the display of icons providing
11129	information about the VM state, including disk activity, in front
11130	ends which do not have other means of doing that. The overlay is
11131	designed to controlled exclusively by IDisplay. It has no locking
11132	of its own, and any changes made to it are not guaranteed to be
11133	visible until the affected portion of IFramebuffer is updated. The
11134	overlay can be created lazily the first time it is requested. This
11135	attribute can also return @c null to signal that the overlay is not
11136	implemented.
11137	</desc>
11138	</attribute>
11139
11140	<attribute name="winId" type="long long" readonly="yes">
11141	<desc>
11142	Platform-dependent identifier of the window where context of this
11143	frame buffer is drawn, or zero if there's no such window.
11144	</desc>
11145	</attribute>
11146
11147	<method name="lock">
11148	<desc>
11149	Locks the frame buffer.
11150	Gets called by the IDisplay object where this frame buffer is
11151	bound to.
11152	</desc>
11153	</method>
11154
11155	<method name="unlock">
11156	<desc>
11157	Unlocks the frame buffer.
11158	Gets called by the IDisplay object where this frame buffer is
11159	bound to.
11160	</desc>
11161	</method>
11162
11163	<method name="notifyUpdate">
11164	<desc>
11165	Informs about an update.
11166	Gets called by the display object where this buffer is
11167	registered.
11168	</desc>
11169	<param name="x" type="unsigned long" dir="in"/>
11170	<param name="y" type="unsigned long" dir="in"/>
11171	<param name="width" type="unsigned long" dir="in"/>
11172	<param name="height" type="unsigned long" dir="in"/>
11173	</method>
11174
11175	<method name="requestResize">
11176	<desc>
11177	Requests a size and pixel format change.
11178
11179	There are two modes of working with the video buffer of the virtual
11180	machine. The <i>indirect</i> mode implies that the IFramebuffer
11181	implementation allocates a memory buffer for the requested display mode
11182	and provides it to the virtual machine. In <i>direct</i> mode, the
11183	IFramebuffer implementation uses the memory buffer allocated and owned
11184	by the virtual machine. This buffer represents the video memory of the
11185	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
11186	usually faster because the implementation gets a raw pointer to the
11187	guest VRAM buffer which it can directly use for visualizing the contents
11188	of the virtual display, as opposed to the indirect mode where the
11189	contents of guest VRAM are copied to the memory buffer provided by
11190	the implementation every time a display update occurs.
11191
11192	It is important to note that the direct mode is really fast only when
11193	the implementation uses the given guest VRAM buffer directly, for
11194	example, by blitting it to the window representing the virtual machine's
11195	display, which saves at least one copy operation comparing to the
11196	indirect mode. However, using the guest VRAM buffer directly is not
11197	always possible: the format and the color depth of this buffer may be
11198	not supported by the target window, or it may be unknown (opaque) as in
11199	case of text or non-linear multi-plane VGA video modes. In this case,
11200	the indirect mode (that is always available) should be used as a
11201	fallback: when the guest VRAM contents are copied to the
11202	implementation-provided memory buffer, color and format conversion is
11203	done automatically by the underlying code.
11204
11205	The @a pixelFormat parameter defines whether the direct mode is
11206	available or not. If @a pixelFormat is <link
11207	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
11208	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
11209	@a bytesPerLine parameters must be ignored and the implementation must use
11210	the indirect mode (where it provides its own buffer in one of the
11211	supported formats). In all other cases, @a pixelFormat together with
11212	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
11213	buffer pointed to by the @a VRAM parameter and the implementation is
11214	free to choose which mode to use. To indicate that this frame buffer uses
11215	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
11216	attribute must return @c true and <link to="#address"/> must
11217	return exactly the same address that is passed in the @a VRAM parameter
11218	of this method; otherwise it is assumed that the indirect strategy is
11219	chosen.
11220
11221	The @a width and @a height parameters represent the size of the
11222	requested display mode in both modes. In case of indirect mode, the
11223	provided memory buffer should be big enough to store data of the given
11224	display mode. In case of direct mode, it is guaranteed that the given
11225	@a VRAM buffer contains enough space to represent the display mode of the
11226	given size. Note that this frame buffer's <link to="#width"/> and <link
11227	to="#height"/> attributes must return exactly the same values as
11228	passed to this method after the resize is completed (see below).
11229
11230	The @a finished output parameter determines if the implementation has
11231	finished resizing the frame buffer or not. If, for some reason, the
11232	resize cannot be finished immediately during this call, @a finished
11233	must be set to @c false, and the implementation must call
11234	<link to="IDisplay::resizeCompleted"/> after it has returned from
11235	this method as soon as possible. If @a finished is @c false, the
11236	machine will not call any frame buffer methods until
11237	<link to="IDisplay::resizeCompleted"/> is called.
11238
11239	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
11240	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
11241	this frame buffer must return exactly the same values as specified in the
11242	parameters of this method, after the resize is completed. If the
11243	indirect mode is chosen, these attributes must return values describing
11244	the format of the implementation's own memory buffer <link
11245	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
11246	value must always correlate with <link to="#pixelFormat"/>. Note that
11247	the <link to="#pixelFormat"/> attribute must never return <link
11248	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
11249
11250	<note>
11251	This method is called by the IDisplay object under the
11252	<link to="#lock"/> provided by this IFramebuffer
11253	implementation. If this method returns @c false in @a finished, then
11254	this lock is not released until
11255	<link to="IDisplay::resizeCompleted"/> is called.
11256	</note>
11257	</desc>
11258	<param name="screenId" type="unsigned long" dir="in">
11259	<desc>
11260	Logical screen number. Must be used in the corresponding call to
11261	<link to="IDisplay::resizeCompleted"/> if this call is made.
11262	</desc>
11263	</param>
11264	<param name="pixelFormat" type="unsigned long" dir="in">
11265	<desc>
11266	Pixel format of the memory buffer pointed to by @a VRAM.
11267	See also <link to="FramebufferPixelFormat"/>.
11268	</desc>
11269	</param>
11270	<param name="VRAM" type="octet" mod="ptr" dir="in">
11271	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
11272	</param>
11273	<param name="bitsPerPixel" type="unsigned long" dir="in">
11274	<desc>Color depth, bits per pixel.</desc>
11275	</param>
11276	<param name="bytesPerLine" type="unsigned long" dir="in">
11277	<desc>Size of one scan line, in bytes.</desc>
11278	</param>
11279	<param name="width" type="unsigned long" dir="in">
11280	<desc>Width of the guest display, in pixels.</desc>
11281	</param>
11282	<param name="height" type="unsigned long" dir="in">
11283	<desc>Height of the guest display, in pixels.</desc>
11284	</param>
11285	<param name="finished" type="boolean" dir="return">
11286	<desc>
11287	Can the VM start using the new frame buffer immediately
11288	after this method returns or it should wait for
11289	<link to="IDisplay::resizeCompleted"/>.
11290	</desc>
11291	</param>
11292	</method>
11293
11294	<method name="videoModeSupported">
11295	<desc>
11296	Returns whether the frame buffer implementation is willing to
11297	support a given video mode. In case it is not able to render
11298	the video mode (or for some reason not willing), it should
11299	return @c false. Usually this method is called when the guest
11300	asks the VMM device whether a given video mode is supported
11301	so the information returned is directly exposed to the guest.
11302	It is important that this method returns very quickly.
11303	</desc>
11304	<param name="width" type="unsigned long" dir="in"/>
11305	<param name="height" type="unsigned long" dir="in"/>
11306	<param name="bpp" type="unsigned long" dir="in"/>
11307	<param name="supported" type="boolean" dir="return"/>
11308	</method>
11309
11310	<method name="getVisibleRegion">
11311	<desc>
11312	Returns the visible region of this frame buffer.
11313
11314	If the @a rectangles parameter is @c null then the value of the
11315	@a count parameter is ignored and the number of elements necessary to
11316	describe the current visible region is returned in @a countCopied.
11317
11318	If @a rectangles is not @c null but @a count is less
11319	than the required number of elements to store region data, the method
11320	will report a failure. If @a count is equal or greater than the
11321	required number of elements, then the actual number of elements copied
11322	to the provided array will be returned in @a countCopied.
11323
11324	<note>
11325	The address of the provided array must be in the process space of
11326	this IFramebuffer object.
11327	</note>
11328	<note>
11329	Method not yet implemented.
11330	</note>
11331	</desc>
11332	<param name="rectangles" type="octet" mod="ptr" dir="in">
11333	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
11334	</param>
11335	<param name="count" type="unsigned long" dir="in">
11336	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11337	</param>
11338	<param name="countCopied" type="unsigned long" dir="return">
11339	<desc>Number of elements copied to the @a rectangles array.</desc>
11340	</param>
11341	</method>
11342
11343	<method name="setVisibleRegion">
11344	<desc>
11345	Suggests a new visible region to this frame buffer. This region
11346	represents the area of the VM display which is a union of regions of
11347	all top-level windows of the guest operating system running inside the
11348	VM (if the Guest Additions for this system support this
11349	functionality). This information may be used by the frontends to
11350	implement the seamless desktop integration feature.
11351
11352	<note>
11353	The address of the provided array must be in the process space of
11354	this IFramebuffer object.
11355	</note>
11356	<note>
11357	The IFramebuffer implementation must make a copy of the provided
11358	array of rectangles.
11359	</note>
11360	<note>
11361	Method not yet implemented.
11362	</note>
11363	</desc>
11364	<param name="rectangles" type="octet" mod="ptr" dir="in">
11365	<desc>Pointer to the @c RTRECT array.</desc>
11366	</param>
11367	<param name="count" type="unsigned long" dir="in">
11368	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
11369	</param>
11370	</method>
11371
11372	<method name="processVHWACommand">
11373	<desc>
11374	Posts a Video HW Acceleration Command to the frame buffer for processing.
11375	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
11376	are posted from quest to the host to be processed by the host hardware.
11377
11378	<note>
11379	The address of the provided command must be in the process space of
11380	this IFramebuffer object.
11381	</note>
11382	</desc>
11383
11384	<param name="command" type="octet" mod="ptr" dir="in">
11385	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
11386	</param>
11387	</method>
11388
11389	</interface>
11390
11391	<interface
11392	name="IFramebufferOverlay" extends="IFramebuffer"
11393	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
11394	wsmap="suppress"
11395	>
11396	<desc>
11397	The IFramebufferOverlay interface represents an alpha blended overlay
11398	for displaying status icons above an IFramebuffer. It is always created
11399	not visible, so that it must be explicitly shown. It only covers a
11400	portion of the IFramebuffer, determined by its width, height and
11401	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
11402	that order) format, and may be written to directly. Do re-read the
11403	width though, after setting it, as it may be adjusted (increased) to
11404	make it more suitable for the front end.
11405	</desc>
11406	<attribute name="x" type="unsigned long" readonly="yes">
11407	<desc>X position of the overlay, relative to the frame buffer.</desc>
11408	</attribute>
11409
11410	<attribute name="y" type="unsigned long" readonly="yes">
11411	<desc>Y position of the overlay, relative to the frame buffer.</desc>
11412	</attribute>
11413
11414	<attribute name="visible" type="boolean" readonly="no">
11415	<desc>
11416	Whether the overlay is currently visible.
11417	</desc>
11418	</attribute>
11419
11420	<attribute name="alpha" type="unsigned long" readonly="no">
11421	<desc>
11422	The global alpha value for the overlay. This may or may not be
11423	supported by a given front end.
11424	</desc>
11425	</attribute>
11426
11427	<method name="move">
11428	<desc>
11429	Changes the overlay's position relative to the IFramebuffer.
11430	</desc>
11431	<param name="x" type="unsigned long" dir="in"/>
11432	<param name="y" type="unsigned long" dir="in"/>
11433	</method>
11434
11435	</interface>
11436
11437	<interface
11438	name="IDisplay" extends="$unknown"
11439	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
11440	wsmap="managed"
11441	>
11442	<desc>
11443	The IDisplay interface represents the virtual machine's display.
11444
11445	The object implementing this interface is contained in each
11446	<link to="IConsole::display"/> attribute and represents the visual
11447	output of the virtual machine.
11448
11449	The virtual display supports pluggable output targets represented by the
11450	IFramebuffer interface. Examples of the output target are a window on
11451	the host computer or an RDP session's display on a remote computer.
11452	</desc>
11453	<method name="getScreenResolution">
11454	<desc>Queries display width, height and color depth for given screen.</desc>
11455	<param name="screenId" type="unsigned long" dir="in"/>
11456	<param name="width" type="unsigned long" dir="out"/>
11457	<param name="height" type="unsigned long" dir="out"/>
11458	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
11459	</method>
11460
11461	<method name="setFramebuffer">
11462	<desc>
11463	Sets the framebuffer for given screen.
11464	</desc>
11465	<param name="screenId" type="unsigned long" dir="in"/>
11466	<param name="framebuffer" type="IFramebuffer" dir="in"/>
11467	</method>
11468
11469	<method name="getFramebuffer">
11470	<desc>
11471	Queries the framebuffer for given screen.
11472	</desc>
11473	<param name="screenId" type="unsigned long" dir="in"/>
11474	<param name="framebuffer" type="IFramebuffer" dir="out"/>
11475	<param name="xOrigin" type="long" dir="out"/>
11476	<param name="yOrigin" type="long" dir="out"/>
11477	</method>
11478
11479	<method name="setVideoModeHint">
11480	<desc>
11481	Asks VirtualBox to request the given video mode from
11482	the guest. This is just a hint and it cannot be guaranteed
11483	that the requested resolution will be used. Guest Additions
11484	are required for the request to be seen by guests. The caller
11485	should issue the request and wait for a resolution change and
11486	after a timeout retry.
11487
11488	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
11489	parameters means that the corresponding values should be taken from the
11490	current video mode (i.e. left unchanged).
11491
11492	If the guest OS supports multi-monitor configuration then the @a display
11493	parameter specifies the number of the guest display to send the hint to:
11494	@c 0 is the primary display, @c 1 is the first secondary and
11495	so on. If the multi-monitor configuration is not supported, @a display
11496	must be @c 0.
11497
11498	<result name="E_INVALIDARG">
11499	The @a display is not associated with any monitor.
11500	</result>
11501
11502	</desc>
11503	<param name="width" type="unsigned long" dir="in"/>
11504	<param name="height" type="unsigned long" dir="in"/>
11505	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
11506	<param name="display" type="unsigned long" dir="in"/>
11507	</method>
11508
11509	<method name="setSeamlessMode">
11510	<desc>
11511	Enables or disables seamless guest display rendering (seamless desktop
11512	integration) mode.
11513	<note>
11514	Calling this method has no effect if <link
11515	to="IGuest::getFacilityStatus"/> with facility <link to="AdditionsFacilityType::Seamless"/>
11516	does not return <link to="AdditionsFacilityStatus::Active"/>.
11517	</note>
11518	</desc>
11519	<param name="enabled" type="boolean" dir="in"/>
11520	</method>
11521
11522	<method name="takeScreenShot">
11523	<desc>
11524	Takes a screen shot of the requested size and copies it to the
11525	32-bpp buffer allocated by the caller and pointed to by @a address.
11526	A pixel consists of 4 bytes in order: B, G, R, 0.
11527
11528	<note>This API can be used only by the COM/XPCOM C++ API as it
11529	requires pointer support. Use <link to="#takeScreenShotToArray" />
11530	with other language bindings.
11531	</note>
11532
11533	<result name="E_NOTIMPL">
11534	Feature not implemented.
11535	</result>
11536	<result name="VBOX_E_IPRT_ERROR">
11537	Could not take a screenshot.
11538	</result>
11539
11540	</desc>
11541	<param name="screenId" type="unsigned long" dir="in"/>
11542	<param name="address" type="octet" mod="ptr" dir="in"/>
11543	<param name="width" type="unsigned long" dir="in"/>
11544	<param name="height" type="unsigned long" dir="in"/>
11545	</method>
11546
11547	<method name="takeScreenShotToArray">
11548	<desc>
11549	Takes a guest screen shot of the requested size and returns it as
11550	an array of bytes in uncompressed 32-bit RGBA format.
11551	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
11552
11553	This API is slow, but could be the only option to get guest screenshot
11554	for scriptable languages not allowed to manipulate with addresses
11555	directly.
11556
11557	<result name="E_NOTIMPL">
11558	Feature not implemented.
11559	</result>
11560	<result name="VBOX_E_IPRT_ERROR">
11561	Could not take a screenshot.
11562	</result>
11563	</desc>
11564	<param name="screenId" type="unsigned long" dir="in">
11565	<desc>
11566	Monitor to take screenshot from.
11567	</desc>
11568	</param>
11569	<param name="width" type="unsigned long" dir="in">
11570	<desc>
11571	Desired image width.
11572	</desc>
11573	</param>
11574	<param name="height" type="unsigned long" dir="in">
11575	<desc>
11576	Desired image height.
11577	</desc>
11578	</param>
11579	<param name="screenData" type="octet" dir="return" safearray="yes">
11580	<desc>
11581	Array with resulting screen data.
11582	</desc>
11583	</param>
11584	</method>
11585
11586	<method name="takeScreenShotPNGToArray">
11587	<desc>
11588	Takes a guest screen shot of the requested size and returns it as
11589	PNG image in array.
11590
11591	<result name="E_NOTIMPL">
11592	Feature not implemented.
11593	</result>
11594	<result name="VBOX_E_IPRT_ERROR">
11595	Could not take a screenshot.
11596	</result>
11597	</desc>
11598	<param name="screenId" type="unsigned long" dir="in">
11599	<desc>
11600	Monitor to take the screenshot from.
11601	</desc>
11602	</param>
11603	<param name="width" type="unsigned long" dir="in">
11604	<desc>
11605	Desired image width.
11606	</desc>
11607	</param>
11608	<param name="height" type="unsigned long" dir="in">
11609	<desc>
11610	Desired image height.
11611	</desc>
11612	</param>
11613	<param name="screenData" type="octet" dir="return" safearray="yes">
11614	<desc>
11615	Array with resulting screen data.
11616	</desc>
11617	</param>
11618	</method>
11619
11620	<method name="drawToScreen">
11621	<desc>
11622	Draws a 32-bpp image of the specified size from the given buffer
11623	to the given point on the VM display.
11624
11625	<result name="E_NOTIMPL">
11626	Feature not implemented.
11627	</result>
11628	<result name="VBOX_E_IPRT_ERROR">
11629	Could not draw to screen.
11630	</result>
11631
11632	</desc>
11633	<param name="screenId" type="unsigned long" dir="in">
11634	<desc>
11635	Monitor to take the screenshot from.
11636	</desc>
11637	</param>
11638	<param name="address" type="octet" mod="ptr" dir="in">
11639	<desc>
11640	Address to store the screenshot to
11641	</desc>
11642	</param>
11643	<param name="x" type="unsigned long" dir="in">
11644	<desc>
11645	Relative to the screen top left corner.
11646	</desc>
11647	</param>
11648	<param name="y" type="unsigned long" dir="in">
11649	<desc>
11650	Relative to the screen top left corner.
11651	</desc>
11652	</param>
11653	<param name="width" type="unsigned long" dir="in">
11654	<desc>
11655	Desired image width.
11656	</desc>
11657	</param>
11658	<param name="height" type="unsigned long" dir="in">
11659	<desc>
11660	Desired image height.
11661	</desc>
11662	</param>
11663	</method>
11664
11665	<method name="invalidateAndUpdate">
11666	<desc>
11667	Does a full invalidation of the VM display and instructs the VM
11668	to update it.
11669
11670	<result name="VBOX_E_IPRT_ERROR">
11671	Could not invalidate and update screen.
11672	</result>
11673
11674	</desc>
11675	</method>
11676
11677	<method name="resizeCompleted">
11678	<desc>
11679	Signals that a framebuffer has completed the resize operation.
11680
11681	<result name="VBOX_E_NOT_SUPPORTED">
11682	Operation only valid for external frame buffers.
11683	</result>
11684
11685	</desc>
11686	<param name="screenId" type="unsigned long" dir="in"/>
11687	</method>
11688
11689	<method name="completeVHWACommand">
11690	<desc>
11691	Signals that the Video HW Acceleration command has completed.
11692	</desc>
11693
11694	<param name="command" type="octet" mod="ptr" dir="in">
11695	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
11696	</param>
11697	</method>
11698
11699	</interface>
11700
11701	<!--
11702	// INetworkAdapter
11703	/////////////////////////////////////////////////////////////////////////
11704	-->
11705
11706	<enum
11707	name="NetworkAttachmentType"
11708	uuid="44bce1ee-99f7-4e8e-89fc-80597fd9eeaf"
11709	>
11710	<desc>
11711	Network attachment type.
11712	</desc>
11713
11714	<const name="Null" value="0">
11715	<desc>Null value, also means "not attached".</desc>
11716	</const>
11717	<const name="NAT" value="1"/>
11718	<const name="Bridged" value="2"/>
11719	<const name="Internal" value="3"/>
11720	<const name="HostOnly" value="4"/>
11721	<const name="VDE" value="5"/>
11722	</enum>
11723
11724	<enum
11725	name="NetworkAdapterType"
11726	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
11727	>
11728	<desc>
11729	Network adapter type.
11730	</desc>
11731
11732	<const name="Null" value="0">
11733	<desc>Null value (never used by the API).</desc>
11734	</const>
11735	<const name="Am79C970A" value="1">
11736	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
11737	</const>
11738	<const name="Am79C973" value="2">
11739	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
11740	</const>
11741	<const name="I82540EM" value="3">
11742	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
11743	</const>
11744	<const name="I82543GC" value="4">
11745	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
11746	</const>
11747	<const name="I82545EM" value="5">
11748	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
11749	</const>
11750	<const name="Virtio" value="6">
11751	<desc>Virtio network device.</desc>
11752	</const>
11753	</enum>
11754
11755	<interface
11756	name="INetworkAdapter" extends="$unknown"
11757	uuid="9bf58a46-c3f7-4f31-80fa-dde9a5dc0b7b"
11758	wsmap="managed"
11759	>
11760	<desc>
11761	Represents a virtual network adapter that is attached to a virtual machine.
11762	Each virtual machine has a fixed number of network adapter slots with one
11763	instance of this attached to each of them. Call
11764	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
11765	is attached to a given slot in a given machine.
11766
11767	Each network adapter can be in one of five attachment modes, which are
11768	represented by the <link to="NetworkAttachmentType" /> enumeration;
11769	see the <link to="#attachmentType" /> attribute.
11770	</desc>
11771
11772	<attribute name="adapterType" type="NetworkAdapterType">
11773	<desc>
11774	Type of the virtual network adapter. Depending on this value,
11775	VirtualBox will provide a different virtual network hardware
11776	to the guest.
11777	</desc>
11778	</attribute>
11779
11780	<attribute name="slot" type="unsigned long" readonly="yes">
11781	<desc>
11782	Slot number this adapter is plugged into. Corresponds to
11783	the value you pass to <link to="IMachine::getNetworkAdapter"/>
11784	to obtain this instance.
11785	</desc>
11786	</attribute>
11787
11788	<attribute name="enabled" type="boolean">
11789	<desc>
11790	Flag whether the network adapter is present in the
11791	guest system. If disabled, the virtual guest hardware will
11792	not contain this network adapter. Can only be changed when
11793	the VM is not running.
11794	</desc>
11795	</attribute>
11796
11797	<attribute name="MACAddress" type="wstring">
11798	<desc>
11799	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
11800	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
11801	</desc>
11802	</attribute>
11803
11804	<attribute name="attachmentType" type="NetworkAttachmentType" readonly="yes"/>
11805
11806	<attribute name="hostInterface" type="wstring">
11807	<desc>
11808	Name of the host network interface the VM is attached to.
11809	</desc>
11810	</attribute>
11811
11812	<attribute name="internalNetwork" type="wstring">
11813	<desc>
11814	Name of the internal network the VM is attached to.
11815	</desc>
11816	</attribute>
11817
11818	<attribute name="NATNetwork" type="wstring">
11819	<desc>
11820	Name of the NAT network the VM is attached to.
11821	</desc>
11822	</attribute>
11823
11824	<attribute name="VDENetwork" type="wstring">
11825	<desc>
11826	Name of the VDE switch the VM is attached to.
11827	</desc>
11828	</attribute>
11829
11830	<attribute name="cableConnected" type="boolean">
11831	<desc>
11832	Flag whether the adapter reports the cable as connected or not.
11833	It can be used to report offline situations to a VM.
11834	</desc>
11835	</attribute>
11836
11837	<attribute name="lineSpeed" type="unsigned long">
11838	<desc>
11839	Line speed reported by custom drivers, in units of 1 kbps.
11840	</desc>
11841	</attribute>
11842
11843	<attribute name="traceEnabled" type="boolean">
11844	<desc>
11845	Flag whether network traffic from/to the network card should be traced.
11846	Can only be toggled when the VM is turned off.
11847	</desc>
11848	</attribute>
11849
11850	<attribute name="traceFile" type="wstring">
11851	<desc>
11852	Filename where a network trace will be stored. If not set, VBox-pid.pcap
11853	will be used.
11854	</desc>
11855	</attribute>
11856
11857	<attribute name="natDriver" type="INATEngine" readonly="yes">
11858	<desc>
11859	Points to the NAT engine which handles the network address translation
11860	for this interface. This is active only when the interface actually uses
11861	NAT (see <link to="#attachToNAT" />).
11862	</desc>
11863	</attribute>
11864
11865	<attribute name="bootPriority" type="unsigned long">
11866	<desc>
11867	Network boot priority of the adapter. Priority 1 is highest. If not set,
11868	the priority is considered to be at the lowest possible setting.
11869	</desc>
11870	</attribute>
11871
11872	<attribute name="bandwidthLimit" type="unsigned long">
11873	<desc>
11874	Maximum throughput allowed for this network adapter, in units of 1 mbps.
11875	A zero value means uncapped/unlimited.
11876	</desc>
11877	</attribute>
11878
11879	<method name="attachToNAT">
11880	<desc>
11881	Attach the network adapter to the Network Address Translation (NAT) interface.
11882	</desc>
11883	</method>
11884
11885	<method name="attachToBridgedInterface">
11886	<desc>
11887	Attach the network adapter to a bridged host interface.
11888	</desc>
11889	</method>
11890
11891	<method name="attachToInternalNetwork">
11892	<desc>
11893	Attach the network adapter to an internal network.
11894	</desc>
11895	</method>
11896
11897	<method name="attachToHostOnlyInterface">
11898	<desc>
11899	Attach the network adapter to the host-only network.
11900	</desc>
11901	</method>
11902
11903	<method name="attachToVDE">
11904	<desc>
11905	Attach the network adapter to a VDE network.
11906	</desc>
11907	</method>
11908
11909	<method name="detach">
11910	<desc>
11911	Detach the network adapter
11912	</desc>
11913	</method>
11914	</interface>
11915
11916
11917	<!--
11918	// ISerialPort
11919	/////////////////////////////////////////////////////////////////////////
11920	-->
11921
11922	<enum
11923	name="PortMode"
11924	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
11925	>
11926	<desc>
11927	The PortMode enumeration represents possible communication modes for
11928	the virtual serial port device.
11929	</desc>
11930
11931	<const name="Disconnected" value="0">
11932	<desc>Virtual device is not attached to any real host device.</desc>
11933	</const>
11934	<const name="HostPipe" value="1">
11935	<desc>Virtual device is attached to a host pipe.</desc>
11936	</const>
11937	<const name="HostDevice" value="2">
11938	<desc>Virtual device is attached to a host device.</desc>
11939	</const>
11940	<const name="RawFile" value="3">
11941	<desc>Virtual device is attached to a raw file.</desc>
11942	</const>
11943	</enum>
11944
11945	<interface
11946	name="ISerialPort" extends="$unknown"
11947	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
11948	wsmap="managed"
11949	>
11950
11951	<desc>
11952	The ISerialPort interface represents the virtual serial port device.
11953
11954	The virtual serial port device acts like an ordinary serial port
11955	inside the virtual machine. This device communicates to the real
11956	serial port hardware in one of two modes: host pipe or host device.
11957
11958	In host pipe mode, the #path attribute specifies the path to the pipe on
11959	the host computer that represents a serial port. The #server attribute
11960	determines if this pipe is created by the virtual machine process at
11961	machine startup or it must already exist before starting machine
11962	execution.
11963
11964	In host device mode, the #path attribute specifies the name of the
11965	serial port device on the host computer.
11966
11967	There is also a third communication mode: the disconnected mode. In this
11968	mode, the guest OS running inside the virtual machine will be able to
11969	detect the serial port, but all port write operations will be discarded
11970	and all port read operations will return no data.
11971
11972	<see>IMachine::getSerialPort</see>
11973	</desc>
11974
11975	<attribute name="slot" type="unsigned long" readonly="yes">
11976	<desc>
11977	Slot number this serial port is plugged into. Corresponds to
11978	the value you pass to <link to="IMachine::getSerialPort"/>
11979	to obtain this instance.
11980	</desc>
11981	</attribute>
11982
11983	<attribute name="enabled" type="boolean">
11984	<desc>
11985	Flag whether the serial port is enabled. If disabled,
11986	the serial port will not be reported to the guest OS.
11987	</desc>
11988	</attribute>
11989
11990	<attribute name="IOBase" type="unsigned long">
11991	<desc>Base I/O address of the serial port.</desc>
11992	</attribute>
11993
11994	<attribute name="IRQ" type="unsigned long">
11995	<desc>IRQ number of the serial port.</desc>
11996	</attribute>
11997
11998	<attribute name="hostMode" type="PortMode">
11999	<desc>
12000	How is this port connected to the host.
12001	<note>
12002	Changing this attribute may fail if the conditions for
12003	<link to="#path"/> are not met.
12004	</note>
12005	</desc>
12006	</attribute>
12007
12008	<attribute name="server" type="boolean">
12009	<desc>
12010	Flag whether this serial port acts as a server (creates a new pipe on
12011	the host) or as a client (uses the existing pipe). This attribute is
12012	used only when <link to="#hostMode"/> is PortMode_HostPipe.
12013	</desc>
12014	</attribute>
12015
12016	<attribute name="path" type="wstring">
12017	<desc>
12018	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
12019	PortMode_HostPipe, or the host serial device name when
12020	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
12021	cases, setting a @c null or empty string as the attribute's value
12022	is an error. Otherwise, the value of this property is ignored.
12023	</desc>
12024	</attribute>
12025
12026	</interface>
12027
12028	<!--
12029	// IParallelPort
12030	/////////////////////////////////////////////////////////////////////////
12031	-->
12032
12033	<interface
12034	name="IParallelPort" extends="$unknown"
12035	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
12036	wsmap="managed"
12037	>
12038
12039	<desc>
12040	The IParallelPort interface represents the virtual parallel port device.
12041
12042	The virtual parallel port device acts like an ordinary parallel port
12043	inside the virtual machine. This device communicates to the real
12044	parallel port hardware using the name of the parallel device on the host
12045	computer specified in the #path attribute.
12046
12047	Each virtual parallel port device is assigned a base I/O address and an
12048	IRQ number that will be reported to the guest operating system and used
12049	to operate the given parallel port from within the virtual machine.
12050
12051	<see>IMachine::getParallelPort</see>
12052	</desc>
12053
12054	<attribute name="slot" type="unsigned long" readonly="yes">
12055	<desc>
12056	Slot number this parallel port is plugged into. Corresponds to
12057	the value you pass to <link to="IMachine::getParallelPort"/>
12058	to obtain this instance.
12059	</desc>
12060	</attribute>
12061
12062	<attribute name="enabled" type="boolean">
12063	<desc>
12064	Flag whether the parallel port is enabled. If disabled,
12065	the parallel port will not be reported to the guest OS.
12066	</desc>
12067	</attribute>
12068
12069	<attribute name="IOBase" type="unsigned long">
12070	<desc>Base I/O address of the parallel port.</desc>
12071	</attribute>
12072
12073	<attribute name="IRQ" type="unsigned long">
12074	<desc>IRQ number of the parallel port.</desc>
12075	</attribute>
12076
12077	<attribute name="path" type="wstring">
12078	<desc>
12079	Host parallel device name. If this parallel port is enabled, setting a
12080	@c null or an empty string as this attribute's value will result into
12081	an error.
12082	</desc>
12083	</attribute>
12084
12085	</interface>
12086
12087
12088	<!--
12089	// IMachineDebugger
12090	/////////////////////////////////////////////////////////////////////////
12091	-->
12092
12093	<interface
12094	name="IMachineDebugger" extends="$unknown"
12095	uuid="1bfd2fa9-0d91-44d3-9515-368dcbb3eb4d"
12096	wsmap="suppress"
12097	>
12098	<method name="dumpGuestCore">
12099	<desc>
12100	Takes a core dump of the guest.
12101
12102	See include/VBox/dbgfcorefmt.h for details on the file format.
12103	</desc>
12104	<param name="filename" type="wstring" dir="in">
12105	<desc>
12106	The name of the output file. The file must not exist.
12107	</desc>
12108	</param>
12109	<param name="compression" type="wstring" dir="in">
12110	<desc>
12111	Reserved for future compression method indicator.
12112	</desc>
12113	</param>
12114	</method>
12115
12116	<method name="dumpHostProcessCore">
12117	<desc>
12118	Takes a core dump of the VM process on the host.
12119
12120	This feature is not implemented in the 4.0.0 release but it may show up
12121	in a dot release.
12122	</desc>
12123	<param name="filename" type="wstring" dir="in">
12124	<desc>
12125	The name of the output file. The file must not exist.
12126	</desc>
12127	</param>
12128	<param name="compression" type="wstring" dir="in">
12129	<desc>
12130	Reserved for future compression method indicator.
12131	</desc>
12132	</param>
12133	</method>
12134
12135	<method name="info">
12136	<desc>
12137	Interfaces with the info dumpers (DBGFInfo).
12138
12139	This feature is not implemented in the 4.0.0 release but it may show up
12140	in a dot release.
12141	</desc>
12142	<param name="name" type="wstring" dir="in">
12143	<desc>
12144	The name of the info item.
12145	</desc>
12146	</param>
12147	<param name="args" type="wstring" dir="in">
12148	<desc>
12149	Arguments to the info dumper.
12150	</desc>
12151	</param>
12152	<param name="info" type="wstring" dir="return">
12153	<desc>
12154	The into string.
12155	</desc>
12156	</param>
12157	</method>
12158
12159	<method name="injectNMI">
12160	<desc>
12161	Inject an NMI into a running VT-x/AMD-V VM.
12162	</desc>
12163	</method>
12164
12165	<method name="modifyLogGroups">
12166	<desc>
12167	Modifies the group settings of the debug logger.
12168
12169	This feature is not implemented in the 4.0.0 release but may show up
12170	in a dot release.
12171	</desc>
12172	<param name="settings" type="wstring" dir="in">
12173	<desc>The group settings string. See iprt/log.h for details.</desc>
12174	</param>
12175	</method>
12176
12177	<method name="modifyLogFlags">
12178	<desc>
12179	Modifies the debug logger flags.
12180
12181	This feature is not implemented in the 4.0.0 release but may show up
12182	in a dot release.
12183	</desc>
12184	<param name="settings" type="wstring" dir="in">
12185	<desc>The flags settings string. See iprt/log.h for details.</desc>
12186	</param>
12187	</method>
12188
12189	<method name="modifyLogDestinations">
12190	<desc>
12191	Modifies the debug logger destinations.
12192
12193	This feature is not implemented in the 4.0.0 release but may show up
12194	in a dot release.
12195	</desc>
12196	<param name="settings" type="wstring" dir="in">
12197	<desc>The destination settings string. See iprt/log.h for details.</desc>
12198	</param>
12199	</method>
12200
12201	<method name="readPhysicalMemory">
12202	<desc>
12203	Reads guest physical memory, no side effects (MMIO++).
12204
12205	This feature is not implemented in the 4.0.0 release but may show up
12206	in a dot release.
12207	</desc>
12208	<param name="address" type="long long" dir="in">
12209	<desc>The guest physical address.</desc>
12210	</param>
12211	<param name="size" type="unsigned long" dir="in">
12212	<desc>The number of bytes to read.</desc>
12213	</param>
12214	<param name="bytes" type="octet" safearray="yes" dir="return">
12215	<desc>The bytes read.</desc>
12216	</param>
12217	</method>
12218
12219	<method name="writePhysicalMemory">
12220	<desc>
12221	Writes guest physical memory, access handles (MMIO++) are ignored.
12222
12223	This feature is not implemented in the 4.0.0 release but may show up
12224	in a dot release.
12225	</desc>
12226	<param name="address" type="long long" dir="in">
12227	<desc>The guest physical address.</desc>
12228	</param>
12229	<param name="size" type="unsigned long" dir="in">
12230	<desc>The number of bytes to read.</desc>
12231	</param>
12232	<param name="bytes" type="octet" safearray="yes" dir="in">
12233	<desc>The bytes to write.</desc>
12234	</param>
12235	</method>
12236
12237	<method name="readVirtualMemory">
12238	<desc>
12239	Reads guest virtual memory, no side effects (MMIO++).
12240
12241	This feature is not implemented in the 4.0.0 release but may show up
12242	in a dot release.
12243	</desc>
12244	<param name="cpuId" type="unsigned long" dir="in">
12245	<desc>The identifier of the Virtual CPU.</desc>
12246	</param>
12247	<param name="address" type="long long" dir="in">
12248	<desc>The guest virtual address.</desc>
12249	</param>
12250	<param name="size" type="unsigned long" dir="in">
12251	<desc>The number of bytes to read.</desc>
12252	</param>
12253	<param name="bytes" type="octet" safearray="yes" dir="return">
12254	<desc>The bytes read.</desc>
12255	</param>
12256	</method>
12257
12258	<method name="writeVirtualMemory">
12259	<desc>
12260	Writes guest virtual memory, access handles (MMIO++) are ignored.
12261
12262	This feature is not implemented in the 4.0.0 release but may show up
12263	in a dot release.
12264	</desc>
12265	<param name="cpuId" type="unsigned long" dir="in">
12266	<desc>The identifier of the Virtual CPU.</desc>
12267	</param>
12268	<param name="address" type="long long" dir="in">
12269	<desc>The guest virtual address.</desc>
12270	</param>
12271	<param name="size" type="unsigned long" dir="in">
12272	<desc>The number of bytes to read.</desc>
12273	</param>
12274	<param name="bytes" type="octet" safearray="yes" dir="in">
12275	<desc>The bytes to write.</desc>
12276	</param>
12277	</method>
12278
12279	<method name="detectOS">
12280	<desc>
12281	Tries to (re-)detect the guest OS kernel.
12282
12283	This feature is not implemented in the 4.0.0 release but may show up
12284	in a dot release.
12285	</desc>
12286	<param name="os" type="wstring" dir="return">
12287	<desc>
12288	The detected OS kernel on success.
12289	</desc>
12290	</param>
12291	</method>
12292
12293	<method name="getRegister">
12294	<desc>
12295	Gets one register.
12296
12297	This feature is not implemented in the 4.0.0 release but may show up
12298	in a dot release.
12299	</desc>
12300	<param name="cpuId" type="unsigned long" dir="in">
12301	<desc>The identifier of the Virtual CPU.</desc>
12302	</param>
12303	<param name="name" type="wstring" dir="in">
12304	<desc>The register name, case is ignored.</desc>
12305	</param>
12306	<param name="value" type="wstring" dir="return">
12307	<desc>
12308	The register value. This is usually a hex value (always 0x prefixed)
12309	but other format may be used for floating point registers (TBD).
12310	</desc>
12311	</param>
12312	</method>
12313
12314	<method name="getRegisters">
12315	<desc>
12316	Gets all the registers for the given CPU.
12317
12318	This feature is not implemented in the 4.0.0 release but may show up
12319	in a dot release.
12320	</desc>
12321	<param name="cpuId" type="unsigned long" dir="in">
12322	<desc>The identifier of the Virtual CPU.</desc>
12323	</param>
12324	<param name="names" type="wstring" dir="out" safearray="yes">
12325	<desc>Array containing the lowercase register names.</desc>
12326	</param>
12327	<param name="values" type="wstring" dir="out" safearray="yes">
12328	<desc>
12329	Array paralell to the names holding the register values as if the
12330	register was returned by <link to="IMachineDebugger::getRegister"/>.
12331	</desc>
12332	</param>
12333	</method>
12334
12335	<method name="setRegister">
12336	<desc>
12337	Gets one register.
12338
12339	This feature is not implemented in the 4.0.0 release but may show up
12340	in a dot release.
12341	</desc>
12342	<param name="cpuId" type="unsigned long" dir="in">
12343	<desc>The identifier of the Virtual CPU.</desc>
12344	</param>
12345	<param name="name" type="wstring" dir="in">
12346	<desc>The register name, case is ignored.</desc>
12347	</param>
12348	<param name="value" type="wstring" dir="in">
12349	<desc>
12350	The new register value. Hexadecimal, decimal and octal formattings
12351	are supported in addition to any special formattings returned by
12352	the getters.
12353	</desc>
12354	</param>
12355	</method>
12356
12357	<method name="setRegisters">
12358	<desc>
12359	Sets zero or more registers atomically.
12360
12361	This feature is not implemented in the 4.0.0 release but may show up
12362	in a dot release.
12363	</desc>
12364	<param name="cpuId" type="unsigned long" dir="in">
12365	<desc>The identifier of the Virtual CPU.</desc>
12366	</param>
12367	<param name="names" type="wstring" dir="in" safearray="yes">
12368	<desc>Array containing the register names, case ignored.</desc>
12369	</param>
12370	<param name="values" type="wstring" dir="in" safearray="yes">
12371	<desc>
12372	Array paralell to the names holding the register values. See
12373	<link to="IMachineDebugger::setRegister"/> for formatting
12374	guidelines.
12375	</desc>
12376	</param>
12377	</method>
12378
12379	<method name="dumpGuestStack">
12380	<desc>
12381	Produce a simple stack dump using the current guest state.
12382
12383	This feature is not implemented in the 4.0.0 release but may show up
12384	in a dot release.
12385	</desc>
12386	<param name="cpuId" type="unsigned long" dir="in">
12387	<desc>The identifier of the Virtual CPU.</desc>
12388	</param>
12389	<param name="stack" type="wstring" dir="return">
12390	<desc>String containing the formatted stack dump.</desc>
12391	</param>
12392	</method>
12393
12394	<method name="resetStats">
12395	<desc>
12396	Reset VM statistics.
12397	</desc>
12398	<param name="pattern" type="wstring" dir="in">
12399	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12400	</param>
12401	</method>
12402
12403	<method name="dumpStats">
12404	<desc>
12405	Dumps VM statistics.
12406	</desc>
12407	<param name="pattern" type="wstring" dir="in">
12408	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12409	</param>
12410	</method>
12411
12412	<method name="getStats">
12413	<desc>
12414	Get the VM statistics in a XMLish format.
12415	</desc>
12416	<param name="pattern" type="wstring" dir="in">
12417	<desc>The selection pattern. A bit similar to filename globbing.</desc>
12418	</param>
12419	<param name="withDescriptions" type="boolean" dir="in">
12420	<desc>Whether to include the descriptions.</desc>
12421	</param>
12422	<param name="stats" type="wstring" dir="out">
12423	<desc>The XML document containing the statistics.</desc>
12424	</param>
12425	</method>
12426
12427	<attribute name="singlestep" type="boolean">
12428	<desc>Switch for enabling singlestepping.</desc>
12429	</attribute>
12430
12431	<attribute name="recompileUser" type="boolean">
12432	<desc>Switch for forcing code recompilation for user mode code.</desc>
12433	</attribute>
12434
12435	<attribute name="recompileSupervisor" type="boolean">
12436	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
12437	</attribute>
12438
12439	<attribute name="PATMEnabled" type="boolean">
12440	<desc>Switch for enabling and disabling the PATM component.</desc>
12441	</attribute>
12442
12443	<attribute name="CSAMEnabled" type="boolean">
12444	<desc>Switch for enabling and disabling the CSAM component.</desc>
12445	</attribute>
12446
12447	<attribute name="logEnabled" type="boolean">
12448	<desc>Switch for enabling and disabling the debug logger.</desc>
12449	</attribute>
12450
12451	<attribute name="logFlags" type="wstring" readonly="yes">
12452	<desc>The debug logger flags.</desc>
12453	</attribute>
12454
12455	<attribute name="logGroups" type="wstring" readonly="yes">
12456	<desc>The debug logger's group settings.</desc>
12457	</attribute>
12458
12459	<attribute name="logDestinations" type="wstring" readonly="yes">
12460	<desc>The debug logger's destination settings.</desc>
12461	</attribute>
12462
12463	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
12464	<desc>
12465	Flag indicating whether the VM is currently making use of CPU hardware
12466	virtualization extensions.
12467	</desc>
12468	</attribute>
12469
12470	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
12471	<desc>
12472	Flag indicating whether the VM is currently making use of the nested paging
12473	CPU hardware virtualization extension.
12474	</desc>
12475	</attribute>
12476
12477	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
12478	<desc>
12479	Flag indicating whether the VM is currently making use of the VPID
12480	VT-x extension.
12481	</desc>
12482	</attribute>
12483
12484	<attribute name="OSName" type="wstring" readonly="yes">
12485	<desc>
12486	Query the guest OS kernel name as detected by the DBGF.
12487
12488	This feature is not implemented in the 4.0.0 release but may show up
12489	in a dot release.
12490	</desc>
12491	</attribute>
12492
12493	<attribute name="OSVersion" type="wstring" readonly="yes">
12494	<desc>
12495	Query the guest OS kernel version string as detected by the DBGF.
12496
12497	This feature is not implemented in the 4.0.0 release but may show up
12498	in a dot release.
12499	</desc>
12500	</attribute>
12501
12502	<attribute name="PAEEnabled" type="boolean" readonly="yes">
12503	<desc>
12504	Flag indicating whether the VM is currently making use of the Physical
12505	Address Extension CPU feature.
12506	</desc>
12507	</attribute>
12508
12509	<attribute name="virtualTimeRate" type="unsigned long">
12510	<desc>
12511	The rate at which the virtual time runs expressed as a percentage.
12512	The accepted range is 2% to 20000%.
12513	</desc>
12514	</attribute>
12515
12516	<attribute name="VM" type="long long" readonly="yes">
12517	<desc>
12518	Gets the VM handle. This is only for internal use while
12519	we carve the details of this interface.
12520	</desc>
12521	</attribute>
12522
12523	</interface>
12524
12525	<!--
12526	// IUSBController
12527	/////////////////////////////////////////////////////////////////////////
12528	-->
12529
12530	<interface
12531	name="IUSBController" extends="$unknown"
12532	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
12533	wsmap="managed"
12534	>
12535	<attribute name="enabled" type="boolean">
12536	<desc>
12537	Flag whether the USB controller is present in the
12538	guest system. If disabled, the virtual guest hardware will
12539	not contain any USB controller. Can only be changed when
12540	the VM is powered off.
12541	</desc>
12542	</attribute>
12543
12544	<attribute name="enabledEhci" type="boolean">
12545	<desc>
12546	Flag whether the USB EHCI controller is present in the
12547	guest system. If disabled, the virtual guest hardware will
12548	not contain a USB EHCI controller. Can only be changed when
12549	the VM is powered off.
12550	</desc>
12551	</attribute>
12552
12553	<attribute name="proxyAvailable" type="boolean" readonly="yes">
12554	<desc>
12555	Flag whether there is an USB proxy available.
12556	</desc>
12557	</attribute>
12558
12559	<attribute name="USBStandard" type="unsigned short" readonly="yes">
12560	<desc>
12561	USB standard version which the controller implements.
12562	This is a BCD which means that the major version is in the
12563	high byte and minor version is in the low byte.
12564	</desc>
12565	</attribute>
12566
12567	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
12568	<desc>
12569	List of USB device filters associated with the machine.
12570
12571	If the machine is currently running, these filters are activated
12572	every time a new (supported) USB device is attached to the host
12573	computer that was not ignored by global filters
12574	(<link to="IHost::USBDeviceFilters"/>).
12575
12576	These filters are also activated when the machine is powered up.
12577	They are run against a list of all currently available USB
12578	devices (in states
12579	<link to="USBDeviceState_Available"/>,
12580	<link to="USBDeviceState_Busy"/>,
12581	<link to="USBDeviceState_Held"/>) that were not previously
12582	ignored by global filters.
12583
12584	If at least one filter matches the USB device in question, this
12585	device is automatically captured (attached to) the virtual USB
12586	controller of this machine.
12587
12588	<see>IUSBDeviceFilter, ::IUSBController</see>
12589	</desc>
12590	</attribute>
12591
12592	<method name="createDeviceFilter">
12593	<desc>
12594	Creates a new USB device filter. All attributes except
12595	the filter name are set to empty (any match),
12596	<i>active</i> is @c false (the filter is not active).
12597
12598	The created filter can then be added to the list of filters using
12599	<link to="#insertDeviceFilter"/>.
12600
12601	<result name="VBOX_E_INVALID_VM_STATE">
12602	The virtual machine is not mutable.
12603	</result>
12604
12605	<see>#deviceFilters</see>
12606	</desc>
12607	<param name="name" type="wstring" dir="in">
12608	<desc>
12609	Filter name. See <link to="IUSBDeviceFilter::name"/>
12610	for more info.
12611	</desc>
12612	</param>
12613	<param name="filter" type="IUSBDeviceFilter" dir="return">
12614	<desc>Created filter object.</desc>
12615	</param>
12616	</method>
12617
12618	<method name="insertDeviceFilter">
12619	<desc>
12620	Inserts the given USB device to the specified position
12621	in the list of filters.
12622
12623	Positions are numbered starting from <tt>0</tt>. If the specified
12624	position is equal to or greater than the number of elements in
12625	the list, the filter is added to the end of the collection.
12626
12627	<note>
12628	Duplicates are not allowed, so an attempt to insert a
12629	filter that is already in the collection, will return an
12630	error.
12631	</note>
12632
12633	<result name="VBOX_E_INVALID_VM_STATE">
12634	Virtual machine is not mutable.
12635	</result>
12636	<result name="E_INVALIDARG">
12637	USB device filter not created within this VirtualBox instance.
12638	</result>
12639	<result name="VBOX_E_INVALID_OBJECT_STATE">
12640	USB device filter already in list.
12641	</result>
12642
12643	<see>#deviceFilters</see>
12644	</desc>
12645	<param name="position" type="unsigned long" dir="in">
12646	<desc>Position to insert the filter to.</desc>
12647	</param>
12648	<param name="filter" type="IUSBDeviceFilter" dir="in">
12649	<desc>USB device filter to insert.</desc>
12650	</param>
12651	</method>
12652
12653	<method name="removeDeviceFilter">
12654	<desc>
12655	Removes a USB device filter from the specified position in the
12656	list of filters.
12657
12658	Positions are numbered starting from <tt>0</tt>. Specifying a
12659	position equal to or greater than the number of elements in
12660	the list will produce an error.
12661
12662	<see>#deviceFilters</see>
12663
12664	<result name="VBOX_E_INVALID_VM_STATE">
12665	Virtual machine is not mutable.
12666	</result>
12667	<result name="E_INVALIDARG">
12668	USB device filter list empty or invalid @a position.
12669	</result>
12670
12671	</desc>
12672	<param name="position" type="unsigned long" dir="in">
12673	<desc>Position to remove the filter from.</desc>
12674	</param>
12675	<param name="filter" type="IUSBDeviceFilter" dir="return">
12676	<desc>Removed USB device filter.</desc>
12677	</param>
12678	</method>
12679
12680	</interface>
12681
12682
12683	<!--
12684	// IUSBDevice
12685	/////////////////////////////////////////////////////////////////////////
12686	-->
12687
12688	<interface
12689	name="IUSBDevice" extends="$unknown"
12690	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
12691	wsmap="managed"
12692	>
12693	<desc>
12694	The IUSBDevice interface represents a virtual USB device attached to the
12695	virtual machine.
12696
12697	A collection of objects implementing this interface is stored in the
12698	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
12699	attached to a running virtual machine's USB controller.
12700	</desc>
12701
12702	<attribute name="id" type="uuid" mod="string" readonly="yes">
12703	<desc>
12704	Unique USB device ID. This ID is built from #vendorId,
12705	#productId, #revision and #serialNumber.
12706	</desc>
12707	</attribute>
12708
12709	<attribute name="vendorId" type="unsigned short" readonly="yes">
12710	<desc>Vendor ID.</desc>
12711	</attribute>
12712
12713	<attribute name="productId" type="unsigned short" readonly="yes">
12714	<desc>Product ID.</desc>
12715	</attribute>
12716
12717	<attribute name="revision" type="unsigned short" readonly="yes">
12718	<desc>
12719	Product revision number. This is a packed BCD represented as
12720	unsigned short. The high byte is the integer part and the low
12721	byte is the decimal.
12722	</desc>
12723	</attribute>
12724
12725	<attribute name="manufacturer" type="wstring" readonly="yes">
12726	<desc>Manufacturer string.</desc>
12727	</attribute>
12728
12729	<attribute name="product" type="wstring" readonly="yes">
12730	<desc>Product string.</desc>
12731	</attribute>
12732
12733	<attribute name="serialNumber" type="wstring" readonly="yes">
12734	<desc>Serial number string.</desc>
12735	</attribute>
12736
12737	<attribute name="address" type="wstring" readonly="yes">
12738	<desc>Host specific address of the device.</desc>
12739	</attribute>
12740
12741	<attribute name="port" type="unsigned short" readonly="yes">
12742	<desc>
12743	Host USB port number the device is physically
12744	connected to.
12745	</desc>
12746	</attribute>
12747
12748	<attribute name="version" type="unsigned short" readonly="yes">
12749	<desc>
12750	The major USB version of the device - 1 or 2.
12751	</desc>
12752	</attribute>
12753
12754	<attribute name="portVersion" type="unsigned short" readonly="yes">
12755	<desc>
12756	The major USB version of the host USB port the device is
12757	physically connected to - 1 or 2. For devices not connected to
12758	anything this will have the same value as the version attribute.
12759	</desc>
12760	</attribute>
12761
12762	<attribute name="remote" type="boolean" readonly="yes">
12763	<desc>
12764	Whether the device is physically connected to a remote VRDE
12765	client or to a local host machine.
12766	</desc>
12767	</attribute>
12768
12769	</interface>
12770
12771
12772	<!--
12773	// IUSBDeviceFilter
12774	/////////////////////////////////////////////////////////////////////////
12775	-->
12776
12777	<interface
12778	name="IUSBDeviceFilter" extends="$unknown"
12779	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
12780	wsmap="managed"
12781	>
12782	<desc>
12783	The IUSBDeviceFilter interface represents an USB device filter used
12784	to perform actions on a group of USB devices.
12785
12786	This type of filters is used by running virtual machines to
12787	automatically capture selected USB devices once they are physically
12788	attached to the host computer.
12789
12790	A USB device is matched to the given device filter if and only if all
12791	attributes of the device match the corresponding attributes of the
12792	filter (that is, attributes are joined together using the logical AND
12793	operation). On the other hand, all together, filters in the list of
12794	filters carry the semantics of the logical OR operation. So if it is
12795	desirable to create a match like "this vendor id OR this product id",
12796	one needs to create two filters and specify "any match" (see below)
12797	for unused attributes.
12798
12799	All filter attributes used for matching are strings. Each string
12800	is an expression representing a set of values of the corresponding
12801	device attribute, that will match the given filter. Currently, the
12802	following filtering expressions are supported:
12803
12804	<ul>
12805	<li><i>Interval filters</i>. Used to specify valid intervals for
12806	integer device attributes (Vendor ID, Product ID and Revision).
12807	The format of the string is:
12808
12809	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
12810
12811	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
12812	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
12813	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
12814	is omitted before a dash (<tt>-</tt>), the minimum possible integer
12815	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
12816	possible integer is assumed.
12817	</li>
12818	<li><i>Boolean filters</i>. Used to specify acceptable values for
12819	boolean device attributes. The format of the string is:
12820
12821	<tt>true\|false\|yes\|no\|0\|1</tt>
12822
12823	</li>
12824	<li><i>Exact match</i>. Used to specify a single value for the given
12825	device attribute. Any string that doesn't start with <tt>int:</tt>
12826	represents the exact match. String device attributes are compared to
12827	this string including case of symbols. Integer attributes are first
12828	converted to a string (see individual filter attributes) and then
12829	compared ignoring case.
12830
12831	</li>
12832	<li><i>Any match</i>. Any value of the corresponding device attribute
12833	will match the given filter. An empty or @c null string is
12834	used to construct this type of filtering expressions.
12835
12836	</li>
12837	</ul>
12838
12839	<note>
12840	On the Windows host platform, interval filters are not currently
12841	available. Also all string filter attributes
12842	(<link to="#manufacturer"/>, <link to="#product"/>,
12843	<link to="#serialNumber"/>) are ignored, so they behave as
12844	<i>any match</i> no matter what string expression is specified.
12845	</note>
12846
12847	<see>IUSBController::deviceFilters, IHostUSBDeviceFilter</see>
12848	</desc>
12849
12850	<attribute name="name" type="wstring">
12851	<desc>
12852	Visible name for this filter.
12853	This name is used to visually distinguish one filter from another,
12854	so it can neither be @c null nor an empty string.
12855	</desc>
12856	</attribute>
12857
12858	<attribute name="active" type="boolean">
12859	<desc>Whether this filter active or has been temporarily disabled.</desc>
12860	</attribute>
12861
12862	<attribute name="vendorId" type="wstring">
12863	<desc>
12864	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
12865	The string representation for the <i>exact matching</i>
12866	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12867	(including leading zeroes).
12868	</desc>
12869	</attribute>
12870
12871	<attribute name="productId" type="wstring">
12872	<desc>
12873	<link to="IUSBDevice::productId">Product ID</link> filter.
12874	The string representation for the <i>exact matching</i>
12875	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
12876	(including leading zeroes).
12877	</desc>
12878	</attribute>
12879
12880	<attribute name="revision" type="wstring">
12881	<desc>
12882	<link to="IUSBDevice::productId">Product revision number</link>
12883	filter. The string representation for the <i>exact matching</i>
12884	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
12885	of the integer part of the revision, and <tt>F</tt> is the
12886	decimal digit of its fractional part (including leading and
12887	trailing zeros).
12888	Note that for interval filters, it's best to use the hexadecimal
12889	form, because the revision is stored as a 16 bit packed BCD value;
12890	so the expression <tt>int:0x0100-0x0199</tt> will match any
12891	revision from <tt>1.0</tt> to <tt>1.99</tt>.
12892	</desc>
12893	</attribute>
12894
12895	<attribute name="manufacturer" type="wstring">
12896	<desc>
12897	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
12898	</desc>
12899	</attribute>
12900
12901	<attribute name="product" type="wstring">
12902	<desc>
12903	<link to="IUSBDevice::product">Product</link> filter.
12904	</desc>
12905	</attribute>
12906
12907	<attribute name="serialNumber" type="wstring">
12908	<desc>
12909	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
12910	</desc>
12911	</attribute>
12912
12913	<attribute name="port" type="wstring">
12914	<desc>
12915	<link to="IUSBDevice::port">Host USB port</link> filter.
12916	</desc>
12917	</attribute>
12918
12919	<attribute name="remote" type="wstring">
12920	<desc>
12921	<link to="IUSBDevice::remote">Remote state</link> filter.
12922	<note>
12923	This filter makes sense only for machine USB filters,
12924	i.e. it is ignored by IHostUSBDeviceFilter objects.
12925	</note>
12926	</desc>
12927	</attribute>
12928
12929	<attribute name="maskedInterfaces" type="unsigned long">
12930	<desc>
12931	This is an advanced option for hiding one or more USB interfaces
12932	from the guest. The value is a bit mask where the bits that are set
12933	means the corresponding USB interface should be hidden, masked off
12934	if you like.
12935	This feature only works on Linux hosts.
12936	</desc>
12937	</attribute>
12938
12939	</interface>
12940
12941
12942	<!--
12943	// IHostUSBDevice
12944	/////////////////////////////////////////////////////////////////////////
12945	-->
12946
12947	<enum
12948	name="USBDeviceState"
12949	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
12950	>
12951	<desc>
12952	USB device state. This enumeration represents all possible states
12953	of the USB device physically attached to the host computer regarding
12954	its state on the host computer and availability to guest computers
12955	(all currently running virtual machines).
12956
12957	Once a supported USB device is attached to the host, global USB
12958	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
12959	either ignore the device, or put it to USBDeviceState_Held state, or do
12960	nothing. Unless the device is ignored by global filters, filters of all
12961	currently running guests (<link to="IUSBController::deviceFilters"/>) are
12962	activated that can put it to USBDeviceState_Captured state.
12963
12964	If the device was ignored by global filters, or didn't match
12965	any filters at all (including guest ones), it is handled by the host
12966	in a normal way. In this case, the device state is determined by
12967	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
12968	or USBDeviceState_Available, depending on the current device usage.
12969
12970	Besides auto-capturing based on filters, the device can be manually
12971	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
12972	state is USBDeviceState_Busy, USBDeviceState_Available or
12973	USBDeviceState_Held.
12974
12975	<note>
12976	Due to differences in USB stack implementations in Linux and Win32,
12977	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
12978	only to the Linux version of the product. This also means that (<link
12979	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
12980	device state is USBDeviceState_Held.
12981	</note>
12982
12983	<see>IHostUSBDevice, IHostUSBDeviceFilter</see>
12984	</desc>
12985
12986	<const name="NotSupported" value="0">
12987	<desc>
12988	Not supported by the VirtualBox server, not available to guests.
12989	</desc>
12990	</const>
12991	<const name="Unavailable" value="1">
12992	<desc>
12993	Being used by the host computer exclusively,
12994	not available to guests.
12995	</desc>
12996	</const>
12997	<const name="Busy" value="2">
12998	<desc>
12999	Being used by the host computer, potentially available to guests.
13000	</desc>
13001	</const>
13002	<const name="Available" value="3">
13003	<desc>
13004	Not used by the host computer, available to guests (the host computer
13005	can also start using the device at any time).
13006	</desc>
13007	</const>
13008	<const name="Held" value="4">
13009	<desc>
13010	Held by the VirtualBox server (ignored by the host computer),
13011	available to guests.
13012	</desc>
13013	</const>
13014	<const name="Captured" value="5">
13015	<desc>
13016	Captured by one of the guest computers, not available
13017	to anybody else.
13018	</desc>
13019	</const>
13020	</enum>
13021
13022	<interface
13023	name="IHostUSBDevice" extends="IUSBDevice"
13024	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
13025	wsmap="managed"
13026	>
13027	<desc>
13028	The IHostUSBDevice interface represents a physical USB device attached
13029	to the host computer.
13030
13031	Besides properties inherited from IUSBDevice, this interface adds the
13032	<link to="#state"/> property that holds the current state of the USB
13033	device.
13034
13035	<see>IHost::USBDevices, IHost::USBDeviceFilters</see>
13036	</desc>
13037
13038	<attribute name="state" type="USBDeviceState" readonly="yes">
13039	<desc>
13040	Current state of the device.
13041	</desc>
13042	</attribute>
13043
13044	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
13045
13046	</interface>
13047
13048
13049	<!--
13050	// IHostUSBDeviceFilter
13051	/////////////////////////////////////////////////////////////////////////
13052	-->
13053
13054	<enum
13055	name="USBDeviceFilterAction"
13056	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
13057	>
13058	<desc>
13059	Actions for host USB device filters.
13060	<see>IHostUSBDeviceFilter, USBDeviceState</see>
13061	</desc>
13062
13063	<const name="Null" value="0">
13064	<desc>Null value (never used by the API).</desc>
13065	</const>
13066	<const name="Ignore" value="1">
13067	<desc>Ignore the matched USB device.</desc>
13068	</const>
13069	<const name="Hold" value="2">
13070	<desc>Hold the matched USB device.</desc>
13071	</const>
13072	</enum>
13073
13074	<interface
13075	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
13076	uuid="4cc70246-d74a-400f-8222-3900489c0374"
13077	wsmap="managed"
13078	>
13079	<desc>
13080	The IHostUSBDeviceFilter interface represents a global filter for a
13081	physical USB device used by the host computer. Used indirectly in
13082	<link to="IHost::USBDeviceFilters"/>.
13083
13084	Using filters of this type, the host computer determines the initial
13085	state of the USB device after it is physically attached to the
13086	host's USB controller.
13087
13088	<note>
13089	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
13090	filters, because it makes sense only for
13091	<link to="IUSBController::deviceFilters">machine USB filters</link>.
13092	</note>
13093
13094	<see>IHost::USBDeviceFilters</see>
13095	</desc>
13096
13097	<attribute name="action" type="USBDeviceFilterAction">
13098	<desc>
13099	Action performed by the host when an attached USB device
13100	matches this filter.
13101	</desc>
13102	</attribute>
13103
13104	</interface>
13105
13106	<!--
13107	// IAudioAdapter
13108	/////////////////////////////////////////////////////////////////////////
13109	-->
13110
13111	<enum
13112	name="AudioDriverType"
13113	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
13114	>
13115	<desc>
13116	Host audio driver type.
13117	</desc>
13118
13119	<const name="Null" value="0">
13120	<desc>Null value, also means "dummy audio driver".</desc>
13121	</const>
13122	<const name="WinMM" value="1">
13123	<desc>Windows multimedia (Windows hosts only).</desc>
13124	</const>
13125	<const name="OSS" value="2">
13126	<desc>Open Sound System (Linux hosts only).</desc>
13127	</const>
13128	<const name="ALSA" value="3">
13129	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
13130	</const>
13131	<const name="DirectSound" value="4">
13132	<desc>DirectSound (Windows hosts only).</desc>
13133	</const>
13134	<const name="CoreAudio" value="5">
13135	<desc>CoreAudio (Mac hosts only).</desc>
13136	</const>
13137	<const name="MMPM" value="6">
13138	<desc>Reserved for historical reasons.</desc>
13139	</const>
13140	<const name="Pulse" value="7">
13141	<desc>PulseAudio (Linux hosts only).</desc>
13142	</const>
13143	<const name="SolAudio" value="8">
13144	<desc>Solaris audio (Solaris hosts only).</desc>
13145	</const>
13146	</enum>
13147
13148	<enum
13149	name="AudioControllerType"
13150	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
13151	>
13152	<desc>
13153	Virtual audio controller type.
13154	</desc>
13155
13156	<const name="AC97" value="0"/>
13157	<const name="SB16" value="1"/>
13158	<const name="HDA" value="2"/>
13159	</enum>
13160
13161	<interface
13162	name="IAudioAdapter" extends="$unknown"
13163	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
13164	wsmap="managed"
13165	>
13166	<desc>
13167	The IAudioAdapter interface represents the virtual audio adapter of
13168	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
13169	</desc>
13170	<attribute name="enabled" type="boolean">
13171	<desc>
13172	Flag whether the audio adapter is present in the
13173	guest system. If disabled, the virtual guest hardware will
13174	not contain any audio adapter. Can only be changed when
13175	the VM is not running.
13176	</desc>
13177	</attribute>
13178	<attribute name="audioController" type="AudioControllerType">
13179	<desc>
13180	The audio hardware we emulate.
13181	</desc>
13182	</attribute>
13183	<attribute name="audioDriver" type="AudioDriverType">
13184	<desc>
13185	Audio driver the adapter is connected to. This setting
13186	can only be changed when the VM is not running.
13187	</desc>
13188	</attribute>
13189	</interface>
13190
13191	<enum
13192	name="AuthType"
13193	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
13194	>
13195	<desc>
13196	VirtualBox authentication type.
13197	</desc>
13198
13199	<const name="Null" value="0">
13200	<desc>Null value, also means "no authentication".</desc>
13201	</const>
13202	<const name="External" value="1"/>
13203	<const name="Guest" value="2"/>
13204	</enum>
13205
13206	<!--
13207	// IVRDEServer
13208	/////////////////////////////////////////////////////////////////////////
13209	-->
13210
13211	<interface
13212	name="IVRDEServer" extends="$unknown"
13213	uuid="be24e0db-e1d6-4d58-b85b-21053d1511b4"
13214	wsmap="managed"
13215	>
13216	<attribute name="enabled" type="boolean">
13217	<desc>VRDE server status.</desc>
13218	</attribute>
13219
13220	<attribute name="authType" type="AuthType">
13221	<desc>VRDE authentication method.</desc>
13222	</attribute>
13223
13224	<attribute name="authTimeout" type="unsigned long">
13225	<desc>Timeout for guest authentication. Milliseconds.</desc>
13226	</attribute>
13227
13228	<attribute name="allowMultiConnection" type="boolean">
13229	<desc>
13230	Flag whether multiple simultaneous connections to the VM are permitted.
13231	Note that this will be replaced by a more powerful mechanism in the future.
13232	</desc>
13233	</attribute>
13234
13235	<attribute name="reuseSingleConnection" type="boolean">
13236	<desc>
13237	Flag whether the existing connection must be dropped and a new connection
13238	must be established by the VRDE server, when a new client connects in single
13239	connection mode.
13240	</desc>
13241	</attribute>
13242
13243	<attribute name="VRDEExtPack" type="wstring">
13244	<desc>
13245	The name of Extension Pack providing VRDE for this VM. Overrides
13246	<link to="ISystemProperties::defaultVRDEExtPack"/>.
13247	</desc>
13248	</attribute>
13249
13250	<attribute name="AuthLibrary" type="wstring">
13251	<desc>
13252	Library used for authentication of RDP clients by this VM. Overrides
13253	<link to="ISystemProperties::VRDEAuthLibrary"/>.
13254	</desc>
13255	</attribute>
13256
13257	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
13258	<desc>
13259	Array of names of properties, which are supported by this VRDE server.
13260	</desc>
13261	</attribute>
13262
13263	<method name="setVRDEProperty">
13264	<desc>
13265	Sets a VRDE specific property string.
13266
13267	If you pass @c null or empty string as a key @a value, the given @a key
13268	will be deleted.
13269
13270	</desc>
13271	<param name="key" type="wstring" dir="in">
13272	<desc>Name of the key to set.</desc>
13273	</param>
13274	<param name="value" type="wstring" dir="in">
13275	<desc>Value to assign to the key.</desc>
13276	</param>
13277	</method>
13278
13279	<method name="getVRDEProperty">
13280	<desc>
13281	Returns a VRDE specific property string.
13282
13283	If the requested data @a key does not exist, this function will
13284	succeed and return an empty string in the @a value argument.
13285
13286	</desc>
13287	<param name="key" type="wstring" dir="in">
13288	<desc>Name of the key to get.</desc>
13289	</param>
13290	<param name="value" type="wstring" dir="return">
13291	<desc>Value of the requested key.</desc>
13292	</param>
13293	</method>
13294
13295	</interface>
13296
13297
13298	<!--
13299	// ISharedFolder
13300	/////////////////////////////////////////////////////////////////////////
13301	-->
13302
13303	<interface
13304	name="ISharedFolder" extends="$unknown"
13305	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
13306	wsmap="struct"
13307	>
13308	<desc>
13309	The ISharedFolder interface represents a folder in the host computer's
13310	file system accessible from the guest OS running inside a virtual
13311	machine using an associated logical name.
13312
13313	There are three types of shared folders:
13314	<ul>
13315	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
13316	folders available to all virtual machines.</li>
13317	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
13318	VM-specific shared folders available to the given virtual machine at
13319	startup.</li>
13320	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
13321	VM-specific shared folders created in the session context (for
13322	example, when the virtual machine is running) and automatically
13323	discarded when the session is closed (the VM is powered off).</li>
13324	</ul>
13325
13326	Logical names of shared folders must be unique within the given scope
13327	(global, permanent or transient). However, they do not need to be unique
13328	across scopes. In this case, the definition of the shared folder in a
13329	more specific scope takes precedence over definitions in all other
13330	scopes. The order of precedence is (more specific to more general):
13331	<ol>
13332	<li>Transient definitions</li>
13333	<li>Permanent definitions</li>
13334	<li>Global definitions</li>
13335	</ol>
13336
13337	For example, if MyMachine has a shared folder named
13338	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
13339	transient shared folder named <tt>C_DRIVE</tt> (that points
13340	to <tt>C:\\\\WINDOWS</tt>) will change the definition
13341	of <tt>C_DRIVE</tt> in the guest OS so
13342	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
13343	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
13344	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
13345	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
13346	to <tt>C:\\</tt> if it still exists.
13347
13348	Note that permanent and transient shared folders of different machines
13349	are in different name spaces, so they don't overlap and don't need to
13350	have unique logical names.
13351
13352	<note>
13353	Global shared folders are not implemented in the current version of the
13354	product.
13355	</note>
13356	</desc>
13357
13358	<attribute name="name" type="wstring" readonly="yes">
13359	<desc>Logical name of the shared folder.</desc>
13360	</attribute>
13361
13362	<attribute name="hostPath" type="wstring" readonly="yes">
13363	<desc>Full path to the shared folder in the host file system.</desc>
13364	</attribute>
13365
13366	<attribute name="accessible" type="boolean" readonly="yes">
13367	<desc>
13368	Whether the folder defined by the host path is currently
13369	accessible or not.
13370	For example, the folder can be inaccessible if it is placed
13371	on the network share that is not available by the time
13372	this property is read.
13373	</desc>
13374	</attribute>
13375
13376	<attribute name="writable" type="boolean" readonly="yes">
13377	<desc>
13378	Whether the folder defined by the host path is writable or
13379	not.
13380	</desc>
13381	</attribute>
13382
13383	<attribute name="autoMount" type="boolean" readonly="yes">
13384	<desc>
13385	Whether the folder gets automatically mounted by the guest or not.
13386	</desc>
13387	</attribute>
13388
13389	<attribute name="lastAccessError" type="wstring" readonly="yes">
13390	<desc>
13391	Text message that represents the result of the last accessibility
13392	check.
13393
13394	Accessibility checks are performed each time the <link to="#accessible"/>
13395	attribute is read. An empty string is returned if the last
13396	accessibility check was successful. A non-empty string indicates a
13397	failure and should normally describe a reason of the failure (for
13398	example, a file read error).
13399	</desc>
13400	</attribute>
13401
13402	</interface>
13403
13404	<!--
13405	// ISession
13406	/////////////////////////////////////////////////////////////////////////
13407	-->
13408
13409	<interface
13410	name="IInternalSessionControl" extends="$unknown"
13411	uuid="a2fbf834-149d-41da-ae52-0dc3b0f032b3"
13412	internal="yes"
13413	wsmap="suppress"
13414	>
13415	<method name="getPID">
13416	<desc>PID of the process that has created this Session object.
13417	</desc>
13418	<param name="pid" type="unsigned long" dir="return"/>
13419	</method>
13420
13421	<method name="getRemoteConsole">
13422	<desc>
13423	Returns the console object suitable for remote control.
13424
13425	<result name="VBOX_E_INVALID_VM_STATE">
13426	Session state prevents operation.
13427	</result>
13428	<result name="VBOX_E_INVALID_OBJECT_STATE">
13429	Session type prevents operation.
13430	</result>
13431
13432	</desc>
13433	<param name="console" type="IConsole" dir="return"/>
13434	</method>
13435
13436	<method name="assignMachine">
13437	<desc>
13438	Assigns the machine object associated with this direct-type
13439	session or informs the session that it will be a remote one
13440	(if @a machine == @c null).
13441
13442	<result name="VBOX_E_INVALID_VM_STATE">
13443	Session state prevents operation.
13444	</result>
13445	<result name="VBOX_E_INVALID_OBJECT_STATE">
13446	Session type prevents operation.
13447	</result>
13448
13449	</desc>
13450	<param name="machine" type="IMachine" dir="in"/>
13451	</method>
13452
13453	<method name="assignRemoteMachine">
13454	<desc>
13455	Assigns the machine and the (remote) console object associated with
13456	this remote-type session.
13457
13458	<result name="VBOX_E_INVALID_VM_STATE">
13459	Session state prevents operation.
13460	</result>
13461
13462	</desc>
13463	<param name="machine" type="IMachine" dir="in"/>
13464	<param name="console" type="IConsole" dir="in"/>
13465	</method>
13466
13467	<method name="updateMachineState">
13468	<desc>
13469	Updates the machine state in the VM process.
13470	Must be called only in certain cases
13471	(see the method implementation).
13472
13473	<result name="VBOX_E_INVALID_VM_STATE">
13474	Session state prevents operation.
13475	</result>
13476	<result name="VBOX_E_INVALID_OBJECT_STATE">
13477	Session type prevents operation.
13478	</result>
13479
13480	</desc>
13481	<param name="aMachineState" type="MachineState" dir="in"/>
13482	</method>
13483
13484	<method name="uninitialize">
13485	<desc>
13486	Uninitializes (closes) this session. Used by VirtualBox to close
13487	the corresponding remote session when the direct session dies
13488	or gets closed.
13489
13490	<result name="VBOX_E_INVALID_VM_STATE">
13491	Session state prevents operation.
13492	</result>
13493
13494	</desc>
13495	</method>
13496
13497	<method name="onNetworkAdapterChange">
13498	<desc>
13499	Triggered when settings of a network adapter of the
13500	associated virtual machine have changed.
13501
13502	<result name="VBOX_E_INVALID_VM_STATE">
13503	Session state prevents operation.
13504	</result>
13505	<result name="VBOX_E_INVALID_OBJECT_STATE">
13506	Session type prevents operation.
13507	</result>
13508
13509	</desc>
13510	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
13511	<param name="changeAdapter" type="boolean" dir="in"/>
13512	</method>
13513
13514	<method name="onSerialPortChange">
13515	<desc>
13516	Triggered when settings of a serial port of the
13517	associated virtual machine have changed.
13518
13519	<result name="VBOX_E_INVALID_VM_STATE">
13520	Session state prevents operation.
13521	</result>
13522	<result name="VBOX_E_INVALID_OBJECT_STATE">
13523	Session type prevents operation.
13524	</result>
13525
13526	</desc>
13527	<param name="serialPort" type="ISerialPort" dir="in"/>
13528	</method>
13529
13530	<method name="onParallelPortChange">
13531	<desc>
13532	Triggered when settings of a parallel port of the
13533	associated virtual machine have changed.
13534
13535	<result name="VBOX_E_INVALID_VM_STATE">
13536	Session state prevents operation.
13537	</result>
13538	<result name="VBOX_E_INVALID_OBJECT_STATE">
13539	Session type prevents operation.
13540	</result>
13541
13542	</desc>
13543	<param name="parallelPort" type="IParallelPort" dir="in"/>
13544	</method>
13545
13546	<method name="onStorageControllerChange">
13547	<desc>
13548	Triggered when settings of a storage controller of the
13549	associated virtual machine have changed.
13550
13551	<result name="VBOX_E_INVALID_VM_STATE">
13552	Session state prevents operation.
13553	</result>
13554	<result name="VBOX_E_INVALID_OBJECT_STATE">
13555	Session type prevents operation.
13556	</result>
13557
13558	</desc>
13559	</method>
13560
13561	<method name="onMediumChange">
13562	<desc>
13563	Triggered when attached media of the
13564	associated virtual machine have changed.
13565
13566	<result name="VBOX_E_INVALID_VM_STATE">
13567	Session state prevents operation.
13568	</result>
13569	<result name="VBOX_E_INVALID_OBJECT_STATE">
13570	Session type prevents operation.
13571	</result>
13572
13573	</desc>
13574
13575	<param name="mediumAttachment" type="IMediumAttachment" dir="in"/>
13576	<param name="force" type="boolean" dir="in"/>
13577	</method>
13578
13579	<method name="onCPUChange">
13580	<desc>
13581	Notification when a CPU changes.
13582	</desc>
13583	<param name="cpu" type="unsigned long" dir="in">
13584	<desc>The CPU which changed</desc>
13585	</param>
13586	<param name="add" type="boolean" dir="in">
13587	<desc>Flag whether the CPU was added or removed</desc>
13588	</param>
13589	</method>
13590
13591	<method name="onCPUExecutionCapChange">
13592	<desc>
13593	Notification when the CPU execution cap changes.
13594	</desc>
13595	<param name="executionCap" type="unsigned long" dir="in">
13596	<desc>The new CPU execution cap value. (1-100)</desc>
13597	</param>
13598	</method>
13599
13600	<method name="onVRDEServerChange">
13601	<desc>
13602	Triggered when settings of the VRDE server object of the
13603	associated virtual machine have changed.
13604
13605	<result name="VBOX_E_INVALID_VM_STATE">
13606	Session state prevents operation.
13607	</result>
13608	<result name="VBOX_E_INVALID_OBJECT_STATE">
13609	Session type prevents operation.
13610	</result>
13611
13612	</desc>
13613	<param name="restart" type="boolean" dir="in">
13614	<desc>Flag whether the server must be restarted</desc>
13615	</param>
13616	</method>
13617
13618	<method name="onUSBControllerChange">
13619	<desc>
13620	Triggered when settings of the USB controller object of the
13621	associated virtual machine have changed.
13622
13623	<result name="VBOX_E_INVALID_VM_STATE">
13624	Session state prevents operation.
13625	</result>
13626	<result name="VBOX_E_INVALID_OBJECT_STATE">
13627	Session type prevents operation.
13628	</result>
13629
13630	</desc>
13631	</method>
13632
13633	<method name="onSharedFolderChange">
13634	<desc>
13635	Triggered when a permanent (global or machine) shared folder has been
13636	created or removed.
13637	<note>
13638	We don't pass shared folder parameters in this notification because
13639	the order in which parallel notifications are delivered is not defined,
13640	therefore it could happen that these parameters were outdated by the
13641	time of processing this notification.
13642	</note>
13643
13644	<result name="VBOX_E_INVALID_VM_STATE">
13645	Session state prevents operation.
13646	</result>
13647	<result name="VBOX_E_INVALID_OBJECT_STATE">
13648	Session type prevents operation.
13649	</result>
13650
13651	</desc>
13652	<param name="global" type="boolean" dir="in"/>
13653	</method>
13654
13655	<method name="onUSBDeviceAttach">
13656	<desc>
13657	Triggered when a request to capture a USB device (as a result
13658	of matched USB filters or direct call to
13659	<link to="IConsole::attachUSBDevice"/>) has completed.
13660	A @c null @a error object means success, otherwise it
13661	describes a failure.
13662
13663	<result name="VBOX_E_INVALID_VM_STATE">
13664	Session state prevents operation.
13665	</result>
13666	<result name="VBOX_E_INVALID_OBJECT_STATE">
13667	Session type prevents operation.
13668	</result>
13669
13670	</desc>
13671	<param name="device" type="IUSBDevice" dir="in"/>
13672	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13673	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
13674	</method>
13675
13676	<method name="onUSBDeviceDetach">
13677	<desc>
13678	Triggered when a request to release the USB device (as a result
13679	of machine termination or direct call to
13680	<link to="IConsole::detachUSBDevice"/>) has completed.
13681	A @c null @a error object means success, otherwise it
13682	describes a failure.
13683
13684	<result name="VBOX_E_INVALID_VM_STATE">
13685	Session state prevents operation.
13686	</result>
13687	<result name="VBOX_E_INVALID_OBJECT_STATE">
13688	Session type prevents operation.
13689	</result>
13690
13691	</desc>
13692	<param name="id" type="uuid" mod="string" dir="in"/>
13693	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
13694	</method>
13695
13696	<method name="onShowWindow">
13697	<desc>
13698	Called by <link to="IMachine::canShowConsoleWindow"/> and by
13699	<link to="IMachine::showConsoleWindow"/> in order to notify
13700	console listeners
13701	<link to="ICanShowWindowEvent"/>
13702	and <link to="IShowWindowEvent"/>.
13703
13704	<result name="VBOX_E_INVALID_OBJECT_STATE">
13705	Session type prevents operation.
13706	</result>
13707
13708	</desc>
13709	<param name="check" type="boolean" dir="in"/>
13710	<param name="canShow" type="boolean" dir="out"/>
13711	<param name="winId" type="long long" dir="out"/>
13712	</method>
13713
13714	<method name="onBandwidthGroupChange">
13715	<desc>
13716	Notification when one of the bandwidth groups change.
13717	</desc>
13718	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
13719	<desc>The bandwidth group which changed.</desc>
13720	</param>
13721	</method>
13722
13723	<method name="accessGuestProperty">
13724	<desc>
13725	Called by <link to="IMachine::getGuestProperty"/> and by
13726	<link to="IMachine::setGuestProperty"/> in order to read and
13727	modify guest properties.
13728
13729	<result name="VBOX_E_INVALID_VM_STATE">
13730	Machine session is not open.
13731	</result>
13732	<result name="VBOX_E_INVALID_OBJECT_STATE">
13733	Session type is not direct.
13734	</result>
13735
13736	</desc>
13737	<param name="name" type="wstring" dir="in"/>
13738	<param name="value" type="wstring" dir="in"/>
13739	<param name="flags" type="wstring" dir="in"/>
13740	<param name="isSetter" type="boolean" dir="in"/>
13741	<param name="retValue" type="wstring" dir="out"/>
13742	<param name="retTimestamp" type="long long" dir="out"/>
13743	<param name="retFlags" type="wstring" dir="out"/>
13744	</method>
13745
13746	<method name="enumerateGuestProperties">
13747	<desc>
13748	Return a list of the guest properties matching a set of patterns along
13749	with their values, time stamps and flags.
13750
13751	<result name="VBOX_E_INVALID_VM_STATE">
13752	Machine session is not open.
13753	</result>
13754	<result name="VBOX_E_INVALID_OBJECT_STATE">
13755	Session type is not direct.
13756	</result>
13757
13758	</desc>
13759	<param name="patterns" type="wstring" dir="in">
13760	<desc>
13761	The patterns to match the properties against as a comma-separated
13762	string. If this is empty, all properties currently set will be
13763	returned.
13764	</desc>
13765	</param>
13766	<param name="key" type="wstring" dir="out" safearray="yes">
13767	<desc>
13768	The key names of the properties returned.
13769	</desc>
13770	</param>
13771	<param name="value" type="wstring" dir="out" safearray="yes">
13772	<desc>
13773	The values of the properties returned. The array entries match the
13774	corresponding entries in the @a key array.
13775	</desc>
13776	</param>
13777	<param name="timestamp" type="long long" dir="out" safearray="yes">
13778	<desc>
13779	The time stamps of the properties returned. The array entries match
13780	the corresponding entries in the @a key array.
13781	</desc>
13782	</param>
13783	<param name="flags" type="wstring" dir="out" safearray="yes">
13784	<desc>
13785	The flags of the properties returned. The array entries match the
13786	corresponding entries in the @a key array.
13787	</desc>
13788	</param>
13789	</method>
13790
13791	<method name="onlineMergeMedium">
13792	<desc>
13793	Triggers online merging of a hard disk. Used internally when deleting
13794	a snapshot while a VM referring to the same hard disk chain is running.
13795
13796	<result name="VBOX_E_INVALID_VM_STATE">
13797	Machine session is not open.
13798	</result>
13799	<result name="VBOX_E_INVALID_OBJECT_STATE">
13800	Session type is not direct.
13801	</result>
13802
13803	</desc>
13804	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
13805	<desc>The medium attachment to identify the medium chain.</desc>
13806	</param>
13807	<param name="sourceIdx" type="unsigned long" dir="in">
13808	<desc>The index of the source image in the chain.
13809	Redundant, but drastically reduces IPC.</desc>
13810	</param>
13811	<param name="targetIdx" type="unsigned long" dir="in">
13812	<desc>The index of the target image in the chain.
13813	Redundant, but drastically reduces IPC.</desc>
13814	</param>
13815	<param name="source" type="IMedium" dir="in">
13816	<desc>Merge source medium.</desc>
13817	</param>
13818	<param name="target" type="IMedium" dir="in">
13819	<desc>Merge target medium.</desc>
13820	</param>
13821	<param name="mergeForward" type="boolean" dir="in">
13822	<desc>Merge direction.</desc>
13823	</param>
13824	<param name="parentForTarget" type="IMedium" dir="in">
13825	<desc>For forward merges: new parent for target medium.</desc>
13826	</param>
13827	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
13828	<desc>For backward merges: list of media which need their parent UUID
13829	updated.</desc>
13830	</param>
13831	<param name="progress" type="IProgress" dir="in">
13832	<desc>
13833	Progress object for this operation.
13834	</desc>
13835	</param>
13836	</method>
13837
13838	</interface>
13839
13840	<interface
13841	name="ISession" extends="$unknown"
13842	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
13843	wsmap="managed"
13844	>
13845	<desc>
13846	The ISession interface represents a client process and allows for locking
13847	virtual machines (represented by IMachine objects) to prevent conflicting
13848	changes to the machine.
13849
13850	Any caller wishing to manipulate a virtual machine needs to create a session
13851	object first, which lives in its own process space. Such session objects are
13852	then associated with <link to="IMachine" /> objects living in the VirtualBox
13853	server process to coordinate such changes.
13854
13855	There are two typical scenarios in which sessions are used:
13856
13857	<ul>
13858	<li>To alter machine settings or control a running virtual machine, one
13859	needs to lock a machine for a given session (client process) by calling
13860	<link to="IMachine::lockMachine"/>.
13861
13862	Whereas multiple sessions may control a running virtual machine, only
13863	one process can obtain a write lock on the machine to prevent conflicting
13864	changes. A write lock is also needed if a process wants to actually run a
13865	virtual machine in its own context, such as the VirtualBox GUI or
13866	VBoxHeadless front-ends. They must also lock a machine for their own
13867	sessions before they are allowed to power up the virtual machine.
13868
13869	As a result, no machine settings can be altered while another process is
13870	already using it, either because that process is modifying machine settings
13871	or because the machine is running.
13872	</li>
13873	<li>
13874	To start a VM using one of the existing VirtualBox front-ends (e.g. the
13875	VirtualBox GUI or VBoxHeadless), one would use
13876	<link to="IMachine::launchVMProcess"/>, which also takes a session object
13877	as its first parameter. This session then identifies the caller and lets the
13878	caller control the started machine (for example, pause machine execution or
13879	power it down) as well as be notified about machine execution state changes.
13880	</li>
13881	</ul>
13882
13883	How sessions objects are created in a client process depends on whether you use
13884	the Main API via COM or via the webservice:
13885
13886	<ul>
13887	<li>When using the COM API directly, an object of the Session class from the
13888	VirtualBox type library needs to be created. In regular COM C++ client code,
13889	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
13890	This object will then act as a local session object in further calls to open
13891	a session.
13892	</li>
13893
13894	<li>In the webservice, the session manager (IWebsessionManager) instead creates
13895	a session object automatically whenever <link to="IWebsessionManager::logon" />
13896	is called. A managed object reference to that session object can be retrieved by
13897	calling <link to="IWebsessionManager::getSessionObject" />.
13898	</li>
13899	</ul>
13900	</desc>
13901
13902	<attribute name="state" type="SessionState" readonly="yes">
13903	<desc>Current state of this session.</desc>
13904	</attribute>
13905
13906	<attribute name="type" type="SessionType" readonly="yes">
13907	<desc>
13908	Type of this session. The value of this attribute is valid only
13909	if the session currently has a machine locked (i.e. its
13910	<link to="#state" /> is Locked), otherwise an error will be returned.
13911	</desc>
13912	</attribute>
13913
13914	<attribute name="machine" type="IMachine" readonly="yes">
13915	<desc>Machine object associated with this session.</desc>
13916	</attribute>
13917
13918	<attribute name="console" type="IConsole" readonly="yes">
13919	<desc>Console object associated with this session.</desc>
13920	</attribute>
13921
13922	<method name="unlockMachine">
13923	<desc>
13924	Unlocks a machine that was previously locked for the current session.
13925
13926	Calling this method is required every time a machine has been locked
13927	for a particular session using the <link to="IMachine::launchVMProcess" />
13928	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
13929	the machine will be set to <link to="MachineState_Aborted" /> on the
13930	server, and changes made to the machine settings will be lost.
13931
13932	Generally, it is recommended to unlock all machines explicitly
13933	before terminating the application (regardless of the reason for
13934	the termination).
13935
13936	<note>
13937	Do not expect the session state (<link to="ISession::state" />
13938	to return to "Unlocked" immediately after you invoke this method,
13939	particularly if you have started a new VM process. The session
13940	state will automatically return to "Unlocked" once the VM is no
13941	longer executing, which can of course take a very long time.
13942	</note>
13943
13944	<result name="E_UNEXPECTED">
13945	Session is not locked.
13946	</result>
13947
13948	</desc>
13949	</method>
13950
13951	</interface>
13952
13953	<!--
13954	// IStorageController
13955	/////////////////////////////////////////////////////////////////////////
13956	-->
13957
13958	<enum
13959	name="StorageBus"
13960	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
13961	>
13962	<desc>
13963	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
13964	see <link to="IStorageController::bus" />.
13965	</desc>
13966	<const name="Null" value="0">
13967	<desc>@c null value. Never used by the API.</desc>
13968	</const>
13969	<const name="IDE" value="1"/>
13970	<const name="SATA" value="2"/>
13971	<const name="SCSI" value="3"/>
13972	<const name="Floppy" value="4"/>
13973	<const name="SAS" value="5"/>
13974	</enum>
13975
13976	<enum
13977	name="StorageControllerType"
13978	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
13979	>
13980	<desc>
13981	The exact variant of storage controller hardware presented
13982	to the guest; see <link to="IStorageController::controllerType" />.
13983	</desc>
13984
13985	<const name="Null" value="0">
13986	<desc>@c null value. Never used by the API.</desc>
13987	</const>
13988	<const name="LsiLogic" value="1">
13989	<desc>A SCSI controller of the LsiLogic variant.</desc>
13990	</const>
13991	<const name="BusLogic" value="2">
13992	<desc>A SCSI controller of the BusLogic variant.</desc>
13993	</const>
13994	<const name="IntelAhci" value="3">
13995	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
13996	</const>
13997	<const name="PIIX3" value="4">
13998	<desc>An IDE controller of the PIIX3 variant.</desc>
13999	</const>
14000	<const name="PIIX4" value="5">
14001	<desc>An IDE controller of the PIIX4 variant.</desc>
14002	</const>
14003	<const name="ICH6" value="6">
14004	<desc>An IDE controller of the ICH6 variant.</desc>
14005	</const>
14006	<const name="I82078" value="7">
14007	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
14008	</const>
14009	<const name="LsiLogicSas" value="8">
14010	<desc>A variant of the LsiLogic controller using SAS.</desc>
14011	</const>
14012	</enum>
14013
14014	<enum
14015	name="ChipsetType"
14016	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
14017	>
14018	<desc>
14019	Type of emulated chipset (mostly southbridge).
14020	</desc>
14021
14022	<const name="Null" value="0">
14023	<desc>@c null value. Never used by the API.</desc>
14024	</const>
14025	<const name="PIIX3" value="1">
14026	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
14027	</const>
14028	<const name="ICH9" value="2">
14029	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
14030	</const>
14031	</enum>
14032
14033	<interface
14034	name="IStorageController" extends="$unknown"
14035	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
14036	wsmap="managed"
14037	>
14038	<desc>
14039	Represents a storage controller that is attached to a virtual machine
14040	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
14041	attached to storage controllers in a real computer, virtual drives
14042	(represented by <link to="IMediumAttachment" />) are attached to virtual
14043	storage controllers, represented by this interface.
14044
14045	As opposed to physical hardware, VirtualBox has a very generic concept
14046	of a storage controller, and for purposes of the Main API, all virtual
14047	storage is attached to virtual machines via instances of this interface.
14048	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
14049	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
14050	is used, certain sub-types may be available and can be selected in
14051	<link to="#controllerType" />.
14052
14053	Depending on these settings, the guest operating system might see
14054	significantly different virtual hardware.
14055	</desc>
14056
14057	<attribute name="name" type="wstring" readonly="yes">
14058	<desc>
14059	Name of the storage controller, as originally specified with
14060	<link to="IMachine::addStorageController" />. This then uniquely
14061	identifies this controller with other method calls such as
14062	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
14063	</desc>
14064	</attribute>
14065
14066	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
14067	<desc>
14068	Maximum number of devices which can be attached to one port.
14069	</desc>
14070	</attribute>
14071
14072	<attribute name="minPortCount" type="unsigned long" readonly="yes">
14073	<desc>
14074	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
14075	</desc>
14076	</attribute>
14077
14078	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
14079	<desc>
14080	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
14081	</desc>
14082	</attribute>
14083
14084	<attribute name="instance" type="unsigned long">
14085	<desc>
14086	The instance number of the device in the running VM.
14087	</desc>
14088	</attribute>
14089
14090	<attribute name="portCount" type="unsigned long">
14091	<desc>
14092	The number of currently usable ports on the controller.
14093	The minimum and maximum number of ports for one controller are
14094	stored in <link to="IStorageController::minPortCount"/>
14095	and <link to="IStorageController::maxPortCount"/>.
14096	</desc>
14097	</attribute>
14098
14099	<attribute name="bus" type="StorageBus" readonly="yes">
14100	<desc>
14101	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
14102	</desc>
14103	</attribute>
14104
14105	<attribute name="controllerType" type="StorageControllerType">
14106	<desc>
14107	The exact variant of storage controller hardware presented
14108	to the guest.
14109	Depending on this value, VirtualBox will provide a different
14110	virtual storage controller hardware to the guest.
14111	For SATA, SAS and floppy controllers, only one variant is
14112	available, but for IDE and SCSI, there are several.
14113
14114	For SCSI controllers, the default type is LsiLogic.
14115	</desc>
14116	</attribute>
14117
14118	<attribute name="useHostIOCache" type="boolean">
14119	<desc>
14120	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
14121	caches and use synchronous file APIs on the host. This was the only option in the API before
14122	VirtualBox 3.2 and is still the default for IDE controllers.
14123
14124	If false, the host I/O cache will be disabled for image files attached to this storage controller.
14125	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
14126	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
14127	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
14128	virtual machines are running at the same time to prevent I/O cache related hangs.
14129	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
14130	</desc>
14131	</attribute>
14132
14133	<attribute name="bootable" type="boolean" readonly="yes">
14134	<desc>
14135	Returns whether it is possible to boot from disks attached to this controller.
14136	</desc>
14137	</attribute>
14138
14139	<method name="getIDEEmulationPort">
14140	<desc>
14141	Gets the corresponding port number which is emulated as an IDE device.
14142	Works only with SATA controllers.
14143
14144	<result name="E_INVALIDARG">
14145	The @a devicePosition is not in the range 0 to 3.
14146	</result>
14147	<result name="E_NOTIMPL">
14148	The storage controller type is not SATAIntelAhci.
14149	</result>
14150
14151	</desc>
14152	<param name="devicePosition" type="long" dir="in"/>
14153	<param name="portNumber" type="long" dir="return"/>
14154	</method>
14155
14156	<method name="setIDEEmulationPort">
14157	<desc>
14158	Sets the port number which is emulated as an IDE device.
14159	Works only with SATA controllers.
14160
14161	<result name="E_INVALIDARG">
14162	The @a devicePosition is not in the range 0 to 3 or the
14163	@a portNumber is not in the range 0 to 29.
14164	</result>
14165	<result name="E_NOTIMPL">
14166	The storage controller type is not SATAIntelAhci.
14167	</result>
14168
14169	</desc>
14170	<param name="devicePosition" type="long" dir="in"/>
14171	<param name="portNumber" type="long" dir="in"/>
14172	</method>
14173
14174	</interface>
14175
14176	<if target="wsdl">
14177
14178	<!--
14179	// IManagedObjectRef
14180	/////////////////////////////////////////////////////////////////////////
14181	-->
14182
14183	<interface
14184	name="IManagedObjectRef" extends="$unknown"
14185	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
14186	internal="yes"
14187	wsmap="managed"
14188	wscpp="hardcoded"
14189	>
14190	<desc>
14191	Managed object reference.
14192
14193	Only within the webservice, a managed object reference (which is really
14194	an opaque number) allows a webservice client to address an object
14195	that lives in the address space of the webservice server.
14196
14197	Behind each managed object reference, there is a COM object that lives
14198	in the webservice server's address space. The COM object is not freed
14199	until the managed object reference is released, either by an explicit
14200	call to <link to="IManagedObjectRef::release" /> or by logging off from
14201	the webservice (<link to="IWebsessionManager::logoff" />), which releases
14202	all objects created during the webservice session.
14203
14204	Whenever a method call of the VirtualBox API returns a COM object, the
14205	webservice representation of that method will instead return a
14206	managed object reference, which can then be used to invoke methods
14207	on that object.
14208	</desc>
14209
14210	<method name="getInterfaceName">
14211	<desc>
14212	Returns the name of the interface that this managed object represents,
14213	for example, "IMachine", as a string.
14214	</desc>
14215	<param name="return" type="wstring" dir="return"/>
14216	</method>
14217
14218	<method name="release">
14219	<desc>
14220	Releases this managed object reference and frees the resources that
14221	were allocated for it in the webservice server process. After calling
14222	this method, the identifier of the reference can no longer be used.
14223	</desc>
14224	</method>
14225
14226	</interface>
14227
14228	<!--
14229	// IWebsessionManager
14230	/////////////////////////////////////////////////////////////////////////
14231	-->
14232
14233	<interface
14234	name="IWebsessionManager" extends="$unknown"
14235	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
14236	internal="yes"
14237	wsmap="global"
14238	wscpp="hardcoded"
14239	>
14240	<desc>
14241	Websession manager. This provides essential services
14242	to webservice clients.
14243	</desc>
14244	<method name="logon">
14245	<desc>
14246	Logs a new client onto the webservice and returns a managed object reference to
14247	the IVirtualBox instance, which the client can then use as a basis to further
14248	queries, since all calls to the VirtualBox API are based on the IVirtualBox
14249	interface, in one way or the other.
14250	</desc>
14251	<param name="username" type="wstring" dir="in"/>
14252	<param name="password" type="wstring" dir="in"/>
14253	<param name="return" type="IVirtualBox" dir="return"/>
14254	</method>
14255
14256	<method name="getSessionObject">
14257	<desc>
14258	Returns a managed object reference to the internal ISession object that was created
14259	for this web service session when the client logged on.
14260
14261	<see>ISession</see>
14262	</desc>
14263	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14264	<param name="return" type="ISession" dir="return"/>
14265	</method>
14266
14267	<method name="logoff">
14268	<desc>
14269	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
14270	and destroys all resources associated with the session (most importantly, all
14271	managed objects created in the server while the session was active).
14272	</desc>
14273	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
14274	</method>
14275
14276	</interface>
14277
14278	</if>
14279
14280	<!--
14281	// IPerformanceCollector & friends
14282	/////////////////////////////////////////////////////////////////////////
14283	-->
14284
14285	<interface
14286	name="IPerformanceMetric" extends="$unknown"
14287	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
14288	>
14289	<desc>
14290	The IPerformanceMetric interface represents parameters of the given
14291	performance metric.
14292	</desc>
14293
14294	<attribute name="metricName" type="wstring" readonly="yes">
14295	<desc>
14296	Name of the metric.
14297	</desc>
14298	</attribute>
14299
14300	<attribute name="object" type="$unknown" readonly="yes">
14301	<desc>
14302	Object this metric belongs to.
14303	</desc>
14304	</attribute>
14305
14306	<attribute name="description" type="wstring" readonly="yes">
14307	<desc>
14308	Textual description of the metric.
14309	</desc>
14310	</attribute>
14311
14312	<attribute name="period" type="unsigned long" readonly="yes">
14313	<desc>
14314	Time interval between samples, measured in seconds.
14315	</desc>
14316	</attribute>
14317
14318	<attribute name="count" type="unsigned long" readonly="yes">
14319	<desc>
14320	Number of recent samples retained by the performance collector for this
14321	metric.
14322
14323	When the collected sample count exceeds this number, older samples
14324	are discarded.
14325	</desc>
14326	</attribute>
14327
14328	<attribute name="unit" type="wstring" readonly="yes">
14329	<desc>
14330	Unit of measurement.
14331	</desc>
14332	</attribute>
14333
14334	<attribute name="minimumValue" type="long" readonly="yes">
14335	<desc>
14336	Minimum possible value of this metric.
14337	</desc>
14338	</attribute>
14339
14340	<attribute name="maximumValue" type="long" readonly="yes">
14341	<desc>
14342	Maximum possible value of this metric.
14343	</desc>
14344	</attribute>
14345	</interface>
14346
14347	<interface
14348	name="IPerformanceCollector" extends="$unknown"
14349	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
14350	wsmap="managed"
14351	>
14352	<desc>
14353	The IPerformanceCollector interface represents a service that collects
14354	and stores performance metrics data.
14355
14356	Performance metrics are associated with objects of interfaces like IHost
14357	and IMachine. Each object has a distinct set of performance metrics. The
14358	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
14359
14360	Metric data is collected at the specified intervals and is retained
14361	internally. The interval and the number of retained samples can be set
14362	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
14363	and collection settings are not persistent, they are discarded as soon as
14364	VBoxSVC process terminates. Moreover, metric settings and data associated
14365	with a particular VM only exist while VM is running. They disappear as
14366	soon as VM shuts down. It is not possible to set up metrics for machines
14367	that are powered off. One needs to start VM first, then set up metric
14368	collection parameters.
14369
14370	Metrics are organized hierarchically, with each level separated by a
14371	slash (/) character. Generally, the scheme for metric names is like this:
14372
14373	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
14374
14375	"Category/Metric" together form the base metric name. A base metric is
14376	the smallest unit for which a sampling interval and the number of
14377	retained samples can be set. Only base metrics can be enabled and
14378	disabled. All sub-metrics are collected when their base metric is
14379	collected. Collected values for any set of sub-metrics can be queried
14380	with <link to="IPerformanceCollector::queryMetricsData" />.
14381
14382	For example "CPU/Load/User:avg" metric name stands for the "CPU"
14383	category, "Load" metric, "User" submetric, "average" aggregate. An
14384	aggregate function is computed over all retained data. Valid aggregate
14385	functions are:
14386
14387	<ul>
14388	<li>avg -- average</li>
14389	<li>min -- minimum</li>
14390	<li>max -- maximum</li>
14391	</ul>
14392
14393	When setting up metric parameters, querying metric data, enabling or
14394	disabling metrics wildcards can be used in metric names to specify a
14395	subset of metrics. For example, to select all CPU-related metrics
14396	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
14397	so on. To query metric values without aggregates <tt>*:</tt> can be used.
14398
14399	The valid names for base metrics are:
14400
14401	<ul>
14402	<li>CPU/Load</li>
14403	<li>CPU/MHz</li>
14404	<li>RAM/Usage</li>
14405	</ul>
14406
14407	The general sequence for collecting and retrieving the metrics is:
14408	<ul>
14409	<li>
14410	Obtain an instance of IPerformanceCollector with
14411	<link to="IVirtualBox::performanceCollector" />
14412	</li>
14413	<li>
14414	Allocate and populate an array with references to objects the metrics
14415	will be collected for. Use references to IHost and IMachine objects.
14416	</li>
14417	<li>
14418	Allocate and populate an array with base metric names the data will
14419	be collected for.
14420	</li>
14421	<li>
14422	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
14423	the metric data will be collected and stored.
14424	</li>
14425	<li>
14426	Wait for the data to get collected.
14427	</li>
14428	<li>
14429	Allocate and populate an array with references to objects the metric
14430	values will be queried for. You can re-use the object array used for
14431	setting base metrics.
14432	</li>
14433	<li>
14434	Allocate and populate an array with metric names the data will be
14435	collected for. Note that metric names differ from base metric names.
14436	</li>
14437	<li>
14438	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
14439	that have been collected so far are returned. Note that the values
14440	are still retained internally and data collection continues.
14441	</li>
14442	</ul>
14443
14444	For an example of usage refer to the following files in VirtualBox SDK:
14445	<ul>
14446	<li>
14447	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
14448	</li>
14449	<li>
14450	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
14451	</li>
14452	</ul>
14453	</desc>
14454
14455	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
14456	<desc>
14457	Array of unique names of metrics.
14458
14459	This array represents all metrics supported by the performance
14460	collector. Individual objects do not necessarily support all of them.
14461	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
14462	list of supported metrics for a particular object.
14463	</desc>
14464	</attribute>
14465
14466	<method name="getMetrics">
14467	<desc>
14468	Returns parameters of specified metrics for a set of objects.
14469	<note>
14470	@c Null metrics array means all metrics. @c Null object array means
14471	all existing objects.
14472	</note>
14473	</desc>
14474	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14475	<desc>
14476	Metric name filter. Currently, only a comma-separated list of metrics
14477	is supported.
14478	</desc>
14479	</param>
14480	<param name="objects" type="$unknown" dir="in" safearray="yes">
14481	<desc>
14482	Set of objects to return metric parameters for.
14483	</desc>
14484	</param>
14485	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
14486	<desc>
14487	Array of returned metric parameters.
14488	</desc>
14489	</param>
14490	</method>
14491
14492	<method name="setupMetrics">
14493	<desc>
14494	Sets parameters of specified base metrics for a set of objects. Returns
14495	an array of <link to="IPerformanceMetric" /> describing the metrics
14496	have been affected.
14497	<note>
14498	@c Null or empty metric name array means all metrics. @c Null or
14499	empty object array means all existing objects. If metric name array
14500	contains a single element and object array contains many, the single
14501	metric name array element is applied to each object array element to
14502	form metric/object pairs.
14503	</note>
14504	</desc>
14505	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14506	<desc>
14507	Metric name filter. Comma-separated list of metrics with wildcard
14508	support.
14509	</desc>
14510	</param>
14511	<param name="objects" type="$unknown" dir="in" safearray="yes">
14512	<desc>
14513	Set of objects to setup metric parameters for.
14514	</desc>
14515	</param>
14516	<param name="period" type="unsigned long" dir="in">
14517	<desc>
14518	Time interval in seconds between two consecutive samples of
14519	performance data.
14520	</desc>
14521	</param>
14522	<param name="count" type="unsigned long" dir="in">
14523	<desc>
14524	Number of samples to retain in performance data history. Older
14525	samples get discarded.
14526	</desc>
14527	</param>
14528	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14529	<desc>
14530	Array of metrics that have been modified by the call to this method.
14531	</desc>
14532	</param>
14533	</method>
14534
14535	<method name="enableMetrics">
14536	<desc>
14537	Turns on collecting specified base metrics. Returns an array of
14538	<link to="IPerformanceMetric" /> describing the metrics have been
14539	affected.
14540	<note>
14541	@c Null or empty metric name array means all metrics. @c Null or
14542	empty object array means all existing objects. If metric name array
14543	contains a single element and object array contains many, the single
14544	metric name array element is applied to each object array element to
14545	form metric/object pairs.
14546	</note>
14547	</desc>
14548	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14549	<desc>
14550	Metric name filter. Comma-separated list of metrics with wildcard
14551	support.
14552	</desc>
14553	</param>
14554	<param name="objects" type="$unknown" dir="in" safearray="yes">
14555	<desc>
14556	Set of objects to enable metrics for.
14557	</desc>
14558	</param>
14559	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14560	<desc>
14561	Array of metrics that have been modified by the call to this method.
14562	</desc>
14563	</param>
14564	</method>
14565
14566	<method name="disableMetrics">
14567	<desc>
14568	Turns off collecting specified base metrics. Returns an array of
14569	<link to="IPerformanceMetric" /> describing the metrics have been
14570	affected.
14571	<note>
14572	@c Null or empty metric name array means all metrics. @c Null or
14573	empty object array means all existing objects. If metric name array
14574	contains a single element and object array contains many, the single
14575	metric name array element is applied to each object array element to
14576	form metric/object pairs.
14577	</note>
14578	</desc>
14579	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14580	<desc>
14581	Metric name filter. Comma-separated list of metrics with wildcard
14582	support.
14583	</desc>
14584	</param>
14585	<param name="objects" type="$unknown" dir="in" safearray="yes">
14586	<desc>
14587	Set of objects to disable metrics for.
14588	</desc>
14589	</param>
14590	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
14591	<desc>
14592	Array of metrics that have been modified by the call to this method.
14593	</desc>
14594	</param>
14595	</method>
14596
14597	<method name="queryMetricsData">
14598	<desc>
14599	Queries collected metrics data for a set of objects.
14600
14601	The data itself and related metric information are returned in seven
14602	parallel and one flattened array of arrays. Elements of
14603	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
14604	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
14605	the same index describe one set of values corresponding to a single
14606	metric.
14607
14608	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
14609	start and length of a sub-array is indicated by
14610	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
14611	value for metric <tt>metricNames[i]</tt> is at
14612	<tt>returnData[returnIndices[i]]</tt>.
14613
14614	<note>
14615	@c Null or empty metric name array means all metrics. @c Null or
14616	empty object array means all existing objects. If metric name array
14617	contains a single element and object array contains many, the single
14618	metric name array element is applied to each object array element to
14619	form metric/object pairs.
14620	</note>
14621	<note>
14622	Data collection continues behind the scenes after call to @c
14623	queryMetricsData. The return data can be seen as the snapshot of the
14624	current state at the time of @c queryMetricsData call. The internally
14625	kept metric values are not cleared by the call. This makes possible
14626	querying different subsets of metrics or aggregates with subsequent
14627	calls. If periodic querying is needed it is highly suggested to query
14628	the values with @c interval*count period to avoid confusion. This way
14629	a completely new set of data values will be provided by each query.
14630	</note>
14631	</desc>
14632	<param name="metricNames" type="wstring" dir="in" safearray="yes">
14633	<desc>
14634	Metric name filter. Comma-separated list of metrics with wildcard
14635	support.
14636	</desc>
14637	</param>
14638	<param name="objects" type="$unknown" dir="in" safearray="yes">
14639	<desc>
14640	Set of objects to query metrics for.
14641	</desc>
14642	</param>
14643	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
14644	<desc>
14645	Names of metrics returned in @c returnData.
14646	</desc>
14647	</param>
14648	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
14649	<desc>
14650	Objects associated with metrics returned in @c returnData.
14651	</desc>
14652	</param>
14653	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
14654	<desc>
14655	Units of measurement for each returned metric.
14656	</desc>
14657	</param>
14658	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
14659	<desc>
14660	Divisor that should be applied to return values in order to get
14661	floating point values. For example:
14662	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
14663	will retrieve the floating point value of i-th sample of the first
14664	metric.
14665	</desc>
14666	</param>
14667	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
14668	<desc>
14669	Sequence numbers of the first elements of value sequences of
14670	particular metrics returned in @c returnData. For aggregate metrics
14671	it is the sequence number of the sample the aggregate started
14672	calculation from.
14673	</desc>
14674	</param>
14675	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
14676	<desc>
14677	Indices of the first elements of value sequences of particular
14678	metrics returned in @c returnData.
14679	</desc>
14680	</param>
14681	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
14682	<desc>
14683	Lengths of value sequences of particular metrics.
14684	</desc>
14685	</param>
14686	<param name="returnData" type="long" dir="return" safearray="yes">
14687	<desc>
14688	Flattened array of all metric data containing sequences of values for
14689	each metric.
14690	</desc>
14691	</param>
14692	</method>
14693
14694	</interface>
14695
14696	<enum
14697	name="NATAliasMode"
14698	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
14699	>
14700	<desc></desc>
14701	<const name="AliasLog" value="0x1">
14702	<desc></desc>
14703	</const>
14704	<const name="AliasProxyOnly" value="0x02">
14705	<desc></desc>
14706	</const>
14707	<const name="AliasUseSamePorts" value="0x04">
14708	<desc></desc>
14709	</const>
14710	</enum>
14711
14712	<enum
14713	name="NATProtocol"
14714	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
14715	>
14716	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
14717	<const name="UDP" value="0">
14718	<desc>Port-forwarding uses UDP protocol.</desc>
14719	</const>
14720	<const name="TCP" value="1">
14721	<desc>Port-forwarding uses TCP protocol.</desc>
14722	</const>
14723	</enum>
14724
14725	<interface
14726	name="INATEngine" extends="$unknown"
14727	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
14728	wsmap="managed"
14729	>
14730	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
14731	allows for changing NAT behavior such as port-forwarding rules. This interface is
14732	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
14733	<attribute name="network" type="wstring">
14734	<desc>The network attribute of the NAT engine (the same value is used with built-in
14735	DHCP server to fill corresponding fields of DHCP leases).</desc>
14736	</attribute>
14737	<attribute name="hostIP" type="wstring">
14738	<desc>IP of host interface to bind all opened sockets to.
14739	<note>Changing this does not change binding of port forwarding.</note>
14740	</desc>
14741	</attribute>
14742	<attribute name="tftpPrefix" type="wstring">
14743	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
14744	the corresponding fields of DHCP leases.</desc>
14745	</attribute>
14746	<attribute name="tftpBootFile" type="wstring">
14747	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
14748	the corresponding fields of DHCP leases.</desc>
14749	</attribute>
14750	<attribute name="tftpNextServer" type="wstring">
14751	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
14752	the corresponding fields of DHCP leases.
14753	<note>The preferred form is IPv4 addresses.</note>
14754	</desc>
14755	</attribute>
14756	<attribute name="aliasMode" type="unsigned long">
14757	<desc></desc>
14758	</attribute>
14759	<attribute name="dnsPassDomain" type="boolean">
14760	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
14761	</attribute>
14762	<attribute name="dnsProxy" type="boolean">
14763	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14764	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
14765	</attribute>
14766	<attribute name="dnsUseHostResolver" type="boolean">
14767	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
14768	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
14769	</attribute>
14770	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
14771	<desc>Array of NAT port-forwarding rules in string representation, in the following
14772	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
14773	</attribute>
14774	<method name="setNetworkSettings">
14775	<desc>Sets network configuration of the NAT engine.</desc>
14776	<param name="mtu" type="unsigned long" dir="in">
14777	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
14778	</param>
14779	<param name="sockSnd" type="unsigned long" dir="in">
14780	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
14781	</param>
14782	<param name="sockRcv" type="unsigned long" dir="in">
14783	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
14784	</param>
14785	<param name="TcpWndSnd" type="unsigned long" dir="in">
14786	<desc>Initial size of the NAT engine's sending TCP window in bytes when
14787	establishing a new TCP connection.</desc>
14788	</param>
14789	<param name="TcpWndRcv" type="unsigned long" dir="in">
14790	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
14791	establishing a new TCP connection.</desc>
14792	</param>
14793	</method>
14794	<method name="getNetworkSettings">
14795	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
14796	for parameter descriptions.</desc>
14797	<param name="mtu" type="unsigned long" dir="out" />
14798	<param name="sockSnd" type="unsigned long" dir="out" />
14799	<param name="sockRcv" type="unsigned long" dir="out" />
14800	<param name="TcpWndSnd" type="unsigned long" dir="out" />
14801	<param name="TcpWndRcv" type="unsigned long" dir="out" />
14802	</method>
14803	<method name="addRedirect">
14804	<desc>Adds a new NAT port-forwarding rule.</desc>
14805	<param name="name" type="wstring" dir="in">
14806	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
14807	auto-generates one using the other parameters.</desc>
14808	</param>
14809	<param name="proto" type="NATProtocol" dir="in">
14810	<desc>Protocol handled with the rule.</desc>
14811	</param>
14812	<param name="hostIp" type="wstring" dir="in">
14813	<desc>IP of the host interface to which the rule should apply. An empty ip address is
14814	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
14815	</param>
14816	<param name="hostPort" type="unsigned short" dir="in">
14817	<desc>The port number to listen on.</desc>
14818	</param>
14819	<param name="guestIp" type="wstring" dir="in">
14820	<desc>The IP address of the guest which the NAT engine will forward matching packets
14821	to. An empty IP address is acceptable, in which case the NAT engine will forward
14822	packets to the first DHCP lease (x.x.x.15).</desc>
14823	</param>
14824	<param name="guestPort" type="unsigned short" dir="in">
14825	<desc>The port number to forward.</desc>
14826	</param>
14827	</method>
14828	<method name="removeRedirect">
14829	<desc>Removes a port-forwarding rule that was previously registered.</desc>
14830	<param name="name" type="wstring" dir="in">
14831	<desc>The name of the rule to delete.</desc>
14832	</param>
14833	</method>
14834	</interface>
14835
14836	<!--
14837	// IExtPackManager
14838	/////////////////////////////////////////////////////////////////////////
14839	-->
14840
14841	<interface
14842	name="IExtPackPlugIn" extends="$unknown"
14843	uuid="58000040-e718-4746-bbce-4b86d96da461"
14844	wsmap="suppress"
14845	>
14846	<desc>
14847	Interface for keeping information about a plug-in that ships with an
14848	extension pack.
14849	</desc>
14850	<attribute name="name" type="wstring" readonly="yes">
14851	<desc>The plug-in name.</desc>
14852	</attribute>
14853	<attribute name="description" type="wstring" readonly="yes">
14854	<desc>The plug-in description.</desc>
14855	</attribute>
14856	<attribute name="frontend" type="wstring" readonly="yes">
14857	<desc>
14858	The name of the frontend or component name this plug-in plugs into.
14859	</desc>
14860	</attribute>
14861	<attribute name="modulePath" type="wstring" readonly="yes">
14862	<desc> The module path. </desc>
14863	</attribute>
14864	</interface>
14865
14866	<interface
14867	name="IExtPackBase" extends="$unknown"
14868	uuid="5ffb0b64-0ad6-467d-af62-1157e7dc3c99"
14869	wsmap="suppress"
14870	>
14871	<desc>
14872	Interface for querying information about an extension pack as well as
14873	accessing COM objects within it.
14874	</desc>
14875	<attribute name="name" type="wstring" readonly="yes">
14876	<desc>The extension pack name. This is unique.</desc>
14877	</attribute>
14878	<attribute name="description" type="wstring" readonly="yes">
14879	<desc>The extension pack description.</desc>
14880	</attribute>
14881	<attribute name="version" type="wstring" readonly="yes">
14882	<desc>
14883	The extension pack version string. This is on the same form as
14884	other VirtualBox version strings, i.e.: "1.2.3", "1.2.3_BETA1",
14885	"1.2.3-OSE", "1.2.3r45678", "1.2.3r45678-OSE", "1.2.3_BETA1-r45678"
14886	or "1.2.3_BETA1-r45678-OSE"
14887	</desc>
14888	</attribute>
14889	<attribute name="revision" type="unsigned long" readonly="yes">
14890	<desc>The extension pack internal revision number.</desc>
14891	</attribute>
14892	<attribute name="VRDEModule" type="wstring" readonly="yes">
14893	<desc>The name of the VRDE module if the extension pack sports one.</desc>
14894	</attribute>
14895	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
14896	<desc>Plug-ins provided by this extension pack.</desc>
14897	</attribute>
14898	<attribute name="usable" type="boolean" readonly="yes">
14899	<desc>
14900	Indicates whether the extension pack is usable or not.
14901
14902	There are a number of reasons why an extension pack might be unusable,
14903	typical examples would be broken installation/file or that it is
14904	incompatible with the current VirtualBox version.
14905	</desc>
14906	</attribute>
14907	<attribute name="whyUnusable" type="wstring" readonly="yes">
14908	<desc>
14909	String indicating why the extension pack is not usable. This is an
14910	empty string if usable and always a non-empty string if not usable.
14911	</desc>
14912	</attribute>
14913	<attribute name="showLicense" type="boolean" readonly="yes">
14914	<desc>Whether to show the license before installation</desc>
14915	</attribute>
14916	<attribute name="license" type="wstring" readonly="yes">
14917	<desc>
14918	The default HTML license text for the extension pack. Same as
14919	calling <link to="#queryLicense">queryLicense</link> with
14920	preferredLocale and preferredLanguage as empty strings and format set
14921	to html.
14922	</desc>
14923	</attribute>
14924
14925	<method name="queryLicense">
14926	<desc>
14927	Full feature version of the license attribute.
14928	</desc>
14929	<param name="preferredLocale" type="wstring" dir="in">
14930	<desc>
14931	The preferred license locale. Pass an empty string to get the default
14932	license.
14933	</desc>
14934	</param>
14935	<param name="preferredLanguage" type="wstring" dir="in">
14936	<desc>
14937	The preferred license language. Pass an empty string to get the
14938	default language for the locale.
14939	</desc>
14940	</param>
14941	<param name="format" type="wstring" dir="in">
14942	<desc>
14943	The license format: html, rtf or txt. If a license is present there
14944	will always be an HTML of it, the rich text format (RTF) and plain
14945	text (txt) versions are optional. If
14946	</desc>
14947	</param>
14948	<param name="licenseText" type="wstring" dir="return">
14949	<desc>The license text.</desc>
14950	</param>
14951	</method>
14952
14953	</interface>
14954
14955	<interface
14956	name="IExtPack" extends="IExtPackBase"
14957	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
14958	wsmap="suppress"
14959	>
14960	<desc>
14961	Interface for querying information about an extension pack as well as
14962	accessing COM objects within it.
14963	</desc>
14964	<method name="queryObject">
14965	<desc>
14966	Queries the IUnknown interface to an object in the extension pack
14967	main module. This allows plug-ins and others to talk directly to an
14968	extension pack.
14969	</desc>
14970	<param name="objUuid" type="wstring" dir="in">
14971	<desc>The object ID. What exactly this is </desc>
14972	</param>
14973	<param name="returnInterface" type="$unknown" dir="return">
14974	<desc>The queried interface.</desc>
14975	</param>
14976	</method>
14977	</interface>
14978
14979	<interface
14980	name="IExtPackFile" extends="IExtPackBase"
14981	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
14982	wsmap="suppress"
14983	>
14984	<desc>
14985	Extension pack file (aka tarball, .vbox-extpack) representation returned
14986	by IExtPackManager::openExtPackFile. This provides the base extension
14987	pack information with the addition of the file name. It also provides an
14988	alternative to IExtPackManager::install.
14989	</desc>
14990	<attribute name="filePath" type="wstring" readonly="yes">
14991	<desc>
14992	The path to the extension pack file.
14993	</desc>
14994	</attribute>
14995
14996	<method name="install">
14997	<desc>
14998	Install the extension pack.
14999	</desc>
15000	<param name="replace" type="boolean" dir="in">
15001	<desc>
15002	Set this to automatically uninstall any existing extension pack with
15003	the same name as the one being installed.
15004	</desc>
15005	</param>
15006	<param name="displayInfo" type="wstring" dir="in">
15007	<desc>
15008	Platform specific display information. Reserved for future hacks.
15009	</desc>
15010	</param>
15011	<param name="progess" type="IProgress" dir="return">
15012	<desc>
15013	Progress object for the operation.
15014	</desc>
15015	</param>
15016	</method>
15017	</interface>
15018
15019	<interface
15020	name="IExtPackManager" extends="$unknown"
15021	uuid="2451b1ba-ab1c-42fb-b453-c58433bea8c7"
15022	wsmap="suppress"
15023	>
15024	<desc>
15025	Interface for managing VirtualBox Extension Packs.
15026
15027	TODO: Describe extension packs, how they are managed and how to create
15028	one.
15029	</desc>
15030
15031	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
15032	<desc>
15033	List of the installed extension packs.
15034	</desc>
15035	</attribute>
15036
15037	<method name="find">
15038	<desc>
15039	Returns the extension pack with the specified name if found.
15040
15041	<result name="VBOX_E_OBJECT_NOT_FOUND">
15042	No extension pack matching @a name was found.
15043	</result>
15044	</desc>
15045	<param name="name" type="wstring" dir="in">
15046	<desc>The name of the extension pack to locate.</desc>
15047	</param>
15048	<param name="returnData" type="IExtPack" dir="return">
15049	<desc>The extension pack if found.</desc>
15050	</param>
15051	</method>
15052
15053	<method name="openExtPackFile">
15054	<desc>
15055	Attempts to open an extension pack file in preparation for
15056	installation.
15057	</desc>
15058	<param name="path" type="wstring" dir="in">
15059	<desc>The path of the extension pack tarball.</desc>
15060	</param>
15061	<param name="file" type="IExtPackFile" dir="return">
15062	<desc>The interface of the extension pack file object.</desc>
15063	</param>
15064	</method>
15065
15066	<method name="uninstall">
15067	<desc>Uninstalls an extension pack, removing all related files.</desc>
15068	<param name="name" type="wstring" dir="in">
15069	<desc>The name of the extension pack to uninstall.</desc>
15070	</param>
15071	<param name="forcedRemoval" type="boolean" dir="in">
15072	<desc>
15073	Forced removal of the extension pack. This means that the uninstall
15074	hook will not be called.
15075	</desc>
15076	</param>
15077	<param name="displayInfo" type="wstring" dir="in">
15078	<desc>
15079	Platform specific display information. Reserved for future hacks.
15080	</desc>
15081	</param>
15082	<param name="progess" type="IProgress" dir="return">
15083	<desc>
15084	Progress object for the operation.
15085	</desc>
15086	</param>
15087	</method>
15088
15089	<method name="cleanup">
15090	<desc>Cleans up failed installs and uninstalls</desc>
15091	</method>
15092
15093	<method name="QueryAllPlugInsForFrontend">
15094	<desc>
15095	Gets the path to all the plug-in modules for a given frontend.
15096
15097	This is a convenience method that is intended to simplify the plug-in
15098	loading process for a frontend.
15099	</desc>
15100	<param name="frontendName" type="wstring" dir="in">
15101	<desc>The name of the frontend or component.</desc>
15102	</param>
15103	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
15104	<desc>Array containing the plug-in modules (full paths).</desc>
15105	</param>
15106	</method>
15107
15108	<method name="IsExtPackUsable">
15109	<desc>Check if the given extension pack is loaded and usable.</desc>
15110	<param name="name" type="wstring" dir="in">
15111	<desc>The name of the extension pack to check for.</desc>
15112	</param>
15113	<param name="usable" type="boolean" dir="return">
15114	<desc>Is the given extension pack loaded and usable.</desc>
15115	</param>
15116	</method>
15117
15118	</interface>
15119
15120	<!--
15121	// BandwidthGroupType
15122	/////////////////////////////////////////////////////////////////////////
15123	-->
15124	<enum
15125	name="BandwidthGroupType"
15126	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
15127
15128	<desc>
15129	Type of a bandwidth control group.
15130	</desc>
15131
15132	<const name="Null" value="0">
15133	<desc>
15134	Null type, must be first.
15135	</desc>
15136	</const>
15137
15138	<const name="Disk" value="1">
15139	<desc>
15140	The bandwidth group controls disk I/O.
15141	</desc>
15142	</const>
15143
15144	<const name="Network" value="2">
15145	<desc>
15146	The bandwidth group controls network I/O.
15147	</desc>
15148	</const>
15149
15150	</enum>
15151
15152	<!--
15153	// IBandwidthGroup
15154	/////////////////////////////////////////////////////////////////////////
15155	-->
15156	<interface
15157	name="IBandwidthGroup" extends="$unknown"
15158	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
15159	wsmap="managed"
15160	>
15161	<desc>Represents one bandwidth group.</desc>
15162
15163	<attribute name="name" type="wstring" readonly="yes">
15164	<desc>Name of the group.</desc>
15165	</attribute>
15166
15167	<attribute name="type" type="BandwidthGroupType" readonly="yes">
15168	<desc>Type of the group.</desc>
15169	</attribute>
15170
15171	<attribute name="reference" type="unsigned long" readonly="yes">
15172	<desc>How many devices/medium attachements use this group.</desc>
15173	</attribute>
15174
15175	<attribute name="maxMbPerSec" type="unsigned long">
15176	<desc>The maximum number of MBytes which can be transfered by all
15177	entities attached to this group during one second.</desc>
15178	</attribute>
15179
15180	</interface>
15181
15182	<!--
15183	// IBandwidthControl
15184	/////////////////////////////////////////////////////////////////////////
15185	-->
15186	<interface
15187	name="IBandwidthControl" extends="$unknown"
15188	uuid="d0a24db0-f756-11df-98cf-0800200c9a66"
15189	wsmap="managed"
15190	>
15191	<desc>
15192	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
15193	This includes network and disk I/O.
15194	</desc>
15195
15196	<attribute name="numGroups" type="unsigned long" readonly="yes">
15197	<desc>
15198	The current number of existing bandwidth groups managed.
15199	</desc>
15200	</attribute>
15201
15202	<method name="CreateBandwidthGroup">
15203	<desc>
15204	Creates a new bandwidth group.
15205	</desc>
15206
15207	<param name="name" type="wstring" dir="in">
15208	<desc>Name of the bandwidth group.</desc>
15209	</param>
15210	<param name="type" type="BandwidthGroupType" dir="in">
15211	<desc>The type of the bandwidth group (network or disk).</desc>
15212	</param>
15213	<param name="maxMbPerSec" type="unsigned long" dir="in">
15214	<desc>The maximum number of MBytes which can be transfered by all
15215	entities attached to this group during one second.</desc>
15216	</param>
15217	</method>
15218
15219	<method name="DeleteBandwidthGroup">
15220	<desc>
15221	Deletes a new bandwidth group.
15222	</desc>
15223
15224	<param name="name" type="wstring" dir="in">
15225	<desc>Name of the bandwidth group to delete.</desc>
15226	</param>
15227	</method>
15228
15229	<method name="GetBandwidthGroup" const="yes">
15230	<desc>
15231	Get a bandwidth group by name.
15232	</desc>
15233
15234	<param name="name" type="wstring" dir="in">
15235	<desc>Name of the bandwidth group to get.</desc>
15236	</param>
15237	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
15238	<desc>Where to store the bandwidth group on success.</desc>
15239	</param>
15240	</method>
15241
15242	<method name="GetAllBandwidthGroups" const="yes">
15243	<desc>
15244	Get all managed bandwidth groups.
15245	</desc>
15246
15247	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
15248	<desc>The array of managed bandwidth groups.</desc>
15249	</param>
15250	</method>
15251	</interface>
15252
15253	<!--
15254	// IVirtualBoxClient
15255	/////////////////////////////////////////////////////////////////////////
15256	-->
15257
15258	<interface
15259	name="IVirtualBoxClient" extends="$unknown"
15260	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
15261	wsmap="suppress"
15262	>
15263	<desc>
15264	Convenience interface for client applications. Treat this as a
15265	singleton, i.e. never create more than one instance of this interface.
15266
15267	At the moment only available for clients of the local API (not usable
15268	via the webservice). Once the session logic is redesigned this might
15269	change.
15270	</desc>
15271
15272	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
15273	<desc>
15274	Reference to the server-side API root object.
15275	</desc>
15276	</attribute>
15277
15278	<attribute name="session" type="ISession" readonly="yes">
15279	<desc>
15280	Create a new session object and return the reference to it.
15281	</desc>
15282	</attribute>
15283
15284	<attribute name="eventSource" type="IEventSource" readonly="yes">
15285	<desc>
15286	Event source for VirtualBoxClient events.
15287	</desc>
15288	</attribute>
15289
15290	</interface>
15291
15292	<!--
15293	// Events
15294	/////////////////////////////////////////////////////////////////////////
15295	-->
15296	<enum
15297	name="VBoxEventType"
15298	uuid="e71c487f-755e-46e9-a476-dd6a5d134597"
15299	>
15300
15301	<desc>
15302	Type of an event.
15303	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15304	</desc>
15305
15306	<const name="Invalid" value="0">
15307	<desc>
15308	Invalid event, must be first.
15309	</desc>
15310	</const>
15311
15312	<const name="Any" value="1">
15313	<desc>
15314	Wildcard for all events.
15315	Events of this type are never delivered, and only used in
15316	registerListener() call to simplify registration.
15317	</desc>
15318	</const>
15319
15320	<const name="Vetoable" value="2">
15321	<desc>
15322	Wildcard for all vetoable events. Events of this type are never delivered, and only
15323	used in registerListener() call to simplify registration.
15324	</desc>
15325	</const>
15326
15327	<const name="MachineEvent" value="3">
15328	<desc>
15329	Wildcard for all machine events. Events of this type are never delivered, and only used in
15330	registerListener() call to simplify registration.
15331	</desc>
15332	</const>
15333
15334	<const name="SnapshotEvent" value="4">
15335	<desc>
15336	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
15337	registerListener() call to simplify registration.
15338	</desc>
15339	</const>
15340
15341	<const name="InputEvent" value="5">
15342	<desc>
15343	Wildcard for all input device (keyboard, mouse) events.
15344	Events of this type are never delivered, and only used in
15345	registerListener() call to simplify registration.
15346	</desc>
15347	</const>
15348
15349	<const name="LastWildcard" value="31">
15350	<desc>
15351	Last wildcard.
15352	</desc>
15353	</const>
15354
15355	<const name="OnMachineStateChanged" value="32">
15356	<desc>
15357	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
15358	</desc>
15359	</const>
15360	<const name="OnMachineDataChanged" value="33">
15361	<desc>
15362	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
15363	</desc>
15364	</const>
15365	<const name="OnExtraDataChanged" value="34">
15366	<desc>
15367	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
15368	</desc>
15369	</const>
15370	<const name="OnExtraDataCanChange" value="35">
15371	<desc>
15372	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
15373	</desc>
15374	</const>
15375	<const name="OnMediumRegistered" value="36">
15376	<desc>
15377	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
15378	</desc>
15379	</const>
15380	<const name="OnMachineRegistered" value="37">
15381	<desc>
15382	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
15383	</desc>
15384	</const>
15385	<const name="OnSessionStateChanged" value="38">
15386	<desc>
15387	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
15388	</desc>
15389	</const>
15390	<const name="OnSnapshotTaken" value="39">
15391	<desc>
15392	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
15393	</desc>
15394	</const>
15395	<const name="OnSnapshotDeleted" value="40">
15396	<desc>
15397	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
15398	</desc>
15399	</const>
15400	<const name="OnSnapshotChanged" value="41">
15401	<desc>
15402	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
15403	</desc>
15404	</const>
15405	<const name="OnGuestPropertyChanged" value="42">
15406	<desc>
15407	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
15408	</desc>
15409	</const>
15410	<!-- Console events -->
15411	<const name="OnMousePointerShapeChanged" value="43">
15412	<desc>
15413	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
15414	</desc>
15415	</const>
15416	<const name="OnMouseCapabilityChanged" value="44">
15417	<desc>
15418	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
15419	</desc>
15420	</const>
15421	<const name="OnKeyboardLedsChanged" value="45">
15422	<desc>
15423	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
15424	</desc>
15425	</const>
15426	<const name="OnStateChanged" value="46">
15427	<desc>
15428	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
15429	</desc>
15430	</const>
15431	<const name="OnAdditionsStateChanged" value="47">
15432	<desc>
15433	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
15434	</desc>
15435	</const>
15436	<const name="OnNetworkAdapterChanged" value="48">
15437	<desc>
15438	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
15439	</desc>
15440	</const>
15441	<const name="OnSerialPortChanged" value="49">
15442	<desc>
15443	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
15444	</desc>
15445	</const>
15446	<const name="OnParallelPortChanged" value="50">
15447	<desc>
15448	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
15449	</desc>
15450	</const>
15451	<const name="OnStorageControllerChanged" value="51">
15452	<desc>
15453	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
15454	</desc>
15455	</const>
15456	<const name="OnMediumChanged" value="52">
15457	<desc>
15458	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
15459	</desc>
15460	</const>
15461	<const name="OnVRDEServerChanged" value="53">
15462	<desc>
15463	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
15464	</desc>
15465	</const>
15466	<const name="OnUSBControllerChanged" value="54">
15467	<desc>
15468	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
15469	</desc>
15470	</const>
15471	<const name="OnUSBDeviceStateChanged" value="55">
15472	<desc>
15473	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
15474	</desc>
15475	</const>
15476	<const name="OnSharedFolderChanged" value="56">
15477	<desc>
15478	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
15479	</desc>
15480	</const>
15481	<const name="OnRuntimeError" value="57">
15482	<desc>
15483	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
15484	</desc>
15485	</const>
15486	<const name="OnCanShowWindow" value="58">
15487	<desc>
15488	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
15489	</desc>
15490	</const>
15491	<const name="OnShowWindow" value="59">
15492	<desc>
15493	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
15494	</desc>
15495	</const>
15496	<const name="OnCPUChanged" value="60">
15497	<desc>
15498	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
15499	</desc>
15500	</const>
15501	<const name="OnVRDEServerInfoChanged" value="61">
15502	<desc>
15503	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
15504	</desc>
15505	</const>
15506	<const name="OnEventSourceChanged" value="62">
15507	<desc>
15508	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
15509	</desc>
15510	</const>
15511	<const name="OnCPUExecutionCapChanged" value="63">
15512	<desc>
15513	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
15514	</desc>
15515	</const>
15516	<const name="OnGuestKeyboard" value="64">
15517	<desc>
15518	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
15519	</desc>
15520	</const>
15521	<const name="OnGuestMouse" value="65">
15522	<desc>
15523	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
15524	</desc>
15525	</const>
15526	<const name="OnNATRedirect" value="66">
15527	<desc>
15528	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
15529	</desc>
15530	</const>
15531	<const name="OnHostPciDevicePlug" value="67">
15532	<desc>
15533	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
15534	</desc>
15535	</const>
15536	<const name="OnVBoxSVCAvailabilityChanged" value="68">
15537	<desc>
15538	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
15539	</desc>
15540	</const>
15541	<const name="OnBandwidthGroupChanged" value="69">
15542	<desc>
15543	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
15544	</desc>
15545	</const>
15546	<const name="OnGuestMonitorChanged" value="70">
15547	<desc>
15548	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
15549	</desc>
15550	</const>
15551
15552	<!-- Last event marker -->
15553	<const name="Last" value="71">
15554	<desc>
15555	Must be last event, used for iterations and structures relying on numerical event values.
15556	</desc>
15557	</const>
15558
15559	</enum>
15560
15561	<interface
15562	name="IEventSource" extends="$unknown"
15563	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
15564	wsmap="managed"
15565	>
15566	<desc>
15567	Event source. Generally, any object which could generate events can be an event source,
15568	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
15569	an event source can work with listeners in either active or passive mode. In active mode it is up to
15570	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
15571	event source keeps track of pending events for each listener and returns available events on demand.
15572
15573	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15574	</desc>
15575
15576	<method name="createListener">
15577	<desc>
15578	Creates a new listener object, useful for passive mode.
15579	</desc>
15580	<param name="listener" type="IEventListener" dir="return"/>
15581	</method>
15582
15583	<method name="createAggregator">
15584	<desc>
15585	Creates an aggregator event source, collecting events from multiple sources.
15586	This way a single listener can listen for events coming from multiple sources,
15587	using a single blocking getEvent() on the returned aggregator.
15588	</desc>
15589	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
15590	<desc>
15591	Subordinate event source this one aggregatres.
15592	</desc>
15593	</param>
15594	<param name="result" type="IEventSource" dir="return">
15595	<desc>
15596	Event source aggregating passed sources.
15597	</desc>
15598	</param>
15599	</method>
15600
15601	<method name="registerListener">
15602	<desc>
15603	Register an event listener.
15604
15605	<note>
15606	To avoid system overload, the VirtualBox server process checks if passive event
15607	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
15608	current implementation, if more than 500 pending events are detected for a passive
15609	event listener, it is forcefully unregistered by the system, and further
15610	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
15611	</note>
15612	</desc>
15613	<param name="listener" type="IEventListener" dir="in">
15614	<desc>Listener to register.</desc>
15615	</param>
15616	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
15617	<desc>
15618	Event types listener is interested in. One can use wildcards like -
15619	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
15620	than one event.
15621	</desc>
15622	</param>
15623	<param name="active" type="boolean" dir="in">
15624	<desc>
15625	Which mode this listener is operating in.
15626	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
15627	In passive mode, an internal event queue is created for this this IEventListener.
15628	For each event coming in, it is added to queues for all interested registered passive
15629	listeners. It is then up to the external code to call the listener's
15630	<link to="IEventListener::handleEvent" /> method. When done with an event, the
15631	external code must call <link to="#eventProcessed" />.
15632	</desc>
15633	</param>
15634	</method>
15635
15636	<method name="unregisterListener">
15637	<desc>
15638	Unregister an event listener. If listener is passive, and some waitable events are still
15639	in queue they are marked as processed automatically.
15640	</desc>
15641	<param name="listener" type="IEventListener" dir="in">
15642	<desc>Listener to unregister.</desc>
15643	</param>
15644	</method>
15645
15646	<method name="fireEvent">
15647	<desc>
15648	Fire an event for this source.
15649	</desc>
15650	<param name="event" type="IEvent" dir="in">
15651	<desc>Event to deliver.</desc>
15652	</param>
15653	<param name="timeout" type="long" dir="in">
15654	<desc>
15655	Maximum time to wait for event processing (if event is waitable), in ms;
15656	0 = no wait, -1 = indefinite wait.
15657	</desc>
15658	</param>
15659	<param name="result" type="boolean" dir="return">
15660	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
15661	</param>
15662	</method>
15663
15664	<method name="getEvent">
15665	<desc>
15666	Get events from this peer's event queue (for passive mode). Calling this method
15667	regularly is required for passive event listeners to avoid system overload;
15668	see <link to="IEventSource::registerListener" /> for details.
15669
15670	<result name="VBOX_E_OBJECT_NOT_FOUND">
15671	Listener is not registered, or autounregistered.
15672	</result>
15673	</desc>
15674	<param name="listener" type="IEventListener" dir="in">
15675	<desc>Which listener to get data for.</desc>
15676	</param>
15677	<param name="timeout" type="long" dir="in">
15678	<desc>
15679	Maximum time to wait for events, in ms;
15680	0 = no wait, -1 = indefinite wait.
15681	</desc>
15682	</param>
15683	<param name="event" type="IEvent" dir="return">
15684	<desc>Event retrieved, or null if none available.</desc>
15685	</param>
15686	</method>
15687
15688	<method name="eventProcessed">
15689	<desc>
15690	Must be called for waitable events after a particular listener finished its
15691	event processing. When all listeners of a particular event have called this
15692	method, the system will then call <link to="IEvent::setProcessed" />.
15693	</desc>
15694	<param name="listener" type="IEventListener" dir="in">
15695	<desc>Which listener processed event.</desc>
15696	</param>
15697	<param name="event" type="IEvent" dir="in">
15698	<desc>Which event.</desc>
15699	</param>
15700	</method>
15701
15702	</interface>
15703
15704	<interface
15705	name="IEventListener" extends="$unknown"
15706	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
15707	wsmap="managed"
15708	>
15709	<desc>
15710	Event listener. An event listener can work in either active or passive mode, depending on the way
15711	it was registered.
15712	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
15713	</desc>
15714
15715	<method name="handleEvent">
15716	<desc>
15717	Handle event callback for active listeners. It is not called for passive listeners. After
15718	calling handleEvent() on all active listeners and having received acknowledgement from all
15719	passive listeners via IEventSource::eventProcessed(), the event is marked as processed and
15720	IEvent::waitProcessed() will return immediately.
15721	</desc>
15722	<param name="event" type="IEvent" dir="in">
15723	<desc>Event available.</desc>
15724	</param>
15725	</method>
15726
15727	</interface>
15728
15729	<interface
15730	name="IEvent" extends="$unknown"
15731	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
15732	wsmap="managed"
15733	>
15734	<desc>
15735	Abstract parent interface for VirtualBox events. Actual events will typically implement
15736	a more specific interface which derives from this (see below).
15737
15738	<b>Introduction to VirtualBox events</b>
15739
15740	Generally speaking, an event (represented by this interface) signals that something
15741	happened, while an event listener (see <link to="IEventListener" />) represents an
15742	entity that is interested in certain events. In order for this to work with
15743	unidirectional protocols (i.e. web services), the concepts of passive and active
15744	listener are used.
15745
15746	Event consumers can register themselves as listeners, providing an array of
15747	events they are interested in (see <link to="IEventSource::registerListener" />).
15748	When an event triggers, the listener is notified about the event. The exact
15749	mechanism of the notification depends on whether the listener was registered as
15750	an active or passive listener:
15751
15752	<ul>
15753	<li>An active listener is very similar to a callback: it is a function invoked
15754	by the API. As opposed to the callbacks that were used in the API before
15755	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
15756	</li>
15757
15758	<li>Passive listeners are somewhat trickier to implement, but do not require
15759	a client function to be callable, which is not an option with scripting
15760	languages or web service clients. Internally the <link to="IEventSource" />
15761	implementation maintains an event queue for each passive listener, and
15762	newly arrived events are put in this queue. When the listener calls
15763	<link to="IEventSource::getEvent"/>, first element from its internal event
15764	queue is returned. When the client completes processing of an event,
15765	the <link to="IEventSource::eventProcessed" /> function must be called,
15766	acknowledging that the event was processed. It supports implementing
15767	waitable events. On passive listener unregistration, all events from its
15768	queue are auto-acknowledged.
15769	</li>
15770	</ul>
15771
15772	Waitable events are useful in situations where the event generator wants to track
15773	delivery or a party wants to wait until all listeners have completed the event. A
15774	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
15775	listeners might veto a certain action, and thus the event producer has to make
15776	sure that all listeners have processed the event and not vetoed before taking
15777	the action.
15778
15779	A given event may have both passive and active listeners at the same time.
15780
15781	<b>Using events</b>
15782
15783	Any VirtualBox object capable of producing externally visible events provides an
15784	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
15785	This event source object is notified by VirtualBox once something has happened, so
15786	consumers may register event listeners with this event source. To register a listener,
15787	an object implementing the <link to="IEventListener" /> interface must be provided.
15788	For active listeners, such an object is typically created by the consumer, while for
15789	passive listeners <link to="IEventSource::createListener" /> should be used. Please
15790	note that a listener created with @c createListener() must not be used as an active listener.
15791
15792	Once created, the listener must be registered to listen for the desired events
15793	(see <link to="IEventSource::registerListener" />), providing an array of
15794	<link to="VBoxEventType" /> enums. Those elements can either be the individual
15795	event IDs or wildcards matching multiple event IDs.
15796
15797	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
15798	called automatically when the event is triggered, while passive listeners have to call
15799	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
15800	an event processing loop.
15801
15802	The IEvent interface is an abstract parent interface for all such VirtualBox events
15803	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
15804	or the event processing loop is to check the <link to="#type" /> attribute of the event and
15805	then cast to the appropriate specific interface using @c QueryInterface().
15806	</desc>
15807
15808	<attribute name="type" readonly="yes" type="VBoxEventType">
15809	<desc>
15810	Event type.
15811	</desc>
15812	</attribute>
15813
15814	<attribute name="source" readonly="yes" type="IEventSource">
15815	<desc>
15816	Source of this event.
15817	</desc>
15818	</attribute>
15819
15820	<attribute name="waitable" readonly="yes" type="boolean">
15821	<desc>
15822	If we can wait for this event being processed. If false, waitProcessed() returns immediately,
15823	and setProcessed() doesn't make sense. Non-waitable events are generally better performing,
15824	as no additional overhead associated with waitability imposed.
15825	Waitable events are needed when one need to be able to wait for particular event processed,
15826	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
15827	until all consumers confirmed events.
15828	</desc>
15829	</attribute>
15830
15831	<method name="setProcessed">
15832	<desc>
15833	Internal method called by the system when all listeners of a particular event have called
15834	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
15835	</desc>
15836	</method>
15837
15838	<method name="waitProcessed">
15839	<desc>
15840	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
15841	described semantics, for non-waitable returns true immediately.
15842	</desc>
15843	<param name="timeout" type="long" dir="in">
15844	<desc>
15845	Maximum time to wait for event processeing, in ms;
15846	0 = no wait, -1 = indefinite wait.
15847	</desc>
15848	</param>
15849	<param name="result" type="boolean" dir="return">
15850	<desc>If this event was processed before timeout.</desc>
15851	</param>
15852	</method>
15853	</interface>
15854
15855
15856	<interface
15857	name="IReusableEvent" extends="IEvent"
15858	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
15859	wsmap="managed"
15860	>
15861	<desc>Base abstract interface for all reusable events.</desc>
15862
15863	<attribute name="generation" readonly="yes" type="unsigned long">
15864	<desc>Current generation of event, incremented on reuse.</desc>
15865	</attribute>
15866
15867	<method name="reuse">
15868	<desc>
15869	Marks an event as reused, increments 'generation', fields shall no
15870	longer be considered valid.
15871	</desc>
15872	</method>
15873	</interface>
15874
15875	<interface
15876	name="IMachineEvent" extends="IEvent"
15877	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
15878	wsmap="managed" id="MachineEvent"
15879	>
15880	<desc>Base abstract interface for all machine events.</desc>
15881
15882	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
15883	<desc>ID of the machine this event relates to.</desc>
15884	</attribute>
15885
15886	</interface>
15887
15888	<interface
15889	name="IMachineStateChangedEvent" extends="IMachineEvent"
15890	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
15891	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
15892	>
15893	<desc>Machine state change event.</desc>
15894
15895	<attribute name="state" readonly="yes" type="MachineState">
15896	<desc>New execution state.</desc>
15897	</attribute>
15898	</interface>
15899
15900	<interface
15901	name="IMachineDataChangedEvent" extends="IMachineEvent"
15902	uuid="6AA70A6C-0DCA-4810-8C5C-457B278E3D49"
15903	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
15904	>
15905	<desc>
15906	Any of the settings of the given machine has changed.
15907	</desc>
15908	</interface>
15909
15910	<interface
15911	name="IMediumRegisteredEvent" extends="IEvent"
15912	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
15913	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
15914	>
15915	<desc>
15916	The given medium was registered or unregistered
15917	within this VirtualBox installation.
15918	</desc>
15919
15920	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
15921	<desc>ID of the medium this event relates to.</desc>
15922	</attribute>
15923
15924	<attribute name="mediumType" readonly="yes" type="DeviceType">
15925	<desc>Type of the medium this event relates to.</desc>
15926	</attribute>
15927
15928	<attribute name="registered" type="boolean" readonly="yes">
15929	<desc>
15930	If @c true, the medium was registered, otherwise it was
15931	unregistered.
15932	</desc>
15933	</attribute>
15934	</interface>
15935
15936	<interface
15937	name="IMachineRegisteredEvent" extends="IMachineEvent"
15938	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
15939	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
15940	>
15941	<desc>
15942	The given machine was registered or unregistered
15943	within this VirtualBox installation.
15944	</desc>
15945
15946	<attribute name="registered" type="boolean" readonly="yes">
15947	<desc>
15948	If @c true, the machine was registered, otherwise it was
15949	unregistered.
15950	</desc>
15951	</attribute>
15952	</interface>
15953
15954	<interface
15955	name="ISessionStateChangedEvent" extends="IMachineEvent"
15956	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
15957	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
15958	>
15959	<desc>
15960	The state of the session for the given machine was changed.
15961	<see>IMachine::sessionState</see>
15962	</desc>
15963
15964	<attribute name="state" type="SessionState" readonly="yes">
15965	<desc>
15966	New session state.
15967	</desc>
15968	</attribute>
15969	</interface>
15970
15971	<interface
15972	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
15973	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
15974	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
15975	>
15976	<desc>
15977	Notification when a guest property has changed.
15978	</desc>
15979
15980	<attribute name="name" readonly="yes" type="wstring">
15981	<desc>
15982	The name of the property that has changed.
15983	</desc>
15984	</attribute>
15985
15986	<attribute name="value" readonly="yes" type="wstring">
15987	<desc>
15988	The new property value.
15989	</desc>
15990	</attribute>
15991
15992	<attribute name="flags" readonly="yes" type="wstring">
15993	<desc>
15994	The new property flags.
15995	</desc>
15996	</attribute>
15997
15998	</interface>
15999
16000	<interface
16001	name="ISnapshotEvent" extends="IMachineEvent"
16002	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
16003	wsmap="managed" id="SnapshotEvent"
16004	>
16005	<desc>Base interface for all snapshot events.</desc>
16006
16007	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
16008	<desc>ID of the snapshot this event relates to.</desc>
16009	</attribute>
16010
16011	</interface>
16012
16013	<interface
16014	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
16015	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
16016	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
16017	>
16018	<desc>
16019	A new snapshot of the machine has been taken.
16020	<see>ISnapshot</see>
16021	</desc>
16022	</interface>
16023
16024	<interface
16025	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
16026	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
16027	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
16028	>
16029	<desc>
16030	Snapshot of the given machine has been deleted.
16031
16032	<note>
16033	This notification is delivered <b>after</b> the snapshot
16034	object has been uninitialized on the server (so that any
16035	attempt to call its methods will return an error).
16036	</note>
16037
16038	<see>ISnapshot</see>
16039	</desc>
16040	</interface>
16041
16042	<interface
16043	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
16044	uuid="07541941-8079-447a-a33e-47a69c7980db"
16045	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
16046	>
16047	<desc>
16048	Snapshot properties (name and/or description) have been changed.
16049	<see>ISnapshot</see>
16050	</desc>
16051	</interface>
16052
16053	<interface
16054	name="IMousePointerShapeChangedEvent" extends="IEvent"
16055	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
16056	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
16057	>
16058	<desc>
16059	Notification when the guest mouse pointer shape has
16060	changed. The new shape data is given.
16061	</desc>
16062
16063	<attribute name="visible" type="boolean" readonly="yes">
16064	<desc>
16065	Flag whether the pointer is visible.
16066	</desc>
16067	</attribute>
16068	<attribute name="alpha" type="boolean" readonly="yes">
16069	<desc>
16070	Flag whether the pointer has an alpha channel.
16071	</desc>
16072	</attribute>
16073	<attribute name="xhot" type="unsigned long" readonly="yes">
16074	<desc>
16075	The pointer hot spot X coordinate.
16076	</desc>
16077	</attribute>
16078	<attribute name="yhot" type="unsigned long" readonly="yes">
16079	<desc>
16080	The pointer hot spot Y coordinate.
16081	</desc>
16082	</attribute>
16083	<attribute name="width" type="unsigned long" readonly="yes">
16084	<desc>
16085	Width of the pointer shape in pixels.
16086	</desc>
16087	</attribute>
16088	<attribute name="height" type="unsigned long" readonly="yes">
16089	<desc>
16090	Height of the pointer shape in pixels.
16091	</desc>
16092	</attribute>
16093	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
16094	<desc>
16095	Shape buffer arrays.
16096
16097	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
16098	followed by a 32-bpp XOR (color) mask.
16099
16100	For pointers without alpha channel the XOR mask pixels are 32
16101	bit values: (lsb)BGR0(msb). For pointers with alpha channel
16102	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
16103
16104	An AND mask is used for pointers with alpha channel, so if the
16105	callback does not support alpha, the pointer could be
16106	displayed as a normal color pointer.
16107
16108	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
16109	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
16110	height</tt>. The padding bits at the end of each scanline are
16111	undefined.
16112
16113	The XOR mask follows the AND mask on the next 4-byte aligned
16114	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
16115	Bytes in the gap between the AND and the XOR mask are undefined.
16116	The XOR mask scanlines have no gap between them and the size of
16117	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
16118
16119	<note>
16120	If @a shape is 0, only the pointer visibility is changed.
16121	</note>
16122	</desc>
16123	</attribute>
16124	</interface>
16125
16126	<interface
16127	name="IMouseCapabilityChangedEvent" extends="IEvent"
16128	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
16129	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
16130	>
16131	<desc>
16132	Notification when the mouse capabilities reported by the
16133	guest have changed. The new capabilities are passed.
16134	</desc>
16135	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
16136	<desc>
16137	Supports absolute coordinates.
16138	</desc>
16139	</attribute>
16140	<attribute name="supportsRelative" type="boolean" readonly="yes">
16141	<desc>
16142	Supports relative coordinates.
16143	</desc>
16144	</attribute>
16145	<attribute name="needsHostCursor" type="boolean" readonly="yes">
16146	<desc>
16147	If host cursor is needed.
16148	</desc>
16149	</attribute>
16150	</interface>
16151
16152	<interface
16153	name="IKeyboardLedsChangedEvent" extends="IEvent"
16154	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
16155	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
16156	>
16157	<desc>
16158	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
16159	to alter the state of the keyboard LEDs.
16160	</desc>
16161	<attribute name="numLock" type="boolean" readonly="yes">
16162	<desc>
16163	NumLock status.
16164	</desc>
16165	</attribute>
16166	<attribute name="capsLock" type="boolean" readonly="yes">
16167	<desc>
16168	CapsLock status.
16169	</desc>
16170	</attribute>
16171	<attribute name="scrollLock" type="boolean" readonly="yes">
16172	<desc>
16173	ScrollLock status.
16174	</desc>
16175	</attribute>
16176	</interface>
16177
16178	<interface
16179	name="IStateChangedEvent" extends="IEvent"
16180	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
16181	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
16182	>
16183	<desc>
16184	Notification when the execution state of the machine has changed.
16185	The new state is given.
16186	</desc>
16187	<attribute name="state" type="MachineState" readonly="yes">
16188	<desc>
16189	New machine state.
16190	</desc>
16191	</attribute>
16192	</interface>
16193
16194	<interface
16195	name="IAdditionsStateChangedEvent" extends="IEvent"
16196	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
16197	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
16198	>
16199	<desc>
16200	Notification when a Guest Additions property changes.
16201	Interested callees should query IGuest attributes to
16202	find out what has changed.
16203	</desc>
16204	</interface>
16205
16206	<interface
16207	name="INetworkAdapterChangedEvent" extends="IEvent"
16208	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
16209	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
16210	>
16211	<desc>
16212	Notification when a property of one of the
16213	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
16214	changes. Interested callees should use INetworkAdapter methods and
16215	attributes to find out what has changed.
16216	</desc>
16217	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
16218	<desc>
16219	Network adapter that is subject to change.
16220	</desc>
16221	</attribute>
16222	</interface>
16223
16224	<interface
16225	name="ISerialPortChangedEvent" extends="IEvent"
16226	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
16227	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
16228	>
16229	<desc>
16230	Notification when a property of one of the
16231	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
16232	Interested callees should use ISerialPort methods and attributes
16233	to find out what has changed.
16234	</desc>
16235	<attribute name="serialPort" type="ISerialPort" readonly="yes">
16236	<desc>
16237	Serial port that is subject to change.
16238	</desc>
16239	</attribute>
16240	</interface>
16241
16242	<interface
16243	name="IParallelPortChangedEvent" extends="IEvent"
16244	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
16245	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
16246	>
16247	<desc>
16248	Notification when a property of one of the
16249	virtual <link to="IMachine::getParallelPort">parallel ports</link>
16250	changes. Interested callees should use ISerialPort methods and
16251	attributes to find out what has changed.
16252	</desc>
16253	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
16254	<desc>
16255	Parallel port that is subject to change.
16256	</desc>
16257	</attribute>
16258	</interface>
16259
16260	<interface
16261	name="IStorageControllerChangedEvent" extends="IEvent"
16262	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
16263	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
16264	>
16265	<desc>
16266	Notification when a
16267	<link to="IMachine::mediumAttachments">medium attachment</link>
16268	changes.
16269	</desc>
16270	</interface>
16271
16272	<interface
16273	name="IMediumChangedEvent" extends="IEvent"
16274	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
16275	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
16276	>
16277	<desc>
16278	Notification when a
16279	<link to="IMachine::mediumAttachments">medium attachment</link>
16280	changes.
16281	</desc>
16282	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
16283	<desc>
16284	Medium attachment that is subject to change.
16285	</desc>
16286	</attribute>
16287	</interface>
16288
16289	<interface
16290	name="ICPUChangedEvent" extends="IEvent"
16291	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
16292	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
16293	>
16294	<desc>
16295	Notification when a CPU changes.
16296	</desc>
16297	<attribute name="cpu" type="unsigned long" readonly="yes">
16298	<desc>
16299	The CPU which changed.
16300	</desc>
16301	</attribute>
16302	<attribute name="add" type="boolean" readonly="yes">
16303	<desc>
16304	Flag whether the CPU was added or removed.
16305	</desc>
16306	</attribute>
16307	</interface>
16308
16309	<interface
16310	name="ICPUExecutionCapChangedEvent" extends="IEvent"
16311	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
16312	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
16313	>
16314	<desc>
16315	Notification when the CPU execution cap changes.
16316	</desc>
16317	<attribute name="executionCap" type="unsigned long" readonly="yes">
16318	<desc>
16319	The new CPU execution cap value. (1-100)
16320	</desc>
16321	</attribute>
16322	</interface>
16323
16324	<interface
16325	name="IGuestKeyboardEvent" extends="IEvent"
16326	uuid="88394258-7006-40d4-b339-472ee3801844"
16327	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
16328	>
16329	<desc>
16330	Notification when guest keyboard event happens.
16331	</desc>
16332	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
16333	<desc>
16334	Array of scancodes.
16335	</desc>
16336	</attribute>
16337	</interface>
16338
16339	<interface
16340	name="IGuestMouseEvent" extends="IReusableEvent"
16341	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
16342	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
16343	>
16344	<desc>
16345	Notification when guest mouse event happens.
16346	</desc>
16347
16348	<attribute name="absolute" type="boolean" readonly="yes">
16349	<desc>
16350	If this event is relative or absolute.
16351	</desc>
16352	</attribute>
16353
16354	<attribute name="x" type="long" readonly="yes">
16355	<desc>
16356	New X position, or X delta.
16357	</desc>
16358	</attribute>
16359
16360	<attribute name="y" type="long" readonly="yes">
16361	<desc>
16362	New Y position, or Y delta.
16363	</desc>
16364	</attribute>
16365
16366	<attribute name="z" type="long" readonly="yes">
16367	<desc>
16368	Z delta.
16369	</desc>
16370	</attribute>
16371
16372	<attribute name="w" type="long" readonly="yes">
16373	<desc>
16374	W delta.
16375	</desc>
16376	</attribute>
16377
16378	<attribute name="buttons" type="long" readonly="yes">
16379	<desc>
16380	Button state bitmask.
16381	</desc>
16382	</attribute>
16383
16384	</interface>
16385
16386
16387	<interface
16388	name="IVRDEServerChangedEvent" extends="IEvent"
16389	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
16390	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
16391	>
16392	<desc>
16393	Notification when a property of the
16394	<link to="IMachine::VRDEServer">VRDE server</link> changes.
16395	Interested callees should use IVRDEServer methods and attributes to
16396	find out what has changed.
16397	</desc>
16398	</interface>
16399
16400	<interface
16401	name="IVRDEServerInfoChangedEvent" extends="IEvent"
16402	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
16403	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
16404	>
16405	<desc>
16406	Notification when the status of the VRDE server changes. Interested callees
16407	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
16408	attributes to find out what is the current status.
16409	</desc>
16410	</interface>
16411
16412	<interface
16413	name="IUSBControllerChangedEvent" extends="IEvent"
16414	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
16415	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
16416	>
16417	<desc>
16418	Notification when a property of the virtual
16419	<link to="IMachine::USBController">USB controller</link> changes.
16420	Interested callees should use IUSBController methods and attributes to
16421	find out what has changed.
16422	</desc>
16423	</interface>
16424
16425	<interface
16426	name="IUSBDeviceStateChangedEvent" extends="IEvent"
16427	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
16428	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
16429	>
16430	<desc>
16431	Notification when a USB device is attached to or detached from
16432	the virtual USB controller.
16433
16434	This notification is sent as a result of the indirect
16435	request to attach the device because it matches one of the
16436	machine USB filters, or as a result of the direct request
16437	issued by <link to="IConsole::attachUSBDevice"/> or
16438	<link to="IConsole::detachUSBDevice"/>.
16439
16440	This notification is sent in case of both a succeeded and a
16441	failed request completion. When the request succeeds, the
16442	@a error parameter is @c null, and the given device has been
16443	already added to (when @a attached is @c true) or removed from
16444	(when @a attached is @c false) the collection represented by
16445	<link to="IConsole::USBDevices"/>. On failure, the collection
16446	doesn't change and the @a error parameter represents the error
16447	message describing the failure.
16448	</desc>
16449	<attribute name="device" type="IUSBDevice" readonly="yes">
16450	<desc>
16451	Device that is subject to state change.
16452	</desc>
16453	</attribute>
16454	<attribute name="attached" type="boolean" readonly="yes">
16455	<desc>
16456	@c true if the device was attached and @c false otherwise.
16457	</desc>
16458	</attribute>
16459	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
16460	<desc>
16461	@c null on success or an error message object on failure.
16462	</desc>
16463	</attribute>
16464	</interface>
16465
16466	<interface
16467	name="ISharedFolderChangedEvent" extends="IEvent"
16468	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
16469	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
16470	>
16471	<desc>
16472	Notification when a shared folder is added or removed.
16473	The @a scope argument defines one of three scopes:
16474	<link to="IVirtualBox::sharedFolders">global shared folders</link>
16475	(<link to="Scope_Global">Global</link>),
16476	<link to="IMachine::sharedFolders">permanent shared folders</link> of
16477	the machine (<link to="Scope_Machine">Machine</link>) or <link
16478	to="IConsole::sharedFolders">transient shared folders</link> of the
16479	machine (<link to="Scope_Session">Session</link>). Interested callees
16480	should use query the corresponding collections to find out what has
16481	changed.
16482	</desc>
16483	<attribute name="scope" type="Scope" readonly="yes">
16484	<desc>
16485	Scope of the notification.
16486	</desc>
16487	</attribute>
16488	</interface>
16489
16490	<interface
16491	name="IRuntimeErrorEvent" extends="IEvent"
16492	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
16493	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
16494	>
16495	<desc>
16496	Notification when an error happens during the virtual
16497	machine execution.
16498
16499	There are three kinds of runtime errors:
16500	<ul>
16501	<li><i>fatal</i></li>
16502	<li><i>non-fatal with retry</i></li>
16503	<li><i>non-fatal warnings</i></li>
16504	</ul>
16505
16506	<b>Fatal</b> errors are indicated by the @a fatal parameter set
16507	to @c true. In case of fatal errors, the virtual machine
16508	execution is always paused before calling this notification, and
16509	the notification handler is supposed either to immediately save
16510	the virtual machine state using <link to="IConsole::saveState"/>
16511	or power it off using <link to="IConsole::powerDown"/>.
16512	Resuming the execution can lead to unpredictable results.
16513
16514	<b>Non-fatal</b> errors and warnings are indicated by the
16515	@a fatal parameter set to @c false. If the virtual machine
16516	is in the Paused state by the time the error notification is
16517	received, it means that the user can <i>try to resume</i> the machine
16518	execution after attempting to solve the problem that caused the
16519	error. In this case, the notification handler is supposed
16520	to show an appropriate message to the user (depending on the
16521	value of the @a id parameter) that offers several actions such
16522	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
16523	wants to retry, the notification handler should continue
16524	the machine execution using the <link to="IConsole::resume"/>
16525	call. If the machine execution is not Paused during this
16526	notification, then it means this notification is a <i>warning</i>
16527	(for example, about a fatal condition that can happen very soon);
16528	no immediate action is required from the user, the machine
16529	continues its normal execution.
16530
16531	Note that in either case the notification handler
16532	<b>must not</b> perform any action directly on a thread
16533	where this notification is called. Everything it is allowed to
16534	do is to post a message to another thread that will then talk
16535	to the user and take the corresponding action.
16536
16537	Currently, the following error identifiers are known:
16538	<ul>
16539	<li><tt>"HostMemoryLow"</tt></li>
16540	<li><tt>"HostAudioNotResponding"</tt></li>
16541	<li><tt>"VDIStorageFull"</tt></li>
16542	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
16543	</ul>
16544	</desc>
16545	<attribute name="fatal" type="boolean" readonly="yes">
16546	<desc>
16547	Whether the error is fatal or not.
16548	</desc>
16549	</attribute>
16550	<attribute name="id" type="wstring" readonly="yes">
16551	<desc>
16552	Error identifier.
16553	</desc>
16554	</attribute>
16555	<attribute name="message" type="wstring" readonly="yes">
16556	<desc>
16557	Optional error message.
16558	</desc>
16559	</attribute>
16560	</interface>
16561
16562
16563	<interface
16564	name="IEventSourceChangedEvent" extends="IEvent"
16565	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
16566	waitable="yes"
16567	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
16568	>
16569	<desc>
16570	Notification when an event source state changes (listener added or removed).
16571	</desc>
16572
16573	<attribute name="listener" type="IEventListener" readonly="yes">
16574	<desc>
16575	Event listener which has changed.
16576	</desc>
16577	</attribute>
16578
16579	<attribute name="add" type="boolean" readonly="yes">
16580	<desc>
16581	Flag whether listener was added or removed.
16582	</desc>
16583	</attribute>
16584	</interface>
16585
16586	<interface
16587	name="IExtraDataChangedEvent" extends="IEvent"
16588	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
16589	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
16590	>
16591	<desc>
16592	Notification when machine specific or global extra data
16593	has changed.
16594	</desc>
16595	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16596	<desc>
16597	ID of the machine this event relates to.
16598	Null for global extra data changes.
16599	</desc>
16600	</attribute>
16601	<attribute name="key" type="wstring" readonly="yes">
16602	<desc>
16603	Extra data key that has changed.
16604	</desc>
16605	</attribute>
16606	<attribute name="value" type="wstring" readonly="yes">
16607	<desc>
16608	Extra data value for the given key.
16609	</desc>
16610	</attribute>
16611	</interface>
16612
16613	<interface
16614	name="IVetoEvent" extends="IEvent"
16615	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
16616	wsmap="managed"
16617	>
16618	<desc>Base abstract interface for veto events.</desc>
16619
16620	<method name="addVeto">
16621	<desc>
16622	Adds a veto on this event.
16623	</desc>
16624	<param name="reason" type="wstring" dir="in">
16625	<desc>
16626	Reason for veto, could be null or empty string.
16627	</desc>
16628	</param>
16629	</method>
16630
16631	<method name="isVetoed">
16632	<desc>
16633	If this event was vetoed.
16634	</desc>
16635	<param name="result" type="boolean" dir="return">
16636	<desc>
16637	Reason for veto.
16638	</desc>
16639	</param>
16640	</method>
16641
16642	<method name="getVetos">
16643	<desc>
16644	Current veto reason list, if size is 0 - no veto.
16645	</desc>
16646	<param name="result" type="wstring" dir="return" safearray="yes">
16647	<desc>
16648	Array of reasons for veto provided by different event handlers.
16649	</desc>
16650	</param>
16651	</method>
16652
16653	</interface>
16654
16655	<interface
16656	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
16657	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
16658	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
16659	waitable="true"
16660	>
16661	<desc>
16662	Notification when someone tries to change extra data for
16663	either the given machine or (if @c null) global extra data.
16664	This gives the chance to veto against changes.
16665	</desc>
16666	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
16667	<desc>
16668	ID of the machine this event relates to.
16669	Null for global extra data changes.
16670	</desc>
16671	</attribute>
16672	<attribute name="key" type="wstring" readonly="yes">
16673	<desc>
16674	Extra data key that has changed.
16675	</desc>
16676	</attribute>
16677	<attribute name="value" type="wstring" readonly="yes">
16678	<desc>
16679	Extra data value for the given key.
16680	</desc>
16681	</attribute>
16682	</interface>
16683
16684	<interface
16685	name="ICanShowWindowEvent" extends="IVetoEvent"
16686	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
16687	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
16688	waitable="true"
16689	>
16690	<desc>
16691	Notification when a call to
16692	<link to="IMachine::canShowConsoleWindow"/> is made by a
16693	front-end to check if a subsequent call to
16694	<link to="IMachine::showConsoleWindow"/> can succeed.
16695
16696	The callee should give an answer appropriate to the current
16697	machine state using event veto. This answer must
16698	remain valid at least until the next
16699	<link to="IConsole::state">machine state</link> change.
16700	</desc>
16701	</interface>
16702
16703	<interface
16704	name="IShowWindowEvent" extends="IEvent"
16705	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
16706	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
16707	waitable="true"
16708	>
16709	<desc>
16710	Notification when a call to
16711	<link to="IMachine::showConsoleWindow"/>
16712	requests the console window to be activated and brought to
16713	foreground on the desktop of the host PC.
16714
16715	This notification should cause the VM console process to
16716	perform the requested action as described above. If it is
16717	impossible to do it at a time of this notification, this
16718	method should return a failure.
16719
16720	Note that many modern window managers on many platforms
16721	implement some sort of focus stealing prevention logic, so
16722	that it may be impossible to activate a window without the
16723	help of the currently active application (which is supposedly
16724	an initiator of this notification). In this case, this method
16725	must return a non-zero identifier that represents the
16726	top-level window of the VM console process. The caller, if it
16727	represents a currently active process, is responsible to use
16728	this identifier (in a platform-dependent manner) to perform
16729	actual window activation.
16730
16731	This method must set @a winId to zero if it has performed all
16732	actions necessary to complete the request and the console
16733	window is now active and in foreground, to indicate that no
16734	further action is required on the caller's side.
16735	</desc>
16736	<attribute name="winId" type="long long">
16737	<desc>
16738	Platform-dependent identifier of the top-level VM console
16739	window, or zero if this method has performed all actions
16740	necessary to implement the <i>show window</i> semantics for
16741	the given platform and/or this VirtualBox front-end.
16742	</desc>
16743	</attribute>
16744	</interface>
16745
16746	<interface
16747	name="INATRedirectEvent" extends="IMachineEvent"
16748	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
16749	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
16750	>
16751	<desc>
16752	Notification when NAT redirect rule added or removed.
16753	</desc>
16754	<attribute name="slot" type="unsigned long" readonly="yes">
16755	<desc>
16756	Adapter which NAT attached to.
16757	</desc>
16758	</attribute>
16759	<attribute name="remove" type="boolean" readonly="yes">
16760	<desc>
16761	Whether rule remove or add.
16762	</desc>
16763	</attribute>
16764	<attribute name="name" type="wstring" readonly="yes">
16765	<desc>
16766	Name of the rule.
16767	</desc>
16768	</attribute>
16769	<attribute name="proto" type="NATProtocol" readonly="yes">
16770	<desc>
16771	Protocol (TCP or UDP) of the redirect rule.
16772	</desc>
16773	</attribute>
16774	<attribute name="hostIp" type="wstring" readonly="yes">
16775	<desc>
16776	Host ip address to bind socket on.
16777	</desc>
16778	</attribute>
16779	<attribute name="hostPort" type="long" readonly="yes">
16780	<desc>
16781	Host port to bind socket on.
16782	</desc>
16783	</attribute>
16784	<attribute name="guestIp" type="wstring" readonly="yes">
16785	<desc>
16786	Guest ip address to redirect to.
16787	</desc>
16788	</attribute>
16789	<attribute name="guestPort" type="long" readonly="yes">
16790	<desc>
16791	Guest port to redirect to.
16792	</desc>
16793	</attribute>
16794	</interface>
16795
16796	<interface
16797	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
16798	waitable="yes"
16799	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
16800	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
16801	>
16802	<desc>
16803	Notification when host PCI device is plugged/unplugged. Plugging
16804	usually takes place on VM startup, unplug - when
16805	IMachine::DetachHostPciDevice is called.
16806
16807	<see>IMachine::DetachHostPciDevice</see>
16808
16809	</desc>
16810
16811	<attribute name="plugged" type="boolean" readonly="yes">
16812	<desc>
16813	If device successfully plugged or unplugged.
16814	</desc>
16815	</attribute>
16816
16817	<attribute name="success" type="boolean" readonly="yes">
16818	<desc>
16819	If operation was successful, if false - 'message' attribute
16820	may be of interest.
16821	</desc>
16822	</attribute>
16823
16824	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
16825	<desc>
16826	Attachment info for this device.
16827	</desc>
16828	</attribute>
16829
16830	<attribute name="message" type="wstring" readonly="yes">
16831	<desc>
16832	Optional error message.
16833	</desc>
16834	</attribute>
16835
16836	</interface>
16837
16838	<interface
16839	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
16840	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
16841	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
16842	>
16843	<desc>
16844	Notification when VBoxSVC becomes unavailable (due to a crash or similar
16845	unexpected circumstances) or available again.
16846	</desc>
16847
16848	<attribute name="available" type="boolean" readonly="yes">
16849	<desc>
16850	Whether VBoxSVC is available now.
16851	</desc>
16852	</attribute>
16853	</interface>
16854
16855	<interface
16856	name="IBandwidthGroupChangedEvent" extends="IEvent"
16857	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
16858	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
16859	>
16860	<desc>
16861	Notification when one of the bandwidth groups changed
16862	</desc>
16863	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
16864	<desc>
16865	The changed bandwidth group.
16866	</desc>
16867	</attribute>
16868	</interface>
16869
16870	<enum
16871	name="GuestMonitorChangedEventType"
16872	uuid="ef172985-7e36-4297-95be-e46396968d66"
16873	>
16874
16875	<desc>
16876	How the guest monitor has been changed.
16877	</desc>
16878
16879	<const name="Enabled" value="0">
16880	<desc>
16881	The guest monitor has been enabled by the guest.
16882	</desc>
16883	</const>
16884
16885	<const name="Disabled" value="1">
16886	<desc>
16887	The guest monitor has been disabled by the guest.
16888	</desc>
16889	</const>
16890
16891	<const name="NewOrigin" value="2">
16892	<desc>
16893	The guest monitor origin has changed in the guest.
16894	</desc>
16895	</const>
16896	</enum>
16897
16898	<interface
16899	name="IGuestMonitorChangedEvent" extends="IEvent"
16900	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
16901	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
16902	>
16903	<desc>
16904	Notification when the guest enables one of its monitors.
16905	</desc>
16906
16907	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
16908	<desc>
16909	What was changed for this guest monitor.
16910	</desc>
16911	</attribute>
16912
16913	<attribute name="screenId" type="unsigned long" readonly="yes">
16914	<desc>
16915	The monitor which was changed.
16916	</desc>
16917	</attribute>
16918
16919	<attribute name="originX" type="unsigned long" readonly="yes">
16920	<desc>
16921	Physical X origin relative to the primary screen.
16922	Valid for Enabled and NewOrigin.
16923	</desc>
16924	</attribute>
16925
16926	<attribute name="originY" type="unsigned long" readonly="yes">
16927	<desc>
16928	Physical Y origin relative to the primary screen.
16929	Valid for Enabled and NewOrigin.
16930	</desc>
16931	</attribute>
16932
16933	<attribute name="width" type="unsigned long" readonly="yes">
16934	<desc>
16935	Width of the screen.
16936	Valid for Enabled.
16937	</desc>
16938	</attribute>
16939
16940	<attribute name="height" type="unsigned long" readonly="yes">
16941	<desc>
16942	Height of the screen.
16943	Valid for Enabled.
16944	</desc>
16945	</attribute>
16946
16947	</interface>
16948
16949	<module name="VBoxSVC" context="LocalServer">
16950	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
16951	namespace="virtualbox.org">
16952	<interface name="IVirtualBox" default="yes"/>
16953	</class>
16954	</module>
16955
16956	<module name="VBoxC" context="InprocServer" threadingModel="Free">
16957	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
16958	namespace="virtualbox.org">
16959	<interface name="IVirtualBoxClient" default="yes"/>
16960	</class>
16961
16962	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
16963	namespace="virtualbox.org">
16964	<interface name="ISession" default="yes"/>
16965	</class>
16966	</module>
16967
16968	</library>
16969
16970	</idl>
16971
16972	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format