VirtualBox.xidl@ 40078

Last change on this file since 40078 was 40066, checked in by vboxsync, 13 years ago
hash the teleporter token.
Property svn:eol-style set to `native`
File size: 659.0 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490
491	<const name="Future" value="99999">
492	<desc>Settings version greater than "1.12", written by a future VirtualBox version.</desc>
493	</const>
494	</enum>
495
496	<enum
497	name="AccessMode"
498	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
499	>
500	<desc>
501	Access mode for opening files.
502	</desc>
503
504	<const name="ReadOnly" value="1"/>
505	<const name="ReadWrite" value="2"/>
506	</enum>
507
508	<enum
509	name="MachineState"
510	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
511	>
512	<desc>
513	Virtual machine execution state.
514
515	This enumeration represents possible values of the <link
516	to="IMachine::state"/> attribute.
517
518	Below is the basic virtual machine state diagram. It shows how the state
519	changes during virtual machine execution. The text in square braces shows
520	a method of the IConsole interface that performs the given state
521	transition.
522
523	<pre>
524	+---------[powerDown()] <- Stuck <--[failure]-+
525	V \|
526	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
527	\| \| \| \| V \|
528	\| Aborted -----+ +--> Running --[pause()]--> Paused
529	\| \| ^ \| ^ \|
530	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
531	\| ^ \| \| \| \|
532	\| \| +-----------------------------------------+-\|-------------------+ +
533	\| \| \| \| \|
534	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
535	\| \| \| \|
536	\| +-------- Saving <--------[saveState()]<----------+---------------------+
537	\| \| \|
538	+-------------- Stopping -------[powerDown()]<----------+---------------------+
539	</pre>
540
541	Note that states to the right from PoweredOff, Aborted and Saved in the
542	above diagram are called <i>online VM states</i>. These states
543	represent the virtual machine which is being executed in a dedicated
544	process (usually with a GUI window attached to it where you can see the
545	activity of the virtual machine and interact with it). There are two
546	special pseudo-states, FirstOnline and LastOnline, that can be used in
547	relational expressions to detect if the given machine state is online or
548	not:
549
550	<pre>
551	if (machine.GetState() >= MachineState_FirstOnline &&
552	machine.GetState() <= MachineState_LastOnline)
553	{
554	...the machine is being executed...
555	}
556	</pre>
557
558	When the virtual machine is in one of the online VM states (that is, being
559	executed), only a few machine settings can be modified. Methods working
560	with such settings contain an explicit note about that. An attempt to
561	change any other setting or perform a modifying operation during this time
562	will result in the @c VBOX_E_INVALID_VM_STATE error.
563
564	All online states except Running, Paused and Stuck are transitional: they
565	represent temporary conditions of the virtual machine that will last as
566	long as the operation that initiated such a condition.
567
568	The Stuck state is a special case. It means that execution of the machine
569	has reached the "Guru Meditation" condition. This condition indicates an
570	internal VMM (virtual machine manager) failure which may happen as a
571	result of either an unhandled low-level virtual hardware exception or one
572	of the recompiler exceptions (such as the <i>too-many-traps</i>
573	condition).
574
575	Note also that any online VM state may transit to the Aborted state. This
576	happens if the process that is executing the virtual machine terminates
577	unexpectedly (for example, crashes). Other than that, the Aborted state is
578	equivalent to PoweredOff.
579
580	There are also a few additional state diagrams that do not deal with
581	virtual machine execution and therefore are shown separately. The states
582	shown on these diagrams are called <i>offline VM states</i> (this includes
583	PoweredOff, Aborted and Saved too).
584
585	The first diagram shows what happens when a lengthy setup operation is
586	being executed (such as <link to="IMachine::attachDevice"/>).
587
588	<pre>
589	+----------------------------------(same state as before the call)------+
590	\| \|
591	+-> PoweredOff --+ \|
592	\| \| \|
593	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
594	\| \|
595	+-> Saved -------+
596	</pre>
597
598	The next two diagrams demonstrate the process of taking a snapshot of a
599	powered off virtual machine, restoring the state to that as of a snapshot
600	or deleting a snapshot, respectively.
601
602	<pre>
603	+----------------------------------(same state as before the call)------+
604	\| \|
605	+-> PoweredOff --+ \|
606	\| +-->[takeSnapshot()] -------------------> Saving ------+
607	+-> Aborted -----+
608
609	+-> PoweredOff --+
610	\| \|
611	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
612	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
613	+-> Saved -------+ \|
614	\| \|
615	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
616	</pre>
617
618	Note that the Saving state is present in both the offline state group and
619	online state group. Currently, the only way to determine what group is
620	assumed in a particular case is to remember the previous machine state: if
621	it was Running or Paused, then Saving is an online state, otherwise it is
622	an offline state. This inconsistency may be removed in one of the future
623	versions of VirtualBox by adding a new state.
624
625	<note internal="yes">
626	For whoever decides to touch this enum: In order to keep the
627	comparisons involving FirstOnline and LastOnline pseudo-states valid,
628	the numeric values of these states must be correspondingly updated if
629	needed: for any online VM state, the condition
630	<tt>FirstOnline <= state <= LastOnline</tt> must be
631	@c true. The same relates to transient states for which
632	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
633	@c true.
634	</note>
635	</desc>
636
637	<const name="Null" value="0">
638	<desc>Null value (never used by the API).</desc>
639	</const>
640	<const name="PoweredOff" value="1">
641	<desc>
642	The machine is not running and has no saved execution state; it has
643	either never been started or been shut down successfully.
644	</desc>
645	</const>
646	<const name="Saved" value="2">
647	<desc>
648	The machine is not currently running, but the execution state of the machine
649	has been saved to an external file when it was running, from where
650	it can be resumed.
651	</desc>
652	</const>
653	<const name="Teleported" value="3">
654	<desc>
655	The machine was teleported to a different host (or process) and then
656	powered off. Take care when powering it on again may corrupt resources
657	it shares with the teleportation target (e.g. disk and network).
658	</desc>
659	</const>
660	<const name="Aborted" value="4">
661	<desc>
662	The process running the machine has terminated abnormally. This may
663	indicate a crash of the VM process in host execution context, or
664	the VM process has been terminated externally.
665	</desc>
666	</const>
667	<const name="Running" value="5">
668	<desc>
669	The machine is currently being executed.
670	<note internal="yes">
671	For whoever decides to touch this enum: In order to keep the
672	comparisons in the old source code valid, this state must immediately
673	precede the Paused state.
674	TODO: Lift this spectacularly wonderful restriction.
675	</note>
676	</desc>
677	</const>
678	<const name="Paused" value="6">
679	<desc>
680	Execution of the machine has been paused.
681	<note internal="yes">
682	For whoever decides to touch this enum: In order to keep the
683	comparisons in the old source code valid, this state must immediately
684	follow the Running state.
685	TODO: Lift this spectacularly wonderful restriction.
686	</note>
687	</desc>
688	</const>
689	<const name="Stuck" value="7">
690	<desc>
691	Execution of the machine has reached the "Guru Meditation"
692	condition. This indicates a severe error in the hypervisor itself.
693	<note internal="yes">
694	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
695	"Guru", perhaps? Or are there some other VMM states that are
696	intended to be lumped in here as well?
697	</note>
698	</desc>
699	</const>
700	<const name="Teleporting" value="8">
701	<desc>
702	The machine is about to be teleported to a different host or process.
703	It is possible to pause a machine in this state, but it will go to the
704	@c TeleportingPausedVM state and it will not be
705	possible to resume it again unless the teleportation fails.
706	</desc>
707	</const>
708	<const name="LiveSnapshotting" value="9">
709	<desc>
710	A live snapshot is being taken. The machine is running normally, but
711	some of the runtime configuration options are inaccessible. Also, if
712	paused while in this state it will transition to
713	@c Saving and it will not be resume the
714	execution until the snapshot operation has completed.
715	</desc>
716	</const>
717	<const name="Starting" value="10">
718	<desc>
719	Machine is being started after powering it on from a
720	zero execution state.
721	</desc>
722	</const>
723	<const name="Stopping" value="11">
724	<desc>
725	Machine is being normally stopped powering it off, or after the guest OS
726	has initiated a shutdown sequence.
727	</desc>
728	</const>
729	<const name="Saving" value="12">
730	<desc>
731	Machine is saving its execution state to a file, or an online
732	snapshot of the machine is being taken.
733	</desc>
734	</const>
735	<const name="Restoring" value="13">
736	<desc>
737	Execution state of the machine is being restored from a file
738	after powering it on from the saved execution state.
739	</desc>
740	</const>
741	<const name="TeleportingPausedVM" value="14">
742	<desc>
743	The machine is being teleported to another host or process, but it is
744	not running. This is the paused variant of the
745	@c state.
746	</desc>
747	</const>
748	<const name="TeleportingIn" value="15">
749	<desc>
750	Teleporting the machine state in from another host or process.
751	</desc>
752	</const>
753	<const name="FaultTolerantSyncing" value="16">
754	<desc>
755	The machine is being synced with a fault tolerant VM running elsewhere.
756	</desc>
757	</const>
758	<const name="DeletingSnapshotOnline" value="17">
759	<desc>
760	Like @c DeletingSnapshot, but the merging of media is ongoing in
761	the background while the machine is running.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotPaused" value="18">
765	<desc>
766	Like @c DeletingSnapshotOnline, but the machine was paused when the
767	merging of differencing media was started.
768	</desc>
769	</const>
770	<const name="RestoringSnapshot" value="19">
771	<desc>
772	A machine snapshot is being restored; this typically does not take long.
773	</desc>
774	</const>
775	<const name="DeletingSnapshot" value="20">
776	<desc>
777	A machine snapshot is being deleted; this can take a long time since this
778	may require merging differencing media. This value indicates that the
779	machine is not running while the snapshot is being deleted.
780	</desc>
781	</const>
782	<const name="SettingUp" value="21">
783	<desc>
784	Lengthy setup operation is in progress.
785	</desc>
786	</const>
787
788	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
789	<desc>
790	Pseudo-state: first online state (for use in relational expressions).
791	</desc>
792	</const>
793	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
794	<desc>
795	Pseudo-state: last online state (for use in relational expressions).
796	</desc>
797	</const>
798
799	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
800	<desc>
801	Pseudo-state: first transient state (for use in relational expressions).
802	</desc>
803	</const>
804	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
805	<desc>
806	Pseudo-state: last transient state (for use in relational expressions).
807	</desc>
808	</const>
809
810	</enum>
811
812	<enum
813	name="SessionState"
814	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
815	>
816	<desc>
817	Session state. This enumeration represents possible values of
818	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
819	attributes.
820	</desc>
821
822	<const name="Null" value="0">
823	<desc>Null value (never used by the API).</desc>
824	</const>
825	<const name="Unlocked" value="1">
826	<desc>
827	In <link to="IMachine::sessionState"/>, this means that the machine
828	is not locked for any sessions.
829
830	In <link to="ISession::state"/>, this means that no machine is
831	currently locked for this session.
832	</desc>
833	</const>
834	<const name="Locked" value="2">
835	<desc>
836	In <link to="IMachine::sessionState"/>, this means that the machine
837	is currently locked for a session, whose process identifier can
838	then be found in the <link to="IMachine::sessionPid" /> attribute.
839
840	In <link to="ISession::state"/>, this means that a machine is
841	currently locked for this session, and the mutable machine object
842	can be found in the <link to="ISession::machine"/> attribute
843	(see <link to="IMachine::lockMachine" /> for details).
844	</desc>
845	</const>
846	<const name="Spawning" value="3">
847	<desc>
848	A new process is being spawned for the machine as a result of
849	<link to="IMachine::launchVMProcess"/> call. This state also occurs
850	as a short transient state during an <link to="IMachine::lockMachine"/>
851	call.
852	</desc>
853	</const>
854	<const name="Unlocking" value="4">
855	<desc>
856	The session is being unlocked.
857	</desc>
858	</const>
859	</enum>
860
861	<enum
862	name="CPUPropertyType"
863	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
864	>
865	<desc>
866	Virtual CPU property type. This enumeration represents possible values of the
867	IMachine get- and setCPUProperty methods.
868	</desc>
869	<const name="Null" value="0">
870	<desc>Null value (never used by the API).</desc>
871	</const>
872	<const name="PAE" value="1">
873	<desc>
874	This setting determines whether VirtualBox will expose the Physical Address
875	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
876	is not available, it will not be reported.
877	</desc>
878	</const>
879	<const name="Synthetic" value="2">
880	<desc>
881	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
882	teleporting between host systems that differ significantly.
883	</desc>
884	</const>
885	</enum>
886
887
888	<enum
889	name="HWVirtExPropertyType"
890	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
891	>
892	<desc>
893	Hardware virtualization property type. This enumeration represents possible values
894	for the <link to="IMachine::getHWVirtExProperty"/> and
895	<link to="IMachine::setHWVirtExProperty"/> methods.
896	</desc>
897	<const name="Null" value="0">
898	<desc>Null value (never used by the API).</desc>
899	</const>
900	<const name="Enabled" value="1">
901	<desc>
902	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
903	such extensions are not available, they will not be used.
904	</desc>
905	</const>
906	<const name="Exclusive" value="2">
907	<desc>
908	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
909	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
910	feature of the host. To share these with other hypervisors, you must disable this property.
911	</desc>
912	</const>
913	<const name="VPID" value="3">
914	<desc>
915	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
916	</desc>
917	</const>
918	<const name="NestedPaging" value="4">
919	<desc>
920	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
921	</desc>
922	</const>
923	<const name="LargePages" value="5">
924	<desc>
925	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
926	</desc>
927	</const>
928	<const name="Force" value="6">
929	<desc>
930	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
931	not set, there will be an automatic fallback to software virtualization.
932	</desc>
933	</const>
934	</enum>
935
936	<enum
937	name="FaultToleranceState"
938	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
939	>
940	<desc>
941	Used with <link to="IMachine::faultToleranceState" />.
942	</desc>
943	<const name="Inactive" value="1">
944	<desc>No fault tolerance enabled.</desc>
945	</const>
946	<const name="Master" value="2">
947	<desc>Fault tolerant master VM.</desc>
948	</const>
949	<const name="Standby" value="3">
950	<desc>Fault tolerant standby VM.</desc>
951	</const>
952	</enum>
953
954	<enum
955	name="LockType"
956	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
957	>
958	<desc>
959	Used with <link to="IMachine::lockMachine" />.
960	</desc>
961	<const name="Write" value="2">
962	<desc>Lock the machine for writing.</desc>
963	</const>
964	<const name="Shared" value="1">
965	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
966	</const>
967	</enum>
968
969	<enum
970	name="SessionType"
971	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
972	>
973	<desc>
974	Session type. This enumeration represents possible values of the
975	<link to="ISession::type"/> attribute.
976	</desc>
977
978	<const name="Null" value="0">
979	<desc>Null value (never used by the API).</desc>
980	</const>
981	<const name="WriteLock" value="1">
982	<desc>
983	Session has acquired an exclusive write lock on a machine
984	using <link to="IMachine::lockMachine"/>.
985	</desc>
986	</const>
987	<const name="Remote" value="2">
988	<desc>
989	Session has launched a VM process using
990	<link to="IMachine::launchVMProcess"/>
991	</desc>
992	</const>
993	<const name="Shared" value="3">
994	<desc>
995	Session has obtained a link to another session using
996	<link to="IMachine::lockMachine"/>
997	</desc>
998	</const>
999	</enum>
1000
1001	<enum
1002	name="DeviceType"
1003	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1004	>
1005	<desc>
1006	Device type.
1007	</desc>
1008	<const name="Null" value="0">
1009	<desc>
1010	Null value, may also mean "no device" (not allowed for
1011	<link to="IConsole::getDeviceActivity"/>).
1012	</desc>
1013	</const>
1014	<const name="Floppy" value="1">
1015	<desc>Floppy device.</desc>
1016	</const>
1017	<const name="DVD" value="2">
1018	<desc>CD/DVD-ROM device.</desc>
1019	</const>
1020	<const name="HardDisk" value="3">
1021	<desc>Hard disk device.</desc>
1022	</const>
1023	<const name="Network" value="4">
1024	<desc>Network device.</desc>
1025	</const>
1026	<const name="USB" value="5">
1027	<desc>USB device.</desc>
1028	</const>
1029	<const name="SharedFolder" value="6">
1030	<desc>Shared folder device.</desc>
1031	</const>
1032	</enum>
1033
1034	<enum
1035	name="DeviceActivity"
1036	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1037	>
1038	<desc>
1039	Device activity for <link to="IConsole::getDeviceActivity"/>.
1040	</desc>
1041
1042	<const name="Null" value="0"/>
1043	<const name="Idle" value="1"/>
1044	<const name="Reading" value="2"/>
1045	<const name="Writing" value="3"/>
1046	</enum>
1047
1048	<enum
1049	name="ClipboardMode"
1050	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1051	>
1052	<desc>
1053	Host-Guest clipboard interchange mode.
1054	</desc>
1055
1056	<const name="Disabled" value="0"/>
1057	<const name="HostToGuest" value="1"/>
1058	<const name="GuestToHost" value="2"/>
1059	<const name="Bidirectional" value="3"/>
1060	</enum>
1061
1062	<enum
1063	name="Scope"
1064	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1065	>
1066	<desc>
1067	Scope of the operation.
1068
1069	A generic enumeration used in various methods to define the action or
1070	argument scope.
1071	</desc>
1072
1073	<const name="Global" value="0"/>
1074	<const name="Machine" value="1"/>
1075	<const name="Session" value="2"/>
1076	</enum>
1077
1078	<enum
1079	name="BIOSBootMenuMode"
1080	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1081	>
1082	<desc>
1083	BIOS boot menu mode.
1084	</desc>
1085
1086	<const name="Disabled" value="0"/>
1087	<const name="MenuOnly" value="1"/>
1088	<const name="MessageAndMenu" value="2"/>
1089	</enum>
1090
1091	<enum
1092	name="ProcessorFeature"
1093	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1094	>
1095	<desc>
1096	CPU features.
1097	</desc>
1098
1099	<const name="HWVirtEx" value="0"/>
1100	<const name="PAE" value="1"/>
1101	<const name="LongMode" value="2"/>
1102	<const name="NestedPaging" value="3"/>
1103	</enum>
1104
1105	<enum
1106	name="FirmwareType"
1107	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1108	>
1109	<desc>
1110	Firmware type.
1111	</desc>
1112	<const name="BIOS" value="1">
1113	<desc>BIOS Firmware.</desc>
1114	</const>
1115	<const name="EFI" value="2">
1116	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1117	</const>
1118	<const name="EFI32" value="3">
1119	<desc>Efi firmware, 32-bit.</desc>
1120	</const>
1121	<const name="EFI64" value="4">
1122	<desc>Efi firmware, 64-bit.</desc>
1123	</const>
1124	<const name="EFIDUAL" value="5">
1125	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1126	</const>
1127	</enum>
1128
1129	<enum
1130	name="PointingHidType"
1131	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1132	>
1133	<desc>
1134	Type of pointing device used in a virtual machine.
1135	</desc>
1136	<const name="None" value="1">
1137	<desc>No mouse.</desc>
1138	</const>
1139	<const name="PS2Mouse" value="2">
1140	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1141	</const>
1142	<const name="USBMouse" value="3">
1143	<desc>USB mouse (relative pointer).</desc>
1144	</const>
1145	<const name="USBTablet" value="4">
1146	<desc>USB tablet (absolute pointer).</desc>
1147	</const>
1148	<const name="ComboMouse" value="5">
1149	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1150	Using of such device can have negative performance implications. </desc>
1151	</const>
1152	</enum>
1153
1154	<enum
1155	name="KeyboardHidType"
1156	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1157	>
1158	<desc>
1159	Type of keyboard device used in a virtual machine.
1160	</desc>
1161	<const name="None" value="1">
1162	<desc>No keyboard.</desc>
1163	</const>
1164	<const name="PS2Keyboard" value="2">
1165	<desc>PS/2 keyboard.</desc>
1166	</const>
1167	<const name="USBKeyboard" value="3">
1168	<desc>USB keyboard.</desc>
1169	</const>
1170	<const name="ComboKeyboard" value="4">
1171	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1172	Using of such device can have negative performance implications. </desc>
1173	</const>
1174	</enum>
1175
1176	<!--
1177	// IVirtualBoxErrorInfo
1178	/////////////////////////////////////////////////////////////////////////
1179	-->
1180
1181	<interface
1182	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1183	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1184	supportsErrorInfo="no"
1185	wsmap="managed"
1186	>
1187	<desc>
1188	The IVirtualBoxErrorInfo interface represents extended error information.
1189
1190	Extended error information can be set by VirtualBox components after
1191	unsuccessful or partially successful method invocation. This information
1192	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1193	and then shown to the client in addition to the plain 32-bit result code.
1194
1195	In MS COM, this interface extends the IErrorInfo interface,
1196	in XPCOM, it extends the nsIException interface. In both cases,
1197	it provides a set of common attributes to retrieve error
1198	information.
1199
1200	Sometimes invocation of some component's method may involve methods of
1201	other components that may also fail (independently of this method's
1202	failure), or a series of non-fatal errors may precede a fatal error that
1203	causes method failure. In cases like that, it may be desirable to preserve
1204	information about all errors happened during method invocation and deliver
1205	it to the caller. The <link to="#next"/> attribute is intended
1206	specifically for this purpose and allows to represent a chain of errors
1207	through a single IVirtualBoxErrorInfo object set after method invocation.
1208
1209	<note>errors are stored to a chain in the reverse order, i.e. the
1210	initial error object you query right after method invocation is the last
1211	error set by the callee, the object it points to in the @a next attribute
1212	is the previous error and so on, up to the first error (which is the last
1213	in the chain).</note>
1214	</desc>
1215
1216	<attribute name="resultCode" type="long" readonly="yes">
1217	<desc>
1218	Result code of the error.
1219	Usually, it will be the same as the result code returned
1220	by the method that provided this error information, but not
1221	always. For example, on Win32, CoCreateInstance() will most
1222	likely return E_NOINTERFACE upon unsuccessful component
1223	instantiation attempt, but not the value the component factory
1224	returned. Value is typed 'long', not 'result',
1225	to make interface usable from scripting languages.
1226	<note>
1227	In MS COM, there is no equivalent.
1228	In XPCOM, it is the same as nsIException::result.
1229	</note>
1230	</desc>
1231	</attribute>
1232
1233	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1234	<desc>
1235	UUID of the interface that defined the error.
1236	<note>
1237	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1238	data type.
1239	In XPCOM, there is no equivalent.
1240	</note>
1241	</desc>
1242	</attribute>
1243
1244	<attribute name="component" type="wstring" readonly="yes">
1245	<desc>
1246	Name of the component that generated the error.
1247	<note>
1248	In MS COM, it is the same as IErrorInfo::GetSource.
1249	In XPCOM, there is no equivalent.
1250	</note>
1251	</desc>
1252	</attribute>
1253
1254	<attribute name="text" type="wstring" readonly="yes">
1255	<desc>
1256	Text description of the error.
1257	<note>
1258	In MS COM, it is the same as IErrorInfo::GetDescription.
1259	In XPCOM, it is the same as nsIException::message.
1260	</note>
1261	</desc>
1262	</attribute>
1263
1264	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1265	<desc>
1266	Next error object if there is any, or @c null otherwise.
1267	<note>
1268	In MS COM, there is no equivalent.
1269	In XPCOM, it is the same as nsIException::inner.
1270	</note>
1271	</desc>
1272	</attribute>
1273
1274	</interface>
1275
1276	<!--
1277	// IVirtualBox
1278	/////////////////////////////////////////////////////////////////////////
1279	-->
1280
1281	<interface
1282	name="IDHCPServer" extends="$unknown"
1283	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1284	wsmap="managed"
1285	>
1286	<desc>
1287	The IDHCPServer interface represents the vbox dhcp server configuration.
1288
1289	To enumerate all the dhcp servers on the host, use the
1290	<link to="IVirtualBox::DHCPServers"/> attribute.
1291	</desc>
1292
1293	<attribute name="enabled" type="boolean">
1294	<desc>
1295	specifies if the dhcp server is enabled
1296	</desc>
1297	</attribute>
1298
1299	<attribute name="IPAddress" type="wstring" readonly="yes">
1300	<desc>
1301	specifies server IP
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="networkMask" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server network mask
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkName" type="wstring" readonly="yes">
1312	<desc>
1313	specifies internal network name the server is used for
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="lowerIP" type="wstring" readonly="yes">
1318	<desc>
1319	specifies from IP address in server address range
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="upperIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies to IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<method name="setConfiguration">
1330	<desc>
1331	configures the server
1332	<result name="E_INVALIDARG">
1333	invalid configuration supplied
1334	</result>
1335	</desc>
1336	<param name="IPAddress" type="wstring" dir="in">
1337	<desc>
1338	server IP address
1339	</desc>
1340	</param>
1341	<param name="networkMask" type="wstring" dir="in">
1342	<desc>
1343	server network mask
1344	</desc>
1345	</param>
1346	<param name="FromIPAddress" type="wstring" dir="in">
1347	<desc>
1348	server From IP address for address range
1349	</desc>
1350	</param>
1351	<param name="ToIPAddress" type="wstring" dir="in">
1352	<desc>
1353	server To IP address for address range
1354	</desc>
1355	</param>
1356	</method>
1357
1358	<method name="start">
1359	<desc>
1360	Starts DHCP server process.
1361	<result name="E_FAIL">
1362	Failed to start the process.
1363	</result>
1364	</desc>
1365	<param name="networkName" type="wstring" dir="in">
1366	<desc>
1367	Name of internal network DHCP server should attach to.
1368	</desc>
1369	</param>
1370	<param name="trunkName" type="wstring" dir="in">
1371	<desc>
1372	Name of internal network trunk.
1373	</desc>
1374	</param>
1375	<param name="trunkType" type="wstring" dir="in">
1376	<desc>
1377	Type of internal network trunk.
1378	</desc>
1379	</param>
1380	</method>
1381
1382	<method name="stop">
1383	<desc>
1384	Stops DHCP server process.
1385	<result name="E_FAIL">
1386	Failed to stop the process.
1387	</result>
1388	</desc>
1389	</method>
1390	</interface>
1391
1392	<interface
1393	name="IVirtualBox" extends="$unknown"
1394	uuid="c28be65f-1a8f-43b4-81f1-eb60cb516e66"
1395	wsmap="managed"
1396	>
1397	<desc>
1398	The IVirtualBox interface represents the main interface exposed by the
1399	product that provides virtual machine management.
1400
1401	An instance of IVirtualBox is required for the product to do anything
1402	useful. Even though the interface does not expose this, internally,
1403	IVirtualBox is implemented as a singleton and actually lives in the
1404	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1405	IVirtualBox can track the state of all virtual machines on a particular
1406	host, regardless of which frontend started them.
1407
1408	To enumerate all the virtual machines on the host, use the
1409	<link to="IVirtualBox::machines"/> attribute.
1410	</desc>
1411
1412	<attribute name="version" type="wstring" readonly="yes">
1413	<desc>
1414	A string representing the version number of the product. The
1415	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1416	last number represents the build number and will frequently change.
1417
1418	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1419	in prerelease builds. Non-Oracle builds may (/shall) also have a
1420	publisher tag, at the end. The publisher tag starts with an underscore
1421	just like the prerelease build type tag.
1422	</desc>
1423	</attribute>
1424
1425	<attribute name="revision" type="unsigned long" readonly="yes">
1426	<desc>
1427	The internal build revision number of the product.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="packageType" type="wstring" readonly="yes">
1432	<desc>
1433	A string representing the package type of this product. The
1434	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1435	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1436	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1437	this.
1438	</desc>
1439	</attribute>
1440
1441	<attribute name="APIVersion" type="wstring" readonly="yes">
1442	<desc>
1443	A string representing the VirtualBox API version number. The format is
1444	2 integer numbers divided by an underscore (e.g. 1_0). After the
1445	first public release of packages with a particular API version the
1446	API will not be changed in an incompatible way. Note that this
1447	guarantee does not apply to development builds, and also there is no
1448	guarantee that this version is identical to the first two integer
1449	numbers of the package version.
1450	</desc>
1451	</attribute>
1452
1453	<attribute name="homeFolder" type="wstring" readonly="yes">
1454	<desc>
1455	Full path to the directory where the global settings file,
1456	<tt>VirtualBox.xml</tt>, is stored.
1457
1458	In this version of VirtualBox, the value of this property is
1459	always <tt><user_dir>/.VirtualBox</tt> (where
1460	<tt><user_dir></tt> is the path to the user directory,
1461	as determined by the host OS), and cannot be changed.
1462
1463	This path is also used as the base to resolve relative paths in
1464	places where relative paths are allowed (unless otherwise
1465	expressly indicated).
1466	</desc>
1467	</attribute>
1468
1469	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1470	<desc>
1471	Full name of the global settings file.
1472	The value of this property corresponds to the value of
1473	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1474	</desc>
1475	</attribute>
1476
1477	<attribute name="host" type="IHost" readonly="yes">
1478	<desc>Associated host object.</desc>
1479	</attribute>
1480
1481	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1482	<desc>Associated system information object.</desc>
1483	</attribute>
1484
1485	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1486	<desc>
1487	Array of machine objects registered within this VirtualBox instance.
1488	</desc>
1489	</attribute>
1490
1491	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of medium objects known to this VirtualBox installation.
1494
1495	This array contains only base media. All differencing
1496	media of the given base medium can be enumerated using
1497	<link to="IMedium::children"/>.
1498	</desc>
1499	</attribute>
1500
1501	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1502	<desc>
1503	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of floppy image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1514
1515	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1516
1517	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1518	<desc>
1519	Collection of global shared folders. Global shared folders are
1520	available to all virtual machines.
1521
1522	New shared folders are added to the collection using
1523	<link to="#createSharedFolder"/>. Existing shared folders can be
1524	removed using <link to="#removeSharedFolder"/>.
1525
1526	<note>
1527	In the current version of the product, global shared folders are not
1528	implemented and therefore this collection is always empty.
1529	</note>
1530	</desc>
1531	</attribute>
1532
1533	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1534	<desc>
1535	Associated performance collector object.
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1540	<desc>
1541	DHCP servers.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="eventSource" type="IEventSource" readonly="yes">
1546	<desc>
1547	Event source for VirtualBox events.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1552	<desc>
1553	The extension pack manager.
1554	</desc>
1555	</attribute>
1556
1557
1558	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1559	<desc>
1560	Names of all internal networks.
1561	</desc>
1562	</attribute>
1563
1564	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all generic network drivers.
1567	</desc>
1568	</attribute>
1569
1570	<method name="composeMachineFilename">
1571	<desc>
1572	Returns a recommended full path of the settings file name for a new virtual
1573	machine.
1574
1575	This API serves two purposes:
1576
1577	<ul>
1578	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1579	for the @a settingsFile argument there, which means that API should use
1580	a recommended default file name.</li>
1581
1582	<li>It can be called manually by a client software before creating a machine,
1583	e.g. if that client wants to pre-create the machine directory to create
1584	virtual hard disks in that directory together with the new machine
1585	settings file. In that case, the file name should be stripped from the
1586	full settings file path returned by this function to obtain the
1587	machine directory.</li>
1588	</ul>
1589
1590	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1591	details about the machine name.
1592
1593	If @a baseFolder is a @c null or empty string (which is recommended), the
1594	default machine settings folder
1595	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1596	a base folder for the created machine, resulting in a file name like
1597	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1598	will be used.
1599
1600	This method does not access the host disks. In particular, it does not check
1601	for whether a machine of this name already exists.
1602	</desc>
1603	<param name="name" type="wstring" dir="in">
1604	<desc>Suggested machine name.</desc>
1605	</param>
1606	<param name="baseFolder" type="wstring" dir="in">
1607	<desc>Base machine folder (optional).</desc>
1608	</param>
1609	<param name="file" type="wstring" dir="return">
1610	<desc>Fully qualified path where the machine would be created.</desc>
1611	</param>
1612	</method>
1613
1614	<method name="createMachine">
1615	<desc>
1616	Creates a new virtual machine by creating a machine settings file at
1617	the given location.
1618
1619	VirtualBox machine settings files use a custom XML dialect. Starting
1620	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1621	and machine files can be created at arbitrary locations.
1622
1623	However, it is is recommended that machines be created in the default
1624	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1625	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1626	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1627	is called automatically to have such a recommended name composed based
1628	on the machine name given in the @a name argument.
1629
1630	If the resulting settings file already exists, this method will fail,
1631	unless @a forceOverwrite is set.
1632
1633	The new machine is created unregistered, with the initial configuration
1634	set according to the specified guest OS type. A typical sequence of
1635	actions to create a new virtual machine is as follows:
1636
1637	<ol>
1638	<li>
1639	Call this method to have a new machine created. The returned machine
1640	object will be "mutable" allowing to change any machine property.
1641	</li>
1642
1643	<li>
1644	Configure the machine using the appropriate attributes and methods.
1645	</li>
1646
1647	<li>
1648	Call <link to="IMachine::saveSettings" /> to write the settings
1649	to the machine's XML settings file. The configuration of the newly
1650	created machine will not be saved to disk until this method is
1651	called.
1652	</li>
1653
1654	<li>
1655	Call <link to="#registerMachine" /> to add the machine to the list
1656	of machines known to VirtualBox.
1657	</li>
1658	</ol>
1659
1660	The specified guest OS type identifier must match an ID of one of known
1661	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1662	array.
1663
1664	Optionally, you may specify an UUID of to assign to the created machine.
1665	However, this is not recommended and you should normally pass an empty
1666	(@c null) UUID to this method so that a new UUID will be automatically
1667	generated for every created machine. You can use UUID
1668	00000000-0000-0000-0000-000000000000 as @c null value.
1669
1670	<note>
1671	There is no way to change the name of the settings file or
1672	subfolder of the created machine directly.
1673	</note>
1674
1675	<result name="VBOX_E_OBJECT_NOT_FOUND">
1676	@a osTypeId is invalid.
1677	</result>
1678	<result name="VBOX_E_FILE_ERROR">
1679	Resulting settings file name is invalid or the settings file already
1680	exists or could not be created due to an I/O error.
1681	</result>
1682	<result name="E_INVALIDARG">
1683	@a name is empty or @c null.
1684	</result>
1685	</desc>
1686
1687	<param name="settingsFile" type="wstring" dir="in">
1688	<desc>Fully qualified path where the settings file should be created,
1689	or NULL for a default folder and file based on the @a name argument
1690	(see <link to="#composeMachineFilename" />).</desc>
1691	</param>
1692	<param name="name" type="wstring" dir="in">
1693	<desc>Machine name.</desc>
1694	</param>
1695	<param name="osTypeId" type="wstring" dir="in">
1696	<desc>Guest OS Type ID.</desc>
1697	</param>
1698	<param name="id" type="uuid" mod="string" dir="in">
1699	<desc>Machine UUID (optional).</desc>
1700	</param>
1701	<param name="forceOverwrite" type="boolean" dir="in">
1702	<desc>If true, an existing machine settings file will be overwritten.</desc>
1703	</param>
1704	<param name="machine" type="IMachine" dir="return">
1705	<desc>Created machine object.</desc>
1706	</param>
1707	</method>
1708
1709	<method name="openMachine">
1710	<desc>
1711	Opens a virtual machine from the existing settings file.
1712	The opened machine remains unregistered until you call
1713	<link to="#registerMachine"/>.
1714
1715	The specified settings file name must be fully qualified.
1716	The file must exist and be a valid machine XML settings file
1717	whose contents will be used to construct the machine object.
1718
1719	<result name="VBOX_E_FILE_ERROR">
1720	Settings file name invalid, not found or sharing violation.
1721	</result>
1722	</desc>
1723	<param name="settingsFile" type="wstring" dir="in">
1724	<desc>
1725	Name of the machine settings file.
1726	</desc>
1727	</param>
1728	<param name="machine" type="IMachine" dir="return">
1729	<desc>Opened machine object.</desc>
1730	</param>
1731	<note>
1732	<link to="IMachine::settingsModified"/> will return
1733	@c false for the created machine, until any of machine settings
1734	are changed.
1735	</note>
1736	</method>
1737
1738	<method name="registerMachine">
1739	<desc>
1740
1741	Registers the machine previously created using
1742	<link to="#createMachine"/> or opened using
1743	<link to="#openMachine"/> within this VirtualBox installation. After
1744	successful method invocation, the
1745	<link to="IMachineRegisteredEvent"/> event is fired.
1746
1747	<note>
1748	This method implicitly calls <link to="IMachine::saveSettings"/>
1749	to save all current machine settings before registering it.
1750	</note>
1751
1752	<result name="VBOX_E_OBJECT_NOT_FOUND">
1753	No matching virtual machine found.
1754	</result>
1755	<result name="VBOX_E_INVALID_OBJECT_STATE">
1756	Virtual machine was not created within this VirtualBox instance.
1757	</result>
1758
1759	</desc>
1760	<param name="machine" type="IMachine" dir="in"/>
1761	</method>
1762
1763	<method name="findMachine">
1764	<desc>
1765	Attempts to find a virtual machine given its name or UUID.
1766
1767	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1768	cannot safely be determined.</note>
1769
1770	<result name="VBOX_E_OBJECT_NOT_FOUND">
1771	Could not find registered machine matching @a nameOrId.
1772	</result>
1773
1774	</desc>
1775	<param name="nameOrId" type="wstring" dir="in">
1776	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1777	</param>
1778	<param name="machine" type="IMachine" dir="return">
1779	<desc>Machine object, if found.</desc>
1780	</param>
1781	</method>
1782
1783	<method name="createAppliance">
1784	<desc>
1785	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1786	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1787	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1788	</desc>
1789	<param name="appliance" type="IAppliance" dir="return">
1790	<desc>New appliance.</desc>
1791	</param>
1792	</method>
1793
1794	<method name="createHardDisk">
1795	<desc>
1796	Creates a new base medium object that will use the given storage
1797	format and location for medium data.
1798
1799	The actual storage unit is not created by this method. In order to
1800	do it, and before you are able to attach the created medium to
1801	virtual machines, you must call one of the following methods to
1802	allocate a format-specific storage unit at the specified location:
1803	<ul>
1804	<li><link to="IMedium::createBaseStorage"/></li>
1805	<li><link to="IMedium::createDiffStorage"/></li>
1806	</ul>
1807
1808	Some medium attributes, such as <link to="IMedium::id"/>, may
1809	remain uninitialized until the medium storage unit is successfully
1810	created by one of the above methods.
1811
1812	After the storage unit is successfully created, it will be
1813	accessible through the <link to="#findMedium"/> method and can
1814	be found in the <link to="#hardDisks"/> array.
1815
1816	The list of all storage formats supported by this VirtualBox
1817	installation can be obtained using
1818	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1819	attribute is empty or @c null then the default storage format
1820	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1821	be used for creating a storage unit of the medium.
1822
1823	Note that the format of the location string is storage format specific.
1824	See <link to="IMedium::location"/> and IMedium for more details.
1825
1826	<result name="VBOX_E_OBJECT_NOT_FOUND">
1827	@a format identifier is invalid. See
1828	<link to="ISystemProperties::mediumFormats"/>.
1829	</result>
1830	<result name="VBOX_E_FILE_ERROR">
1831	@a location is a not valid file name (for file-based formats only).
1832	</result>
1833	</desc>
1834	<param name="format" type="wstring" dir="in">
1835	<desc>
1836	Identifier of the storage format to use for the new medium.
1837	</desc>
1838	</param>
1839	<param name="location" type="wstring" dir="in">
1840	<desc>
1841	Location of the storage unit for the new medium.
1842	</desc>
1843	</param>
1844	<param name="medium" type="IMedium" dir="return">
1845	<desc>Created medium object.</desc>
1846	</param>
1847	</method>
1848
1849	<method name="openMedium">
1850	<desc>
1851	Opens a medium from an existing storage location.
1852
1853	Once a medium has been opened, it can be passed to other VirtualBox
1854	methods, in particular to <link to="IMachine::attachDevice" />.
1855
1856	Depending on the given device type, the file at the storage location
1857	must be in one of the media formats understood by VirtualBox:
1858
1859	<ul>
1860	<li>With a "HardDisk" device type, the file must be a hard disk image
1861	in one of the formats supported by VirtualBox (see
1862	<link to="ISystemProperties::mediumFormats" />).
1863	After this method succeeds, if the medium is a base medium, it
1864	will be added to the <link to="#hardDisks"/> array attribute. </li>
1865	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1866	After this method succeeds, the medium will be added to the
1867	<link to="#DVDImages"/> array attribute.</li>
1868	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1869	After this method succeeds, the medium will be added to the
1870	<link to="#floppyImages"/> array attribute.</li>
1871	</ul>
1872
1873	After having been opened, the medium can be found by the <link to="#findMedium"/>
1874	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1875
1876	The UUID of the newly opened medium will either be retrieved from the
1877	storage location, if the format supports it (e.g. for hard disk images),
1878	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1879	If for some reason you need to change the medium's UUID, use
1880	<link to="IMedium::setIDs" />.
1881
1882	If a differencing hard disk medium is to be opened by this method, the
1883	operation will succeed only if its parent medium and all ancestors,
1884	if any, are already known to this VirtualBox installation (for example,
1885	were opened by this method before).
1886
1887	This method attempts to guess the storage format of the specified medium
1888	by reading medium data at the specified location.
1889
1890	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1891	the image is opened for read/write access and must have according permissions,
1892	as VirtualBox may actually write status information into the disk's metadata
1893	sections.
1894
1895	Note that write access is required for all typical hard disk usage in VirtualBox,
1896	since VirtualBox may need to write metadata such as a UUID into the image.
1897	The only exception is opening a source image temporarily for copying and
1898	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1899	again soon.
1900
1901	The format of the location string is storage format specific. See
1902	<link to="IMedium::location"/> and IMedium for more details.
1903
1904	<result name="VBOX_E_FILE_ERROR">
1905	Invalid medium storage file location or could not find the medium
1906	at the specified location.
1907	</result>
1908	<result name="VBOX_E_IPRT_ERROR">
1909	Could not get medium storage format.
1910	</result>
1911	<result name="E_INVALIDARG">
1912	Invalid medium storage format.
1913	</result>
1914	<result name="VBOX_E_INVALID_OBJECT_STATE">
1915	Medium has already been added to a media registry.
1916	</result>
1917	</desc>
1918	<param name="location" type="wstring" dir="in">
1919	<desc>
1920	Location of the storage unit that contains medium data in one of
1921	the supported storage formats.
1922	</desc>
1923	</param>
1924	<param name="deviceType" type="DeviceType" dir="in">
1925	<desc>
1926	Must be one of "HardDisk", "DVD" or "Floppy".
1927	</desc>
1928	</param>
1929	<param name="accessMode" type="AccessMode" dir="in">
1930	<desc>Whether to open the image in read/write or read-only mode. For
1931	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1932	</param>
1933	<param name="forceNewUuid" type="boolean" dir="in">
1934	<desc>Allows the caller to request a completely new medium UUID for
1935	the image which is to be opened. Useful if one intends to open an exact
1936	copy of a previously opened image, as this would normally fail due to
1937	the duplicate UUID.</desc>
1938	</param>
1939	<param name="medium" type="IMedium" dir="return">
1940	<desc>Opened medium object.</desc>
1941	</param>
1942	</method>
1943
1944	<method name="findMedium">
1945	<desc>
1946	Returns a medium of the given type that uses the given fully qualified
1947	location or UUID to store medium data.
1948
1949	The given medium must be known to this VirtualBox installation, i.e.
1950	it must be previously created by <link to="#createHardDisk"/> or opened
1951	by <link to="#openMedium"/>.
1952
1953	The search is done by comparing the value of the @a location argument to
1954	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1955	attributes of each known medium.
1956
1957	On case sensitive file systems, a case sensitive comparison is performed,
1958	otherwise the case of symbols in the file path is ignored.
1959
1960	<result name="VBOX_E_OBJECT_NOT_FOUND">
1961	No medium object matching @a location found.
1962	</result>
1963	</desc>
1964	<param name="location" type="wstring" dir="in">
1965	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1966	</param>
1967	<param name="type" type="DeviceType" dir="in">
1968	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1969	</param>
1970	<param name="medium" type="IMedium" dir="return">
1971	<desc>Medium object, if found.</desc>
1972	</param>
1973	</method>
1974
1975	<method name="getGuestOSType">
1976	<desc>
1977	Returns an object describing the specified guest OS type.
1978
1979	The requested guest OS type is specified using a string which is a
1980	mnemonic identifier of the guest operating system, such as
1981	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1982	particular virtual machine can be read or set using the
1983	<link to="IMachine::OSTypeId"/> attribute.
1984
1985	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1986	available guest OS type objects. Each object has an
1987	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1988	the guest OS this object describes.
1989
1990	<result name="E_INVALIDARG">
1991	@a id is not a valid Guest OS type.
1992	</result>
1993
1994	</desc>
1995	<param name="id" type="uuid" mod="string" dir="in">
1996	<desc>Guest OS type ID string.</desc>
1997	</param>
1998	<param name="type" type="IGuestOSType" dir="return">
1999	<desc>Guest OS type object.</desc>
2000	</param>
2001	</method>
2002
2003	<method name="createSharedFolder">
2004	<desc>
2005	Creates a new global shared folder by associating the given logical
2006	name with the given host path, adds it to the collection of shared
2007	folders and starts sharing it. Refer to the description of
2008	<link to="ISharedFolder"/> to read more about logical names.
2009	<note>
2010	In the current implementation, this operation is not
2011	implemented.
2012	</note>
2013	</desc>
2014	<param name="name" type="wstring" dir="in">
2015	<desc>Unique logical name of the shared folder.</desc>
2016	</param>
2017	<param name="hostPath" type="wstring" dir="in">
2018	<desc>Full path to the shared folder in the host file system.</desc>
2019	</param>
2020	<param name="writable" type="boolean" dir="in">
2021	<desc>Whether the share is writable or readonly</desc>
2022	</param>
2023	<param name="automount" type="boolean" dir="in">
2024	<desc>Whether the share gets automatically mounted by the guest
2025	or not.</desc>
2026	</param>
2027	</method>
2028
2029	<method name="removeSharedFolder">
2030	<desc>
2031	Removes the global shared folder with the given name previously
2032	created by <link to="#createSharedFolder"/> from the collection of
2033	shared folders and stops sharing it.
2034	<note>
2035	In the current implementation, this operation is not
2036	implemented.
2037	</note>
2038	</desc>
2039	<param name="name" type="wstring" dir="in">
2040	<desc>Logical name of the shared folder to remove.</desc>
2041	</param>
2042	</method>
2043
2044	<method name="getExtraDataKeys">
2045	<desc>
2046	Returns an array representing the global extra data keys which currently
2047	have values defined.
2048	</desc>
2049	<param name="value" type="wstring" dir="return" safearray="yes">
2050	<desc>Array of extra data keys.</desc>
2051	</param>
2052	</method>
2053
2054	<method name="getExtraData">
2055	<desc>
2056	Returns associated global extra data.
2057
2058	If the requested data @a key does not exist, this function will
2059	succeed and return an empty string in the @a value argument.
2060
2061	<result name="VBOX_E_FILE_ERROR">
2062	Settings file not accessible.
2063	</result>
2064	<result name="VBOX_E_XML_ERROR">
2065	Could not parse the settings file.
2066	</result>
2067
2068	</desc>
2069	<param name="key" type="wstring" dir="in">
2070	<desc>Name of the data key to get.</desc>
2071	</param>
2072	<param name="value" type="wstring" dir="return">
2073	<desc>Value of the requested data key.</desc>
2074	</param>
2075	</method>
2076
2077	<method name="setExtraData">
2078	<desc>
2079	Sets associated global extra data.
2080
2081	If you pass @c null or empty string as a key @a value, the given @a key
2082	will be deleted.
2083
2084	<note>
2085	Before performing the actual data change, this method will ask all
2086	registered event listener using the
2087	<link to="IExtraDataCanChangeEvent"/>
2088	notification for a permission. If one of the listeners refuses the
2089	new value, the change will not be performed.
2090	</note>
2091	<note>
2092	On success, the
2093	<link to="IExtraDataChangedEvent"/> notification
2094	is called to inform all registered listeners about a successful data
2095	change.
2096	</note>
2097
2098	<result name="VBOX_E_FILE_ERROR">
2099	Settings file not accessible.
2100	</result>
2101	<result name="VBOX_E_XML_ERROR">
2102	Could not parse the settings file.
2103	</result>
2104	<result name="E_ACCESSDENIED">
2105	Modification request refused.
2106	</result>
2107
2108	</desc>
2109	<param name="key" type="wstring" dir="in">
2110	<desc>Name of the data key to set.</desc>
2111	</param>
2112	<param name="value" type="wstring" dir="in">
2113	<desc>Value to assign to the key.</desc>
2114	</param>
2115	</method>
2116
2117	<!--method name="createDHCPServerForInterface">
2118	<desc>
2119	Creates a dhcp server settings to be used for the given interface
2120	<result name="E_INVALIDARG">
2121	Host network interface @a name already exists.
2122	</result>
2123	</desc>
2124	<param name="interface" type="IHostNetworkInterface" dir="in">
2125	<desc>Network Interface</desc>
2126	</param>
2127	<param name="server" type="IDHCPServer" dir="out">
2128	<desc>Dhcp server settings</desc>
2129	</param>
2130	</method-->
2131
2132	<method name="createDHCPServer">
2133	<desc>
2134	Creates a dhcp server settings to be used for the given internal network name
2135	<result name="E_INVALIDARG">
2136	Host network interface @a name already exists.
2137	</result>
2138	</desc>
2139	<param name="name" type="wstring" dir="in">
2140	<desc>server name</desc>
2141	</param>
2142	<param name="server" type="IDHCPServer" dir="return">
2143	<desc>Dhcp server settings</desc>
2144	</param>
2145	</method>
2146
2147	<method name="findDHCPServerByNetworkName">
2148	<desc>
2149	Searches a dhcp server settings to be used for the given internal network name
2150	<result name="E_INVALIDARG">
2151	Host network interface @a name already exists.
2152	</result>
2153
2154	</desc>
2155	<param name="name" type="wstring" dir="in">
2156	<desc>server name</desc>
2157	</param>
2158	<param name="server" type="IDHCPServer" dir="return">
2159	<desc>Dhcp server settings</desc>
2160	</param>
2161	</method>
2162
2163	<!--method name="findDHCPServerForInterface">
2164	<desc>
2165	Searches a dhcp server settings to be used for the given interface
2166	<result name="E_INVALIDARG">
2167	Host network interface @a name already exists.
2168	</result>
2169	</desc>
2170	<param name="interface" type="IHostNetworkInterface" dir="in">
2171	<desc>Network Interface</desc>
2172	</param>
2173	<param name="server" type="IDHCPServer" dir="out">
2174	<desc>Dhcp server settings</desc>
2175	</param>
2176	</method-->
2177
2178	<method name="removeDHCPServer">
2179	<desc>
2180	Removes the dhcp server settings
2181	<result name="E_INVALIDARG">
2182	Host network interface @a name already exists.
2183	</result>
2184	</desc>
2185	<param name="server" type="IDHCPServer" dir="in">
2186	<desc>Dhcp server settings to be removed</desc>
2187	</param>
2188	</method>
2189
2190
2191	<method name="checkFirmwarePresent">
2192	<desc>
2193	Check if this VirtualBox installation has a firmware
2194	of the given type available, either system-wide or per-user.
2195	Optionally, this may return a hint where this firmware can be
2196	downloaded from.
2197	</desc>
2198	<param name="firmwareType" type="FirmwareType" dir="in">
2199	<desc>
2200	Type of firmware to check.
2201	</desc>
2202	</param>
2203	<param name="version" type="wstring" dir="in">
2204	<desc>Expected version number, usually empty string (presently ignored).</desc>
2205	</param>
2206
2207	<param name="url" type="wstring" dir="out">
2208	<desc>
2209	Suggested URL to download this firmware from.
2210	</desc>
2211	</param>
2212
2213	<param name="file" type="wstring" dir="out">
2214	<desc>
2215	Filename of firmware, only valid if result == TRUE.
2216	</desc>
2217	</param>
2218
2219	<param name="result" type="boolean" dir="return">
2220	<desc>If firmware of this type and version is available.</desc>
2221	</param>
2222	</method>
2223
2224	</interface>
2225
2226	<!--
2227	// IVFSExplorer
2228	/////////////////////////////////////////////////////////////////////////
2229	-->
2230
2231	<enum
2232	name="VFSType"
2233	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2234	>
2235	<desc>
2236	Virtual file systems supported by VFSExplorer.
2237	</desc>
2238
2239	<const name="File" value="1" />
2240	<const name="Cloud" value="2" />
2241	<const name="S3" value="3" />
2242	<const name="WebDav" value="4" />
2243	</enum>
2244
2245	<enum
2246	name="VFSFileType"
2247	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2248	>
2249	<desc>
2250	File types known by VFSExplorer.
2251	</desc>
2252
2253	<const name="Unknown" value="1" />
2254	<const name="Fifo" value="2" />
2255	<const name="DevChar" value="3" />
2256	<const name="Directory" value="4" />
2257	<const name="DevBlock" value="5" />
2258	<const name="File" value="6" />
2259	<const name="SymLink" value="7" />
2260	<const name="Socket" value="8" />
2261	<const name="WhiteOut" value="9" />
2262	</enum>
2263
2264	<interface
2265	name="IVFSExplorer" extends="$unknown"
2266	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2267	wsmap="managed"
2268	>
2269	<desc>
2270	The VFSExplorer interface unifies access to different file system
2271	types. This includes local file systems as well remote file systems like
2272	S3. For a list of supported types see <link to="VFSType" />.
2273	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2274	</desc>
2275
2276	<attribute name="path" type="wstring" readonly="yes">
2277	<desc>Returns the current path in the virtual file system.</desc>
2278	</attribute>
2279
2280	<attribute name="type" type="VFSType" readonly="yes">
2281	<desc>Returns the file system type which is currently in use.</desc>
2282	</attribute>
2283
2284	<method name="update">
2285	<desc>Updates the internal list of files/directories from the
2286	current directory level. Use <link to="#entryList" /> to get the full list
2287	after a call to this method.</desc>
2288
2289	<param name="aProgress" type="IProgress" dir="return">
2290	<desc>Progress object to track the operation completion.</desc>
2291	</param>
2292	</method>
2293
2294	<method name="cd">
2295	<desc>Change the current directory level.</desc>
2296
2297	<param name="aDir" type="wstring" dir="in">
2298	<desc>The name of the directory to go in.</desc>
2299	</param>
2300
2301	<param name="aProgress" type="IProgress" dir="return">
2302	<desc>Progress object to track the operation completion.</desc>
2303	</param>
2304	</method>
2305
2306	<method name="cdUp">
2307	<desc>Go one directory upwards from the current directory level.</desc>
2308
2309	<param name="aProgress" type="IProgress" dir="return">
2310	<desc>Progress object to track the operation completion.</desc>
2311	</param>
2312	</method>
2313
2314	<method name="entryList">
2315	<desc>Returns a list of files/directories after a call to <link
2316	to="#update" />. The user is responsible for keeping this internal
2317	list up do date.</desc>
2318
2319	<param name="aNames" type="wstring" safearray="yes" dir="out">
2320	<desc>The list of names for the entries.</desc>
2321	</param>
2322
2323	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2324	<desc>The list of types for the entries.</desc>
2325	</param>
2326
2327	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2328	<desc>The list of sizes (in bytes) for the entries.</desc>
2329	</param>
2330
2331	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2332	<desc>The list of file modes (in octal form) for the entries.</desc>
2333	</param>
2334	</method>
2335
2336	<method name="exists">
2337	<desc>Checks if the given file list exists in the current directory
2338	level.</desc>
2339
2340	<param name="aNames" type="wstring" safearray="yes" dir="in">
2341	<desc>The names to check.</desc>
2342	</param>
2343
2344	<param name="aExists" type="wstring" safearray="yes" dir="return">
2345	<desc>The names which exist.</desc>
2346	</param>
2347	</method>
2348
2349	<method name="remove">
2350	<desc>Deletes the given files in the current directory level.</desc>
2351
2352	<param name="aNames" type="wstring" safearray="yes" dir="in">
2353	<desc>The names to remove.</desc>
2354	</param>
2355
2356	<param name="aProgress" type="IProgress" dir="return">
2357	<desc>Progress object to track the operation completion.</desc>
2358	</param>
2359	</method>
2360
2361	</interface>
2362
2363	<enum
2364	name="ImportOptions" extends="$unknown"
2365	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2366	>
2367
2368	<desc>
2369	Import options, used with <link to="IAppliance::importMachines" />.
2370	</desc>
2371
2372	<const name="KeepAllMACs" value="1">
2373	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2374	</const>
2375	<const name="KeepNATMACs" value="2">
2376	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2377	</const>
2378
2379	</enum>
2380
2381
2382	<!--
2383	// IAppliance
2384	/////////////////////////////////////////////////////////////////////////
2385	-->
2386
2387	<interface
2388	name="IAppliance" extends="$unknown"
2389	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2390	wsmap="managed"
2391	>
2392	<desc>
2393	Represents a platform-independent appliance in OVF format. An instance of this is returned
2394	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2395	virtual machines within an appliance with VirtualBox.
2396
2397	The OVF standard suggests two different physical file formats:
2398
2399	<ol>
2400	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2401	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2402	this descriptor file references other files such as disk images, as OVF appliances typically
2403	do, those additional files must be in the same directory as the descriptor file.</li>
2404
2405	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2406	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2407	files and optionally other files.
2408
2409	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2410	be added with a later version.</li>
2411	</ol>
2412
2413	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2414	<link to="IMachine" /> involves the following sequence of API calls:
2415
2416	<ol>
2417	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2418	</li>
2419
2420	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2421	would like to import. So long as this file is syntactically valid, this will succeed
2422	and fill the appliance object with the parsed data from the OVF file.
2423	</li>
2424
2425	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2426	contents of the IAppliance attributes accordingly. These can be inspected by a
2427	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2428	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2429	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2430	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2431	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2432	The GUI can then give the user the option to confirm and/or change these suggestions.
2433	</li>
2434
2435	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2436	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2437	</li>
2438
2439	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2440	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2441	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2442	can be found in the <link to="#machines" /> array attribute.
2443	</li>
2444	</ol>
2445
2446	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2447
2448	<ol>
2449	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2450	an empty IAppliance object.
2451	</li>
2452
2453	<li>For each machine you would like to export, call <link to="IMachine::export" />
2454	with the IAppliance object you just created. Each such call creates one instance of
2455	<link to="IVirtualSystemDescription" /> inside the appliance.
2456	</li>
2457
2458	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2459	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2460	</li>
2461
2462	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2463	file written.</li>
2464	</ol>
2465
2466	</desc>
2467
2468	<attribute name="path" type="wstring" readonly="yes">
2469	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2470	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2471	<link to="#write" /> (for export).
2472	This attribute is empty until one of these methods has been called.
2473	</desc>
2474	</attribute>
2475
2476	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2477	<desc>
2478	Array of virtual disk definitions. One such description exists for each
2479	disk definition in the OVF; each string array item represents one such piece of
2480	disk information, with the information fields separated by tab (\\t) characters.
2481
2482	The caller should be prepared for additional fields being appended to
2483	this string in future versions of VirtualBox and therefore check for
2484	the number of tabs in the strings returned.
2485
2486	In the current version, the following eight fields are returned per string
2487	in the array:
2488
2489	<ol>
2490	<li>Disk ID (unique string identifier given to disk)</li>
2491
2492	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2493
2494	<li>Populated size (optional unsigned integer indicating the current size of the
2495	disk; can be approximate; -1 if unspecified)</li>
2496
2497	<li>Format (string identifying the disk format, typically
2498	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2499
2500	<li>Reference (where to find the disk image, typically a file name; if empty,
2501	then the disk should be created on import)</li>
2502
2503	<li>Image size (optional unsigned integer indicating the size of the image,
2504	which need not necessarily be the same as the values specified above, since
2505	the image may be compressed or sparse; -1 if not specified)</li>
2506
2507	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2508	presently unsupported and always -1)</li>
2509
2510	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2511	</ol>
2512	</desc>
2513	</attribute>
2514
2515	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2516	<desc> Array of virtual system descriptions. One such description is created
2517	for each virtual system (machine) found in the OVF.
2518	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2519	(for export) has been called.
2520	</desc>
2521	</attribute>
2522
2523	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2524	<desc>
2525	Contains the UUIDs of the machines created from the information in this appliances. This is only
2526	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2527	succeeded.
2528	</desc>
2529	</attribute>
2530
2531	<method name="read">
2532	<desc>
2533	Reads an OVF file into the appliance object.
2534
2535	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2536	mere fact that this method returns successfully does not mean that VirtualBox supports all
2537	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2538	</desc>
2539	<param name="file" type="wstring" dir="in">
2540	<desc>
2541	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2542	on whether the appliance is distributed as a set of files or as a single file, respectively).
2543	</desc>
2544	</param>
2545	<param name="aProgress" type="IProgress" dir="return">
2546	<desc>Progress object to track the operation completion.</desc>
2547	</param>
2548	</method>
2549
2550	<method name="interpret">
2551	<desc>
2552	Interprets the OVF data that was read when the appliance was constructed. After
2553	calling this method, one can inspect the
2554	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2555	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2556	the appliance.
2557
2558	Calling this method is the second step of importing an appliance into VirtualBox;
2559	see <link to="IAppliance" /> for an overview.
2560
2561	After calling this method, one should call <link to="#getWarnings" /> to find out
2562	if problems were encountered during the processing which might later lead to
2563	errors.
2564	</desc>
2565	</method>
2566
2567	<method name="importMachines">
2568	<desc>
2569	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2570	and other interfaces that match the information contained in the appliance as
2571	closely as possible, as represented by the import instructions in the
2572	<link to="#virtualSystemDescriptions" /> array.
2573
2574	Calling this method is the final step of importing an appliance into VirtualBox;
2575	see <link to="IAppliance" /> for an overview.
2576
2577	Since importing the appliance will most probably involve copying and converting
2578	disk images, which can take a long time, this method operates asynchronously and
2579	returns an IProgress object to allow the caller to monitor the progress.
2580
2581	After the import succeeded, the UUIDs of the IMachine instances created can be
2582	retrieved from the <link to="#machines" /> array attribute.
2583	</desc>
2584
2585	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2586	<desc>Options for the importing operation.</desc>
2587	</param>
2588
2589	<param name="aProgress" type="IProgress" dir="return">
2590	<desc>Progress object to track the operation completion.</desc>
2591	</param>
2592	</method>
2593
2594	<method name="createVFSExplorer">
2595	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2596
2597	<param name="aUri" type="wstring" dir="in">
2598	<desc>The URI describing the file system to use.</desc>
2599	</param>
2600
2601	<param name="aExplorer" type="IVFSExplorer" dir="return">
2602	<desc></desc>
2603	</param>
2604	</method>
2605
2606	<method name="write">
2607	<desc>
2608	Writes the contents of the appliance exports into a new OVF file.
2609
2610	Calling this method is the final step of exporting an appliance from VirtualBox;
2611	see <link to="IAppliance" /> for an overview.
2612
2613	Since exporting the appliance will most probably involve copying and converting
2614	disk images, which can take a long time, this method operates asynchronously and
2615	returns an IProgress object to allow the caller to monitor the progress.
2616	</desc>
2617	<param name="format" type="wstring" dir="in">
2618	<desc>
2619	Output format, as a string. Currently supported formats are "ovf-0.9" and "ovf-1.0";
2620	future versions of VirtualBox may support additional formats.
2621	</desc>
2622	</param>
2623	<param name="manifest" type="boolean" dir="in">
2624	<desc>
2625	Indicate if the optional manifest file (.mf) should be written. The manifest file
2626	is used for integrity checks prior import.
2627	</desc>
2628	</param>
2629	<param name="path" type="wstring" dir="in">
2630	<desc>
2631	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2632	on whether the appliance is distributed as a set of files or as a single file, respectively).
2633	</desc>
2634	</param>
2635	<param name="progress" type="IProgress" dir="return">
2636	<desc>Progress object to track the operation completion.</desc>
2637	</param>
2638	</method>
2639
2640	<method name="getWarnings">
2641	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2642
2643	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2644	<desc></desc>
2645	</param>
2646	</method>
2647
2648	</interface>
2649
2650	<enum
2651	name="VirtualSystemDescriptionType"
2652	uuid="303c0900-a746-4612-8c67-79003e91f459"
2653	>
2654	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2655	a configuration value.</desc>
2656
2657	<const name="Ignore" value="1" />
2658	<const name="OS" value="2" />
2659	<const name="Name" value="3" />
2660	<const name="Product" value="4" />
2661	<const name="Vendor" value="5" />
2662	<const name="Version" value="6" />
2663	<const name="ProductUrl" value="7" />
2664	<const name="VendorUrl" value="8" />
2665	<const name="Description" value="9" />
2666	<const name="License" value="10" />
2667	<const name="Miscellaneous" value="11" />
2668	<const name="CPU" value="12" />
2669	<const name="Memory" value="13" />
2670	<const name="HardDiskControllerIDE" value="14" />
2671	<const name="HardDiskControllerSATA" value="15" />
2672	<const name="HardDiskControllerSCSI" value="16" />
2673	<const name="HardDiskControllerSAS" value="17" />
2674	<const name="HardDiskImage" value="18" />
2675	<const name="Floppy" value="19" />
2676	<const name="CDROM" value="20" />
2677	<const name="NetworkAdapter" value="21" />
2678	<const name="USBController" value="22" />
2679	<const name="SoundCard" value="23" />
2680	<const name="SettingsFile" value="24">
2681	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2682	</const>
2683	</enum>
2684
2685	<enum
2686	name="VirtualSystemDescriptionValueType"
2687	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2688	>
2689	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2690	type to fetch.</desc>
2691
2692	<const name="Reference" value="1" />
2693	<const name="Original" value="2" />
2694	<const name="Auto" value="3" />
2695	<const name="ExtraConfig" value="4" />
2696
2697	</enum>
2698
2699	<interface
2700	name="IVirtualSystemDescription" extends="$unknown"
2701	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2702	wsmap="managed"
2703	>
2704
2705	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2706	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2707	<link to="IAppliance::interpret" /> has been called, that array contains information
2708	about how the virtual systems described in the OVF should best be imported into
2709	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2710	import an OVF into VirtualBox.
2711	</desc>
2712
2713	<attribute name="count" type="unsigned long" readonly="yes">
2714	<desc>Return the number of virtual system description entries.</desc>
2715	</attribute>
2716
2717	<method name="getDescription">
2718	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2719	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2720
2721	The list below identifies the value sets that are possible depending on the
2722	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2723	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2724	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2725	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2726	the @a aExtraConfigValues[] array item may also be used.
2727
2728	<ul>
2729	<li>
2730	"OS": the guest operating system type. There must be exactly one such array item on import. The
2731	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2732	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2733	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2734	</li>
2735	<li>
2736	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2737	if none is present on import, then an automatic name will be created from the operating system
2738	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2739	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2740	<link to="IMachine" /> name that does not exist yet.
2741	</li>
2742	<li>
2743	"Description": an arbitrary description.
2744	</li>
2745	<li>
2746	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2747	code to display such a license for agreement; the Main API does not enforce any such policy.
2748	</li>
2749	<li>
2750	Miscellaneous: reserved for future use.
2751	</li>
2752	<li>
2753	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2754	</li>
2755	<li>
2756	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2757	is present on import, then VirtualBox will set a meaningful default based on the operating system
2758	type.
2759	</li>
2760	<li>
2761	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2762	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2763	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2764	writes into the OVF.
2765	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2766	type can use to specify which hard disk controller a virtual disk should be connected to.
2767	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2768	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2769	its virtual machines supports four channels (primary master, primary slave, secondary master,
2770	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2771	</li>
2772	<li>
2773	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2774	has no value in @a aOvfValues[] or @a aVBoxValues[].
2775	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2776	</li>
2777	<li>
2778	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2779	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2780	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2781	whereas VirtualBox considers it a class of storage controllers of its own; see
2782	<link to="StorageControllerType" />).
2783	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2784	</li>
2785	<li>
2786	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2787	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2788
2789	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2790	a path since the image file should be in the same location as the OVF file itself), whereas the
2791	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2792	hard disk image. This means that on import the image will be copied and converted from the
2793	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2794
2795	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2796	format: "controller=<index>;channel=<c>"
2797	In this string, <index> must be an integer specifying the hard disk controller to connect
2798	the image to. That number must be the index of an array item with one of the hard disk controller
2799	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2800	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2801	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2802	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2803	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2804	</li>
2805	<li>
2806	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2807	attachment information as with "HardDiskImage" items.
2808	</li>
2809	<li>
2810	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2811	attachment information as with "HardDiskImage" items.
2812	</li>
2813	<li>
2814	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2815	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2816	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2817	</li>
2818	<li>
2819	"USBController": a USB controller. There can be at most one such item. If and only if such an
2820	item ispresent, USB support will be enabled for the new virtual machine.
2821	</li>
2822	<li>
2823	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2824	present, sound support will be enabled for the new virtual machine. Note that the virtual
2825	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2826	may be different from the virtual soundcard expected by the appliance.
2827	</li>
2828	</ul>
2829
2830	</desc>
2831
2832	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2833	<desc></desc>
2834	</param>
2835
2836	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2837	<desc></desc>
2838	</param>
2839
2840	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2841	<desc></desc>
2842	</param>
2843
2844	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2845	<desc></desc>
2846	</param>
2847
2848	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2849	<desc></desc>
2850	</param>
2851
2852	</method>
2853
2854	<method name="getDescriptionByType">
2855	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2856	should be returned.</desc>
2857
2858	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2871	<desc></desc>
2872	</param>
2873
2874	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2875	<desc></desc>
2876	</param>
2877
2878	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2879	<desc></desc>
2880	</param>
2881
2882	</method>
2883
2884	<method name="getValuesByType">
2885	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2886	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2887	values.</desc>
2888
2889	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2890	<desc></desc>
2891	</param>
2892
2893	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2894	<desc></desc>
2895	</param>
2896
2897	<param name="aValues" type="wstring" dir="return" safearray="yes">
2898	<desc></desc>
2899	</param>
2900
2901	</method>
2902
2903	<method name="setFinalValues">
2904	<desc>
2905	This method allows the appliance's user to change the configuration for the virtual
2906	system descriptions. For each array item returned from <link to="#getDescription" />,
2907	you must pass in one boolean value and one configuration value.
2908
2909	Each item in the boolean array determines whether the particular configuration item
2910	should be enabled.
2911	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2912	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2913	and SoundCard.
2914
2915	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2916	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2917	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2918	for valid configuration values for the individual array item types. If the
2919	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2920	</desc>
2921
2922	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2923	<desc></desc>
2924	</param>
2925
2926	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2927	<desc></desc>
2928	</param>
2929
2930	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2931	<desc></desc>
2932	</param>
2933	</method>
2934
2935	<method name="addDescription">
2936	<desc>
2937	This method adds an additional description entry to the stack of already
2938	available descriptions for this virtual system. This is handy for writing
2939	values which aren't directly supported by VirtualBox. One example would
2940	be the License type of <link to="VirtualSystemDescriptionType" />.
2941	</desc>
2942
2943	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2944	<desc></desc>
2945	</param>
2946
2947	<param name="aVBoxValue" type="wstring" dir="in">
2948	<desc></desc>
2949	</param>
2950
2951	<param name="aExtraConfigValue" type="wstring" dir="in">
2952	<desc></desc>
2953	</param>
2954	</method>
2955	</interface>
2956
2957
2958	<!--
2959	// IMachine
2960	/////////////////////////////////////////////////////////////////////////
2961	-->
2962
2963	<interface
2964	name="IInternalMachineControl" extends="$unknown"
2965	uuid="2087906d-bb92-43a0-8014-4cab009e4888"
2966	internal="yes"
2967	wsmap="suppress"
2968	>
2969	<method name="setRemoveSavedStateFile">
2970	<desc>
2971	Updates the flag whether the saved state file is removed on a
2972	machine state change from Saved to PoweredOff.
2973	</desc>
2974	<param name="aRemove" type="boolean" dir="in"/>
2975	</method>
2976
2977	<method name="updateState">
2978	<desc>
2979	Updates the VM state.
2980	<note>
2981	This operation will also update the settings file with the correct
2982	information about the saved state file and delete this file from disk
2983	when appropriate.
2984	</note>
2985	</desc>
2986	<param name="state" type="MachineState" dir="in"/>
2987	</method>
2988
2989	<method name="getIPCId">
2990	<param name="id" type="wstring" dir="return"/>
2991	</method>
2992
2993	<method name="beginPowerUp">
2994	<desc>
2995	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
2996	gives it the progress object that should be part of any pending
2997	<link to="IMachine::launchVMProcess"/> operations. The progress
2998	object may be called back to reflect an early cancelation, so some care
2999	have to be taken with respect to any cancelation callbacks. The console
3000	object will call <link to="IInternalMachineControl::endPowerUp"/>
3001	to signal the completion of the progress object.
3002	</desc>
3003	<param name="aProgress" type="IProgress" dir="in" />
3004	</method>
3005
3006	<method name="endPowerUp">
3007	<desc>
3008	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3009	This method may query status information from the progress object it
3010	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3011	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3012	call in order to complete that progress object.
3013	</desc>
3014	<param name="result" type="long" dir="in"/>
3015	</method>
3016
3017	<method name="beginPoweringDown">
3018	<desc>
3019	Called by the VM process to inform the server it wants to
3020	stop the VM execution and power down.
3021	</desc>
3022	<param name="progress" type="IProgress" dir="out">
3023	<desc>
3024	Progress object created by VBoxSVC to wait until
3025	the VM is powered down.
3026	</desc>
3027	</param>
3028	</method>
3029
3030	<method name="endPoweringDown">
3031	<desc>
3032	Called by the VM process to inform the server that powering
3033	down previously requested by #beginPoweringDown is either
3034	successfully finished or there was a failure.
3035
3036	<result name="VBOX_E_FILE_ERROR">
3037	Settings file not accessible.
3038	</result>
3039	<result name="VBOX_E_XML_ERROR">
3040	Could not parse the settings file.
3041	</result>
3042
3043	</desc>
3044
3045	<param name="result" type="long" dir="in">
3046	<desc>@c S_OK to indicate success.
3047	</desc>
3048	</param>
3049	<param name="errMsg" type="wstring" dir="in">
3050	<desc>@c human readable error message in case of failure.
3051	</desc>
3052	</param>
3053	</method>
3054
3055	<method name="runUSBDeviceFilters">
3056	<desc>
3057	Asks the server to run USB devices filters of the associated
3058	machine against the given USB device and tell if there is
3059	a match.
3060	<note>
3061	Intended to be used only for remote USB devices. Local
3062	ones don't require to call this method (this is done
3063	implicitly by the Host and USBProxyService).
3064	</note>
3065	</desc>
3066	<param name="device" type="IUSBDevice" dir="in"/>
3067	<param name="matched" type="boolean" dir="out"/>
3068	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3069	</method>
3070
3071	<method name="captureUSBDevice">
3072	<desc>
3073	Requests a capture of the given host USB device.
3074	When the request is completed, the VM process will
3075	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3076	notification.
3077	</desc>
3078	<param name="id" type="uuid" mod="string" dir="in"/>
3079	</method>
3080
3081	<method name="detachUSBDevice">
3082	<desc>
3083	Notification that a VM is going to detach (@a done = @c false) or has
3084	already detached (@a done = @c true) the given USB device.
3085	When the @a done = @c true request is completed, the VM process will
3086	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3087	notification.
3088	<note>
3089	In the @a done = @c true case, the server must run its own filters
3090	and filters of all VMs but this one on the detached device
3091	as if it were just attached to the host computer.
3092	</note>
3093	</desc>
3094	<param name="id" type="uuid" mod="string" dir="in"/>
3095	<param name="done" type="boolean" dir="in"/>
3096	</method>
3097
3098	<method name="autoCaptureUSBDevices">
3099	<desc>
3100	Requests a capture all matching USB devices attached to the host.
3101	When the request is completed, the VM process will
3102	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3103	notification per every captured device.
3104	</desc>
3105	</method>
3106
3107	<method name="detachAllUSBDevices">
3108	<desc>
3109	Notification that a VM that is being powered down. The done
3110	parameter indicates whether which stage of the power down
3111	we're at. When @a done = @c false the VM is announcing its
3112	intentions, while when @a done = @c true the VM is reporting
3113	what it has done.
3114	<note>
3115	In the @a done = @c true case, the server must run its own filters
3116	and filters of all VMs but this one on all detach devices as
3117	if they were just attached to the host computer.
3118	</note>
3119	</desc>
3120	<param name="done" type="boolean" dir="in"/>
3121	</method>
3122
3123	<method name="onSessionEnd">
3124	<desc>
3125	Triggered by the given session object when the session is about
3126	to close normally.
3127	</desc>
3128	<param name="session" type="ISession" dir="in">
3129	<desc>Session that is being closed</desc>
3130	</param>
3131	<param name="progress" type="IProgress" dir="return">
3132	<desc>
3133	Used to wait until the corresponding machine is actually
3134	dissociated from the given session on the server.
3135	Returned only when this session is a direct one.
3136	</desc>
3137	</param>
3138	</method>
3139
3140	<method name="beginSavingState">
3141	<desc>
3142	Called by the VM process to inform the server it wants to
3143	save the current state and stop the VM execution.
3144	</desc>
3145	<param name="progress" type="IProgress" dir="out">
3146	<desc>
3147	Progress object created by VBoxSVC to wait until
3148	the state is saved.
3149	</desc>
3150	</param>
3151	<param name="stateFilePath" type="wstring" dir="out">
3152	<desc>
3153	File path the VM process must save the execution state to.
3154	</desc>
3155	</param>
3156	</method>
3157
3158	<method name="endSavingState">
3159	<desc>
3160	Called by the VM process to inform the server that saving
3161	the state previously requested by #beginSavingState is either
3162	successfully finished or there was a failure.
3163
3164	<result name="VBOX_E_FILE_ERROR">
3165	Settings file not accessible.
3166	</result>
3167	<result name="VBOX_E_XML_ERROR">
3168	Could not parse the settings file.
3169	</result>
3170
3171	</desc>
3172
3173	<param name="result" type="long" dir="in">
3174	<desc>@c S_OK to indicate success.
3175	</desc>
3176	</param>
3177	<param name="errMsg" type="wstring" dir="in">
3178	<desc>@c human readable error message in case of failure.
3179	</desc>
3180	</param>
3181	</method>
3182
3183	<method name="adoptSavedState">
3184	<desc>
3185	Gets called by <link to="IConsole::adoptSavedState"/>.
3186	<result name="VBOX_E_FILE_ERROR">
3187	Invalid saved state file path.
3188	</result>
3189	</desc>
3190	<param name="savedStateFile" type="wstring" dir="in">
3191	<desc>Path to the saved state file to adopt.</desc>
3192	</param>
3193	</method>
3194
3195	<method name="beginTakingSnapshot">
3196	<desc>
3197	Called from the VM process to request from the server to perform the
3198	server-side actions of creating a snapshot (creating differencing images
3199	and the snapshot object).
3200
3201	<result name="VBOX_E_FILE_ERROR">
3202	Settings file not accessible.
3203	</result>
3204	<result name="VBOX_E_XML_ERROR">
3205	Could not parse the settings file.
3206	</result>
3207	</desc>
3208	<param name="initiator" type="IConsole" dir="in">
3209	<desc>The console object that initiated this call.</desc>
3210	</param>
3211	<param name="name" type="wstring" dir="in">
3212	<desc>Snapshot name.</desc>
3213	</param>
3214	<param name="description" type="wstring" dir="in">
3215	<desc>Snapshot description.</desc>
3216	</param>
3217	<param name="consoleProgress" type="IProgress" dir="in">
3218	<desc>
3219	Progress object created by the VM process tracking the
3220	snapshot's progress. This has the following sub-operations:
3221	<ul>
3222	<li>setting up (weight 1);</li>
3223	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3224	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3225	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3226	<li>finishing up (weight 1)</li>
3227	</ul>
3228	</desc>
3229	</param>
3230	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3231	<desc>
3232	Whether this is an online snapshot (i.e. the machine is running).
3233	</desc>
3234	</param>
3235	<param name="stateFilePath" type="wstring" dir="out">
3236	<desc>
3237	File path the VM process must save the execution state to.
3238	</desc>
3239	</param>
3240	</method>
3241
3242	<method name="endTakingSnapshot">
3243	<desc>
3244	Called by the VM process to inform the server that the snapshot
3245	previously requested by #beginTakingSnapshot is either
3246	successfully taken or there was a failure.
3247	</desc>
3248
3249	<param name="success" type="boolean" dir="in">
3250	<desc>@c true to indicate success and @c false otherwise</desc>
3251	</param>
3252	</method>
3253
3254	<method name="deleteSnapshot">
3255	<desc>
3256	Gets called by <link to="IConsole::deleteSnapshot"/>,
3257	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3258	<link to="IConsole::deleteSnapshotRange"/>.
3259	<result name="VBOX_E_INVALID_OBJECT_STATE">
3260	Snapshot has more than one child snapshot. Only possible if the
3261	delete operation does not delete all children or the range does
3262	not meet the linearity condition.
3263	</result>
3264	</desc>
3265	<param name="initiator" type="IConsole" dir="in">
3266	<desc>The console object that initiated this call.</desc>
3267	</param>
3268	<param name="startId" type="uuid" mod="string" dir="in">
3269	<desc>UUID of the first snapshot to delete.</desc>
3270	</param>
3271	<param name="endId" type="uuid" mod="string" dir="in">
3272	<desc>UUID of the last snapshot to delete.</desc>
3273	</param>
3274	<param name="deleteAllChildren" type="boolean" dir="in">
3275	<desc>Whether all children should be deleted.</desc>
3276	</param>
3277	<param name="machineState" type="MachineState" dir="out">
3278	<desc>New machine state after this operation is started.</desc>
3279	</param>
3280	<param name="progress" type="IProgress" dir="return">
3281	<desc>Progress object to track the operation completion.</desc>
3282	</param>
3283	</method>
3284
3285	<method name="finishOnlineMergeMedium">
3286	<desc>
3287	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3288	</desc>
3289	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3290	<desc>The medium attachment which needs to be cleaned up.</desc>
3291	</param>
3292	<param name="source" type="IMedium" dir="in">
3293	<desc>Merge source medium.</desc>
3294	</param>
3295	<param name="target" type="IMedium" dir="in">
3296	<desc>Merge target medium.</desc>
3297	</param>
3298	<param name="mergeForward" type="boolean" dir="in">
3299	<desc>Merge direction.</desc>
3300	</param>
3301	<param name="parentForTarget" type="IMedium" dir="in">
3302	<desc>For forward merges: new parent for target medium.</desc>
3303	</param>
3304	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3305	<desc>For backward merges: list of media which need their parent UUID
3306	updated.</desc>
3307	</param>
3308	</method>
3309
3310	<method name="restoreSnapshot">
3311	<desc>
3312	Gets called by <link to="IConsole::restoreSnapshot"/>.
3313	</desc>
3314	<param name="initiator" type="IConsole" dir="in">
3315	<desc>The console object that initiated this call.</desc>
3316	</param>
3317	<param name="snapshot" type="ISnapshot" dir="in">
3318	<desc>The snapshot to restore the VM state from.</desc>
3319	</param>
3320	<param name="machineState" type="MachineState" dir="out">
3321	<desc>New machine state after this operation is started.</desc>
3322	</param>
3323	<param name="progress" type="IProgress" dir="return">
3324	<desc>Progress object to track the operation completion.</desc>
3325	</param>
3326	</method>
3327
3328	<method name="pullGuestProperties">
3329	<desc>
3330	Get the list of the guest properties matching a set of patterns along
3331	with their values, time stamps and flags and give responsibility for
3332	managing properties to the console.
3333	</desc>
3334	<param name="name" type="wstring" dir="out" safearray="yes">
3335	<desc>
3336	The names of the properties returned.
3337	</desc>
3338	</param>
3339	<param name="value" type="wstring" dir="out" safearray="yes">
3340	<desc>
3341	The values of the properties returned. The array entries match the
3342	corresponding entries in the @a name array.
3343	</desc>
3344	</param>
3345	<param name="timestamp" type="long long" dir="out" safearray="yes">
3346	<desc>
3347	The time stamps of the properties returned. The array entries match
3348	the corresponding entries in the @a name array.
3349	</desc>
3350	</param>
3351	<param name="flags" type="wstring" dir="out" safearray="yes">
3352	<desc>
3353	The flags of the properties returned. The array entries match the
3354	corresponding entries in the @a name array.
3355	</desc>
3356	</param>
3357	</method>
3358
3359	<method name="pushGuestProperty">
3360	<desc>
3361	Update a single guest property in IMachine.
3362	</desc>
3363	<param name="name" type="wstring" dir="in">
3364	<desc>
3365	The name of the property to be updated.
3366	</desc>
3367	</param>
3368	<param name="value" type="wstring" dir="in">
3369	<desc>
3370	The value of the property.
3371	</desc>
3372	</param>
3373	<param name="timestamp" type="long long" dir="in">
3374	<desc>
3375	The timestamp of the property.
3376	</desc>
3377	</param>
3378	<param name="flags" type="wstring" dir="in">
3379	<desc>
3380	The flags of the property.
3381	</desc>
3382	</param>
3383	</method>
3384
3385	<method name="lockMedia">
3386	<desc>
3387	Locks all media attached to the machine for writing and parents of
3388	attached differencing media (if any) for reading. This operation is
3389	atomic so that if it fails no media is actually locked.
3390
3391	This method is intended to be called when the machine is in Starting or
3392	Restoring state. The locked media will be automatically unlocked when
3393	the machine is powered off or crashed.
3394	</desc>
3395	</method>
3396	<method name="unlockMedia">
3397	<desc>
3398	Unlocks all media previously locked using
3399	<link to="IInternalMachineControl::lockMedia"/>.
3400
3401	This method is intended to be used with teleportation so that it is
3402	possible to teleport between processes on the same machine.
3403	</desc>
3404	</method>
3405
3406	<method name="ejectMedium">
3407	<desc>
3408	Tells VBoxSVC that the guest has ejected the medium associated with
3409	the medium attachment.
3410	</desc>
3411	<param name="attachment" type="IMediumAttachment" dir="in">
3412	<desc>
3413	The medium attachment where the eject happened.
3414	</desc>
3415	</param>
3416	<param name="newAttachment" type="IMediumAttachment" dir="return">
3417	<desc>
3418	A new reference to the medium attachment, as the config change can
3419	result in the creation of a new instance.
3420	</desc>
3421	</param>
3422	</method>
3423	</interface>
3424
3425	<interface
3426	name="IBIOSSettings" extends="$unknown"
3427	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3428	wsmap="managed"
3429	>
3430	<desc>
3431	The IBIOSSettings interface represents BIOS settings of the virtual
3432	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3433	</desc>
3434	<attribute name="logoFadeIn" type="boolean">
3435	<desc>Fade in flag for BIOS logo animation.</desc>
3436	</attribute>
3437
3438	<attribute name="logoFadeOut" type="boolean">
3439	<desc>Fade out flag for BIOS logo animation.</desc>
3440	</attribute>
3441
3442	<attribute name="logoDisplayTime" type="unsigned long">
3443	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3444	</attribute>
3445
3446	<attribute name="logoImagePath" type="wstring">
3447	<desc>
3448	Local file system path for external BIOS splash image. Empty string
3449	means the default image is shown on boot.
3450	</desc>
3451	</attribute>
3452
3453	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3454	<desc>Mode of the BIOS boot device menu.</desc>
3455	</attribute>
3456
3457	<attribute name="ACPIEnabled" type="boolean">
3458	<desc>ACPI support flag.</desc>
3459	</attribute>
3460
3461	<attribute name="IOAPICEnabled" type="boolean">
3462	<desc>
3463	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3464	and support IRQs above 15.
3465	</desc>
3466	</attribute>
3467
3468	<attribute name="timeOffset" type="long long">
3469	<desc>
3470	Offset in milliseconds from the host system time. This allows for
3471	guests running with a different system date/time than the host.
3472	It is equivalent to setting the system date/time in the BIOS except
3473	it is not an absolute value but a relative one. Guest Additions
3474	time synchronization honors this offset.
3475	</desc>
3476	</attribute>
3477
3478	<attribute name="PXEDebugEnabled" type="boolean">
3479	<desc>
3480	PXE debug logging flag. If set, VirtualBox will write extensive
3481	PXE trace information to the release log.
3482	</desc>
3483	</attribute>
3484
3485	</interface>
3486
3487	<enum
3488	name="CleanupMode"
3489	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3490	>
3491	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3492	</desc>
3493	<const name="UnregisterOnly" value="1">
3494	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3495	</const>
3496	<const name="DetachAllReturnNone" value="2">
3497	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3498	</const>
3499	<const name="DetachAllReturnHardDisksOnly" value="3">
3500	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3501	</const>
3502	<const name="Full" value="4">
3503	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3504	</const>
3505	</enum>
3506
3507	<interface
3508	name="IPciAddress" extends="$unknown"
3509	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3510	wsmap="struct"
3511	>
3512
3513	<desc>
3514	Address on the PCI bus.
3515	</desc>
3516
3517	<attribute name="bus" type="short">
3518	<desc>
3519	Bus number.
3520	</desc>
3521	</attribute>
3522
3523	<attribute name="device" type="short">
3524	<desc>
3525	Device number.
3526	</desc>
3527	</attribute>
3528
3529	<attribute name="devFunction" type="short">
3530	<desc>
3531	Device function number.
3532	</desc>
3533	</attribute>
3534
3535	<method name="asLong">
3536	<desc>
3537	Convert PCI address into long.
3538	</desc>
3539	<param name="result" type="long" dir="return" />
3540	</method>
3541
3542	<method name="fromLong">
3543	<desc>
3544	Make PCI address from long.
3545	</desc>
3546	<param name="number" type="long" dir="in" />
3547	</method>
3548	</interface>
3549
3550	<interface
3551	name="IPciDeviceAttachment" extends="$unknown"
3552	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3553	wsmap="struct"
3554	>
3555
3556	<desc>
3557	Information about PCI attachments.
3558	</desc>
3559
3560	<attribute name="name" type="wstring" readonly="yes">
3561	<desc>
3562	Device name.
3563	</desc>
3564	</attribute>
3565
3566	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3567	<desc>
3568	If this is physical or virtual device.
3569	</desc>
3570	</attribute>
3571
3572	<attribute name="hostAddress" type="long" readonly="yes">
3573	<desc>
3574	Address of device on the host, applicable only to host devices.
3575	</desc>
3576	</attribute>
3577
3578	<attribute name="guestAddress" type="long" readonly="yes">
3579	<desc>
3580	Address of device on the guest.
3581	</desc>
3582	</attribute>
3583
3584	</interface>
3585
3586	<enum
3587	name="CloneMode" extends="$unknown"
3588	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3589	>
3590
3591	<desc>
3592	Clone mode, used with <link to="IMachine::cloneTo" />.
3593	</desc>
3594
3595	<const name="MachineState" value="1">
3596	<desc>Clone the state of the selected machine.</desc>
3597	</const>
3598	<const name="MachineAndChildStates" value="2">
3599	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3600	</const>
3601	<const name="AllStates" value="3">
3602	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3603	</const>
3604
3605	</enum>
3606
3607	<enum
3608	name="CloneOptions" extends="$unknown"
3609	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3610	>
3611
3612	<desc>
3613	Clone options, used with <link to="IMachine::cloneTo" />.
3614	</desc>
3615
3616	<const name="Link" value="1">
3617	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3618	</const>
3619	<const name="KeepAllMACs" value="2">
3620	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3621	</const>
3622	<const name="KeepNATMACs" value="3">
3623	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3624	</const>
3625	<const name="KeepDiskNames" value="4">
3626	<desc>Don't change the disk names.</desc>
3627	</const>
3628
3629	</enum>
3630
3631
3632	<interface
3633	name="IMachine" extends="$unknown"
3634	uuid="116704af-f221-4d9e-8697-c11331622907"
3635	wsmap="managed"
3636	>
3637	<desc>
3638	The IMachine interface represents a virtual machine, or guest, created
3639	in VirtualBox.
3640
3641	This interface is used in two contexts. First of all, a collection of
3642	objects implementing this interface is stored in the
3643	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3644	machines that are currently registered with this VirtualBox
3645	installation. Also, once a session has been opened for the given virtual
3646	machine (e.g. the virtual machine is running), the machine object
3647	associated with the open session can be queried from the session object;
3648	see <link to="ISession"/> for details.
3649
3650	The main role of this interface is to expose the settings of the virtual
3651	machine and provide methods to change various aspects of the virtual
3652	machine's configuration. For machine objects stored in the
3653	<link to="IVirtualBox::machines"/> collection, all attributes are
3654	read-only unless explicitly stated otherwise in individual attribute
3655	and method descriptions.
3656
3657	In order to change a machine setting, a session for this machine must be
3658	opened using one of the <link to="IMachine::lockMachine" /> or
3659	<link to="IMachine::launchVMProcess"/> methods. After the
3660	machine has been successfully locked for a session, a mutable machine object
3661	needs to be queried from the session object and then the desired settings
3662	changes can be applied to the returned object using IMachine attributes and
3663	methods. See the <link to="ISession"/> interface description for more
3664	information about sessions.
3665
3666	Note that IMachine does not provide methods to control virtual machine
3667	execution (such as start the machine, or power it down) -- these methods
3668	are grouped in a separate interface called <link to="IConsole" />.
3669
3670	<see><link to="ISession"/>, <link to="IConsole"/></see>
3671	</desc>
3672
3673	<attribute name="parent" type="IVirtualBox" readonly="yes">
3674	<desc>Associated parent object.</desc>
3675	</attribute>
3676
3677	<attribute name="accessible" type="boolean" readonly="yes">
3678	<desc>
3679	Whether this virtual machine is currently accessible or not.
3680
3681	A machine is always deemed accessible unless it is registered <i>and</i>
3682	its settings file cannot be read or parsed (either because the file itself
3683	is unavailable or has invalid XML contents).
3684
3685	Every time this property is read, the accessibility state of
3686	this machine is re-evaluated. If the returned value is @c false,
3687	the <link to="#accessError"/> property may be used to get the
3688	detailed error information describing the reason of
3689	inaccessibility, including XML error messages.
3690
3691	When the machine is inaccessible, only the following properties
3692	can be used on it:
3693	<ul>
3694	<li><link to="#parent"/></li>
3695	<li><link to="#id"/></li>
3696	<li><link to="#settingsFilePath"/></li>
3697	<li><link to="#accessible"/></li>
3698	<li><link to="#accessError"/></li>
3699	</ul>
3700
3701	An attempt to access any other property or method will return
3702	an error.
3703
3704	The only possible action you can perform on an inaccessible
3705	machine is to unregister it using the
3706	<link to="IMachine::unregister"/> call (or, to check
3707	for the accessibility state once more by querying this
3708	property).
3709
3710	<note>
3711	In the current implementation, once this property returns
3712	@c true, the machine will never become inaccessible
3713	later, even if its settings file cannot be successfully
3714	read/written any more (at least, until the VirtualBox
3715	server is restarted). This limitation may be removed in
3716	future releases.
3717	</note>
3718	</desc>
3719	</attribute>
3720
3721	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3722	<desc>
3723	Error information describing the reason of machine
3724	inaccessibility.
3725
3726	Reading this property is only valid after the last call to
3727	<link to="#accessible"/> returned @c false (i.e. the
3728	machine is currently inaccessible). Otherwise, a @c null
3729	IVirtualBoxErrorInfo object will be returned.
3730	</desc>
3731	</attribute>
3732
3733	<attribute name="name" type="wstring">
3734	<desc>
3735	Name of the virtual machine.
3736
3737	Besides being used for human-readable identification purposes
3738	everywhere in VirtualBox, the virtual machine name is also used
3739	as a name of the machine's settings file and as a name of the
3740	subdirectory this settings file resides in. Thus, every time you
3741	change the value of this property, the settings file will be
3742	renamed once you call <link to="#saveSettings"/> to confirm the
3743	change. The containing subdirectory will be also renamed, but
3744	only if it has exactly the same name as the settings file
3745	itself prior to changing this property (for backward compatibility
3746	with previous API releases). The above implies the following
3747	limitations:
3748	<ul>
3749	<li>The machine name cannot be empty.</li>
3750	<li>The machine name can contain only characters that are valid
3751	file name characters according to the rules of the file
3752	system used to store VirtualBox configuration.</li>
3753	<li>You cannot have two or more machines with the same name
3754	if they use the same subdirectory for storing the machine
3755	settings files.</li>
3756	<li>You cannot change the name of the machine if it is running,
3757	or if any file in the directory containing the settings file
3758	is being used by another running machine or by any other
3759	process in the host operating system at a time when
3760	<link to="#saveSettings"/> is called.
3761	</li>
3762	</ul>
3763	If any of the above limitations are hit, <link to="#saveSettings"/>
3764	will return an appropriate error message explaining the exact
3765	reason and the changes you made to this machine will not be saved.
3766
3767	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3768	file is recommended, but not enforced. (Previous versions always
3769	used a generic ".xml" extension.)
3770	</desc>
3771	</attribute>
3772
3773	<attribute name="description" type="wstring">
3774	<desc>
3775	Description of the virtual machine.
3776
3777	The description attribute can contain any text and is
3778	typically used to describe the hardware and software
3779	configuration of the virtual machine in detail (i.e. network
3780	settings, versions of the installed software and so on).
3781	</desc>
3782	</attribute>
3783
3784	<attribute name="id" type="uuid" mod="string" readonly="yes">
3785	<desc>UUID of the virtual machine.</desc>
3786	</attribute>
3787
3788	<attribute name="OSTypeId" type="wstring">
3789	<desc>
3790	User-defined identifier of the Guest OS type.
3791	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3792	an IGuestOSType object representing details about the given
3793	Guest OS type.
3794	<note>
3795	This value may differ from the value returned by
3796	<link to="IGuest::OSTypeId"/> if Guest Additions are
3797	installed to the guest OS.
3798	</note>
3799	</desc>
3800	</attribute>
3801
3802	<attribute name="hardwareVersion" type="wstring">
3803	<desc>Hardware version identifier. Internal use only for now.</desc>
3804	</attribute>
3805
3806	<attribute name="hardwareUUID" type="uuid" mod="string">
3807	<desc>
3808	The UUID presented to the guest via memory tables, hardware and guest
3809	properties. For most VMs this is the same as the @a id, but for VMs
3810	which have been cloned or teleported it may be the same as the source
3811	VM. This latter is because the guest shouldn't notice that it was
3812	cloned or teleported.
3813	</desc>
3814	</attribute>
3815
3816	<attribute name="CPUCount" type="unsigned long">
3817	<desc>Number of virtual CPUs in the VM.</desc>
3818	</attribute>
3819
3820	<attribute name="CPUHotPlugEnabled" type="boolean">
3821	<desc>
3822	This setting determines whether VirtualBox allows CPU
3823	hotplugging for this machine.</desc>
3824	</attribute>
3825
3826	<attribute name="CPUExecutionCap" type="unsigned long">
3827	<desc>
3828	Means to limit the number of CPU cycles a guest can use. The unit
3829	is percentage of host CPU cycles per second. The valid range
3830	is 1 - 100. 100 (the default) implies no limit.
3831	</desc>
3832	</attribute>
3833
3834	<attribute name="memorySize" type="unsigned long">
3835	<desc>System memory size in megabytes.</desc>
3836	</attribute>
3837
3838	<attribute name="memoryBalloonSize" type="unsigned long">
3839	<desc>Memory balloon size in megabytes.</desc>
3840	</attribute>
3841
3842	<attribute name="pageFusionEnabled" type="boolean">
3843	<desc>
3844	This setting determines whether VirtualBox allows page
3845	fusion for this machine (64 bits host only).
3846	</desc>
3847	</attribute>
3848
3849	<attribute name="VRAMSize" type="unsigned long">
3850	<desc>Video memory size in megabytes.</desc>
3851	</attribute>
3852
3853	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3854	<desc>
3855	This setting determines whether VirtualBox allows this machine to make
3856	use of the 3D graphics support available on the host.</desc>
3857	</attribute>
3858
3859	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3860	<desc>
3861	This setting determines whether VirtualBox allows this machine to make
3862	use of the 2D video acceleration support available on the host.</desc>
3863	</attribute>
3864
3865	<attribute name="monitorCount" type="unsigned long">
3866	<desc>
3867	Number of virtual monitors.
3868	<note>
3869	Only effective on Windows XP and later guests with
3870	Guest Additions installed.
3871	</note>
3872	</desc>
3873	</attribute>
3874
3875	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3876	<desc>Object containing all BIOS settings.</desc>
3877	</attribute>
3878
3879	<attribute name="firmwareType" type="FirmwareType">
3880	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3881	bootstrap in this VM.</desc>
3882	</attribute>
3883
3884	<attribute name="pointingHidType" type="PointingHidType">
3885	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3886	The default is typically "PS2Mouse" but can vary depending on the
3887	requirements of the guest operating system.</desc>
3888	</attribute>
3889
3890	<attribute name="keyboardHidType" type="KeyboardHidType">
3891	<desc>Type of keyboard HID used in this VM.
3892	The default is typically "PS2Keyboard" but can vary depending on the
3893	requirements of the guest operating system.</desc>
3894	</attribute>
3895
3896	<attribute name="hpetEnabled" type="boolean">
3897	<desc>This attribute controls if High Precision Event Timer (HPET) is
3898	enabled in this VM. Use this property if you want to provide guests
3899	with additional time source, or if guest requires HPET to function correctly.
3900	Default is false.</desc>
3901	</attribute>
3902
3903	<attribute name="chipsetType" type="ChipsetType">
3904	<desc>Chipset type used in this VM.</desc>
3905	</attribute>
3906
3907	<attribute name="snapshotFolder" type="wstring">
3908	<desc>
3909	Full path to the directory used to store snapshot data
3910	(differencing media and saved state files) of this machine.
3911
3912	The initial value of this property is
3913	<tt><</tt><link to="#settingsFilePath">
3914	path_to_settings_file</link><tt>>/<</tt>
3915	<link to="#id">machine_uuid</link>
3916	<tt>></tt>.
3917
3918	Currently, it is an error to try to change this property on
3919	a machine that has snapshots (because this would require to
3920	move possibly large files to a different location).
3921	A separate method will be available for this purpose later.
3922
3923	<note>
3924	Setting this property to @c null or to an empty string will restore
3925	the initial value.
3926	</note>
3927	<note>
3928	When setting this property, the specified path can be
3929	absolute (full path) or relative to the directory where the
3930	<link to="#settingsFilePath">machine settings file</link>
3931	is located. When reading this property, a full path is
3932	always returned.
3933	</note>
3934	<note>
3935	The specified path may not exist, it will be created
3936	when necessary.
3937	</note>
3938	</desc>
3939	</attribute>
3940
3941	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3942	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3943	</attribute>
3944
3945	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
3946	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
3947
3948	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
3949	<desc>Array of media attached to this machine.</desc>
3950	</attribute>
3951
3952	<attribute name="USBController" type="IUSBController" readonly="yes">
3953	<desc>
3954	Associated USB controller object.
3955
3956	<note>
3957	If USB functionality is not available in the given edition of
3958	VirtualBox, this method will set the result code to @c E_NOTIMPL.
3959	</note>
3960	</desc>
3961	</attribute>
3962
3963	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
3964	<desc>Associated audio adapter, always present.</desc>
3965	</attribute>
3966
3967	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
3968	<desc>Array of storage controllers attached to this machine.</desc>
3969	</attribute>
3970
3971	<attribute name="settingsFilePath" type="wstring" readonly="yes">
3972	<desc>
3973	Full name of the file containing machine settings data.
3974	</desc>
3975	</attribute>
3976
3977	<attribute name="settingsModified" type="boolean" readonly="yes">
3978	<desc>
3979	Whether the settings of this machine have been modified
3980	(but neither yet saved nor discarded).
3981	<note>
3982	Reading this property is only valid on instances returned
3983	by <link to="ISession::machine"/> and on new machines
3984	created by <link to="IVirtualBox::createMachine"/> or opened
3985	by <link to="IVirtualBox::openMachine"/> but not
3986	yet registered, or on unregistered machines after calling
3987	<link to="IMachine::unregister"/>. For all other
3988	cases, the settings can never be modified.
3989	</note>
3990	<note>
3991	For newly created unregistered machines, the value of this
3992	property is always @c true until <link to="#saveSettings"/>
3993	is called (no matter if any machine settings have been
3994	changed after the creation or not). For opened machines
3995	the value is set to @c false (and then follows to normal rules).
3996	</note>
3997	</desc>
3998	</attribute>
3999
4000	<attribute name="sessionState" type="SessionState" readonly="yes">
4001	<desc>Current session state for this machine.</desc>
4002	</attribute>
4003
4004	<attribute name="sessionType" type="wstring" readonly="yes">
4005	<desc>
4006	Type of the session. If <link to="#sessionState"/> is
4007	Spawning or Locked, this attribute contains the
4008	same value as passed to the
4009	<link to="IMachine::launchVMProcess"/> method in the
4010	@a type parameter. If the session was used with
4011	<link to="IMachine::lockMachine" />, or if
4012	<link to="#sessionState"/> is SessionClosed, the value of this
4013	attribute is an empty string.
4014	</desc>
4015	</attribute>
4016
4017	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4018	<desc>
4019	Identifier of the session process. This attribute contains the
4020	platform-dependent identifier of the process whose session was
4021	used with <link to="IMachine::lockMachine" /> call. The returned
4022	value is only valid if <link to="#sessionState"/> is Locked or
4023	Unlocking by the time this property is read.
4024	</desc>
4025	</attribute>
4026
4027	<attribute name="state" type="MachineState" readonly="yes">
4028	<desc>Current execution state of this machine.</desc>
4029	</attribute>
4030
4031	<attribute name="lastStateChange" type="long long" readonly="yes">
4032	<desc>
4033	Time stamp of the last execution state change,
4034	in milliseconds since 1970-01-01 UTC.
4035	</desc>
4036	</attribute>
4037
4038	<attribute name="stateFilePath" type="wstring" readonly="yes">
4039	<desc>
4040	Full path to the file that stores the execution state of
4041	the machine when it is in the <link to="MachineState_Saved"/> state.
4042	<note>
4043	When the machine is not in the Saved state, this attribute is
4044	an empty string.
4045	</note>
4046	</desc>
4047	</attribute>
4048
4049	<attribute name="logFolder" type="wstring" readonly="yes">
4050	<desc>
4051	Full path to the folder that stores a set of rotated log files
4052	recorded during machine execution. The most recent log file is
4053	named <tt>VBox.log</tt>, the previous log file is
4054	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4055	in the current version).
4056	</desc>
4057	</attribute>
4058
4059	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4060	<desc>
4061	Current snapshot of this machine. This is @c null if the machine
4062	currently has no snapshots. If it is not @c null, then it was
4063	set by one of <link to="IConsole::takeSnapshot" />,
4064	<link to="IConsole::deleteSnapshot" />
4065	or <link to="IConsole::restoreSnapshot" />, depending on which
4066	was called last. See <link to="ISnapshot"/> for details.
4067	</desc>
4068	</attribute>
4069
4070	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4071	<desc>
4072	Number of snapshots taken on this machine. Zero means the
4073	machine doesn't have any snapshots.
4074	</desc>
4075	</attribute>
4076
4077	<attribute name="currentStateModified" type="boolean" readonly="yes">
4078	<desc>
4079	Returns @c true if the current state of the machine is not
4080	identical to the state stored in the current snapshot.
4081
4082	The current state is identical to the current snapshot only
4083	directly after one of the following calls are made:
4084
4085	<ul>
4086	<li><link to="IConsole::restoreSnapshot"/>
4087	</li>
4088	<li><link to="IConsole::takeSnapshot"/> (issued on a
4089	"powered off" or "saved" machine, for which
4090	<link to="#settingsModified"/> returns @c false)
4091	</li>
4092	</ul>
4093
4094	The current state remains identical until one of the following
4095	happens:
4096	<ul>
4097	<li>settings of the machine are changed</li>
4098	<li>the saved state is deleted</li>
4099	<li>the current snapshot is deleted</li>
4100	<li>an attempt to execute the machine is made</li>
4101	</ul>
4102
4103	<note>
4104	For machines that don't have snapshots, this property is
4105	always @c false.
4106	</note>
4107	</desc>
4108	</attribute>
4109
4110	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4111	<desc>
4112	Collection of shared folders for this machine (permanent shared
4113	folders). These folders are shared automatically at machine startup
4114	and available only to the guest OS installed within this machine.
4115
4116	New shared folders are added to the collection using
4117	<link to="#createSharedFolder"/>. Existing shared folders can be
4118	removed using <link to="#removeSharedFolder"/>.
4119	</desc>
4120	</attribute>
4121
4122	<attribute name="clipboardMode" type="ClipboardMode">
4123	<desc>
4124	Synchronization mode between the host OS clipboard
4125	and the guest OS clipboard.
4126	</desc>
4127	</attribute>
4128
4129	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4130	<desc>
4131	A comma-separated list of simple glob patterns. Changes to guest
4132	properties whose name matches one of the patterns will generate an
4133	<link to="IGuestPropertyChangedEvent"/> signal.
4134	</desc>
4135	</attribute>
4136
4137	<attribute name="teleporterEnabled" type="boolean">
4138	<desc>
4139	When set to @a true, the virtual machine becomes a target teleporter
4140	the next time it is powered on. This can only set to @a true when the
4141	VM is in the @a PoweredOff or @a Aborted state.
4142
4143	<!-- This property is automatically set to @a false when the VM is powered
4144	on. (bird: This doesn't work yet ) -->
4145	</desc>
4146	</attribute>
4147
4148	<attribute name="teleporterPort" type="unsigned long">
4149	<desc>
4150	The TCP port the target teleporter will listen for incoming
4151	teleportations on.
4152
4153	0 means the port is automatically selected upon power on. The actual
4154	value can be read from this property while the machine is waiting for
4155	incoming teleportations.
4156	</desc>
4157	</attribute>
4158
4159	<attribute name="teleporterAddress" type="wstring">
4160	<desc>
4161	The address the target teleporter will listen on. If set to an empty
4162	string, it will listen on all addresses.
4163	</desc>
4164	</attribute>
4165
4166	<attribute name="teleporterPassword" type="wstring">
4167	<desc>
4168	The password to check for on the target teleporter. This is just a
4169	very basic measure to prevent simple hacks and operators accidentally
4170	beaming a virtual machine to the wrong place.
4171
4172	Note that you SET a plain text password while reading back a HASHED
4173	password. Setting a hashed password is currently not supported.
4174	</desc>
4175	</attribute>
4176
4177	<attribute name="faultToleranceState" type="FaultToleranceState">
4178	<desc>
4179	Fault tolerance state; disabled, source or target.
4180	This property can be changed at any time. If you change it for a running
4181	VM, then the fault tolerance address and port must be set beforehand.
4182	</desc>
4183	</attribute>
4184
4185	<attribute name="faultTolerancePort" type="unsigned long">
4186	<desc>
4187	The TCP port the fault tolerance source or target will use for
4188	communication.
4189	</desc>
4190	</attribute>
4191
4192	<attribute name="faultToleranceAddress" type="wstring">
4193	<desc>
4194	The address the fault tolerance source or target.
4195	</desc>
4196	</attribute>
4197
4198	<attribute name="faultTolerancePassword" type="wstring">
4199	<desc>
4200	The password to check for on the standby VM. This is just a
4201	very basic measure to prevent simple hacks and operators accidentally
4202	choosing the wrong standby VM.
4203	</desc>
4204	</attribute>
4205
4206	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4207	<desc>
4208	The interval in ms used for syncing the state between source and target.
4209	</desc>
4210	</attribute>
4211
4212	<attribute name="RTCUseUTC" type="boolean">
4213	<desc>
4214	When set to @a true, the RTC device of the virtual machine will run
4215	in UTC time, otherwise in local time. Especially Unix guests prefer
4216	the time in UTC.
4217	</desc>
4218	</attribute>
4219
4220	<attribute name="ioCacheEnabled" type="boolean">
4221	<desc>
4222	When set to @a true, the builtin I/O cache of the virtual machine
4223	will be enabled.
4224	</desc>
4225	</attribute>
4226
4227	<attribute name="ioCacheSize" type="unsigned long">
4228	<desc>
4229	Maximum size of the I/O cache in MB.
4230	</desc>
4231	</attribute>
4232
4233	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4234	<desc>
4235	Bandwidth control manager.
4236	</desc>
4237	</attribute>
4238
4239	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4240	<desc>Array of PCI devices assigned to this machine, to get list of all
4241	PCI devices attached to the machine use
4242	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4243	is intended to list only devices additional to what described in
4244	virtual hardware config. Usually, this list keeps host's physical
4245	devices assigned to the particular machine.
4246	</desc>
4247	</attribute>
4248
4249	<method name="lockMachine">
4250	<desc>
4251	Locks the machine for the given session to enable the caller
4252	to make changes to the machine or start the VM or control
4253	VM execution.
4254
4255	There are two ways to lock a machine for such uses:
4256
4257	<ul>
4258	<li>If you want to make changes to the machine settings,
4259	you must obtain an exclusive write lock on the machine
4260	by setting @a lockType to @c Write.
4261
4262	This will only succeed if no other process has locked
4263	the machine to prevent conflicting changes. Only after
4264	an exclusive write lock has been obtained using this method, one
4265	can change all VM settings or execute the VM in the process
4266	space of the session object. (Note that the latter is only of
4267	interest if you actually want to write a new front-end for
4268	virtual machines; but this API gets called internally by
4269	the existing front-ends such as VBoxHeadless and the VirtualBox
4270	GUI to acquire a write lock on the machine that they are running.)
4271
4272	On success, write-locking the machine for a session creates
4273	a second copy of the IMachine object. It is this second object
4274	upon which changes can be made; in VirtualBox terminology, the
4275	second copy is "mutable". It is only this second, mutable machine
4276	object upon which you can call methods that change the
4277	machine state. After having called this method, you can
4278	obtain this second, mutable machine object using the
4279	<link to="ISession::machine" /> attribute.
4280	</li>
4281	<li>If you only want to check the machine state or control
4282	machine execution without actually changing machine
4283	settings (e.g. to get access to VM statistics or take
4284	a snapshot or save the machine state), then set the
4285	@a lockType argument to @c Shared.
4286
4287	If no other session has obtained a lock, you will obtain an
4288	exclusive write lock as described above. However, if another
4289	session has already obtained such a lock, then a link to that
4290	existing session will be established which allows you
4291	to control that existing session.
4292
4293	To find out which type of lock was obtained, you can
4294	inspect <link to="ISession::type" />, which will have been
4295	set to either @c WriteLock or @c Shared.
4296	</li>
4297	</ul>
4298
4299	In either case, you can get access to the <link to="IConsole" />
4300	object which controls VM execution.
4301
4302	Also in all of the above cases, one must always call
4303	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4304	the machine's state will eventually be set to "Aborted".
4305
4306	To change settings on a machine, the following sequence is typically
4307	performed:
4308
4309	<ol>
4310	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4311
4312	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4313
4314	<li>Change the settings of the machine by invoking IMachine methods.</li>
4315
4316	<li>Call <link to="IMachine::saveSettings" />.</li>
4317
4318	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4319	</ol>
4320
4321	<result name="E_UNEXPECTED">
4322	Virtual machine not registered.
4323	</result>
4324	<result name="E_ACCESSDENIED">
4325	Process not started by OpenRemoteSession.
4326	</result>
4327	<result name="VBOX_E_INVALID_OBJECT_STATE">
4328	Session already open or being opened.
4329	</result>
4330	<result name="VBOX_E_VM_ERROR">
4331	Failed to assign machine to session.
4332	</result>
4333	</desc>
4334	<param name="session" type="ISession" dir="in">
4335	<desc>
4336	Session object for which the machine will be locked.
4337	</desc>
4338	</param>
4339	<param name="lockType" type="LockType" dir="in">
4340	<desc>
4341	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4342	If set to @c Shared, then either acquire an exclusive write lock or establish
4343	a link to an existing session.
4344	</desc>
4345	</param>
4346	</method>
4347
4348	<method name="launchVMProcess">
4349	<desc>
4350	Spawns a new process that will execute the virtual machine and obtains a shared
4351	lock on the machine for the calling session.
4352
4353	If launching the VM succeeds, the new VM process will create its own session
4354	and write-lock the machine for it, preventing conflicting changes from other
4355	processes. If the machine is already locked (because it is already running or
4356	because another session has a write lock), launching the VM process will therefore
4357	fail. Reversely, future attempts to obtain a write lock will also fail while the
4358	machine is running.
4359
4360	The caller's session object remains separate from the session opened by the new
4361	VM process. It receives its own <link to="IConsole" /> object which can be used
4362	to control machine execution, but it cannot be used to change all VM settings
4363	which would be available after a <link to="#lockMachine" /> call.
4364
4365	The caller must eventually release the session's shared lock by calling
4366	<link to="ISession::unlockMachine" /> on the local session object once this call
4367	has returned. However, the session's state (see <link to="ISession::state" />)
4368	will not return to "Unlocked" until the remote session has also unlocked
4369	the machine (i.e. the machine has stopped running).
4370
4371	Launching a VM process can take some time (a new VM is started in a new process,
4372	for which memory and other resources need to be set up). Because of this,
4373	an <link to="IProgress" /> object is returned to allow the caller to wait
4374	for this asynchronous operation to be completed. Until then, the caller's
4375	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4376	and <link to="ISession::console" /> attributes cannot be accessed.
4377	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4378	similar calls to wait for completion. Completion is signalled when the VM
4379	is powered on. If launching the VM fails, error messages can be queried
4380	via the progress object, if available.
4381
4382	The progress object will have at least 2 sub-operations. The first
4383	operation covers the period up to the new VM process calls powerUp.
4384	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4385	progress object. Because <link to="IConsole::powerUp"/> may require
4386	some extra sub-operations, the <link to="IProgress::operationCount"/>
4387	may change at the completion of operation.
4388
4389	For details on the teleportation progress operation, see
4390	<link to="IConsole::powerUp"/>.
4391
4392	The @a environment argument is a string containing definitions of
4393	environment variables in the following format:
4394	<pre>
4395	NAME[=VALUE]\n
4396	NAME[=VALUE]\n
4397	...
4398	</pre>
4399	where <tt>\\n</tt> is the new line character. These environment
4400	variables will be appended to the environment of the VirtualBox server
4401	process. If an environment variable exists both in the server process
4402	and in this list, the value from this list takes precedence over the
4403	server's variable. If the value of the environment variable is
4404	omitted, this variable will be removed from the resulting environment.
4405	If the environment string is @c null or empty, the server environment
4406	is inherited by the started process as is.
4407
4408	<result name="E_UNEXPECTED">
4409	Virtual machine not registered.
4410	</result>
4411	<result name="E_INVALIDARG">
4412	Invalid session type @a type.
4413	</result>
4414	<result name="VBOX_E_OBJECT_NOT_FOUND">
4415	No machine matching @a machineId found.
4416	</result>
4417	<result name="VBOX_E_INVALID_OBJECT_STATE">
4418	Session already open or being opened.
4419	</result>
4420	<result name="VBOX_E_IPRT_ERROR">
4421	Launching process for machine failed.
4422	</result>
4423	<result name="VBOX_E_VM_ERROR">
4424	Failed to assign machine to session.
4425	</result>
4426	</desc>
4427	<param name="session" type="ISession" dir="in">
4428	<desc>
4429	Client session object to which the VM process will be connected (this
4430	must be in "Unlocked" state).
4431	</desc>
4432	</param>
4433	<param name="type" type="wstring" dir="in">
4434	<desc>
4435	Front-end to use for the new VM process. The following are currently supported:
4436	<ul>
4437	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4438	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4439	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4440	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4441	the currently running VM or session owner. In this case the
4442	@a session parameter may be @c NULL (if it is non-null it isn't
4443	used in any way), and the @a progress return value will be always
4444	NULL. The operation completes immediately.</li>
4445	</ul>
4446	</desc>
4447	</param>
4448	<param name="environment" type="wstring" dir="in">
4449	<desc>
4450	Environment to pass to the VM process.
4451	</desc>
4452	</param>
4453	<param name="progress" type="IProgress" dir="return">
4454	<desc>Progress object to track the operation completion.</desc>
4455	</param>
4456	</method>
4457
4458	<method name="setBootOrder">
4459	<desc>
4460	Puts the given device to the specified position in
4461	the boot order.
4462
4463	To indicate that no device is associated with the given position,
4464	<link to="DeviceType_Null"/> should be used.
4465
4466	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4467
4468	<result name="E_INVALIDARG">
4469	Boot @a position out of range.
4470	</result>
4471	<result name="E_NOTIMPL">
4472	Booting from USB @a device currently not supported.
4473	</result>
4474
4475	</desc>
4476	<param name="position" type="unsigned long" dir="in">
4477	<desc>
4478	Position in the boot order (@c 1 to the total number of
4479	devices the machine can boot from, as returned by
4480	<link to="ISystemProperties::maxBootPosition"/>).
4481	</desc>
4482	</param>
4483	<param name="device" type="DeviceType" dir="in">
4484	<desc>
4485	The type of the device used to boot at the given position.
4486	</desc>
4487	</param>
4488	</method>
4489
4490	<method name="getBootOrder" const="yes">
4491	<desc>
4492	Returns the device type that occupies the specified
4493	position in the boot order.
4494
4495	@todo [remove?]
4496	If the machine can have more than one device of the returned type
4497	(such as hard disks), then a separate method should be used to
4498	retrieve the individual device that occupies the given position.
4499
4500	If here are no devices at the given position, then
4501	<link to="DeviceType_Null"/> is returned.
4502
4503	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4504
4505	<result name="E_INVALIDARG">
4506	Boot @a position out of range.
4507	</result>
4508
4509	</desc>
4510	<param name="position" type="unsigned long" dir="in">
4511	<desc>
4512	Position in the boot order (@c 1 to the total number of
4513	devices the machine can boot from, as returned by
4514	<link to="ISystemProperties::maxBootPosition"/>).
4515	</desc>
4516	</param>
4517	<param name="device" type="DeviceType" dir="return">
4518	<desc>
4519	Device at the given position.
4520	</desc>
4521	</param>
4522	</method>
4523
4524	<method name="attachDevice">
4525	<desc>
4526	Attaches a device and optionally mounts a medium to the given storage
4527	controller (<link to="IStorageController" />, identified by @a name),
4528	at the indicated port and device.
4529
4530	This method is intended for managing storage devices in general while a
4531	machine is powered off. It can be used to attach and detach fixed
4532	and removable media. The following kind of media can be attached
4533	to a machine:
4534
4535	<ul>
4536	<li>For fixed and removable media, you can pass in a medium that was
4537	previously opened using <link to="IVirtualBox::openMedium" />.
4538	</li>
4539
4540	<li>Only for storage devices supporting removable media (such as
4541	DVDs and floppies), you can also specify a null pointer to
4542	indicate an empty drive or one of the medium objects listed
4543	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4544	arrays to indicate a host drive.
4545	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4546	to change the media while the machine is running.
4547	</li>
4548	</ul>
4549
4550	In a VM's default configuration of virtual machines, the secondary
4551	master of the IDE controller is used for a CD/DVD drive.
4552
4553	After calling this returns successfully, a new instance of
4554	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4555	attachments (see <link to="IMachine::mediumAttachments"/>).
4556
4557	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4558	information about attaching media.
4559
4560	The specified device slot must not have a device attached to it,
4561	or this method will fail.
4562
4563	<note>
4564	You cannot attach a device to a newly created machine until
4565	this machine's settings are saved to disk using
4566	<link to="#saveSettings"/>.
4567	</note>
4568	<note>
4569	If the medium is being attached indirectly, a new differencing medium
4570	will implicitly be created for it and attached instead. If the
4571	changes made to the machine settings (including this indirect
4572	attachment) are later cancelled using <link to="#discardSettings"/>,
4573	this implicitly created differencing medium will implicitly
4574	be deleted.
4575	</note>
4576
4577	<result name="E_INVALIDARG">
4578	SATA device, SATA port, IDE port or IDE slot out of range, or
4579	file or UUID not found.
4580	</result>
4581	<result name="VBOX_E_INVALID_OBJECT_STATE">
4582	Machine must be registered before media can be attached.
4583	</result>
4584	<result name="VBOX_E_INVALID_VM_STATE">
4585	Invalid machine state.
4586	</result>
4587	<result name="VBOX_E_OBJECT_IN_USE">
4588	A medium is already attached to this or another virtual machine.
4589	</result>
4590
4591	</desc>
4592	<param name="name" type="wstring" dir="in">
4593	<desc>Name of the storage controller to attach the device to.</desc>
4594	</param>
4595	<param name="controllerPort" type="long" dir="in">
4596	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4597	the primary controller and 1 specifies the secondary controller.
4598	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4599	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4600	</param>
4601	<param name="device" type="long" dir="in">
4602	<desc>Device slot in the given port to attach the device to. This is only
4603	relevant for IDE controllers, for which 0 specifies the master device and
4604	1 specifies the slave device. For all other controller types, this must
4605	be 0.</desc>
4606	</param>
4607	<param name="type" type="DeviceType" dir="in">
4608	<desc>Device type of the attached device. For media opened by
4609	<link to="IVirtualBox::openMedium" />, this must match the device type
4610	specified there.</desc>
4611	</param>
4612	<param name="medium" type="IMedium" dir="in">
4613	<desc>Medium to mount or NULL for an empty drive.</desc>
4614	</param>
4615	</method>
4616
4617	<method name="detachDevice">
4618	<desc>
4619	Detaches the device attached to a device slot of the specified bus.
4620
4621	Detaching the device from the virtual machine is deferred. This means
4622	that the medium remains associated with the machine when this method
4623	returns and gets actually de-associated only after a successful
4624	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4625	for more detailed information about attaching media.
4626
4627	<note>
4628	You cannot detach a device from a running machine.
4629	</note>
4630	<note>
4631	Detaching differencing media implicitly created by <link
4632	to="#attachDevice"/> for the indirect attachment using this
4633	method will <b>not</b> implicitly delete them. The
4634	<link to="IMedium::deleteStorage"/> operation should be
4635	explicitly performed by the caller after the medium is successfully
4636	detached and the settings are saved with
4637	<link to="#saveSettings"/>, if it is the desired action.
4638	</note>
4639
4640	<result name="VBOX_E_INVALID_VM_STATE">
4641	Attempt to detach medium from a running virtual machine.
4642	</result>
4643	<result name="VBOX_E_OBJECT_NOT_FOUND">
4644	No medium attached to given slot/bus.
4645	</result>
4646	<result name="VBOX_E_NOT_SUPPORTED">
4647	Medium format does not support storage deletion.
4648	</result>
4649
4650	</desc>
4651	<param name="name" type="wstring" dir="in">
4652	<desc>Name of the storage controller to detach the medium from.</desc>
4653	</param>
4654	<param name="controllerPort" type="long" dir="in">
4655	<desc>Port number to detach the medium from.</desc>
4656	</param>
4657	<param name="device" type="long" dir="in">
4658	<desc>Device slot number to detach the medium from.</desc>
4659	</param>
4660	</method>
4661
4662	<method name="passthroughDevice">
4663	<desc>
4664	Sets the passthrough mode of an existing DVD device. Changing the
4665	setting while the VM is running is forbidden. The setting is only used
4666	if at VM start the device is configured as a host DVD drive, in all
4667	other cases it is ignored. The device must already exist; see
4668	<link to="IMachine::attachDevice"/> for how to attach a new device.
4669
4670	The @a controllerPort and @a device parameters specify the device slot and
4671	have have the same meaning as with <link to="IMachine::attachDevice" />.
4672
4673	<result name="E_INVALIDARG">
4674	SATA device, SATA port, IDE port or IDE slot out of range.
4675	</result>
4676	<result name="VBOX_E_INVALID_OBJECT_STATE">
4677	Attempt to modify an unregistered virtual machine.
4678	</result>
4679	<result name="VBOX_E_INVALID_VM_STATE">
4680	Invalid machine state.
4681	</result>
4682
4683	</desc>
4684	<param name="name" type="wstring" dir="in">
4685	<desc>Name of the storage controller.</desc>
4686	</param>
4687	<param name="controllerPort" type="long" dir="in">
4688	<desc>Storage controller port.</desc>
4689	</param>
4690	<param name="device" type="long" dir="in">
4691	<desc>Device slot in the given port.</desc>
4692	</param>
4693	<param name="passthrough" type="boolean" dir="in">
4694	<desc>New value for the passthrough setting.</desc>
4695	</param>
4696	</method>
4697
4698	<method name="temporaryEjectDevice">
4699	<desc>
4700	Sets the behavior for guest-triggered medium eject. In some situations
4701	it is desirable that such ejects update the VM configuration, and in
4702	others the eject should keep the VM configuration. The device must
4703	already exist; see <link to="IMachine::attachDevice"/> for how to
4704	attach a new device.
4705
4706	The @a controllerPort and @a device parameters specify the device slot and
4707	have have the same meaning as with <link to="IMachine::attachDevice" />.
4708
4709	<result name="E_INVALIDARG">
4710	SATA device, SATA port, IDE port or IDE slot out of range.
4711	</result>
4712	<result name="VBOX_E_INVALID_OBJECT_STATE">
4713	Attempt to modify an unregistered virtual machine.
4714	</result>
4715	<result name="VBOX_E_INVALID_VM_STATE">
4716	Invalid machine state.
4717	</result>
4718
4719	</desc>
4720	<param name="name" type="wstring" dir="in">
4721	<desc>Name of the storage controller.</desc>
4722	</param>
4723	<param name="controllerPort" type="long" dir="in">
4724	<desc>Storage controller port.</desc>
4725	</param>
4726	<param name="device" type="long" dir="in">
4727	<desc>Device slot in the given port.</desc>
4728	</param>
4729	<param name="temporaryEject" type="boolean" dir="in">
4730	<desc>New value for the eject behavior.</desc>
4731	</param>
4732	</method>
4733
4734	<method name="nonRotationalDevice">
4735	<desc>
4736	Sets a flag in the device information which indicates that the medium
4737	is not based on rotational technology, i.e. that the access times are
4738	more or less independent of the position on the medium. This may or may
4739	not be supported by a particular drive, and is silently ignored in the
4740	latter case. At the moment only hard disks (which is a misnomer in this
4741	context) accept this setting. Changing the setting while the VM is
4742	running is forbidden. The device must already exist; see
4743	<link to="IMachine::attachDevice"/> for how to attach a new device.
4744
4745	The @a controllerPort and @a device parameters specify the device slot and
4746	have have the same meaning as with <link to="IMachine::attachDevice" />.
4747
4748	<result name="E_INVALIDARG">
4749	SATA device, SATA port, IDE port or IDE slot out of range.
4750	</result>
4751	<result name="VBOX_E_INVALID_OBJECT_STATE">
4752	Attempt to modify an unregistered virtual machine.
4753	</result>
4754	<result name="VBOX_E_INVALID_VM_STATE">
4755	Invalid machine state.
4756	</result>
4757
4758	</desc>
4759	<param name="name" type="wstring" dir="in">
4760	<desc>Name of the storage controller.</desc>
4761	</param>
4762	<param name="controllerPort" type="long" dir="in">
4763	<desc>Storage controller port.</desc>
4764	</param>
4765	<param name="device" type="long" dir="in">
4766	<desc>Device slot in the given port.</desc>
4767	</param>
4768	<param name="nonRotational" type="boolean" dir="in">
4769	<desc>New value for the non-rotational device flag.</desc>
4770	</param>
4771	</method>
4772
4773	<method name="setAutoDiscardForDevice">
4774	<desc>
4775	Sets a flag in the device information which indicates that the medium
4776	supports discarding unsused blocks (called trimming for SATA or unmap
4777	for SCSI devices) .This may or may not be supported by a particular drive,
4778	and is silently ignored in the latter case. At the moment only hard disks
4779	(which is a misnomer in this context) accept this setting. Changing the
4780	setting while the VM is running is forbidden. The device must already
4781	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4782	device.
4783
4784	The @a controllerPort and @a device parameters specify the device slot and
4785	have have the same meaning as with <link to="IMachine::attachDevice" />.
4786
4787	<result name="E_INVALIDARG">
4788	SATA device, SATA port, SCSI port out of range.
4789	</result>
4790	<result name="VBOX_E_INVALID_OBJECT_STATE">
4791	Attempt to modify an unregistered virtual machine.
4792	</result>
4793	<result name="VBOX_E_INVALID_VM_STATE">
4794	Invalid machine state.
4795	</result>
4796
4797	</desc>
4798	<param name="name" type="wstring" dir="in">
4799	<desc>Name of the storage controller.</desc>
4800	</param>
4801	<param name="controllerPort" type="long" dir="in">
4802	<desc>Storage controller port.</desc>
4803	</param>
4804	<param name="device" type="long" dir="in">
4805	<desc>Device slot in the given port.</desc>
4806	</param>
4807	<param name="discard" type="boolean" dir="in">
4808	<desc>New value for the discard device flag.</desc>
4809	</param>
4810	</method>
4811
4812	<method name="setBandwidthGroupForDevice">
4813	<desc>
4814	Sets the bandwidth group of an existing storage device.
4815	The device must already exist; see <link to="IMachine::attachDevice"/>
4816	for how to attach a new device.
4817
4818	The @a controllerPort and @a device parameters specify the device slot and
4819	have have the same meaning as with <link to="IMachine::attachDevice" />.
4820
4821	<result name="E_INVALIDARG">
4822	SATA device, SATA port, IDE port or IDE slot out of range.
4823	</result>
4824	<result name="VBOX_E_INVALID_OBJECT_STATE">
4825	Attempt to modify an unregistered virtual machine.
4826	</result>
4827	<result name="VBOX_E_INVALID_VM_STATE">
4828	Invalid machine state.
4829	</result>
4830
4831	</desc>
4832	<param name="name" type="wstring" dir="in">
4833	<desc>Name of the storage controller.</desc>
4834	</param>
4835	<param name="controllerPort" type="long" dir="in">
4836	<desc>Storage controller port.</desc>
4837	</param>
4838	<param name="device" type="long" dir="in">
4839	<desc>Device slot in the given port.</desc>
4840	</param>
4841	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4842	<desc>New value for the bandwidth group or NULL for no group.</desc>
4843	</param>
4844	</method>
4845
4846	<method name="mountMedium">
4847	<desc>
4848	Mounts a medium (<link to="IMedium" />, identified
4849	by the given UUID @a id) to the given storage controller
4850	(<link to="IStorageController" />, identified by @a name),
4851	at the indicated port and device. The device must already exist;
4852	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4853
4854	This method is intended only for managing removable media, where the
4855	device is fixed but media is changeable at runtime (such as DVDs
4856	and floppies). It cannot be used for fixed media such as hard disks.
4857
4858	The @a controllerPort and @a device parameters specify the device slot and
4859	have have the same meaning as with <link to="IMachine::attachDevice" />.
4860
4861	The specified device slot can have a medium mounted, which will be
4862	unmounted first. Specifying a zero UUID (or an empty string) for
4863	@a medium does just an unmount.
4864
4865	See <link to="IMedium"/> for more detailed information about
4866	attaching media.
4867
4868	<result name="E_INVALIDARG">
4869	SATA device, SATA port, IDE port or IDE slot out of range.
4870	</result>
4871	<result name="VBOX_E_INVALID_OBJECT_STATE">
4872	Attempt to attach medium to an unregistered virtual machine.
4873	</result>
4874	<result name="VBOX_E_INVALID_VM_STATE">
4875	Invalid machine state.
4876	</result>
4877	<result name="VBOX_E_OBJECT_IN_USE">
4878	Medium already attached to this or another virtual machine.
4879	</result>
4880
4881	</desc>
4882	<param name="name" type="wstring" dir="in">
4883	<desc>Name of the storage controller to attach the medium to.</desc>
4884	</param>
4885	<param name="controllerPort" type="long" dir="in">
4886	<desc>Port to attach the medium to.</desc>
4887	</param>
4888	<param name="device" type="long" dir="in">
4889	<desc>Device slot in the given port to attach the medium to.</desc>
4890	</param>
4891	<param name="medium" type="IMedium" dir="in">
4892	<desc>Medium to mount or NULL for an empty drive.</desc>
4893	</param>
4894	<param name="force" type="boolean" dir="in">
4895	<desc>Allows to force unmount/mount of a medium which is locked by
4896	the device slot in the given port to attach the medium to.</desc>
4897	</param>
4898	</method>
4899
4900	<method name="getMedium" const="yes">
4901	<desc>
4902	Returns the virtual medium attached to a device slot of the specified
4903	bus.
4904
4905	Note that if the medium was indirectly attached by
4906	<link to="#mountMedium"/> to the given device slot then this
4907	method will return not the same object as passed to the
4908	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4909	more detailed information about mounting a medium.
4910
4911	<result name="VBOX_E_OBJECT_NOT_FOUND">
4912	No medium attached to given slot/bus.
4913	</result>
4914
4915	</desc>
4916	<param name="name" type="wstring" dir="in">
4917	<desc>Name of the storage controller the medium is attached to.</desc>
4918	</param>
4919	<param name="controllerPort" type="long" dir="in">
4920	<desc>Port to query.</desc>
4921	</param>
4922	<param name="device" type="long" dir="in">
4923	<desc>Device slot in the given port to query.</desc>
4924	</param>
4925	<param name="medium" type="IMedium" dir="return">
4926	<desc>Attached medium object.</desc>
4927	</param>
4928	</method>
4929
4930	<method name="getMediumAttachmentsOfController" const="yes">
4931	<desc>
4932	Returns an array of medium attachments which are attached to the
4933	the controller with the given name.
4934
4935	<result name="VBOX_E_OBJECT_NOT_FOUND">
4936	A storage controller with given name doesn't exist.
4937	</result>
4938	</desc>
4939	<param name="name" type="wstring" dir="in"/>
4940	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4941	</method>
4942
4943	<method name="getMediumAttachment" const="yes">
4944	<desc>
4945	Returns a medium attachment which corresponds to the controller with
4946	the given name, on the given port and device slot.
4947
4948	<result name="VBOX_E_OBJECT_NOT_FOUND">
4949	No attachment exists for the given controller/port/device combination.
4950	</result>
4951	</desc>
4952	<param name="name" type="wstring" dir="in"/>
4953	<param name="controllerPort" type="long" dir="in"/>
4954	<param name="device" type="long" dir="in"/>
4955	<param name="attachment" type="IMediumAttachment" dir="return"/>
4956	</method>
4957
4958	<method name="attachHostPciDevice">
4959	<desc>
4960	Attaches host PCI device with the given (host) PCI address to the
4961	PCI bus of the virtual machine. Please note, that this operation
4962	is two phase, as real attachment will happen when VM will start,
4963	and most information will be delivered as IHostPciDevicePlugEvent
4964	on IVirtualBox event source.
4965
4966	<see><link to="IHostPciDevicePlugEvent"/></see>
4967
4968	<result name="VBOX_E_INVALID_VM_STATE">
4969	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4970	</result>
4971	<result name="VBOX_E_PDM_ERROR">
4972	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4973	</result>
4974	<result name="VBOX_E_NOT_SUPPORTED">
4975	Hardware or host OS doesn't allow PCI device passthrought.
4976	</result>
4977	</desc>
4978	<param name="hostAddress" type="long" dir="in">
4979	<desc>Address of the host PCI device.</desc>
4980	</param>
4981	<param name="desiredGuestAddress" type="long" dir="in">
4982	<desc>Desired position of this device on guest PCI bus.</desc>
4983	</param>
4984	<param name="tryToUnbind" type="boolean" dir="in">
4985	<desc>If VMM shall try to unbind existing drivers from the
4986	device before attaching it to the guest.</desc>
4987	</param>
4988	</method>
4989
4990	<method name="detachHostPciDevice">
4991	<desc>
4992	Detach host PCI device from the virtual machine.
4993	Also HostPciDevicePlugEvent on IVirtualBox event source
4994	will be delivered. As currently we don't support hot device
4995	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4996
4997	<see><link to="IHostPciDevicePlugEvent"/></see>
4998
4999	<result name="VBOX_E_INVALID_VM_STATE">
5000	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5001	</result>
5002	<result name="VBOX_E_OBJECT_NOT_FOUND">
5003	This host device is not attached to this machine.
5004	</result>
5005	<result name="VBOX_E_PDM_ERROR">
5006	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5007	</result>
5008	<result name="VBOX_E_NOT_SUPPORTED">
5009	Hardware or host OS doesn't allow PCI device passthrought.
5010	</result>
5011	</desc>
5012	<param name="hostAddress" type="long" dir="in">
5013	<desc>Address of the host PCI device.</desc>
5014	</param>
5015	</method>
5016
5017	<method name="getNetworkAdapter" const="yes">
5018	<desc>
5019	Returns the network adapter associated with the given slot.
5020	Slots are numbered sequentially, starting with zero. The total
5021	number of adapters per machine is defined by the
5022	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5023	so the maximum slot number is one less than that property's value.
5024
5025	<result name="E_INVALIDARG">
5026	Invalid @a slot number.
5027	</result>
5028
5029	</desc>
5030	<param name="slot" type="unsigned long" dir="in"/>
5031	<param name="adapter" type="INetworkAdapter" dir="return"/>
5032	</method>
5033
5034	<method name="addStorageController">
5035	<desc>
5036	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5037	machine and returns it as an instance of
5038	<link to="IStorageController" />.
5039
5040	@a name identifies the controller for subsequent calls such as
5041	<link to="#getStorageControllerByName" />,
5042	<link to="#getStorageControllerByInstance" />,
5043	<link to="#removeStorageController" />,
5044	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5045
5046	After the controller has been added, you can set its exact
5047	type by setting the <link to="IStorageController::controllerType" />.
5048
5049	<result name="VBOX_E_OBJECT_IN_USE">
5050	A storage controller with given name exists already.
5051	</result>
5052	<result name="E_INVALIDARG">
5053	Invalid @a controllerType.
5054	</result>
5055	</desc>
5056	<param name="name" type="wstring" dir="in"/>
5057	<param name="connectionType" type="StorageBus" dir="in"/>
5058	<param name="controller" type="IStorageController" dir="return"/>
5059	</method>
5060
5061	<method name="getStorageControllerByName" const="yes">
5062	<desc>
5063	Returns a storage controller with the given name.
5064
5065	<result name="VBOX_E_OBJECT_NOT_FOUND">
5066	A storage controller with given name doesn't exist.
5067	</result>
5068	</desc>
5069	<param name="name" type="wstring" dir="in"/>
5070	<param name="storageController" type="IStorageController" dir="return"/>
5071	</method>
5072
5073	<method name="getStorageControllerByInstance" const="yes">
5074	<desc>
5075	Returns a storage controller with the given instance number.
5076
5077	<result name="VBOX_E_OBJECT_NOT_FOUND">
5078	A storage controller with given instance number doesn't exist.
5079	</result>
5080	</desc>
5081	<param name="instance" type="unsigned long" dir="in"/>
5082	<param name="storageController" type="IStorageController" dir="return"/>
5083	</method>
5084
5085	<method name="removeStorageController">
5086	<desc>
5087	Removes a storage controller from the machine.
5088
5089	<result name="VBOX_E_OBJECT_NOT_FOUND">
5090	A storage controller with given name doesn't exist.
5091	</result>
5092	</desc>
5093	<param name="name" type="wstring" dir="in"/>
5094	</method>
5095
5096	<method name="setStorageControllerBootable">
5097	<desc>
5098	Sets the bootable flag of the storage controller with the given name.
5099
5100	<result name="VBOX_E_OBJECT_NOT_FOUND">
5101	A storage controller with given name doesn't exist.
5102	</result>
5103	<result name="VBOX_E_OBJECT_IN_USE">
5104	Another storage controller is marked as bootable already.
5105	</result>
5106	</desc>
5107	<param name="name" type="wstring" dir="in"/>
5108	<param name="bootable" type="boolean" dir="in"/>
5109	</method>
5110
5111	<method name="getSerialPort" const="yes">
5112	<desc>
5113	Returns the serial port associated with the given slot.
5114	Slots are numbered sequentially, starting with zero. The total
5115	number of serial ports per machine is defined by the
5116	<link to="ISystemProperties::serialPortCount"/> property,
5117	so the maximum slot number is one less than that property's value.
5118
5119	<result name="E_INVALIDARG">
5120	Invalid @a slot number.
5121	</result>
5122
5123	</desc>
5124	<param name="slot" type="unsigned long" dir="in"/>
5125	<param name="port" type="ISerialPort" dir="return"/>
5126	</method>
5127
5128	<method name="getParallelPort" const="yes">
5129	<desc>
5130	Returns the parallel port associated with the given slot.
5131	Slots are numbered sequentially, starting with zero. The total
5132	number of parallel ports per machine is defined by the
5133	<link to="ISystemProperties::parallelPortCount"/> property,
5134	so the maximum slot number is one less than that property's value.
5135
5136	<result name="E_INVALIDARG">
5137	Invalid @a slot number.
5138	</result>
5139
5140	</desc>
5141	<param name="slot" type="unsigned long" dir="in"/>
5142	<param name="port" type="IParallelPort" dir="return"/>
5143	</method>
5144
5145	<method name="getExtraDataKeys">
5146	<desc>
5147	Returns an array representing the machine-specific extra data keys
5148	which currently have values defined.
5149	</desc>
5150	<param name="value" type="wstring" dir="return" safearray="yes">
5151	<desc>Array of extra data keys.</desc>
5152	</param>
5153	</method>
5154
5155	<method name="getExtraData">
5156	<desc>
5157	Returns associated machine-specific extra data.
5158
5159	If the requested data @a key does not exist, this function will
5160	succeed and return an empty string in the @a value argument.
5161
5162	<result name="VBOX_E_FILE_ERROR">
5163	Settings file not accessible.
5164	</result>
5165	<result name="VBOX_E_XML_ERROR">
5166	Could not parse the settings file.
5167	</result>
5168
5169	</desc>
5170	<param name="key" type="wstring" dir="in">
5171	<desc>Name of the data key to get.</desc>
5172	</param>
5173	<param name="value" type="wstring" dir="return">
5174	<desc>Value of the requested data key.</desc>
5175	</param>
5176	</method>
5177
5178	<method name="setExtraData">
5179	<desc>
5180	Sets associated machine-specific extra data.
5181
5182	If you pass @c null or an empty string as a key @a value, the given
5183	@a key will be deleted.
5184
5185	<note>
5186	Before performing the actual data change, this method will ask all
5187	registered listeners using the
5188	<link to="IExtraDataCanChangeEvent"/>
5189	notification for a permission. If one of the listeners refuses the
5190	new value, the change will not be performed.
5191	</note>
5192	<note>
5193	On success, the
5194	<link to="IExtraDataChangedEvent"/> notification
5195	is called to inform all registered listeners about a successful data
5196	change.
5197	</note>
5198	<note>
5199	This method can be called outside the machine session and therefore
5200	it's a caller's responsibility to handle possible race conditions
5201	when several clients change the same key at the same time.
5202	</note>
5203
5204	<result name="VBOX_E_FILE_ERROR">
5205	Settings file not accessible.
5206	</result>
5207	<result name="VBOX_E_XML_ERROR">
5208	Could not parse the settings file.
5209	</result>
5210
5211	</desc>
5212	<param name="key" type="wstring" dir="in">
5213	<desc>Name of the data key to set.</desc>
5214	</param>
5215	<param name="value" type="wstring" dir="in">
5216	<desc>Value to assign to the key.</desc>
5217	</param>
5218	</method>
5219
5220	<method name="getCPUProperty" const="yes">
5221	<desc>
5222	Returns the virtual CPU boolean value of the specified property.
5223
5224	<result name="E_INVALIDARG">
5225	Invalid property.
5226	</result>
5227
5228	</desc>
5229	<param name="property" type="CPUPropertyType" dir="in">
5230	<desc>
5231	Property type to query.
5232	</desc>
5233	</param>
5234	<param name="value" type="boolean" dir="return">
5235	<desc>
5236	Property value.
5237	</desc>
5238	</param>
5239	</method>
5240
5241	<method name="setCPUProperty">
5242	<desc>
5243	Sets the virtual CPU boolean value of the specified property.
5244
5245	<result name="E_INVALIDARG">
5246	Invalid property.
5247	</result>
5248
5249	</desc>
5250	<param name="property" type="CPUPropertyType" dir="in">
5251	<desc>
5252	Property type to query.
5253	</desc>
5254	</param>
5255	<param name="value" type="boolean" dir="in">
5256	<desc>
5257	Property value.
5258	</desc>
5259	</param>
5260	</method>
5261
5262	<method name="getCPUIDLeaf" const="yes">
5263	<desc>
5264	Returns the virtual CPU cpuid information for the specified leaf.
5265
5266	Currently supported index values for cpuid:
5267	Standard CPUID leafs: 0 - 0xA
5268	Extended CPUID leafs: 0x80000000 - 0x8000000A
5269
5270	See the Intel and AMD programmer's manuals for detailed information
5271	about the cpuid instruction and its leafs.
5272	<result name="E_INVALIDARG">
5273	Invalid id.
5274	</result>
5275
5276	</desc>
5277	<param name="id" type="unsigned long" dir="in">
5278	<desc>
5279	CPUID leaf index.
5280	</desc>
5281	</param>
5282	<param name="valEax" type="unsigned long" dir="out">
5283	<desc>
5284	CPUID leaf value for register eax.
5285	</desc>
5286	</param>
5287	<param name="valEbx" type="unsigned long" dir="out">
5288	<desc>
5289	CPUID leaf value for register ebx.
5290	</desc>
5291	</param>
5292	<param name="valEcx" type="unsigned long" dir="out">
5293	<desc>
5294	CPUID leaf value for register ecx.
5295	</desc>
5296	</param>
5297	<param name="valEdx" type="unsigned long" dir="out">
5298	<desc>
5299	CPUID leaf value for register edx.
5300	</desc>
5301	</param>
5302	</method>
5303
5304	<method name="setCPUIDLeaf">
5305	<desc>
5306	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5307	are not passed unmodified. VirtualBox clears features that it doesn't support.
5308
5309	Currently supported index values for cpuid:
5310	Standard CPUID leafs: 0 - 0xA
5311	Extended CPUID leafs: 0x80000000 - 0x8000000A
5312
5313	See the Intel and AMD programmer's manuals for detailed information
5314	about the cpuid instruction and its leafs.
5315
5316	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5317	random crashes inside VMs.
5318	<result name="E_INVALIDARG">
5319	Invalid id.
5320	</result>
5321
5322	</desc>
5323	<param name="id" type="unsigned long" dir="in">
5324	<desc>
5325	CPUID leaf index.
5326	</desc>
5327	</param>
5328	<param name="valEax" type="unsigned long" dir="in">
5329	<desc>
5330	CPUID leaf value for register eax.
5331	</desc>
5332	</param>
5333	<param name="valEbx" type="unsigned long" dir="in">
5334	<desc>
5335	CPUID leaf value for register ebx.
5336	</desc>
5337	</param>
5338	<param name="valEcx" type="unsigned long" dir="in">
5339	<desc>
5340	CPUID leaf value for register ecx.
5341	</desc>
5342	</param>
5343	<param name="valEdx" type="unsigned long" dir="in">
5344	<desc>
5345	CPUID leaf value for register edx.
5346	</desc>
5347	</param>
5348	</method>
5349
5350	<method name="removeCPUIDLeaf">
5351	<desc>
5352	Removes the virtual CPU cpuid leaf for the specified index
5353
5354	<result name="E_INVALIDARG">
5355	Invalid id.
5356	</result>
5357
5358	</desc>
5359	<param name="id" type="unsigned long" dir="in">
5360	<desc>
5361	CPUID leaf index.
5362	</desc>
5363	</param>
5364	</method>
5365
5366	<method name="removeAllCPUIDLeaves">
5367	<desc>
5368	Removes all the virtual CPU cpuid leaves
5369	</desc>
5370	</method>
5371
5372	<method name="getHWVirtExProperty" const="yes">
5373	<desc>
5374	Returns the value of the specified hardware virtualization boolean property.
5375
5376	<result name="E_INVALIDARG">
5377	Invalid property.
5378	</result>
5379
5380	</desc>
5381	<param name="property" type="HWVirtExPropertyType" dir="in">
5382	<desc>
5383	Property type to query.
5384	</desc>
5385	</param>
5386	<param name="value" type="boolean" dir="return">
5387	<desc>
5388	Property value.
5389	</desc>
5390	</param>
5391	</method>
5392
5393	<method name="setHWVirtExProperty">
5394	<desc>
5395	Sets a new value for the specified hardware virtualization boolean property.
5396
5397	<result name="E_INVALIDARG">
5398	Invalid property.
5399	</result>
5400
5401	</desc>
5402	<param name="property" type="HWVirtExPropertyType" dir="in">
5403	<desc>
5404	Property type to set.
5405	</desc>
5406	</param>
5407	<param name="value" type="boolean" dir="in">
5408	<desc>
5409	New property value.
5410	</desc>
5411	</param>
5412	</method>
5413
5414	<method name="saveSettings">
5415	<desc>
5416	Saves any changes to machine settings made since the session
5417	has been opened or a new machine has been created, or since the
5418	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5419	For registered machines, new settings become visible to all
5420	other VirtualBox clients after successful invocation of this
5421	method.
5422	<note>
5423	The method sends <link to="IMachineDataChangedEvent"/>
5424	notification event after the configuration has been successfully
5425	saved (only for registered machines).
5426	</note>
5427	<note>
5428	Calling this method is only valid on instances returned
5429	by <link to="ISession::machine"/> and on new machines
5430	created by <link to="IVirtualBox::createMachine"/> but not
5431	yet registered, or on unregistered machines after calling
5432	<link to="IMachine::unregister"/>.
5433	</note>
5434
5435	<result name="VBOX_E_FILE_ERROR">
5436	Settings file not accessible.
5437	</result>
5438	<result name="VBOX_E_XML_ERROR">
5439	Could not parse the settings file.
5440	</result>
5441	<result name="E_ACCESSDENIED">
5442	Modification request refused.
5443	</result>
5444
5445	</desc>
5446	</method>
5447
5448	<method name="discardSettings">
5449	<desc>
5450	Discards any changes to the machine settings made since the session
5451	has been opened or since the last call to <link to="#saveSettings"/>
5452	or <link to="#discardSettings"/>.
5453	<note>
5454	Calling this method is only valid on instances returned
5455	by <link to="ISession::machine"/> and on new machines
5456	created by <link to="IVirtualBox::createMachine"/> or
5457	opened by <link to="IVirtualBox::openMachine"/> but not
5458	yet registered, or on unregistered machines after calling
5459	<link to="IMachine::unregister"/>.
5460	</note>
5461
5462	<result name="VBOX_E_INVALID_VM_STATE">
5463	Virtual machine is not mutable.
5464	</result>
5465
5466	</desc>
5467	</method>
5468
5469	<method name="unregister">
5470	<desc>
5471	Unregisters a machine previously registered with
5472	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5473	cleanup before the machine is unregistered.
5474
5475	This method does not delete any files. It only changes the machine configuration and
5476	the list of registered machines in the VirtualBox object. To delete the files which
5477	belonged to the machine, including the XML file of the machine itself, call
5478	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5479	from this method.
5480
5481	How thoroughly this method cleans up the machine configuration before unregistering
5482	the machine depends on the @a cleanupMode argument.
5483
5484	<ul>
5485	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5486	cleanup will be performed. The call will fail if the machine is in "Saved" state
5487	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5488	It is the responsibility of the caller to delete all such configuration in this mode.
5489	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5490	which it replaces.</li>
5491	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5492	state or if it has snapshots or media attached. All media attached to the current machine
5493	state or in snapshots will be detached. No medium objects will be returned;
5494	all of the machine's media will remain open.</li>
5495	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5496	except that all the hard disk medium objects which were detached from the machine will
5497	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5498	API for closing and deletion.</li>
5499	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5500	that all media will be returned in the array, including removable media like DVDs and
5501	floppies. This might be useful if the user wants to inspect in detail which media were
5502	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5503	in that case because users will typically want to preserve ISO and RAW image files.</li>
5504	</ul>
5505
5506	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5507	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5508	deleted with all its saved states and hard disk images, but images for removable
5509	drives (such as ISO and RAW files) will remain on disk.
5510
5511	This API does not verify whether the media files returned in the array are still
5512	attached to other machines (i.e. shared between several machines). If such a shared
5513	image is passed to <link to="#delete" /> however, closing the image will fail there
5514	and the image will be silently skipped.
5515
5516	This API may, however, move media from this machine's media registry to other media
5517	registries (see <link to="IMedium" /> for details on media registries). For machines
5518	created with VirtualBox 4.0 or later, if media from this machine's media registry
5519	are also attached to another machine (shared attachments), each such medium will be
5520	moved to another machine's registry. This is because without this machine's media
5521	registry, the other machine cannot find its media any more and would become inaccessible.
5522
5523	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5524	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5525	if media are moved to other machines' media registries.
5526
5527	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5528	is fired.
5529
5530	The call will fail if the machine is currently locked (see <link to="ISession" />).
5531
5532	<note>
5533	If the given machine is inaccessible (see <link to="#accessible"/>), it
5534	will be unregistered and fully uninitialized right afterwards. As a result,
5535	the returned machine object will be unusable and an attempt to call
5536	<b>any</b> method will return the "Object not ready" error.
5537	</note>
5538
5539	<result name="VBOX_E_INVALID_OBJECT_STATE">
5540	Machine is currently locked for a session.
5541	</result>
5542	</desc>
5543
5544	<param name="cleanupMode" type="CleanupMode" dir="in">
5545	<desc>How to clean up after the machine has been unregistered.</desc>
5546	</param>
5547	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5548	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5549	</param>
5550	</method>
5551
5552	<method name="delete">
5553	<desc>
5554	Deletes the files associated with this machine from disk. If medium objects are passed
5555	in with the @a aMedia argument, they are closed and, if closing was successful, their
5556	storage files are deleted as well. For convenience, this array of media files can be
5557	the same as the one returned from a previous <link to="#unregister" /> call.
5558
5559	This method must only be called on machines which are either write-locked (i.e. on instances
5560	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5561	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5562	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5563
5564	The following files will be deleted by this method:
5565	<ul>
5566	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5567	argument other than "UnregisterOnly", this will delete all saved state files that
5568	the machine had in use; possibly one if the machine was in "Saved" state and one
5569	for each online snapshot that the machine had.</li>
5570	<li>On each medium object passed in the @a aMedia array, this will call
5571	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5572	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5573	in use, e.g. because it is still attached to a second machine; in that case the
5574	storage will not be deleted.</li>
5575	<li>Finally, the machine's own XML file will be deleted.</li>
5576	</ul>
5577
5578	Since deleting large disk image files can be a time-consuming I/O operation, this
5579	method operates asynchronously and returns an IProgress object to allow the caller
5580	to monitor the progress. There will be one sub-operation for each file that is
5581	being deleted (saved state or medium storage file).
5582
5583	<note>
5584	<link to="#settingsModified"/> will return @c true after this
5585	method successfully returns.
5586	</note>
5587
5588	<result name="VBOX_E_INVALID_VM_STATE">
5589	Machine is registered but not write-locked.
5590	</result>
5591	<result name="VBOX_E_IPRT_ERROR">
5592	Could not delete the settings file.
5593	</result>
5594	</desc>
5595	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5596	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5597	</param>
5598	<param name="aProgress" type="IProgress" dir="return">
5599	<desc>Progress object to track the operation completion.</desc>
5600	</param>
5601	</method>
5602
5603	<method name="export">
5604	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5605	steps required to export VirtualBox machines to OVF.
5606	</desc>
5607
5608	<param name="aAppliance" type="IAppliance" dir="in">
5609	<desc>Appliance to export this machine to.</desc>
5610	</param>
5611	<param name="location" type="wstring" dir="in">
5612	<desc>The target location.</desc>
5613	</param>
5614	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5615	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5616	</param>
5617	</method >
5618
5619	<method name="findSnapshot">
5620	<desc>
5621	Returns a snapshot of this machine with the given name or UUID.
5622
5623	Returns a snapshot of this machine with the given UUID.
5624	A @c null argument can be used to obtain the first snapshot
5625	taken on this machine. To traverse the whole tree of snapshots
5626	starting from the root, inspect the root snapshot's
5627	<link to="ISnapshot::children" /> attribute and recurse over those children.
5628
5629	<result name="VBOX_E_OBJECT_NOT_FOUND">
5630	Virtual machine has no snapshots or snapshot not found.
5631	</result>
5632
5633	</desc>
5634	<param name="nameOrId" type="wstring" dir="in">
5635	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5636	</param>
5637	<param name="snapshot" type="ISnapshot" dir="return">
5638	<desc>Snapshot object with the given name.</desc>
5639	</param>
5640	</method>
5641
5642	<method name="createSharedFolder">
5643	<desc>
5644	Creates a new permanent shared folder by associating the given logical
5645	name with the given host path, adds it to the collection of shared
5646	folders and starts sharing it. Refer to the description of
5647	<link to="ISharedFolder"/> to read more about logical names.
5648
5649	<result name="VBOX_E_OBJECT_IN_USE">
5650	Shared folder already exists.
5651	</result>
5652	<result name="VBOX_E_FILE_ERROR">
5653	Shared folder @a hostPath not accessible.
5654	</result>
5655
5656	</desc>
5657	<param name="name" type="wstring" dir="in">
5658	<desc>Unique logical name of the shared folder.</desc>
5659	</param>
5660	<param name="hostPath" type="wstring" dir="in">
5661	<desc>Full path to the shared folder in the host file system.</desc>
5662	</param>
5663	<param name="writable" type="boolean" dir="in">
5664	<desc>Whether the share is writable or readonly.</desc>
5665	</param>
5666	<param name="automount" type="boolean" dir="in">
5667	<desc>Whether the share gets automatically mounted by the guest
5668	or not.</desc>
5669	</param>
5670	</method>
5671
5672	<method name="removeSharedFolder">
5673	<desc>
5674	Removes the permanent shared folder with the given name previously
5675	created by <link to="#createSharedFolder"/> from the collection of
5676	shared folders and stops sharing it.
5677
5678	<result name="VBOX_E_INVALID_VM_STATE">
5679	Virtual machine is not mutable.
5680	</result>
5681	<result name="VBOX_E_OBJECT_NOT_FOUND">
5682	Shared folder @a name does not exist.
5683	</result>
5684
5685	</desc>
5686	<param name="name" type="wstring" dir="in">
5687	<desc>Logical name of the shared folder to remove.</desc>
5688	</param>
5689	</method>
5690
5691	<method name="canShowConsoleWindow">
5692	<desc>
5693	Returns @c true if the VM console process can activate the
5694	console window and bring it to foreground on the desktop of
5695	the host PC.
5696	<note>
5697	This method will fail if a session for this machine is not
5698	currently open.
5699	</note>
5700
5701	<result name="VBOX_E_INVALID_VM_STATE">
5702	Machine session is not open.
5703	</result>
5704
5705	</desc>
5706	<param name="canShow" type="boolean" dir="return">
5707	<desc>
5708	@c true if the console window can be shown and @c false otherwise.
5709	</desc>
5710	</param>
5711	</method>
5712
5713	<method name="showConsoleWindow">
5714	<desc>
5715	Activates the console window and brings it to foreground on
5716	the desktop of the host PC. Many modern window managers on
5717	many platforms implement some sort of focus stealing
5718	prevention logic, so that it may be impossible to activate
5719	a window without the help of the currently active
5720	application. In this case, this method will return a non-zero
5721	identifier that represents the top-level window of the VM
5722	console process. The caller, if it represents a currently
5723	active process, is responsible to use this identifier (in a
5724	platform-dependent manner) to perform actual window
5725	activation.
5726	<note>
5727	This method will fail if a session for this machine is not
5728	currently open.
5729	</note>
5730
5731	<result name="VBOX_E_INVALID_VM_STATE">
5732	Machine session is not open.
5733	</result>
5734
5735	</desc>
5736	<param name="winId" type="long long" dir="return">
5737	<desc>
5738	Platform-dependent identifier of the top-level VM console
5739	window, or zero if this method has performed all actions
5740	necessary to implement the <i>show window</i> semantics for
5741	the given platform and/or VirtualBox front-end.
5742	</desc>
5743	</param>
5744	</method>
5745
5746	<method name="getGuestProperty" const="yes">
5747	<desc>
5748	Reads an entry from the machine's guest property store.
5749
5750	<result name="VBOX_E_INVALID_VM_STATE">
5751	Machine session is not open.
5752	</result>
5753
5754	</desc>
5755	<param name="name" type="wstring" dir="in">
5756	<desc>
5757	The name of the property to read.
5758	</desc>
5759	</param>
5760	<param name="value" type="wstring" dir="out">
5761	<desc>
5762	The value of the property. If the property does not exist then this
5763	will be empty.
5764	</desc>
5765	</param>
5766	<param name="timestamp" type="long long" dir="out">
5767	<desc>
5768	The time at which the property was last modified, as seen by the
5769	server process.
5770	</desc>
5771	</param>
5772	<param name="flags" type="wstring" dir="out">
5773	<desc>
5774	Additional property parameters, passed as a comma-separated list of
5775	"name=value" type entries.
5776	</desc>
5777	</param>
5778	</method>
5779
5780	<method name="getGuestPropertyValue" const="yes">
5781	<desc>
5782	Reads a value from the machine's guest property store.
5783
5784	<result name="VBOX_E_INVALID_VM_STATE">
5785	Machine session is not open.
5786	</result>
5787
5788	</desc>
5789	<param name="property" type="wstring" dir="in">
5790	<desc>
5791	The name of the property to read.
5792	</desc>
5793	</param>
5794	<param name="value" type="wstring" dir="return">
5795	<desc>
5796	The value of the property. If the property does not exist then this
5797	will be empty.
5798	</desc>
5799	</param>
5800	</method>
5801
5802	<method name="getGuestPropertyTimestamp" const="yes">
5803	<desc>
5804	Reads a property timestamp from the machine's guest property store.
5805
5806	<result name="VBOX_E_INVALID_VM_STATE">
5807	Machine session is not open.
5808	</result>
5809
5810	</desc>
5811	<param name="property" type="wstring" dir="in">
5812	<desc>
5813	The name of the property to read.
5814	</desc>
5815	</param>
5816	<param name="value" type="long long" dir="return">
5817	<desc>
5818	The timestamp. If the property does not exist then this will be
5819	empty.
5820	</desc>
5821	</param>
5822	</method>
5823
5824	<method name="setGuestProperty">
5825	<desc>
5826	Sets, changes or deletes an entry in the machine's guest property
5827	store.
5828
5829	<result name="E_ACCESSDENIED">
5830	Property cannot be changed.
5831	</result>
5832	<result name="E_INVALIDARG">
5833	Invalid @a flags.
5834	</result>
5835	<result name="VBOX_E_INVALID_VM_STATE">
5836	Virtual machine is not mutable or session not open.
5837	</result>
5838	<result name="VBOX_E_INVALID_OBJECT_STATE">
5839	Cannot set transient property when machine not running.
5840	</result>
5841
5842	</desc>
5843	<param name="property" type="wstring" dir="in">
5844	<desc>
5845	The name of the property to set, change or delete.
5846	</desc>
5847	</param>
5848	<param name="value" type="wstring" dir="in">
5849	<desc>
5850	The new value of the property to set, change or delete. If the
5851	property does not yet exist and value is non-empty, it will be
5852	created. If the value is @c null or empty, the property will be
5853	deleted if it exists.
5854	</desc>
5855	</param>
5856	<param name="flags" type="wstring" dir="in">
5857	<desc>
5858	Additional property parameters, passed as a comma-separated list of
5859	"name=value" type entries.
5860	</desc>
5861	</param>
5862	</method>
5863
5864	<method name="setGuestPropertyValue">
5865	<desc>
5866	Sets, changes or deletes a value in the machine's guest property
5867	store. The flags field will be left unchanged or created empty for a
5868	new property.
5869
5870	<result name="E_ACCESSDENIED">
5871	Property cannot be changed.
5872	</result>
5873	<result name="VBOX_E_INVALID_VM_STATE">
5874	Virtual machine is not mutable or session not open.
5875	</result>
5876	<result name="VBOX_E_INVALID_OBJECT_STATE">
5877	Cannot set transient property when machine not running.
5878	</result>
5879	</desc>
5880
5881	<param name="property" type="wstring" dir="in">
5882	<desc>
5883	The name of the property to set, change or delete.
5884	</desc>
5885	</param>
5886	<param name="value" type="wstring" dir="in">
5887	<desc>
5888	The new value of the property to set, change or delete. If the
5889	property does not yet exist and value is non-empty, it will be
5890	created. If the value is @c null or empty, the property will be
5891	deleted if it exists.
5892	</desc>
5893	</param>
5894	</method>
5895
5896	<method name="deleteGuestProperty" const="yes">
5897	<desc>
5898	Deletes an entry from the machine's guest property store.
5899
5900	<result name="VBOX_E_INVALID_VM_STATE">
5901	Machine session is not open.
5902	</result>
5903
5904	</desc>
5905	<param name="name" type="wstring" dir="in">
5906	<desc>
5907	The name of the property to delete.
5908	</desc>
5909	</param>
5910	</method>
5911
5912	<method name="enumerateGuestProperties" const="yes">
5913	<desc>
5914	Return a list of the guest properties matching a set of patterns along
5915	with their values, time stamps and flags.
5916	</desc>
5917	<param name="patterns" type="wstring" dir="in">
5918	<desc>
5919	The patterns to match the properties against, separated by '\|'
5920	characters. If this is empty or @c null, all properties will match.
5921	</desc>
5922	</param>
5923	<param name="name" type="wstring" dir="out" safearray="yes">
5924	<desc>
5925	The names of the properties returned.
5926	</desc>
5927	</param>
5928	<param name="value" type="wstring" dir="out" safearray="yes">
5929	<desc>
5930	The values of the properties returned. The array entries match the
5931	corresponding entries in the @a name array.
5932	</desc>
5933	</param>
5934	<param name="timestamp" type="long long" dir="out" safearray="yes">
5935	<desc>
5936	The time stamps of the properties returned. The array entries match
5937	the corresponding entries in the @a name array.
5938	</desc>
5939	</param>
5940	<param name="flags" type="wstring" dir="out" safearray="yes">
5941	<desc>
5942	The flags of the properties returned. The array entries match the
5943	corresponding entries in the @a name array.
5944	</desc>
5945	</param>
5946	</method>
5947
5948	<method name="querySavedGuestSize" const="yes">
5949	<desc>
5950	Returns the guest dimensions from the saved state.
5951	</desc>
5952	<param name="screenId" type="unsigned long" dir="in">
5953	<desc>
5954	Saved guest screen to query info from.
5955	</desc>
5956	</param>
5957	<param name="width" type="unsigned long" dir="out">
5958	<desc>
5959	Guest width at the time of the saved state was taken.
5960	</desc>
5961	</param>
5962	<param name="height" type="unsigned long" dir="out">
5963	<desc>
5964	Guest height at the time of the saved state was taken.
5965	</desc>
5966	</param>
5967	</method>
5968
5969	<method name="querySavedThumbnailSize">
5970	<desc>
5971	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5972	</desc>
5973	<param name="screenId" type="unsigned long" dir="in">
5974	<desc>
5975	Saved guest screen to query info from.
5976	</desc>
5977	</param>
5978	<param name="size" type="unsigned long" dir="out">
5979	<desc>
5980	Size of buffer required to store the bitmap.
5981	</desc>
5982	</param>
5983	<param name="width" type="unsigned long" dir="out">
5984	<desc>
5985	Bitmap width.
5986	</desc>
5987	</param>
5988	<param name="height" type="unsigned long" dir="out">
5989	<desc>
5990	Bitmap height.
5991	</desc>
5992	</param>
5993	</method>
5994
5995	<method name="readSavedThumbnailToArray">
5996	<desc>
5997	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5998	</desc>
5999	<param name="screenId" type="unsigned long" dir="in">
6000	<desc>
6001	Saved guest screen to read from.
6002	</desc>
6003	</param>
6004	<param name="BGR" type="boolean" dir="in">
6005	<desc>
6006	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6007	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6008	</desc>
6009	</param>
6010	<param name="width" type="unsigned long" dir="out">
6011	<desc>
6012	Bitmap width.
6013	</desc>
6014	</param>
6015	<param name="height" type="unsigned long" dir="out">
6016	<desc>
6017	Bitmap height.
6018	</desc>
6019	</param>
6020	<param name="data" type="octet" safearray="yes" dir="return">
6021	<desc>
6022	Array with resulting bitmap data.
6023	</desc>
6024	</param>
6025	</method>
6026
6027	<method name="readSavedThumbnailPNGToArray">
6028	<desc>
6029	Thumbnail in PNG format is retrieved to an array of bytes.
6030	</desc>
6031	<param name="screenId" type="unsigned long" dir="in">
6032	<desc>
6033	Saved guest screen to read from.
6034	</desc>
6035	</param>
6036	<param name="width" type="unsigned long" dir="out">
6037	<desc>
6038	Image width.
6039	</desc>
6040	</param>
6041	<param name="height" type="unsigned long" dir="out">
6042	<desc>
6043	Image height.
6044	</desc>
6045	</param>
6046	<param name="data" type="octet" dir="return" safearray="yes">
6047	<desc>
6048	Array with resulting PNG data.
6049	</desc>
6050	</param>
6051	</method>
6052
6053	<method name="querySavedScreenshotPNGSize">
6054	<desc>
6055	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6056	</desc>
6057	<param name="screenId" type="unsigned long" dir="in">
6058	<desc>
6059	Saved guest screen to query info from.
6060	</desc>
6061	</param>
6062	<param name="size" type="unsigned long" dir="out">
6063	<desc>
6064	Size of buffer required to store the PNG binary data.
6065	</desc>
6066	</param>
6067	<param name="width" type="unsigned long" dir="out">
6068	<desc>
6069	Image width.
6070	</desc>
6071	</param>
6072	<param name="height" type="unsigned long" dir="out">
6073	<desc>
6074	Image height.
6075	</desc>
6076	</param>
6077	</method>
6078
6079	<method name="readSavedScreenshotPNGToArray">
6080	<desc>
6081	Screenshot in PNG format is retrieved to an array of bytes.
6082	</desc>
6083	<param name="screenId" type="unsigned long" dir="in">
6084	<desc>
6085	Saved guest screen to read from.
6086	</desc>
6087	</param>
6088	<param name="width" type="unsigned long" dir="out">
6089	<desc>
6090	Image width.
6091	</desc>
6092	</param>
6093	<param name="height" type="unsigned long" dir="out">
6094	<desc>
6095	Image height.
6096	</desc>
6097	</param>
6098	<param name="data" type="octet" dir="return" safearray="yes">
6099	<desc>
6100	Array with resulting PNG data.
6101	</desc>
6102	</param>
6103	</method>
6104
6105	<method name="hotPlugCPU">
6106	<desc>
6107	Plugs a CPU into the machine.
6108	</desc>
6109	<param name="cpu" type="unsigned long" dir="in">
6110	<desc>
6111	The CPU id to insert.
6112	</desc>
6113	</param>
6114	</method>
6115
6116	<method name="hotUnplugCPU">
6117	<desc>
6118	Removes a CPU from the machine.
6119	</desc>
6120	<param name="cpu" type="unsigned long" dir="in">
6121	<desc>
6122	The CPU id to remove.
6123	</desc>
6124	</param>
6125	</method>
6126
6127	<method name="getCPUStatus">
6128	<desc>
6129	Returns the current status of the given CPU.
6130	</desc>
6131	<param name="cpu" type="unsigned long" dir="in">
6132	<desc>
6133	The CPU id to check for.
6134	</desc>
6135	</param>
6136	<param name="attached" type="boolean" dir="return">
6137	<desc>
6138	Status of the CPU.
6139	</desc>
6140	</param>
6141	</method>
6142
6143	<method name="queryLogFilename">
6144	<desc>
6145	Queries for the VM log file name of an given index. Returns an empty
6146	string if a log file with that index doesn't exists.
6147	</desc>
6148	<param name="idx" type="unsigned long" dir="in">
6149	<desc>
6150	Which log file name to query. 0=current log file.
6151	</desc>
6152	</param>
6153	<param name="filename" type="wstring" dir="return">
6154	<desc>
6155	On return the full path to the log file or an empty string on error.
6156	</desc>
6157	</param>
6158	</method>
6159
6160	<method name="readLog">
6161	<desc>
6162	Reads the VM log file. The chunk size is limited, so even if you
6163	ask for a big piece there might be less data returned.
6164	</desc>
6165	<param name="idx" type="unsigned long" dir="in">
6166	<desc>
6167	Which log file to read. 0=current log file.
6168	</desc>
6169	</param>
6170	<param name="offset" type="long long" dir="in">
6171	<desc>
6172	Offset in the log file.
6173	</desc>
6174	</param>
6175	<param name="size" type="long long" dir="in">
6176	<desc>
6177	Chunk size to read in the log file.
6178	</desc>
6179	</param>
6180	<param name="data" type="octet" dir="return" safearray="yes">
6181	<desc>
6182	Data read from the log file. A data size of 0 means end of file
6183	if the requested chunk size was not 0. This is the unprocessed
6184	file data, i.e. the line ending style depends on the platform of
6185	the system the server is running on.
6186	</desc>
6187	</param>
6188	</method>
6189
6190	<method name="cloneTo">
6191	<desc>
6192	Creates a clone of this machine, either as a full clone (which means
6193	creating independent copies of the hard disk media, save states and so
6194	on), or as a linked clone (which uses its own differencing media,
6195	sharing the parent media with the source machine).
6196
6197	The target machine object must have been created previously with <link
6198	to="IVirtualBox::createMachine"/>, and all the settings will be
6199	transferred except the VM name and the hardware UUID. You can set the
6200	VM name and the new hardware UUID when creating the target machine. The
6201	network MAC addresses are newly created for all newtwork adapters. You
6202	can change that behaviour with the options parameter. The operation is
6203	performed asynchronously, so the machine object will be not be usable
6204	until the @a progress object signals completion.
6205
6206	<result name="E_INVALIDARG">
6207	@a target is @c null.
6208	</result>
6209	</desc>
6210
6211	<param name="target" type="IMachine" dir="in">
6212	<desc>Target machine object.</desc>
6213	</param>
6214	<param name="mode" type="CloneMode" dir="in">
6215	<desc>Which states should be cloned.</desc>
6216	</param>
6217	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6218	<desc>Options for the cloning operation.</desc>
6219	</param>
6220	<param name="progress" type="IProgress" dir="return">
6221	<desc>Progress object to track the operation completion.</desc>
6222	</param>
6223	</method>
6224
6225	</interface>
6226
6227	<!--
6228	// IConsole
6229	/////////////////////////////////////////////////////////////////////////
6230	-->
6231
6232	<interface
6233	name="IVRDEServerInfo" extends="$unknown"
6234	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6235	wsmap="struct"
6236	>
6237	<desc>
6238	Contains information about the remote desktop (VRDE) server capabilities and status.
6239	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6240	</desc>
6241
6242	<attribute name="active" type="boolean" readonly="yes">
6243	<desc>
6244	Whether the remote desktop connection is active.
6245	</desc>
6246	</attribute>
6247
6248	<attribute name="port" type="long" readonly="yes">
6249	<desc>
6250	VRDE server port number. If this property is equal to <tt>0</tt>, then
6251	the VRDE server failed to start, usually because there are no free IP
6252	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6253	server has not yet been started.
6254	</desc>
6255	</attribute>
6256
6257	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6258	<desc>
6259	How many times a client connected.
6260	</desc>
6261	</attribute>
6262
6263	<attribute name="beginTime" type="long long" readonly="yes">
6264	<desc>
6265	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6266	</desc>
6267	</attribute>
6268
6269	<attribute name="endTime" type="long long" readonly="yes">
6270	<desc>
6271	When the last connection was terminated or the current time, if
6272	connection is still active, in milliseconds since 1970-01-01 UTC.
6273	</desc>
6274	</attribute>
6275
6276	<attribute name="bytesSent" type="long long" readonly="yes">
6277	<desc>
6278	How many bytes were sent in last or current, if still active, connection.
6279	</desc>
6280	</attribute>
6281
6282	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6283	<desc>
6284	How many bytes were sent in all connections.
6285	</desc>
6286	</attribute>
6287
6288	<attribute name="bytesReceived" type="long long" readonly="yes">
6289	<desc>
6290	How many bytes were received in last or current, if still active, connection.
6291	</desc>
6292	</attribute>
6293
6294	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6295	<desc>
6296	How many bytes were received in all connections.
6297	</desc>
6298	</attribute>
6299
6300	<attribute name="user" type="wstring" readonly="yes">
6301	<desc>
6302	Login user name supplied by the client.
6303	</desc>
6304	</attribute>
6305
6306	<attribute name="domain" type="wstring" readonly="yes">
6307	<desc>
6308	Login domain name supplied by the client.
6309	</desc>
6310	</attribute>
6311
6312	<attribute name="clientName" type="wstring" readonly="yes">
6313	<desc>
6314	The client name supplied by the client.
6315	</desc>
6316	</attribute>
6317
6318	<attribute name="clientIP" type="wstring" readonly="yes">
6319	<desc>
6320	The IP address of the client.
6321	</desc>
6322	</attribute>
6323
6324	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6325	<desc>
6326	The client software version number.
6327	</desc>
6328	</attribute>
6329
6330	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6331	<desc>
6332	Public key exchange method used when connection was established.
6333	Values: 0 - RDP4 public key exchange scheme.
6334	1 - X509 certificates were sent to client.
6335	</desc>
6336	</attribute>
6337
6338	</interface>
6339
6340	<interface
6341	name="IConsole" extends="$unknown"
6342	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6343	wsmap="managed"
6344	>
6345	<desc>
6346	The IConsole interface represents an interface to control virtual
6347	machine execution.
6348
6349	A console object gets created when a machine has been locked for a
6350	particular session (client process) using <link to="IMachine::lockMachine" />
6351	or <link to="IMachine::launchVMProcess"/>. The console object can
6352	then be found in the session's <link to="ISession::console" /> attribute.
6353
6354	Methods of the IConsole interface allow the caller to query the current
6355	virtual machine execution state, pause the machine or power it down, save
6356	the machine state or take a snapshot, attach and detach removable media
6357	and so on.
6358
6359	<see><link to="ISession"/></see>
6360	</desc>
6361
6362	<attribute name="machine" type="IMachine" readonly="yes">
6363	<desc>
6364	Machine object for this console session.
6365	<note>
6366	This is a convenience property, it has the same value as
6367	<link to="ISession::machine"/> of the corresponding session
6368	object.
6369	</note>
6370	</desc>
6371	</attribute>
6372
6373	<attribute name="state" type="MachineState" readonly="yes">
6374	<desc>
6375	Current execution state of the machine.
6376	<note>
6377	This property always returns the same value as the corresponding
6378	property of the IMachine object for this console session.
6379	For the process that owns (executes) the VM, this is the
6380	preferable way of querying the VM state, because no IPC
6381	calls are made.
6382	</note>
6383	</desc>
6384	</attribute>
6385
6386	<attribute name="guest" type="IGuest" readonly="yes">
6387	<desc>Guest object.</desc>
6388	</attribute>
6389
6390	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6391	<desc>
6392	Virtual keyboard object.
6393	<note>
6394	If the machine is not running, any attempt to use
6395	the returned object will result in an error.
6396	</note>
6397	</desc>
6398	</attribute>
6399
6400	<attribute name="mouse" type="IMouse" readonly="yes">
6401	<desc>
6402	Virtual mouse object.
6403	<note>
6404	If the machine is not running, any attempt to use
6405	the returned object will result in an error.
6406	</note>
6407	</desc>
6408	</attribute>
6409
6410	<attribute name="display" type="IDisplay" readonly="yes">
6411	<desc>Virtual display object.
6412	<note>
6413	If the machine is not running, any attempt to use
6414	the returned object will result in an error.
6415	</note>
6416	</desc>
6417	</attribute>
6418
6419	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6420	<desc>Debugging interface.</desc>
6421	</attribute>
6422
6423	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6424	<desc>
6425	Collection of USB devices currently attached to the virtual
6426	USB controller.
6427	<note>
6428	The collection is empty if the machine is not running.
6429	</note>
6430	</desc>
6431	</attribute>
6432
6433	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6434	<desc>
6435	List of USB devices currently attached to the remote VRDE client.
6436	Once a new device is physically attached to the remote host computer,
6437	it appears in this list and remains there until detached.
6438	</desc>
6439	</attribute>
6440
6441	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6442	<desc>
6443	Collection of shared folders for the current session. These folders
6444	are called transient shared folders because they are available to the
6445	guest OS running inside the associated virtual machine only for the
6446	duration of the session (as opposed to
6447	<link to="IMachine::sharedFolders"/> which represent permanent shared
6448	folders). When the session is closed (e.g. the machine is powered down),
6449	these folders are automatically discarded.
6450
6451	New shared folders are added to the collection using
6452	<link to="#createSharedFolder"/>. Existing shared folders can be
6453	removed using <link to="#removeSharedFolder"/>.
6454	</desc>
6455	</attribute>
6456
6457	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6458	<desc>
6459	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6460	</desc>
6461	</attribute>
6462
6463	<attribute name="eventSource" type="IEventSource" readonly="yes">
6464	<desc>
6465	Event source for console events.
6466	</desc>
6467	</attribute>
6468
6469	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6470	<desc>Array of PCI devices attached to this machine.</desc>
6471	</attribute>
6472
6473	<attribute name="useHostClipboard" type="boolean">
6474	<desc>
6475	Whether the guest clipboard should be connected to the host one or
6476	whether it should only be allowed access to the VRDE clipboard. This
6477	setting may not affect existing guest clipboard connections which
6478	are already connected to the host clipboard.
6479	</desc>
6480	</attribute>
6481
6482	<method name="powerUp">
6483	<desc>
6484	Starts the virtual machine execution using the current machine
6485	state (that is, its current execution state, current settings and
6486	current storage devices).
6487
6488	<note>
6489	This method is only useful for front-ends that want to actually
6490	execute virtual machines in their own process (like the VirtualBox
6491	or VBoxSDL front-ends). Unless you are intending to write such a
6492	front-end, do not call this method. If you simply want to
6493	start virtual machine execution using one of the existing front-ends
6494	(for example the VirtualBox GUI or headless server), use
6495	<link to="IMachine::launchVMProcess"/> instead; these
6496	front-ends will power up the machine automatically for you.
6497	</note>
6498
6499	If the machine is powered off or aborted, the execution will
6500	start from the beginning (as if the real hardware were just
6501	powered on).
6502
6503	If the machine is in the <link to="MachineState_Saved"/> state,
6504	it will continue its execution the point where the state has
6505	been saved.
6506
6507	If the machine <link to="IMachine::teleporterEnabled"/> property is
6508	enabled on the machine being powered up, the machine will wait for an
6509	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6510	state. The returned progress object will have at least three
6511	operations where the last three are defined as: (1) powering up and
6512	starting TCP server, (2) waiting for incoming teleportations, and
6513	(3) perform teleportation. These operations will be reflected as the
6514	last three operations of the progress objected returned by
6515	<link to="IMachine::launchVMProcess"/> as well.
6516
6517	<see><link to="#saveState"/></see>
6518
6519	<result name="VBOX_E_INVALID_VM_STATE">
6520	Virtual machine already running.
6521	</result>
6522	<result name="VBOX_E_HOST_ERROR">
6523	Host interface does not exist or name not set.
6524	</result>
6525	<result name="VBOX_E_FILE_ERROR">
6526	Invalid saved state file.
6527	</result>
6528	</desc>
6529	<param name="progress" type="IProgress" dir="return">
6530	<desc>Progress object to track the operation completion.</desc>
6531	</param>
6532	</method>
6533
6534	<method name="powerUpPaused">
6535	<desc>
6536	Identical to powerUp except that the VM will enter the
6537	<link to="MachineState_Paused"/> state, instead of
6538	<link to="MachineState_Running"/>.
6539
6540	<see><link to="#powerUp"/></see>
6541	<result name="VBOX_E_INVALID_VM_STATE">
6542	Virtual machine already running.
6543	</result>
6544	<result name="VBOX_E_HOST_ERROR">
6545	Host interface does not exist or name not set.
6546	</result>
6547	<result name="VBOX_E_FILE_ERROR">
6548	Invalid saved state file.
6549	</result>
6550	</desc>
6551	<param name="progress" type="IProgress" dir="return">
6552	<desc>Progress object to track the operation completion.</desc>
6553	</param>
6554	</method>
6555
6556	<method name="powerDown">
6557	<desc>
6558	Initiates the power down procedure to stop the virtual machine
6559	execution.
6560
6561	The completion of the power down procedure is tracked using the returned
6562	IProgress object. After the operation is complete, the machine will go
6563	to the PoweredOff state.
6564	<result name="VBOX_E_INVALID_VM_STATE">
6565	Virtual machine must be Running, Paused or Stuck to be powered down.
6566	</result>
6567	</desc>
6568	<param name="progress" type="IProgress" dir="return">
6569	<desc>Progress object to track the operation completion.</desc>
6570	</param>
6571	</method>
6572
6573	<method name="reset">
6574	<desc>Resets the virtual machine.
6575	<result name="VBOX_E_INVALID_VM_STATE">
6576	Virtual machine not in Running state.
6577	</result>
6578	<result name="VBOX_E_VM_ERROR">
6579	Virtual machine error in reset operation.
6580	</result>
6581	</desc>
6582	</method>
6583
6584	<method name="pause">
6585	<desc>Pauses the virtual machine execution.
6586	<result name="VBOX_E_INVALID_VM_STATE">
6587	Virtual machine not in Running state.
6588	</result>
6589	<result name="VBOX_E_VM_ERROR">
6590	Virtual machine error in suspend operation.
6591	</result>
6592	</desc>
6593	</method>
6594
6595	<method name="resume">
6596	<desc>Resumes the virtual machine execution.
6597	<result name="VBOX_E_INVALID_VM_STATE">
6598	Virtual machine not in Paused state.
6599	</result>
6600	<result name="VBOX_E_VM_ERROR">
6601	Virtual machine error in resume operation.
6602	</result>
6603	</desc>
6604	</method>
6605
6606	<method name="powerButton">
6607	<desc>Sends the ACPI power button event to the guest.
6608	<result name="VBOX_E_INVALID_VM_STATE">
6609	Virtual machine not in Running state.
6610	</result>
6611	<result name="VBOX_E_PDM_ERROR">
6612	Controlled power off failed.
6613	</result>
6614	</desc>
6615	</method>
6616
6617	<method name="sleepButton">
6618	<desc>Sends the ACPI sleep button event to the guest.
6619	<result name="VBOX_E_INVALID_VM_STATE">
6620	Virtual machine not in Running state.
6621	</result>
6622	<result name="VBOX_E_PDM_ERROR">
6623	Sending sleep button event failed.
6624	</result>
6625	</desc>
6626	</method>
6627
6628	<method name="getPowerButtonHandled">
6629	<desc>Checks if the last power button event was handled by guest.
6630	<result name="VBOX_E_PDM_ERROR">
6631	Checking if the event was handled by the guest OS failed.
6632	</result>
6633	</desc>
6634	<param name="handled" type="boolean" dir="return"/>
6635	</method>
6636
6637	<method name="getGuestEnteredACPIMode">
6638	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6639	G1 (sleeping). If this method returns @c false, the guest will
6640	most likely not respond to external ACPI events.
6641	<result name="VBOX_E_INVALID_VM_STATE">
6642	Virtual machine not in Running state.
6643	</result>
6644	</desc>
6645	<param name="entered" type="boolean" dir="return"/>
6646	</method>
6647
6648	<method name="saveState">
6649	<desc>
6650	Saves the current execution state of a running virtual machine
6651	and stops its execution.
6652
6653	After this operation completes, the machine will go to the
6654	Saved state. Next time it is powered up, this state will
6655	be restored and the machine will continue its execution from
6656	the place where it was saved.
6657
6658	This operation differs from taking a snapshot to the effect
6659	that it doesn't create new differencing media. Also, once
6660	the machine is powered up from the state saved using this method,
6661	the saved state is deleted, so it will be impossible to return
6662	to this state later.
6663
6664	<note>
6665	On success, this method implicitly calls
6666	<link to="IMachine::saveSettings"/> to save all current machine
6667	settings (including runtime changes to the DVD medium, etc.).
6668	Together with the impossibility to change any VM settings when it is
6669	in the Saved state, this guarantees adequate hardware
6670	configuration of the machine when it is restored from the saved
6671	state file.
6672	</note>
6673
6674	<note>
6675	The machine must be in the Running or Paused state, otherwise
6676	the operation will fail.
6677	</note>
6678	<result name="VBOX_E_INVALID_VM_STATE">
6679	Virtual machine state neither Running nor Paused.
6680	</result>
6681	<result name="VBOX_E_FILE_ERROR">
6682	Failed to create directory for saved state file.
6683	</result>
6684
6685	<see><link to="#takeSnapshot"/></see>
6686	</desc>
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="adoptSavedState">
6693	<desc>
6694	Associates the given saved state file to the virtual machine.
6695
6696	On success, the machine will go to the Saved state. Next time it is
6697	powered up, it will be restored from the adopted saved state and
6698	continue execution from the place where the saved state file was
6699	created.
6700
6701	The specified saved state file path may be absolute or relative to the
6702	folder the VM normally saves the state to (usually,
6703	<link to="IMachine::snapshotFolder"/>).
6704
6705	<note>
6706	It's a caller's responsibility to make sure the given saved state
6707	file is compatible with the settings of this virtual machine that
6708	represent its virtual hardware (memory size, storage disk configuration
6709	etc.). If there is a mismatch, the behavior of the virtual machine
6710	is undefined.
6711	</note>
6712	<result name="VBOX_E_INVALID_VM_STATE">
6713	Virtual machine state neither PoweredOff nor Aborted.
6714	</result>
6715	</desc>
6716	<param name="savedStateFile" type="wstring" dir="in">
6717	<desc>Path to the saved state file to adopt.</desc>
6718	</param>
6719	</method>
6720
6721	<method name="discardSavedState">
6722	<desc>
6723	Forcibly resets the machine to "Powered Off" state if it is
6724	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6725	Next time the machine is powered up, a clean boot will occur.
6726	<note>
6727	This operation is equivalent to resetting or powering off
6728	the machine without doing a proper shutdown of the guest
6729	operating system; as with resetting a running phyiscal
6730	computer, it can can lead to data loss.
6731	</note>
6732	If @a fRemoveFile is @c true, the file in the machine directory
6733	into which the machine state was saved is also deleted. If
6734	this is @c false, then the state can be recovered and later
6735	re-inserted into a machine using <link to="#adoptSavedState" />.
6736	The location of the file can be found in the
6737	<link to="IMachine::stateFilePath" /> attribute.
6738	<result name="VBOX_E_INVALID_VM_STATE">
6739	Virtual machine not in state Saved.
6740	</result>
6741	</desc>
6742	<param name="fRemoveFile" type="boolean" dir="in" >
6743	<desc>Whether to also remove the saved state file.</desc>
6744	</param>
6745	</method>
6746
6747	<method name="getDeviceActivity">
6748	<desc>
6749	Gets the current activity type of a given device or device group.
6750	<result name="E_INVALIDARG">
6751	Invalid device type.
6752	</result>
6753	</desc>
6754	<param name="type" type="DeviceType" dir="in"/>
6755	<param name="activity" type="DeviceActivity" dir="return"/>
6756	</method>
6757
6758	<method name="attachUSBDevice">
6759	<desc>
6760	Attaches a host USB device with the given UUID to the
6761	USB controller of the virtual machine.
6762
6763	The device needs to be in one of the following states:
6764	<link to="USBDeviceState_Busy"/>,
6765	<link to="USBDeviceState_Available"/> or
6766	<link to="USBDeviceState_Held"/>,
6767	otherwise an error is immediately returned.
6768
6769	When the device state is
6770	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6771	be returned if the host computer refuses to release it for some reason.
6772
6773	<see><link to="IUSBController::deviceFilters"/>,
6774	<link to="USBDeviceState"/></see>
6775	<result name="VBOX_E_INVALID_VM_STATE">
6776	Virtual machine state neither Running nor Paused.
6777	</result>
6778	<result name="VBOX_E_PDM_ERROR">
6779	Virtual machine does not have a USB controller.
6780	</result>
6781	</desc>
6782	<param name="id" type="uuid" mod="string" dir="in">
6783	<desc>UUID of the host USB device to attach.</desc>
6784	</param>
6785	</method>
6786
6787	<method name="detachUSBDevice">
6788	<desc>
6789	Detaches an USB device with the given UUID from the USB controller
6790	of the virtual machine.
6791
6792	After this method succeeds, the VirtualBox server re-initiates
6793	all USB filters as if the device were just physically attached
6794	to the host, but filters of this machine are ignored to avoid
6795	a possible automatic re-attachment.
6796
6797	<see><link to="IUSBController::deviceFilters"/>,
6798	<link to="USBDeviceState"/></see>
6799
6800	<result name="VBOX_E_PDM_ERROR">
6801	Virtual machine does not have a USB controller.
6802	</result>
6803	<result name="E_INVALIDARG">
6804	USB device not attached to this virtual machine.
6805	</result>
6806	</desc>
6807	<param name="id" type="uuid" mod="string" dir="in">
6808	<desc>UUID of the USB device to detach.</desc>
6809	</param>
6810	<param name="device" type="IUSBDevice" dir="return">
6811	<desc>Detached USB device.</desc>
6812	</param>
6813	</method>
6814
6815	<method name="findUSBDeviceByAddress">
6816	<desc>
6817	Searches for a USB device with the given host address.
6818
6819	<result name="VBOX_E_OBJECT_NOT_FOUND">
6820	Given @c name does not correspond to any USB device.
6821	</result>
6822
6823	<see><link to="IUSBDevice::address"/></see>
6824	</desc>
6825	<param name="name" type="wstring" dir="in">
6826	<desc>
6827	Address of the USB device (as assigned by the host) to
6828	search for.
6829	</desc>
6830	</param>
6831	<param name="device" type="IUSBDevice" dir="return">
6832	<desc>Found USB device object.</desc>
6833	</param>
6834	</method>
6835
6836	<method name="findUSBDeviceById">
6837	<desc>
6838	Searches for a USB device with the given UUID.
6839
6840	<result name="VBOX_E_OBJECT_NOT_FOUND">
6841	Given @c id does not correspond to any USB device.
6842	</result>
6843
6844	<see><link to="IUSBDevice::id"/></see>
6845	</desc>
6846	<param name="id" type="uuid" mod="string" dir="in">
6847	<desc>UUID of the USB device to search for.</desc>
6848	</param>
6849	<param name="device" type="IUSBDevice" dir="return">
6850	<desc>Found USB device object.</desc>
6851	</param>
6852	</method>
6853
6854	<method name="createSharedFolder">
6855	<desc>
6856	Creates a transient new shared folder by associating the given logical
6857	name with the given host path, adds it to the collection of shared
6858	folders and starts sharing it. Refer to the description of
6859	<link to="ISharedFolder"/> to read more about logical names.
6860
6861	<result name="VBOX_E_INVALID_VM_STATE">
6862	Virtual machine in Saved state or currently changing state.
6863	</result>
6864	<result name="VBOX_E_FILE_ERROR">
6865	Shared folder already exists or not accessible.
6866	</result>
6867	</desc>
6868	<param name="name" type="wstring" dir="in">
6869	<desc>Unique logical name of the shared folder.</desc>
6870	</param>
6871	<param name="hostPath" type="wstring" dir="in">
6872	<desc>Full path to the shared folder in the host file system.</desc>
6873	</param>
6874	<param name="writable" type="boolean" dir="in">
6875	<desc>Whether the share is writable or readonly</desc>
6876	</param>
6877	<param name="automount" type="boolean" dir="in">
6878	<desc>Whether the share gets automatically mounted by the guest
6879	or not.</desc>
6880	</param>
6881	</method>
6882
6883	<method name="removeSharedFolder">
6884	<desc>
6885	Removes a transient shared folder with the given name previously
6886	created by <link to="#createSharedFolder"/> from the collection of
6887	shared folders and stops sharing it.
6888	<result name="VBOX_E_INVALID_VM_STATE">
6889	Virtual machine in Saved state or currently changing state.
6890	</result>
6891	<result name="VBOX_E_FILE_ERROR">
6892	Shared folder does not exists.
6893	</result>
6894	</desc>
6895	<param name="name" type="wstring" dir="in">
6896	<desc>Logical name of the shared folder to remove.</desc>
6897	</param>
6898	</method>
6899
6900	<method name="takeSnapshot">
6901	<desc>
6902	Saves the current execution state
6903	and all settings of the machine and creates differencing images
6904	for all normal (non-independent) media.
6905	See <link to="ISnapshot" /> for an introduction to snapshots.
6906
6907	This method can be called for a PoweredOff, Saved (see
6908	<link to="#saveState"/>), Running or
6909	Paused virtual machine. When the machine is PoweredOff, an
6910	offline snapshot is created. When the machine is Running a live
6911	snapshot is created, and an online snapshot is is created when Paused.
6912
6913	The taken snapshot is always based on the
6914	<link to="IMachine::currentSnapshot">current snapshot</link>
6915	of the associated virtual machine and becomes a new current snapshot.
6916
6917	<note>
6918	This method implicitly calls <link to="IMachine::saveSettings"/> to
6919	save all current machine settings before taking an offline snapshot.
6920	</note>
6921
6922	<result name="VBOX_E_INVALID_VM_STATE">
6923	Virtual machine currently changing state.
6924	</result>
6925	</desc>
6926	<param name="name" type="wstring" dir="in">
6927	<desc>Short name for the snapshot.</desc>
6928	</param>
6929	<param name="description" type="wstring" dir="in">
6930	<desc>Optional description of the snapshot.</desc>
6931	</param>
6932	<param name="progress" type="IProgress" dir="return">
6933	<desc>Progress object to track the operation completion.</desc>
6934	</param>
6935	</method>
6936
6937	<method name="deleteSnapshot">
6938	<desc>
6939	Starts deleting the specified snapshot asynchronously.
6940	See <link to="ISnapshot" /> for an introduction to snapshots.
6941
6942	The execution state and settings of the associated machine stored in
6943	the snapshot will be deleted. The contents of all differencing media of
6944	this snapshot will be merged with the contents of their dependent child
6945	media to keep the medium chain valid (in other words, all changes
6946	represented by media being deleted will be propagated to their child
6947	medium). After that, this snapshot's differencing medium will be
6948	deleted. The parent of this snapshot will become a new parent for all
6949	its child snapshots.
6950
6951	If the deleted snapshot is the current one, its parent snapshot will
6952	become a new current snapshot. The current machine state is not directly
6953	affected in this case, except that currently attached differencing
6954	media based on media of the deleted snapshot will be also merged as
6955	described above.
6956
6957	If the deleted snapshot is the first or current snapshot, then the
6958	respective IMachine attributes will be adjusted. Deleting the current
6959	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6960	to make all current machine settings permanent.
6961
6962	Deleting a snapshot has the following preconditions:
6963
6964	<ul>
6965	<li>Child media of all normal media of the deleted snapshot
6966	must be accessible (see <link to="IMedium::state"/>) for this
6967	operation to succeed. If only one running VM refers to all images
6968	which participates in merging the operation can be performed while
6969	the VM is running. Otherwise all virtual machines whose media are
6970	directly or indirectly based on the media of deleted snapshot must
6971	be powered off. In any case, online snapshot deleting usually is
6972	slower than the same operation without any running VM.</li>
6973
6974	<li>You cannot delete the snapshot if a medium attached to it has
6975	more than one child medium (differencing images) because otherwise
6976	merging would be impossible. This might be the case if there is
6977	more than one child snapshot or differencing images were created
6978	for other reason (e.g. implicitly because of multiple machine
6979	attachments).</li>
6980	</ul>
6981
6982	The virtual machine's <link to="IMachine::state">state</link> is
6983	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6984	"DeletingSnapshotPaused" while this operation is in progress.
6985
6986	<note>
6987	Merging medium contents can be very time and disk space
6988	consuming, if these media are big in size and have many
6989	children. However, if the snapshot being deleted is the last
6990	(head) snapshot on the branch, the operation will be rather
6991	quick.
6992	</note>
6993	<result name="VBOX_E_INVALID_VM_STATE">
6994	The running virtual machine prevents deleting this snapshot. This
6995	happens only in very specific situations, usually snapshots can be
6996	deleted without trouble while a VM is running. The error message
6997	text explains the reason for the failure.
6998	</result>
6999	</desc>
7000	<param name="id" type="uuid" mod="string" dir="in">
7001	<desc>UUID of the snapshot to delete.</desc>
7002	</param>
7003	<param name="progress" type="IProgress" dir="return">
7004	<desc>Progress object to track the operation completion.</desc>
7005	</param>
7006	</method>
7007
7008	<method name="deleteSnapshotAndAllChildren">
7009	<desc>
7010	Starts deleting the specified snapshot and all its children
7011	asynchronously. See <link to="ISnapshot" /> for an introduction to
7012	snapshots. The conditions and many details are the same as with
7013	<link to="#deleteSnapshot"/>.
7014
7015	This operation is very fast if the snapshot subtree does not include
7016	the current state. It is still significantly faster than deleting the
7017	snapshots one by one if the current state is in the subtree and there
7018	are more than one snapshots from current state to the snapshot which
7019	marks the subtree, since it eliminates the incremental image merging.
7020
7021	<note>This API method is right now not implemented!</note>
7022
7023	<result name="VBOX_E_INVALID_VM_STATE">
7024	The running virtual machine prevents deleting this snapshot. This
7025	happens only in very specific situations, usually snapshots can be
7026	deleted without trouble while a VM is running. The error message
7027	text explains the reason for the failure.
7028	</result>
7029	<result name="E_NOTIMPL">
7030	The method is not implemented yet.
7031	</result>
7032	</desc>
7033	<param name="id" type="uuid" mod="string" dir="in">
7034	<desc>UUID of the snapshot to delete, including all its children.</desc>
7035	</param>
7036	<param name="progress" type="IProgress" dir="return">
7037	<desc>Progress object to track the operation completion.</desc>
7038	</param>
7039	</method>
7040
7041	<method name="deleteSnapshotRange">
7042	<desc>
7043	Starts deleting the specified snapshot range. This is limited to
7044	linear snapshot lists, which means there may not be any other child
7045	snapshots other than the direct sequence between the start and end
7046	snapshot. If the start and end snapshot point to the same snapshot this
7047	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7048	<link to="ISnapshot" /> for an introduction to snapshots. The
7049	conditions and many details are the same as with
7050	<link to="#deleteSnapshot"/>.
7051
7052	This operation is generally faster than deleting snapshots one by one
7053	and often also needs less extra disk space before freeing up disk space
7054	by deleting the removed disk images corresponding to the snapshot.
7055
7056	<note>This API method is right now not implemented!</note>
7057
7058	<result name="VBOX_E_INVALID_VM_STATE">
7059	The running virtual machine prevents deleting this snapshot. This
7060	happens only in very specific situations, usually snapshots can be
7061	deleted without trouble while a VM is running. The error message
7062	text explains the reason for the failure.
7063	</result>
7064	<result name="E_NOTIMPL">
7065	The method is not implemented yet.
7066	</result>
7067	</desc>
7068	<param name="startId" type="uuid" mod="string" dir="in">
7069	<desc>UUID of the first snapshot to delete.</desc>
7070	</param>
7071	<param name="endId" type="uuid" mod="string" dir="in">
7072	<desc>UUID of the last snapshot to delete.</desc>
7073	</param>
7074	<param name="progress" type="IProgress" dir="return">
7075	<desc>Progress object to track the operation completion.</desc>
7076	</param>
7077	</method>
7078
7079	<method name="restoreSnapshot">
7080	<desc>
7081	Starts resetting the machine's current state to the state contained
7082	in the given snapshot, asynchronously. All current settings of the
7083	machine will be reset and changes stored in differencing media
7084	will be lost.
7085	See <link to="ISnapshot" /> for an introduction to snapshots.
7086
7087	After this operation is successfully completed, new empty differencing
7088	media are created for all normal media of the machine.
7089
7090	If the given snapshot is an online snapshot, the machine will go to
7091	the <link to="MachineState_Saved"> saved state</link>, so that the
7092	next time it is powered on, the execution state will be restored
7093	from the state of the snapshot.
7094
7095	<note>
7096	The machine must not be running, otherwise the operation will fail.
7097	</note>
7098
7099	<note>
7100	If the machine state is <link to="MachineState_Saved">Saved</link>
7101	prior to this operation, the saved state file will be implicitly
7102	deleted (as if <link to="IConsole::discardSavedState"/> were
7103	called).
7104	</note>
7105
7106	<result name="VBOX_E_INVALID_VM_STATE">
7107	Virtual machine is running.
7108	</result>
7109	</desc>
7110	<param name="snapshot" type="ISnapshot" dir="in">
7111	<desc>The snapshot to restore the VM state from.</desc>
7112	</param>
7113	<param name="progress" type="IProgress" dir="return">
7114	<desc>Progress object to track the operation completion.</desc>
7115	</param>
7116	</method>
7117
7118	<method name="teleport">
7119	<desc>
7120	Teleport the VM to a different host machine or process.
7121
7122	TODO explain the details.
7123
7124	<result name="VBOX_E_INVALID_VM_STATE">
7125	Virtual machine not running or paused.
7126	</result>
7127	</desc>
7128	<param name="hostname" type="wstring" dir="in">
7129	<desc>The name or IP of the host to teleport to.</desc>
7130	</param>
7131	<param name="tcpport" type="unsigned long" dir="in">
7132	<desc>The TCP port to connect to (1..65535).</desc>
7133	</param>
7134	<param name="password" type="wstring" dir="in">
7135	<desc>The password.</desc>
7136	</param>
7137	<param name="maxDowntime" type="unsigned long" dir="in">
7138	<desc>
7139	The maximum allowed downtime given as milliseconds. 0 is not a valid
7140	value. Recommended value: 250 ms.
7141
7142	The higher the value is, the greater the chance for a successful
7143	teleportation. A small value may easily result in the teleportation
7144	process taking hours and eventually fail.
7145
7146	<note>
7147	The current implementation treats this a guideline, not as an
7148	absolute rule.
7149	</note>
7150	</desc>
7151	</param>
7152	<param name="progress" type="IProgress" dir="return">
7153	<desc>Progress object to track the operation completion.</desc>
7154	</param>
7155	</method>
7156
7157	</interface>
7158
7159	<!--
7160	// IHost
7161	/////////////////////////////////////////////////////////////////////////
7162	-->
7163
7164	<enum
7165	name="HostNetworkInterfaceMediumType"
7166	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7167	>
7168	<desc>
7169	Type of encapsulation. Ethernet encapsulation includes both wired and
7170	wireless Ethernet connections.
7171	<see><link to="IHostNetworkInterface"/></see>
7172	</desc>
7173
7174	<const name="Unknown" value="0">
7175	<desc>
7176	The type of interface cannot be determined.
7177	</desc>
7178	</const>
7179	<const name="Ethernet" value="1">
7180	<desc>
7181	Ethernet frame encapsulation.
7182	</desc>
7183	</const>
7184	<const name="PPP" value="2">
7185	<desc>
7186	Point-to-point protocol encapsulation.
7187	</desc>
7188	</const>
7189	<const name="SLIP" value="3">
7190	<desc>
7191	Serial line IP encapsulation.
7192	</desc>
7193	</const>
7194	</enum>
7195
7196	<enum
7197	name="HostNetworkInterfaceStatus"
7198	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7199	>
7200	<desc>
7201	Current status of the interface.
7202	<see><link to="IHostNetworkInterface"/></see>
7203	</desc>
7204
7205	<const name="Unknown" value="0">
7206	<desc>
7207	The state of interface cannot be determined.
7208	</desc>
7209	</const>
7210	<const name="Up" value="1">
7211	<desc>
7212	The interface is fully operational.
7213	</desc>
7214	</const>
7215	<const name="Down" value="2">
7216	<desc>
7217	The interface is not functioning.
7218	</desc>
7219	</const>
7220	</enum>
7221
7222	<enum
7223	name="HostNetworkInterfaceType"
7224	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7225	>
7226	<desc>
7227	Network interface type.
7228	</desc>
7229	<const name="Bridged" value="1"/>
7230	<const name="HostOnly" value="2"/>
7231	</enum>
7232
7233	<interface
7234	name="IHostNetworkInterface" extends="$unknown"
7235	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7236	wsmap="managed"
7237	>
7238	<desc>
7239	Represents one of host's network interfaces. IP V6 address and network
7240	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7241	separated by colons.
7242	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7243	</desc>
7244	<attribute name="name" type="wstring" readonly="yes">
7245	<desc>Returns the host network interface name.</desc>
7246	</attribute>
7247
7248	<attribute name="id" type="uuid" mod="string" readonly="yes">
7249	<desc>Returns the interface UUID.</desc>
7250	</attribute>
7251
7252	<attribute name="networkName" type="wstring" readonly="yes">
7253	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7254	</attribute>
7255
7256	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7257	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7258	</attribute>
7259
7260	<attribute name="IPAddress" type="wstring" readonly="yes">
7261	<desc>Returns the IP V4 address of the interface.</desc>
7262	</attribute>
7263
7264	<attribute name="networkMask" type="wstring" readonly="yes">
7265	<desc>Returns the network mask of the interface.</desc>
7266	</attribute>
7267
7268	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7269	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7270	</attribute>
7271
7272	<attribute name="IPV6Address" type="wstring" readonly="yes">
7273	<desc>Returns the IP V6 address of the interface.</desc>
7274	</attribute>
7275
7276	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7277	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7278	</attribute>
7279
7280	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7281	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7282	</attribute>
7283
7284	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7285	<desc>Type of protocol encapsulation used.</desc>
7286	</attribute>
7287
7288	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7289	<desc>Status of the interface.</desc>
7290	</attribute>
7291
7292	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7293	<desc>specifies the host interface type.</desc>
7294	</attribute>
7295
7296	<method name="enableStaticIpConfig">
7297	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7298	<param name="IPAddress" type="wstring" dir="in">
7299	<desc>
7300	IP address.
7301	</desc>
7302	</param>
7303	<param name="networkMask" type="wstring" dir="in">
7304	<desc>
7305	network mask.
7306	</desc>
7307	</param>
7308	</method>
7309
7310	<method name="enableStaticIpConfigV6">
7311	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7312	<param name="IPV6Address" type="wstring" dir="in">
7313	<desc>
7314	IP address.
7315	</desc>
7316	</param>
7317	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7318	<desc>
7319	network mask.
7320	</desc>
7321	</param>
7322	</method>
7323
7324	<method name="enableDynamicIpConfig">
7325	<desc>enables the dynamic IP configuration.</desc>
7326	</method>
7327
7328	<method name="dhcpRediscover">
7329	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7330	</method>
7331
7332	</interface>
7333
7334	<interface
7335	name="IHost" extends="$unknown"
7336	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7337	wsmap="managed"
7338	>
7339	<desc>
7340	The IHost interface represents the physical machine that this VirtualBox
7341	installation runs on.
7342
7343	An object implementing this interface is returned by the
7344	<link to="IVirtualBox::host" /> attribute. This interface contains
7345	read-only information about the host's physical hardware (such as what
7346	processors and disks are available, what the host operating system is,
7347	and so on) and also allows for manipulating some of the host's hardware,
7348	such as global USB device filters and host interface networking.
7349
7350	</desc>
7351	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7352	<desc>List of DVD drives available on the host.</desc>
7353	</attribute>
7354
7355	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7356	<desc>List of floppy drives available on the host.</desc>
7357	</attribute>
7358
7359	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7360	<desc>
7361	List of USB devices currently attached to the host.
7362	Once a new device is physically attached to the host computer,
7363	it appears in this list and remains there until detached.
7364
7365	<note>
7366	If USB functionality is not available in the given edition of
7367	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7368	</note>
7369	</desc>
7370	</attribute>
7371
7372	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7373	<desc>
7374	List of USB device filters in action.
7375	When a new device is physically attached to the host computer,
7376	filters from this list are applied to it (in order they are stored
7377	in the list). The first matched filter will determine the
7378	<link to="IHostUSBDeviceFilter::action">action</link>
7379	performed on the device.
7380
7381	Unless the device is ignored by these filters, filters of all
7382	currently running virtual machines
7383	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7384
7385	<note>
7386	If USB functionality is not available in the given edition of
7387	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7388	</note>
7389
7390	<see><link to="IHostUSBDeviceFilter"/>,
7391	<link to="USBDeviceState"/></see>
7392	</desc>
7393	</attribute>
7394
7395	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7396	<desc>List of host network interfaces currently defined on the host.</desc>
7397	</attribute>
7398
7399	<attribute name="processorCount" type="unsigned long" readonly="yes">
7400	<desc>Number of (logical) CPUs installed in the host system.</desc>
7401	</attribute>
7402
7403	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7404	<desc>Number of (logical) CPUs online in the host system.</desc>
7405	</attribute>
7406
7407	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7408	<desc>Number of physical processor cores installed in the host system.</desc>
7409	</attribute>
7410
7411	<method name="getProcessorSpeed">
7412	<desc>Query the (approximate) maximum speed of a specified host CPU in
7413	Megahertz.
7414	</desc>
7415	<param name="cpuId" type="unsigned long" dir="in">
7416	<desc>
7417	Identifier of the CPU.
7418	</desc>
7419	</param>
7420	<param name="speed" type="unsigned long" dir="return">
7421	<desc>
7422	Speed value. 0 is returned if value is not known or @a cpuId is
7423	invalid.
7424	</desc>
7425	</param>
7426	</method>
7427
7428	<method name="getProcessorFeature">
7429	<desc>Query whether a CPU feature is supported or not.</desc>
7430	<param name="feature" type="ProcessorFeature" dir="in">
7431	<desc>
7432	CPU Feature identifier.
7433	</desc>
7434	</param>
7435	<param name="supported" type="boolean" dir="return">
7436	<desc>
7437	Feature is supported or not.
7438	</desc>
7439	</param>
7440	</method>
7441
7442	<method name="getProcessorDescription">
7443	<desc>Query the model string of a specified host CPU.
7444	</desc>
7445	<param name="cpuId" type="unsigned long" dir="in">
7446	<desc>
7447	Identifier of the CPU.
7448	<note>
7449	The current implementation might not necessarily return the
7450	description for this exact CPU.
7451	</note>
7452	</desc>
7453	</param>
7454	<param name="description" type="wstring" dir="return">
7455	<desc>
7456	Model string. An empty string is returned if value is not known or
7457	@a cpuId is invalid.
7458	</desc>
7459	</param>
7460	</method>
7461
7462	<method name="getProcessorCPUIDLeaf">
7463	<desc>
7464	Returns the CPU cpuid information for the specified leaf.
7465	</desc>
7466	<param name="cpuId" type="unsigned long" dir="in">
7467	<desc>
7468	Identifier of the CPU. The CPU most be online.
7469	<note>
7470	The current implementation might not necessarily return the
7471	description for this exact CPU.
7472	</note>
7473	</desc>
7474	</param>
7475	<param name="leaf" type="unsigned long" dir="in">
7476	<desc>
7477	CPUID leaf index (eax).
7478	</desc>
7479	</param>
7480	<param name="subLeaf" type="unsigned long" dir="in">
7481	<desc>
7482	CPUID leaf sub index (ecx). This currently only applies to cache
7483	information on Intel CPUs. Use 0 if retrieving values for
7484	<link to="IMachine::setCPUIDLeaf"/>.
7485	</desc>
7486	</param>
7487	<param name="valEax" type="unsigned long" dir="out">
7488	<desc>
7489	CPUID leaf value for register eax.
7490	</desc>
7491	</param>
7492	<param name="valEbx" type="unsigned long" dir="out">
7493	<desc>
7494	CPUID leaf value for register ebx.
7495	</desc>
7496	</param>
7497	<param name="valEcx" type="unsigned long" dir="out">
7498	<desc>
7499	CPUID leaf value for register ecx.
7500	</desc>
7501	</param>
7502	<param name="valEdx" type="unsigned long" dir="out">
7503	<desc>
7504	CPUID leaf value for register edx.
7505	</desc>
7506	</param>
7507	</method>
7508
7509	<attribute name="memorySize" type="unsigned long" readonly="yes">
7510	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7511	</attribute>
7512
7513	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7514	<desc>Available system memory in the host system.</desc>
7515	</attribute>
7516
7517	<attribute name="operatingSystem" type="wstring" readonly="yes">
7518	<desc>Name of the host system's operating system.</desc>
7519	</attribute>
7520
7521	<attribute name="OSVersion" type="wstring" readonly="yes">
7522	<desc>Host operating system's version string.</desc>
7523	</attribute>
7524
7525	<attribute name="UTCTime" type="long long" readonly="yes">
7526	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7527	</attribute>
7528
7529	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7530	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7531	</attribute>
7532
7533	<method name="createHostOnlyNetworkInterface">
7534	<desc>
7535	Creates a new adapter for Host Only Networking.
7536	<result name="E_INVALIDARG">
7537	Host network interface @a name already exists.
7538	</result>
7539	</desc>
7540	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7541	<desc>
7542	Created host interface object.
7543	</desc>
7544	</param>
7545	<param name="progress" type="IProgress" dir="return">
7546	<desc>
7547	Progress object to track the operation completion.
7548	</desc>
7549	</param>
7550	</method>
7551
7552	<method name="removeHostOnlyNetworkInterface">
7553	<desc>
7554	Removes the given Host Only Networking interface.
7555	<result name="VBOX_E_OBJECT_NOT_FOUND">
7556	No host network interface matching @a id found.
7557	</result>
7558	</desc>
7559	<param name="id" type="uuid" mod="string" dir="in">
7560	<desc>
7561	Adapter GUID.
7562	</desc>
7563	</param>
7564	<param name="progress" type="IProgress" dir="return">
7565	<desc>
7566	Progress object to track the operation completion.
7567	</desc>
7568	</param>
7569	</method>
7570
7571	<method name="createUSBDeviceFilter">
7572	<desc>
7573	Creates a new USB device filter. All attributes except
7574	the filter name are set to empty (any match),
7575	<i>active</i> is @c false (the filter is not active).
7576
7577	The created filter can be added to the list of filters using
7578	<link to="#insertUSBDeviceFilter"/>.
7579
7580	<see><link to="#USBDeviceFilters"/></see>
7581	</desc>
7582	<param name="name" type="wstring" dir="in">
7583	<desc>
7584	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7585	</desc>
7586	</param>
7587	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7588	<desc>Created filter object.</desc>
7589	</param>
7590	</method>
7591
7592	<method name="insertUSBDeviceFilter">
7593	<desc>
7594	Inserts the given USB device to the specified position
7595	in the list of filters.
7596
7597	Positions are numbered starting from @c 0. If the specified
7598	position is equal to or greater than the number of elements in
7599	the list, the filter is added at the end of the collection.
7600
7601	<note>
7602	Duplicates are not allowed, so an attempt to insert a
7603	filter already in the list is an error.
7604	</note>
7605	<note>
7606	If USB functionality is not available in the given edition of
7607	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7608	</note>
7609
7610	<see><link to="#USBDeviceFilters"/></see>
7611
7612	<result name="VBOX_E_INVALID_OBJECT_STATE">
7613	USB device filter is not created within this VirtualBox instance.
7614	</result>
7615	<result name="E_INVALIDARG">
7616	USB device filter already in list.
7617	</result>
7618
7619	</desc>
7620	<param name="position" type="unsigned long" dir="in">
7621	<desc>Position to insert the filter to.</desc>
7622	</param>
7623	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7624	<desc>USB device filter to insert.</desc>
7625	</param>
7626	</method>
7627
7628	<method name="removeUSBDeviceFilter">
7629	<desc>
7630	Removes a USB device filter from the specified position in the
7631	list of filters.
7632
7633	Positions are numbered starting from @c 0. Specifying a
7634	position equal to or greater than the number of elements in
7635	the list will produce an error.
7636
7637	<note>
7638	If USB functionality is not available in the given edition of
7639	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7640	</note>
7641
7642	<see><link to="#USBDeviceFilters"/></see>
7643
7644	<result name="E_INVALIDARG">
7645	USB device filter list empty or invalid @a position.
7646	</result>
7647
7648	</desc>
7649	<param name="position" type="unsigned long" dir="in">
7650	<desc>Position to remove the filter from.</desc>
7651	</param>
7652	</method>
7653
7654	<method name="findHostDVDDrive">
7655	<desc>
7656	Searches for a host DVD drive with the given @c name.
7657
7658	<result name="VBOX_E_OBJECT_NOT_FOUND">
7659	Given @c name does not correspond to any host drive.
7660	</result>
7661
7662	</desc>
7663	<param name="name" type="wstring" dir="in">
7664	<desc>Name of the host drive to search for</desc>
7665	</param>
7666	<param name="drive" type="IMedium" dir="return">
7667	<desc>Found host drive object</desc>
7668	</param>
7669	</method>
7670
7671	<method name="findHostFloppyDrive">
7672	<desc>
7673	Searches for a host floppy drive with the given @c name.
7674
7675	<result name="VBOX_E_OBJECT_NOT_FOUND">
7676	Given @c name does not correspond to any host floppy drive.
7677	</result>
7678
7679	</desc>
7680	<param name="name" type="wstring" dir="in">
7681	<desc>Name of the host floppy drive to search for</desc>
7682	</param>
7683	<param name="drive" type="IMedium" dir="return">
7684	<desc>Found host floppy drive object</desc>
7685	</param>
7686	</method>
7687
7688	<method name="findHostNetworkInterfaceByName">
7689	<desc>
7690	Searches through all host network interfaces for an interface with
7691	the given @c name.
7692	<note>
7693	The method returns an error if the given @c name does not
7694	correspond to any host network interface.
7695	</note>
7696	</desc>
7697	<param name="name" type="wstring" dir="in">
7698	<desc>Name of the host network interface to search for.</desc>
7699	</param>
7700	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7701	<desc>Found host network interface object.</desc>
7702	</param>
7703	</method>
7704	<method name="findHostNetworkInterfaceById">
7705	<desc>
7706	Searches through all host network interfaces for an interface with
7707	the given GUID.
7708	<note>
7709	The method returns an error if the given GUID does not
7710	correspond to any host network interface.
7711	</note>
7712	</desc>
7713	<param name="id" type="uuid" mod="string" dir="in">
7714	<desc>GUID of the host network interface to search for.</desc>
7715	</param>
7716	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7717	<desc>Found host network interface object.</desc>
7718	</param>
7719	</method>
7720	<method name="findHostNetworkInterfacesOfType">
7721	<desc>
7722	Searches through all host network interfaces and returns a list of interfaces of the specified type
7723	</desc>
7724	<param name="type" type="HostNetworkInterfaceType" dir="in">
7725	<desc>type of the host network interfaces to search for.</desc>
7726	</param>
7727	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7728	<desc>Found host network interface objects.</desc>
7729	</param>
7730	</method>
7731
7732	<method name="findUSBDeviceById">
7733	<desc>
7734	Searches for a USB device with the given UUID.
7735
7736	<result name="VBOX_E_OBJECT_NOT_FOUND">
7737	Given @c id does not correspond to any USB device.
7738	</result>
7739
7740	<see><link to="IUSBDevice::id"/></see>
7741	</desc>
7742	<param name="id" type="uuid" mod="string" dir="in">
7743	<desc>UUID of the USB device to search for.</desc>
7744	</param>
7745	<param name="device" type="IHostUSBDevice" dir="return">
7746	<desc>Found USB device object.</desc>
7747	</param>
7748	</method>
7749
7750	<method name="findUSBDeviceByAddress">
7751	<desc>
7752	Searches for a USB device with the given host address.
7753
7754	<result name="VBOX_E_OBJECT_NOT_FOUND">
7755	Given @c name does not correspond to any USB device.
7756	</result>
7757
7758	<see><link to="IUSBDevice::address"/></see>
7759	</desc>
7760	<param name="name" type="wstring" dir="in">
7761	<desc>
7762	Address of the USB device (as assigned by the host) to
7763	search for.
7764	</desc>
7765	</param>
7766	<param name="device" type="IHostUSBDevice" dir="return">
7767	<desc>Found USB device object.</desc>
7768	</param>
7769	</method>
7770
7771	<method name="generateMACAddress">
7772	<desc>
7773	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7774	</desc>
7775	<param name="address" type="wstring" dir="return">
7776	<desc>New Ethernet MAC address.</desc>
7777	</param>
7778	</method>
7779
7780	</interface>
7781
7782	<!--
7783	// ISystemProperties
7784	/////////////////////////////////////////////////////////////////////////
7785	-->
7786
7787	<interface
7788	name="ISystemProperties"
7789	extends="$unknown"
7790	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7791	wsmap="managed"
7792	>
7793	<desc>
7794	The ISystemProperties interface represents global properties of the given
7795	VirtualBox installation.
7796
7797	These properties define limits and default values for various attributes
7798	and parameters. Most of the properties are read-only, but some can be
7799	changed by a user.
7800	</desc>
7801
7802	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7803	<desc>Minimum guest system memory in Megabytes.</desc>
7804	</attribute>
7805
7806	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7807	<desc>Maximum guest system memory in Megabytes.</desc>
7808	</attribute>
7809
7810	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7811	<desc>Minimum guest video memory in Megabytes.</desc>
7812	</attribute>
7813
7814	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7815	<desc>Maximum guest video memory in Megabytes.</desc>
7816	</attribute>
7817
7818	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7819	<desc>Minimum CPU count.</desc>
7820	</attribute>
7821
7822	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7823	<desc>Maximum CPU count.</desc>
7824	</attribute>
7825
7826	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7827	<desc>Maximum of monitors which could be connected.</desc>
7828	</attribute>
7829
7830	<attribute name="infoVDSize" type="long long" readonly="yes">
7831	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7832	does not reflect the limits of any virtual disk image format.</desc>
7833	</attribute>
7834
7835	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7836	<desc>
7837	Maximum number of serial ports associated with every
7838	<link to="IMachine"/> instance.
7839	</desc>
7840	</attribute>
7841
7842	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7843	<desc>
7844	Maximum number of parallel ports associated with every
7845	<link to="IMachine"/> instance.
7846	</desc>
7847	</attribute>
7848
7849	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7850	<desc>
7851	Maximum device position in the boot order. This value corresponds
7852	to the total number of devices a machine can boot from, to make it
7853	possible to include all possible devices to the boot list.
7854	<see><link to="IMachine::setBootOrder"/></see>
7855	</desc>
7856	</attribute>
7857
7858	<attribute name="defaultMachineFolder" type="wstring">
7859	<desc>
7860	Full path to the default directory used to create new or open
7861	existing machines when a machine settings file name contains no
7862	path.
7863
7864	Starting with VirtualBox 4.0, by default, this attribute contains
7865	the full path of folder named "VirtualBox VMs" in the user's
7866	home directory, which depends on the host platform.
7867
7868	When setting this attribute, a full path must be specified.
7869	Setting this property to @c null or an empty string or the
7870	special value "Machines" (for compatibility reasons) will restore
7871	that default value.
7872
7873	If the folder specified herein does not exist, it will be created
7874	automatically as needed.
7875
7876	<see>
7877	<link to="IVirtualBox::createMachine"/>,
7878	<link to="IVirtualBox::openMachine"/>
7879	</see>
7880	</desc>
7881	</attribute>
7882
7883	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7884	<desc>
7885	List of all medium storage formats supported by this VirtualBox
7886	installation.
7887
7888	Keep in mind that the medium format identifier
7889	(<link to="IMediumFormat::id"/>) used in other API calls like
7890	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7891	medium format is a case-insensitive string. This means that, for
7892	example, all of the following strings:
7893	<pre>
7894	"VDI"
7895	"vdi"
7896	"VdI"</pre>
7897	refer to the same medium format.
7898
7899	Note that the virtual medium framework is backend-based, therefore
7900	the list of supported formats depends on what backends are currently
7901	installed.
7902
7903	<see><link to="IMediumFormat"/></see>
7904	</desc>
7905	</attribute>
7906
7907	<attribute name="defaultHardDiskFormat" type="wstring">
7908	<desc>
7909	Identifier of the default medium format used by VirtualBox.
7910
7911	The medium format set by this attribute is used by VirtualBox
7912	when the medium format was not specified explicitly. One example is
7913	<link to="IVirtualBox::createHardDisk"/> with the empty
7914	format argument. A more complex example is implicit creation of
7915	differencing media when taking a snapshot of a virtual machine:
7916	this operation will try to use a format of the parent medium first
7917	and if this format does not support differencing media the default
7918	format specified by this argument will be used.
7919
7920	The list of supported medium formats may be obtained by the
7921	<link to="#mediumFormats"/> call. Note that the default medium
7922	format must have a capability to create differencing media;
7923	otherwise operations that create media implicitly may fail
7924	unexpectedly.
7925
7926	The initial value of this property is <tt>"VDI"</tt> in the current
7927	version of the VirtualBox product, but may change in the future.
7928
7929	<note>
7930	Setting this property to @c null or empty string will restore the
7931	initial value.
7932	</note>
7933
7934	<see>
7935	<link to="#mediumFormats"/>,
7936	<link to="IMediumFormat::id"/>,
7937	<link to="IVirtualBox::createHardDisk"/>
7938	</see>
7939	</desc>
7940	</attribute>
7941
7942	<attribute name="freeDiskSpaceWarning" type="long long">
7943	<desc>Issue a warning if the free disk space is below (or in some disk
7944	intensive operation is expected to go below) the given size in
7945	bytes.</desc>
7946	</attribute>
7947
7948	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7949	<desc>Issue a warning if the free disk space is below (or in some disk
7950	intensive operation is expected to go below) the given percentage.</desc>
7951	</attribute>
7952
7953	<attribute name="freeDiskSpaceError" type="long long">
7954	<desc>Issue an error if the free disk space is below (or in some disk
7955	intensive operation is expected to go below) the given size in
7956	bytes.</desc>
7957	</attribute>
7958
7959	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7960	<desc>Issue an error if the free disk space is below (or in some disk
7961	intensive operation is expected to go below) the given percentage.</desc>
7962	</attribute>
7963
7964	<attribute name="VRDEAuthLibrary" type="wstring">
7965	<desc>
7966	Library that provides authentication for Remote Desktop clients. The library
7967	is used if a virtual machine's authentication type is set to "external"
7968	in the VM RemoteDisplay configuration.
7969
7970	The system library extension (".DLL" or ".so") must be omitted.
7971	A full path can be specified; if not, then the library must reside on the
7972	system's default library path.
7973
7974	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7975	of that name in one of the default VirtualBox library directories.
7976
7977	For details about VirtualBox authentication libraries and how to implement
7978	them, please refer to the VirtualBox manual.
7979
7980	<note>
7981	Setting this property to @c null or empty string will restore the
7982	initial value.
7983	</note>
7984	</desc>
7985	</attribute>
7986
7987	<attribute name="webServiceAuthLibrary" type="wstring">
7988	<desc>
7989	Library that provides authentication for webservice clients. The library
7990	is used if a virtual machine's authentication type is set to "external"
7991	in the VM RemoteDisplay configuration and will be called from
7992	within the <link to="IWebsessionManager::logon" /> implementation.
7993
7994	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7995	there is no per-VM setting for this, as the webservice is a global
7996	resource (if it is running). Only for this setting (for the webservice),
7997	setting this value to a literal <tt>"null"</tt> string disables authentication,
7998	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7999	no matter what user name and password are supplied.
8000
8001	The initial value of this property is <tt>"VBoxAuth"</tt>,
8002	meaning that the webservice will use the same authentication
8003	library that is used by default for VRDE (again, see
8004	<link to="ISystemProperties::VRDEAuthLibrary" />).
8005	The format and calling convention of authentication libraries
8006	is the same for the webservice as it is for VRDE.
8007
8008	<note>
8009	Setting this property to @c null or empty string will restore the
8010	initial value.
8011	</note>
8012	</desc>
8013	</attribute>
8014
8015	<attribute name="defaultVRDEExtPack" type="wstring">
8016	<desc>
8017	The name of the extension pack providing the default VRDE.
8018
8019	This attribute is for choosing between multiple extension packs
8020	providing VRDE. If only one is installed, it will automatically be the
8021	default one. The attribute value can be empty if no VRDE extension
8022	pack is installed.
8023
8024	For details about VirtualBox Remote Desktop Extension and how to
8025	implement one, please refer to the VirtualBox SDK.
8026	</desc>
8027	</attribute>
8028
8029	<attribute name="logHistoryCount" type="unsigned long">
8030	<desc>
8031	This value specifies how many old release log files are kept.
8032	</desc>
8033	</attribute>
8034
8035	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8036	<desc>This value hold the default audio driver for the current
8037	system.</desc>
8038	</attribute>
8039
8040
8041	<method name="getMaxNetworkAdapters">
8042	<desc>
8043	Maximum total number of network adapters associated with every
8044	<link to="IMachine"/> instance.
8045	</desc>
8046
8047	<param name="chipset" type="ChipsetType" dir="in">
8048	<desc>The chipset type to get the value for.</desc>
8049	</param>
8050
8051
8052	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8053	<desc>The maximum total number of network adapters allowed.</desc>
8054	</param>
8055
8056	</method>
8057
8058	<method name="getMaxNetworkAdaptersOfType">
8059	<desc>
8060	Maximum number of network adapters of a given attachment type,
8061	associated with every <link to="IMachine"/> instance.
8062	</desc>
8063
8064	<param name="chipset" type="ChipsetType" dir="in">
8065	<desc>The chipset type to get the value for.</desc>
8066	</param>
8067
8068	<param name="type" type="NetworkAttachmentType" dir="in">
8069	<desc>Type of attachment.</desc>
8070	</param>
8071
8072	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8073	<desc>The maximum number of network adapters allowed for
8074	particular chipset and attachment type.</desc>
8075	</param>
8076
8077	</method>
8078
8079
8080	<method name="getMaxDevicesPerPortForStorageBus">
8081	<desc>Returns the maximum number of devices which can be attached to a port
8082	for the given storage bus.</desc>
8083
8084	<param name="bus" type="StorageBus" dir="in">
8085	<desc>The storage bus type to get the value for.</desc>
8086	</param>
8087
8088	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8089	<desc>The maximum number of devices which can be attached to the port for the given
8090	storage bus.</desc>
8091	</param>
8092	</method>
8093
8094	<method name="getMinPortCountForStorageBus">
8095	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8096
8097	<param name="bus" type="StorageBus" dir="in">
8098	<desc>The storage bus type to get the value for.</desc>
8099	</param>
8100
8101	<param name="minPortCount" type="unsigned long" dir="return">
8102	<desc>The minimum number of ports for the given storage bus.</desc>
8103	</param>
8104	</method>
8105
8106	<method name="getMaxPortCountForStorageBus">
8107	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8108
8109	<param name="bus" type="StorageBus" dir="in">
8110	<desc>The storage bus type to get the value for.</desc>
8111	</param>
8112
8113	<param name="maxPortCount" type="unsigned long" dir="return">
8114	<desc>The maximum number of ports for the given storage bus.</desc>
8115	</param>
8116	</method>
8117
8118	<method name="getMaxInstancesOfStorageBus">
8119	<desc>Returns the maximum number of storage bus instances which
8120	can be configured for each VM. This corresponds to the number of
8121	storage controllers one can have. Value may depend on chipset type
8122	used.</desc>
8123
8124	<param name="chipset" type="ChipsetType" dir="in">
8125	<desc>The chipset type to get the value for.</desc>
8126	</param>
8127
8128	<param name="bus" type="StorageBus" dir="in">
8129	<desc>The storage bus type to get the value for.</desc>
8130	</param>
8131
8132	<param name="maxInstances" type="unsigned long" dir="return">
8133	<desc>The maximum number of instances for the given storage bus.</desc>
8134	</param>
8135	</method>
8136
8137	<method name="getDeviceTypesForStorageBus">
8138	<desc>Returns list of all the supported device types
8139	(<link to="DeviceType"/>) for the given type of storage
8140	bus.</desc>
8141
8142	<param name="bus" type="StorageBus" dir="in">
8143	<desc>The storage bus type to get the value for.</desc>
8144	</param>
8145
8146	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8147	<desc>The list of all supported device types for the given storage bus.</desc>
8148	</param>
8149	</method>
8150
8151	<method name="getDefaultIoCacheSettingForStorageController">
8152	<desc>Returns the default I/O cache setting for the
8153	given storage controller</desc>
8154
8155	<param name="controllerType" type="StorageControllerType" dir="in">
8156	<desc>The storage controller to the setting for.</desc>
8157	</param>
8158
8159	<param name="enabled" type="boolean" dir="return">
8160	<desc>Returned flag indicating the default value</desc>
8161	</param>
8162	</method>
8163	</interface>
8164
8165	<!--
8166	// IGuest
8167	/////////////////////////////////////////////////////////////////////////
8168	-->
8169
8170	<interface
8171	name="IGuestOSType" extends="$unknown"
8172	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8173	wsmap="struct"
8174	>
8175	<desc>
8176	</desc>
8177
8178	<attribute name="familyId" type="wstring" readonly="yes">
8179	<desc>Guest OS family identifier string.</desc>
8180	</attribute>
8181
8182	<attribute name="familyDescription" type="wstring" readonly="yes">
8183	<desc>Human readable description of the guest OS family.</desc>
8184	</attribute>
8185
8186	<attribute name="id" type="wstring" readonly="yes">
8187	<desc>Guest OS identifier string.</desc>
8188	</attribute>
8189
8190	<attribute name="description" type="wstring" readonly="yes">
8191	<desc>Human readable description of the guest OS.</desc>
8192	</attribute>
8193
8194	<attribute name="is64Bit" type="boolean" readonly="yes">
8195	<desc>Returns @c true if the given OS is 64-bit</desc>
8196	</attribute>
8197
8198	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8199	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8200	</attribute>
8201
8202	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8203	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8204	</attribute>
8205
8206	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8207	<desc>Recommended RAM size in Megabytes.</desc>
8208	</attribute>
8209
8210	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8211	<desc>Recommended video RAM size in Megabytes.</desc>
8212	</attribute>
8213
8214	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8215	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8216	</attribute>
8217
8218	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8219	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8220	</attribute>
8221
8222	<attribute name="recommendedHDD" type="long long" readonly="yes">
8223	<desc>Recommended hard disk size in bytes.</desc>
8224	</attribute>
8225
8226	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8227	<desc>Returns recommended network adapter for this OS type.</desc>
8228	</attribute>
8229
8230	<attribute name="recommendedPae" type="boolean" readonly="yes">
8231	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8232	</attribute>
8233
8234	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8235	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8236	</attribute>
8237
8238	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8239	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8240	</attribute>
8241
8242	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8243	<desc>Recommended storage controller type for HD drives.</desc>
8244	</attribute>
8245
8246	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8247	<desc>Recommended storage bus type for HD drives.</desc>
8248	</attribute>
8249
8250	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8251	<desc>Recommended firmware type.</desc>
8252	</attribute>
8253
8254	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8255	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8256	</attribute>
8257
8258	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8259	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8260	</attribute>
8261
8262	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8263	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8264	</attribute>
8265
8266	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8267	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8268	</attribute>
8269
8270	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8271	<desc>Recommended chipset type.</desc>
8272	</attribute>
8273
8274	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8275	<desc>Recommended audio type.</desc>
8276	</attribute>
8277
8278	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8279	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8280	</attribute>
8281
8282	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8283	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8284	</attribute>
8285
8286	</interface>
8287
8288	<enum
8289	name="AdditionsFacilityType"
8290	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8291	>
8292	<desc>
8293	Guest Additions facility IDs.
8294	</desc>
8295
8296	<const name="None" value="0">
8297	<desc>No/invalid facility.</desc>
8298	</const>
8299	<const name="VBoxGuestDriver" value="20">
8300	<desc>VirtualBox base driver (VBoxGuest).</desc>
8301	</const>
8302	<const name="VBoxService" value="100">
8303	<desc>VirtualBox system service (VBoxService).</desc>
8304	</const>
8305	<const name="VBoxTrayClient" value="101">
8306	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8307	</const>
8308	<const name="Seamless" value="1000">
8309	<desc>Seamless guest desktop integration.</desc>
8310	</const>
8311	<const name="Graphics" value="1100">
8312	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8313	are not immediately acted on and guest display resizes are probably not initiated by
8314	the guest additions.
8315	</desc>
8316	</const>
8317	<const name="All" value="2147483646">
8318	<desc>All facilities selected.</desc>
8319	</const>
8320	</enum>
8321
8322	<enum
8323	name="AdditionsFacilityClass"
8324	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8325	>
8326	<desc>
8327	Guest Additions facility classes.
8328	</desc>
8329
8330	<const name="None" value="0">
8331	<desc>No/invalid class.</desc>
8332	</const>
8333	<const name="Driver" value="10">
8334	<desc>Driver.</desc>
8335	</const>
8336	<const name="Service" value="30">
8337	<desc>System service.</desc>
8338	</const>
8339	<const name="Program" value="50">
8340	<desc>Program.</desc>
8341	</const>
8342	<const name="Feature" value="100">
8343	<desc>Feature.</desc>
8344	</const>
8345	<const name="ThirdParty" value="999">
8346	<desc>Third party.</desc>
8347	</const>
8348	<const name="All" value="2147483646">
8349	<desc>All facility classes selected.</desc>
8350	</const>
8351	</enum>
8352
8353	<enum
8354	name="AdditionsFacilityStatus"
8355	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8356	>
8357	<desc>
8358	Guest Additions facility states.
8359	</desc>
8360
8361	<const name="Inactive" value="0">
8362	<desc>Facility is not active.</desc>
8363	</const>
8364	<const name="Paused" value="1">
8365	<desc>Facility has been paused.</desc>
8366	</const>
8367	<const name="PreInit" value="20">
8368	<desc>Facility is preparing to initialize.</desc>
8369	</const>
8370	<const name="Init" value="30">
8371	<desc>Facility is initializing.</desc>
8372	</const>
8373	<const name="Active" value="50">
8374	<desc>Facility is up and running.</desc>
8375	</const>
8376	<const name="Terminating" value="100">
8377	<desc>Facility is shutting down.</desc>
8378	</const>
8379	<const name="Terminated" value="101">
8380	<desc>Facility successfully shut down.</desc>
8381	</const>
8382	<const name="Failed" value="800">
8383	<desc>Facility failed to start.</desc>
8384	</const>
8385	<const name="Unknown" value="999">
8386	<desc>Facility status is unknown.</desc>
8387	</const>
8388	</enum>
8389
8390	<interface
8391	name="IAdditionsFacility" extends="$unknown"
8392	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8393	wsmap="struct"
8394	>
8395	<desc>
8396	Structure representing a Guest Additions facility.
8397	</desc>
8398
8399	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8400	<desc>The class this facility is part of.</desc>
8401	</attribute>
8402
8403	<attribute name="lastUpdated" type="long long" readonly="yes">
8404	<desc>
8405	Time stamp of the last status update,
8406	in milliseconds since 1970-01-01 UTC.
8407	</desc>
8408	</attribute>
8409
8410	<attribute name="name" type="wstring" readonly="yes">
8411	<desc>The facility's friendly name.</desc>
8412	</attribute>
8413
8414	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8415	<desc>The current status.</desc>
8416	</attribute>
8417
8418	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8419	<desc>The facility's type ID.</desc>
8420	</attribute>
8421	</interface>
8422
8423	<enum
8424	name="AdditionsRunLevelType"
8425	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8426	>
8427	<desc>
8428	Guest Additions run level type.
8429	</desc>
8430
8431	<const name="None" value="0">
8432	<desc>Guest Additions are not loaded.</desc>
8433	</const>
8434	<const name="System" value="1">
8435	<desc>Guest drivers are loaded.</desc>
8436	</const>
8437	<const name="Userland" value="2">
8438	<desc>Common components (such as application services) are loaded.</desc>
8439	</const>
8440	<const name="Desktop" value="3">
8441	<desc>Per-user desktop components are loaded.</desc>
8442	</const>
8443	</enum>
8444
8445	<enum
8446	name="AdditionsUpdateFlag"
8447	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8448	>
8449	<desc>
8450	Guest Additions update flags.
8451	</desc>
8452
8453	<const name="None" value="0">
8454	<desc>No flag set.</desc>
8455	</const>
8456	<const name="WaitForUpdateStartOnly" value="1">
8457	<desc>Only wait for the update process being started and do not
8458	wait while peforming the actual update.</desc>
8459	</const>
8460	</enum>
8461
8462	<enum
8463	name="ExecuteProcessFlag"
8464	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8465	>
8466	<desc>
8467	Guest process execution flags.
8468	</desc>
8469
8470	<const name="None" value="0">
8471	<desc>No flag set.</desc>
8472	</const>
8473	<const name="WaitForProcessStartOnly" value="1">
8474	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8475	process itself then uses an infinite timeout.</desc>
8476	</const>
8477	<const name="IgnoreOrphanedProcesses" value="2">
8478	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8479	</const>
8480	<const name="Hidden" value="4">
8481	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8482	</const>
8483	<const name="NoProfile" value="8">
8484	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8485	</const>
8486	<const name="WaitForStdOut" value="16">
8487	<desc>The guest process waits until all data from stdout is read out.</desc>
8488	</const>
8489	<const name="WaitForStdErr" value="32">
8490	<desc>The guest process waits until all data from stderr is read out.</desc>
8491	</const>
8492	</enum>
8493
8494	<enum
8495	name="ExecuteProcessStatus"
8496	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8497	>
8498	<desc>
8499	Guest process execution status.
8500	</desc>
8501	<const name="Undefined" value="0">
8502	<desc>Process is in an undefined state.</desc>
8503	</const>
8504
8505	<const name="Started" value="1">
8506	<desc>Process has been started.</desc>
8507	</const>
8508	<const name="TerminatedNormally" value="2">
8509	<desc>Process terminated normally.</desc>
8510	</const>
8511	<const name="TerminatedSignal" value="3">
8512	<desc>Process terminated via signal.</desc>
8513	</const>
8514	<const name="TerminatedAbnormally" value="4">
8515	<desc>Process terminated abnormally.</desc>
8516	</const>
8517	<const name="TimedOutKilled" value="5">
8518	<desc>Process timed out and was killed.</desc>
8519	</const>
8520	<const name="TimedOutAbnormally" value="6">
8521	<desc>Process timed out and was not killed successfully.</desc>
8522	</const>
8523	<const name="Down" value="7">
8524	<desc>Service/OS is stopping, process was killed.</desc>
8525	</const>
8526	<const name="Error" value="8">
8527	<desc>Something went wrong (error code in flags).</desc>
8528	</const>
8529	</enum>
8530
8531	<enum
8532	name="ProcessInputFlag"
8533	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8534	>
8535	<desc>
8536	Guest process input flags.
8537	</desc>
8538	<const name="None" value="0">
8539	<desc>No flag set.</desc>
8540	</const>
8541	<const name="EndOfFile" value="1">
8542	<desc>End of file (input) reached.</desc>
8543	</const>
8544	</enum>
8545
8546	<enum
8547	name="ProcessOutputFlag"
8548	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8549	>
8550	<desc>
8551	Guest process output flags for specifying which
8552	type of output to retrieve.
8553	</desc>
8554	<const name="None" value="0">
8555	<desc>No flags set. Get output from stdout.</desc>
8556	</const>
8557	<const name="StdErr" value="1">
8558	<desc>Get output from stderr.</desc>
8559	</const>
8560	</enum>
8561
8562	<enum
8563	name="CopyFileFlag"
8564	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8565	>
8566	<desc>
8567	Host/Guest copy flags. At the moment none of these flags
8568	are implemented.
8569	</desc>
8570	<const name="None" value="0">
8571	<desc>No flag set.</desc>
8572	</const>
8573	<const name="Recursive" value="1">
8574	<desc>Copy directories recursively.</desc>
8575	</const>
8576	<const name="Update" value="2">
8577	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8578	</const>
8579	<const name="FollowLinks" value="4">
8580	<desc>Follow symbolic links.</desc>
8581	</const>
8582	</enum>
8583
8584	<enum
8585	name="DirectoryCreateFlag"
8586	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8587	>
8588	<desc>
8589	Directory creation flags.
8590	</desc>
8591	<const name="None" value="0">
8592	<desc>No flag set.</desc>
8593	</const>
8594	<const name="Parents" value="1">
8595	<desc>No error if existing, make parent directories as needed.</desc>
8596	</const>
8597	</enum>
8598
8599	<enum
8600	name="DragAndDropAction"
8601	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8602	>
8603	<desc>
8604	Possible actions within an Drag and Drop operation.
8605	</desc>
8606
8607	<const name="Ignore" value="0">
8608	<desc>Do nothing.</desc>
8609	</const>
8610
8611	<const name="Copy" value="1">
8612	<desc>Copy the item to the target.</desc>
8613	</const>
8614
8615	<const name="Move" value="2">
8616	<desc>Move the item to the target.</desc>
8617	</const>
8618
8619	<const name="Link" value="3">
8620	<desc>Link the item from within the target.</desc>
8621	</const>
8622	</enum>
8623
8624	<enum
8625	name="DirectoryOpenFlag"
8626	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8627	>
8628	<desc>
8629	Directory open flags.
8630	</desc>
8631	<const name="None" value="0">
8632	<desc>No flag set.</desc>
8633	</const>
8634	</enum>
8635
8636	<enum
8637	name="GuestDirEntryType"
8638	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8639	>
8640	<desc>
8641	Guest directory entry type.
8642	</desc>
8643	<const name="Unknown" value="0">
8644	<desc>Unknown.</desc>
8645	</const>
8646	<const name="Directory" value="4">
8647	<desc>Regular file.</desc>
8648	</const>
8649	<const name="File" value="10">
8650	<desc>Regular file.</desc>
8651	</const>
8652	<const name="Symlink" value="12">
8653	<desc>Symbolic link.</desc>
8654	</const>
8655	</enum>
8656
8657	<interface
8658	name="IGuestDirEntry" extends="$unknown"
8659	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8660	wsmap="struct"
8661	>
8662	<desc>
8663	Structure representing a directory entry on the guest OS.
8664	</desc>
8665	<attribute name="nodeId" type="long long" readonly="yes">
8666	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8667	</attribute>
8668	<attribute name="name" type="wstring" readonly="yes">
8669	<desc>The filename.</desc>
8670	</attribute>
8671	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8672	<desc>The entry type.</desc>
8673	</attribute>
8674	</interface>
8675
8676	<interface
8677	name="IGuest" extends="$unknown"
8678	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8679	wsmap="managed"
8680	>
8681	<desc>
8682	The IGuest interface represents information about the operating system
8683	running inside the virtual machine. Used in
8684	<link to="IConsole::guest"/>.
8685
8686	IGuest provides information about the guest operating system, whether
8687	Guest Additions are installed and other OS-specific virtual machine
8688	properties.
8689	</desc>
8690
8691	<attribute name="OSTypeId" type="wstring" readonly="yes">
8692	<desc>
8693	Identifier of the Guest OS type as reported by the Guest
8694	Additions.
8695	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8696	an IGuestOSType object representing details about the given
8697	Guest OS type.
8698	<note>
8699	If Guest Additions are not installed, this value will be
8700	the same as <link to="IMachine::OSTypeId"/>.
8701	</note>
8702	</desc>
8703	</attribute>
8704
8705	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8706	<desc>
8707	Current run level of the Guest Additions.
8708	</desc>
8709	</attribute>
8710
8711	<attribute name="additionsVersion" type="wstring" readonly="yes">
8712	<desc>
8713	Version of the Guest Additions in the same format as
8714	<link to="IVirtualBox::version"/>.
8715	</desc>
8716	</attribute>
8717
8718	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8719	<desc>
8720	The internal build revision number of the additions.
8721
8722	See also <link to="IVirtualBox::revision"/>.
8723	</desc>
8724	</attribute>
8725
8726	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8727	<desc>
8728	Array of current known facilities. Only returns facilities where a status is known,
8729	e.g. facilities with an unknown status will not be returned.
8730	</desc>
8731	</attribute>
8732
8733	<attribute name="memoryBalloonSize" type="unsigned long">
8734	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8735	</attribute>
8736
8737	<attribute name="statisticsUpdateInterval" type="unsigned long">
8738	<desc>Interval to update guest statistics in seconds.</desc>
8739	</attribute>
8740
8741	<method name="internalGetStatistics">
8742	<desc>
8743	Internal method; do not use as it might change at any time.
8744	</desc>
8745	<param name="cpuUser" type="unsigned long" dir="out">
8746	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8747	</param>
8748	<param name="cpuKernel" type="unsigned long" dir="out">
8749	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8750	</param>
8751	<param name="cpuIdle" type="unsigned long" dir="out">
8752	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8753	</param>
8754	<param name="memTotal" type="unsigned long" dir="out">
8755	<desc>Total amount of physical guest RAM.</desc>
8756	</param>
8757	<param name="memFree" type="unsigned long" dir="out">
8758	<desc>Free amount of physical guest RAM.</desc>
8759	</param>
8760	<param name="memBalloon" type="unsigned long" dir="out">
8761	<desc>Amount of ballooned physical guest RAM.</desc>
8762	</param>
8763	<param name="memShared" type="unsigned long" dir="out">
8764	<desc>Amount of shared physical guest RAM.</desc>
8765	</param>
8766	<param name="memCache" type="unsigned long" dir="out">
8767	<desc>Total amount of guest (disk) cache memory.</desc>
8768	</param>
8769	<param name="pagedTotal" type="unsigned long" dir="out">
8770	<desc>Total amount of space in the page file.</desc>
8771	</param>
8772	<param name="memAllocTotal" type="unsigned long" dir="out">
8773	<desc>Total amount of memory allocated by the hypervisor.</desc>
8774	</param>
8775	<param name="memFreeTotal" type="unsigned long" dir="out">
8776	<desc>Total amount of free memory available in the hypervisor.</desc>
8777	</param>
8778	<param name="memBalloonTotal" type="unsigned long" dir="out">
8779	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8780	</param>
8781	<param name="memSharedTotal" type="unsigned long" dir="out">
8782	<desc>Total amount of shared memory in the hypervisor.</desc>
8783	</param>
8784	</method>
8785
8786	<method name="getFacilityStatus">
8787	<desc>
8788	Get the current status of a Guest Additions facility.
8789	</desc>
8790	<param name="facility" type="AdditionsFacilityType" dir="in">
8791	<desc>Facility to check status for.</desc>
8792	</param>
8793	<param name="timestamp" type="long long" dir="out">
8794	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8795	</param>
8796	<param name="status" type="AdditionsFacilityStatus" dir="return">
8797	<desc>The current (latest) facility status.</desc>
8798	</param>
8799	</method>
8800
8801	<method name="getAdditionsStatus">
8802	<desc>
8803	Retrieve the current status of a certain Guest Additions run level.
8804
8805	<result name="VBOX_E_NOT_SUPPORTED">
8806	Wrong status level specified.
8807	</result>
8808
8809	</desc>
8810	<param name="level" type="AdditionsRunLevelType" dir="in">
8811	<desc>Status level to check</desc>
8812	</param>
8813	<param name="active" type="boolean" dir="return">
8814	<desc>Flag whether the status level has been reached or not</desc>
8815	</param>
8816	</method>
8817
8818	<method name="setCredentials">
8819	<desc>
8820	Store login credentials that can be queried by guest operating
8821	systems with Additions installed. The credentials are transient
8822	to the session and the guest may also choose to erase them. Note
8823	that the caller cannot determine whether the guest operating system
8824	has queried or made use of the credentials.
8825
8826	<result name="VBOX_E_VM_ERROR">
8827	VMM device is not available.
8828	</result>
8829
8830	</desc>
8831	<param name="userName" type="wstring" dir="in">
8832	<desc>User name string, can be empty</desc>
8833	</param>
8834	<param name="password" type="wstring" dir="in">
8835	<desc>Password string, can be empty</desc>
8836	</param>
8837	<param name="domain" type="wstring" dir="in">
8838	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8839	</param>
8840	<param name="allowInteractiveLogon" type="boolean" dir="in">
8841	<desc>
8842	Flag whether the guest should alternatively allow the user to
8843	interactively specify different credentials. This flag might
8844	not be supported by all versions of the Additions.
8845	</desc>
8846	</param>
8847	</method>
8848
8849	<method name="dragHGEnter">
8850	<desc>
8851	Informs the guest about a Drag and Drop enter event.
8852
8853	This is used in Host - Guest direction.
8854
8855	<result name="VBOX_E_VM_ERROR">
8856	VMM device is not available.
8857	</result>
8858
8859	</desc>
8860	<param name="screenId" type="unsigned long" dir="in">
8861	<desc>The screen id where the Drag and Drop event occured.</desc>
8862	</param>
8863	<param name="y" type="unsigned long" dir="in">
8864	<desc>y-position of the event.</desc>
8865	</param>
8866	<param name="x" type="unsigned long" dir="in">
8867	<desc>x-position of the event.</desc>
8868	</param>
8869	<param name="defaultAction" type="DragAndDropAction" dir="in">
8870	<desc>The default action to use.</desc>
8871	</param>
8872	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8873	<desc>The actions which are allowed.</desc>
8874	</param>
8875	<param name="formats" type="wstring" dir="in" safearray="yes">
8876	<desc>The supported mime types.</desc>
8877	</param>
8878	<param name="resultAction" type="DragAndDropAction" dir="return">
8879	<desc>The resulting action of this event.</desc>
8880	</param>
8881	</method>
8882
8883	<method name="dragHGMove">
8884	<desc>
8885	Informs the guest about a Drag and Drop move event.
8886
8887	This is used in Host - Guest direction.
8888
8889	<result name="VBOX_E_VM_ERROR">
8890	VMM device is not available.
8891	</result>
8892
8893	</desc>
8894	<param name="screenId" type="unsigned long" dir="in">
8895	<desc>The screen id where the Drag and Drop event occured.</desc>
8896	</param>
8897	<param name="x" type="unsigned long" dir="in">
8898	<desc>x-position of the event.</desc>
8899	</param>
8900	<param name="y" type="unsigned long" dir="in">
8901	<desc>y-position of the event.</desc>
8902	</param>
8903	<param name="defaultAction" type="DragAndDropAction" dir="in">
8904	<desc>The default action to use.</desc>
8905	</param>
8906	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8907	<desc>The actions which are allowed.</desc>
8908	</param>
8909	<param name="formats" type="wstring" dir="in" safearray="yes">
8910	<desc>The supported mime types.</desc>
8911	</param>
8912	<param name="resultAction" type="DragAndDropAction" dir="return">
8913	<desc>The resulting action of this event.</desc>
8914	</param>
8915	</method>
8916
8917	<method name="dragHGLeave">
8918	<desc>
8919	Informs the guest about a Drag and Drop leave event.
8920
8921	This is used in Host - Guest direction.
8922
8923	<result name="VBOX_E_VM_ERROR">
8924	VMM device is not available.
8925	</result>
8926
8927	</desc>
8928	<param name="screenId" type="unsigned long" dir="in">
8929	<desc>The screen id where the Drag and Drop event occured.</desc>
8930	</param>
8931	</method>
8932
8933	<method name="dragHGDrop">
8934	<desc>
8935	Informs the guest about a drop event.
8936
8937	This is used in Host - Guest direction.
8938
8939	<result name="VBOX_E_VM_ERROR">
8940	VMM device is not available.
8941	</result>
8942
8943	</desc>
8944	<param name="screenId" type="unsigned long" dir="in">
8945	<desc>The screen id where the Drag and Drop event occured.</desc>
8946	</param>
8947	<param name="x" type="unsigned long" dir="in">
8948	<desc>x-position of the event.</desc>
8949	</param>
8950	<param name="y" type="unsigned long" dir="in">
8951	<desc>y-position of the event.</desc>
8952	</param>
8953	<param name="defaultAction" type="DragAndDropAction" dir="in">
8954	<desc>The default action to use.</desc>
8955	</param>
8956	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8957	<desc>The actions which are allowed.</desc>
8958	</param>
8959	<param name="formats" type="wstring" dir="in" safearray="yes">
8960	<desc>The supported mime types.</desc>
8961	</param>
8962	<param name="format" type="wstring" dir="out">
8963	<desc>The resulting format of this event.</desc>
8964	</param>
8965	<param name="resultAction" type="DragAndDropAction" dir="return">
8966	<desc>The resulting action of this event.</desc>
8967	</param>
8968	</method>
8969
8970	<method name="dragHGPutData">
8971	<desc>
8972	Informs the guest about a drop data event.
8973
8974	This is used in Host - Guest direction.
8975
8976	<result name="VBOX_E_VM_ERROR">
8977	VMM device is not available.
8978	</result>
8979
8980	</desc>
8981	<param name="screenId" type="unsigned long" dir="in">
8982	<desc>The screen id where the Drag and Drop event occured.</desc>
8983	</param>
8984	<param name="format" type="wstring" dir="in">
8985	<desc>The mime type the data is in.</desc>
8986	</param>
8987	<param name="data" type="octet" dir="in" safearray="yes">
8988	<desc>The actual data.</desc>
8989	</param>
8990	<param name="progress" type="IProgress" dir="return">
8991	<desc>Progress object to track the operation completion.</desc>
8992	</param>
8993	</method>
8994
8995	<method name="dragGHPending">
8996	<desc>
8997	Ask the guest if there is any Drag and Drop operation pending in the guest.
8998
8999	If no Drag and Drop operation is pending currently, Ignore is returned.
9000
9001	This is used in Guest - Host direction.
9002
9003	<result name="VBOX_E_VM_ERROR">
9004	VMM device is not available.
9005	</result>
9006
9007	</desc>
9008	<param name="screenId" type="unsigned long" dir="in">
9009	<desc>The screen id where the Drag and Drop event occured.</desc>
9010	</param>
9011	<param name="format" type="wstring" dir="out" safearray="yes">
9012	<desc>On return the supported mime types.</desc>
9013	</param>
9014	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9015	<desc>On return the actions which are allowed.</desc>
9016	</param>
9017	<param name="defaultAction" type="DragAndDropAction" dir="return">
9018	<desc>On return the default action to use.</desc>
9019	</param>
9020	</method>
9021
9022	<method name="dragGHDropped">
9023	<desc>
9024	Informs the guest that a drop event occured for a pending Drag and Drop event.
9025
9026	This is used in Guest - Host direction.
9027
9028	<result name="VBOX_E_VM_ERROR">
9029	VMM device is not available.
9030	</result>
9031
9032	</desc>
9033
9034	<param name="format" type="wstring" dir="in">
9035	<desc>The mime type the data must be in.</desc>
9036	</param>
9037	<param name="action" type="DragAndDropAction" dir="in">
9038	<desc>The action to use.</desc>
9039	</param>
9040	<param name="progress" type="IProgress" dir="return">
9041	<desc>Progress object to track the operation completion.</desc>
9042	</param>
9043	</method>
9044
9045	<method name="dragGHGetData">
9046	<desc>
9047	Fetch the data of a previously Drag and Drop event from the guest.
9048
9049	This is used in Guest - Host direction.
9050
9051	<result name="VBOX_E_VM_ERROR">
9052	VMM device is not available.
9053	</result>
9054
9055	</desc>
9056
9057	<param name="data" type="octet" safearray="yes" dir="return">
9058	<desc>The actual data.</desc>
9059	</param>
9060	</method>
9061
9062	<method name="executeProcess">
9063	<desc>
9064	Executes an existing program inside the guest VM.
9065
9066	<note>
9067	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9068	to serve up to 25 guest processes at a time. If all 25 guest processes
9069	are still active and running, starting a new guest process will result in an
9070	appropriate error message.
9071
9072	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9073	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9074	set, the guest process will not exit until all data from the specified
9075	stream(s) is/are read out.
9076
9077	To raise or lower the guest process execution limit, either the guest property
9078	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9079	command line by specifying "--control-procs-max-kept" needs to be modified.
9080	A restart of the guest OS is required afterwards. To serve unlimited guest
9081	processes, a value of "0" needs to be set (not recommended).
9082	</note>
9083
9084	<result name="VBOX_E_IPRT_ERROR">
9085	Could not execute process.
9086	</result>
9087
9088	</desc>
9089	<param name="execName" type="wstring" dir="in">
9090	<desc>
9091	Full path name of the command to execute on the guest; the
9092	commands has to exists in the guest VM in order to be executed.
9093	</desc>
9094	</param>
9095	<param name="flags" type="unsigned long" dir="in">
9096	<desc>
9097	<link to="ExecuteProcessFlag"/> flags.
9098	</desc>
9099	</param>
9100	<param name="arguments" type="wstring" safearray="yes" dir="in">
9101	<desc>
9102	Array of arguments passed to the execution command.
9103	</desc>
9104	</param>
9105	<param name="environment" type="wstring" safearray="yes" dir="in">
9106	<desc>
9107	Environment variables that can be set while the command is being
9108	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9109	variable just set its name ("NAME") without a value.
9110	</desc>
9111	</param>
9112	<param name="userName" type="wstring" dir="in">
9113	<desc>
9114	User name under which the command will be executed; has to exist
9115	and have the appropriate rights to execute programs in the VM.
9116	</desc>
9117	</param>
9118	<param name="password" type="wstring" dir="in">
9119	<desc>
9120	Password of the user account specified.
9121	</desc>
9122	</param>
9123	<param name="timeoutMS" type="unsigned long" dir="in">
9124	<desc>
9125	The maximum timeout value (in msec) to wait for finished program
9126	execution. Pass 0 for an infinite timeout.
9127	</desc>
9128	</param>
9129	<param name="pid" type="unsigned long" dir="out">
9130	<desc>
9131	The PID (process ID) of the started command for later reference.
9132	</desc>
9133	</param>
9134	<param name="progress" type="IProgress" dir="return">
9135	<desc>Progress object to track the operation completion.</desc>
9136	</param>
9137	</method>
9138
9139	<method name="getProcessOutput">
9140	<desc>
9141	Retrieves output of a formerly started and running guest process.
9142
9143	<note>
9144	Starting with VirtualBox 4.1.8 this only will return output data
9145	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9146	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9147	<link to="ExecuteProcessFlag"/> is set in the
9148	former <link to="#executeProcess"/> call for this guest process.
9149	</note>
9150
9151	<result name="VBOX_E_IPRT_ERROR">
9152	Could not retrieve output.
9153	</result>
9154
9155	</desc>
9156	<param name="pid" type="unsigned long" dir="in">
9157	<desc>
9158	Process id returned by earlier <link to="#executeProcess"/> call.
9159	</desc>
9160	</param>
9161	<param name="flags" type="unsigned long" dir="in">
9162	<desc>
9163	<link to="ProcessOutputFlag"/> flags.
9164	</desc>
9165	</param>
9166	<param name="timeoutMS" type="unsigned long" dir="in">
9167	<desc>
9168	The maximum timeout value (in msec) to wait for output
9169	data. Pass 0 for an infinite timeout.
9170	</desc>
9171	</param>
9172	<param name="size" type="long long" dir="in">
9173	<desc>
9174	Size in bytes to read in the buffer.
9175	</desc>
9176	</param>
9177	<param name="data" type="octet" safearray="yes" dir="return">
9178	<desc>
9179	Buffer for retrieving the actual output. A data size of 0 means end of file
9180	if the requested size was not 0. This is the unprocessed
9181	output data, i.e. the line ending style depends on the platform of
9182	the system the server is running on.
9183	</desc>
9184	</param>
9185	</method>
9186
9187	<method name="getProcessStatus">
9188	<desc>
9189	Retrieves status, exit code and the exit reason of a formerly started
9190	guest process. If a guest process exited or got terminated this function
9191	returns its final status and removes this process from the list of
9192	known guest processes for further retrieval.
9193
9194	<result name="VBOX_E_IPRT_ERROR">
9195	Process with specified PID was not found.
9196	</result>
9197
9198	</desc>
9199	<param name="pid" type="unsigned long" dir="in">
9200	<desc>
9201	Process id returned by earlier <link to="#executeProcess"/> call.
9202	</desc>
9203	</param>
9204	<param name="exitcode" type="unsigned long" dir="out">
9205	<desc>
9206	The exit code (if available).
9207	</desc>
9208	</param>
9209	<param name="flags" type="unsigned long" dir="out">
9210	<desc>
9211	Additional flags of process status. Not used at the moment and
9212	must be set to 0.
9213	</desc>
9214	</param>
9215	<param name="reason" type="ExecuteProcessStatus" dir="return">
9216	<desc>
9217	The current process status.
9218	</desc>
9219	</param>
9220	</method>
9221
9222	<method name="copyFromGuest">
9223	<desc>
9224	Copies files/directories from guest to the host.
9225
9226	<result name="VBOX_E_IPRT_ERROR">
9227	Error while copying.
9228	</result>
9229
9230	</desc>
9231	<param name="source" type="wstring" dir="in">
9232	<desc>
9233	Source file on the guest to copy.
9234	</desc>
9235	</param>
9236	<param name="dest" type="wstring" dir="in">
9237	<desc>
9238	Destination path on the host.
9239	</desc>
9240	</param>
9241	<param name="userName" type="wstring" dir="in">
9242	<desc>
9243	User name under which the copy command will be executed; the
9244	user has to exist and have the appropriate rights to read from
9245	the source path.
9246	</desc>
9247	</param>
9248	<param name="password" type="wstring" dir="in">
9249	<desc>
9250	Password of the user account specified.
9251	</desc>
9252	</param>
9253	<param name="flags" type="unsigned long" dir="in">
9254	<desc>
9255	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9256	</desc>
9257	</param>
9258	<param name="progress" type="IProgress" dir="return">
9259	<desc>Progress object to track the operation completion.</desc>
9260	</param>
9261	</method>
9262
9263	<method name="copyToGuest">
9264	<desc>
9265	Copies files/directories from host to the guest.
9266
9267	<result name="VBOX_E_IPRT_ERROR">
9268	Error while copying.
9269	</result>
9270
9271	</desc>
9272	<param name="source" type="wstring" dir="in">
9273	<desc>
9274	Source file on the host to copy.
9275	</desc>
9276	</param>
9277	<param name="dest" type="wstring" dir="in">
9278	<desc>
9279	Destination path on the guest.
9280	</desc>
9281	</param>
9282	<param name="userName" type="wstring" dir="in">
9283	<desc>
9284	User name under which the copy command will be executed; the
9285	user has to exist and have the appropriate rights to write to
9286	the destination path.
9287	</desc>
9288	</param>
9289	<param name="password" type="wstring" dir="in">
9290	<desc>
9291	Password of the user account specified.
9292	</desc>
9293	</param>
9294	<param name="flags" type="unsigned long" dir="in">
9295	<desc>
9296	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9297	</desc>
9298	</param>
9299	<param name="progress" type="IProgress" dir="return">
9300	<desc>Progress object to track the operation completion.</desc>
9301	</param>
9302	</method>
9303
9304	<method name="directoryClose">
9305	<desc>
9306	Closes a formerly opened guest directory.
9307
9308	<result name="VBOX_E_IPRT_ERROR">
9309	Error while closing directory.
9310	</result>
9311
9312	</desc>
9313	<param name="handle" type="unsigned long" dir="in">
9314	<desc>
9315	Handle of opened directory to close.
9316	</desc>
9317	</param>
9318	</method>
9319
9320	<method name="directoryCreate">
9321	<desc>
9322	Creates a directory on the guest.
9323
9324	<result name="VBOX_E_IPRT_ERROR">
9325	Error while creating directory.
9326	</result>
9327
9328	</desc>
9329	<param name="directory" type="wstring" dir="in">
9330	<desc>
9331	Directory to create.
9332	</desc>
9333	</param>
9334	<param name="userName" type="wstring" dir="in">
9335	<desc>
9336	User name under which the directory creation will be executed; the
9337	user has to exist and have the appropriate rights to create the
9338	desired directory.
9339	</desc>
9340	</param>
9341	<param name="password" type="wstring" dir="in">
9342	<desc>
9343	Password of the user account specified.
9344	</desc>
9345	</param>
9346	<param name="mode" type="unsigned long" dir="in">
9347	<desc>
9348	File mode.
9349	</desc>
9350	</param>
9351	<param name="flags" type="unsigned long" dir="in">
9352	<desc>
9353	<link to="DirectoryCreateFlag"/> flags.
9354	</desc>
9355	</param>
9356	</method>
9357
9358	<method name="directoryOpen">
9359	<desc>
9360	Opens a directory on the guest.
9361
9362	<result name="VBOX_E_IPRT_ERROR">
9363	Error while opening / reading directory.
9364	</result>
9365
9366	</desc>
9367	<param name="directory" type="wstring" dir="in">
9368	<desc>
9369	Directory to read.
9370	</desc>
9371	</param>
9372	<param name="filter" type="wstring" dir="in">
9373	<desc>
9374	Directory filter (DOS style wildcards). Set to empty
9375	string if no filter required.
9376	</desc>
9377	</param>
9378	<param name="flags" type="unsigned long" dir="in">
9379	<desc>
9380	<link to="DirectoryOpenFlag"/> flags.
9381	</desc>
9382	</param>
9383	<param name="userName" type="wstring" dir="in">
9384	<desc>
9385	User name under which the directory reading will be performed; the
9386	user has to exist and have the appropriate rights to access / read the
9387	desired directory.
9388	</desc>
9389	</param>
9390	<param name="password" type="wstring" dir="in">
9391	<desc>
9392	Password of the user account specified.
9393	</desc>
9394	</param>
9395	<param name="handle" type="unsigned long" dir="return">
9396	<desc>
9397	Handle of opened directory returned by openDirectory.
9398	</desc>
9399	</param>
9400	</method>
9401
9402	<method name="directoryRead">
9403	<desc>
9404	Reads the next directory entry of an opened guest directory.
9405
9406	<result name="E_ABORT">
9407	When the end of the directory has been reached.
9408	</result>
9409
9410	<result name="VBOX_E_IPRT_ERROR">
9411	Error while opening / reading directory.
9412	</result>
9413
9414	</desc>
9415	<param name="handle" type="unsigned long" dir="in">
9416	<desc>
9417	Handle of opened directory returned by openDirectory.
9418	</desc>
9419	</param>
9420	<param name="entry" type="IGuestDirEntry" dir="return">
9421	<desc>
9422	Information about next directory entry on success.
9423	</desc>
9424	</param>
9425	</method>
9426
9427	<method name="fileExists">
9428	<desc>
9429	Checks if the specified file name exists and is a regular file.
9430
9431	If the file name ends with a slash or backslash, the function assumes
9432	it's a directory and will check if the specified directory exists and
9433	is a regular directory.
9434
9435	<result name="VBOX_E_IPRT_ERROR">
9436	Error while looking up information.
9437	</result>
9438
9439	</desc>
9440	<param name="file" type="wstring" dir="in">
9441	<desc>
9442	Full path of file to check.
9443	</desc>
9444	</param>
9445	<param name="userName" type="wstring" dir="in">
9446	<desc>
9447	User name under which the lookup will be performed; the
9448	user has to exist and have the appropriate rights to access / read the
9449	desired directory.
9450	</desc>
9451	</param>
9452	<param name="password" type="wstring" dir="in">
9453	<desc>
9454	Password of the user account specified.
9455	</desc>
9456	</param>
9457	<param name="exists" type="boolean" dir="return">
9458	<desc>
9459	True if it's a regular file, false if it isn't (or doesn't exist).
9460	</desc>
9461	</param>
9462	</method>
9463
9464	<method name="fileQuerySize">
9465	<desc>
9466	Queries the size of a file, given the path to it.
9467
9468	<result name="VBOX_E_IPRT_ERROR">
9469	Error while looking up information.
9470	</result>
9471
9472	</desc>
9473	<param name="file" type="wstring" dir="in">
9474	<desc>
9475	Full path of file to query file size for.
9476	</desc>
9477	</param>
9478	<param name="userName" type="wstring" dir="in">
9479	<desc>
9480	User name under which the lookup will be performed; the
9481	user has to exist and have the appropriate rights to access / read the
9482	desired directory.
9483	</desc>
9484	</param>
9485	<param name="password" type="wstring" dir="in">
9486	<desc>
9487	Password of the user account specified.
9488	</desc>
9489	</param>
9490	<param name="size" type="long long" dir="return">
9491	<desc>
9492	Size (in bytes) of file specified.
9493	</desc>
9494	</param>
9495	</method>
9496
9497	<method name="setProcessInput">
9498	<desc>
9499	Sends input into a formerly started process.
9500
9501	<result name="VBOX_E_IPRT_ERROR">
9502	Could not send input.
9503	</result>
9504
9505	</desc>
9506	<param name="pid" type="unsigned long" dir="in">
9507	<desc>
9508	Process id returned by earlier <link to="#executeProcess"/> call.
9509	</desc>
9510	</param>
9511	<param name="flags" type="unsigned long" dir="in">
9512	<desc>
9513	<link to="ProcessInputFlag"/> flags.
9514	</desc>
9515	</param>
9516	<param name="timeoutMS" type="unsigned long" dir="in">
9517	<desc>
9518	The maximum timeout value (in msec) to wait for getting the
9519	data transfered to the guest. Pass 0 for an infinite timeout.
9520	</desc>
9521	</param>
9522	<param name="data" type="octet" dir="in" safearray="yes">
9523	<desc>
9524	Buffer of input data to send to the started process to.
9525	</desc>
9526	</param>
9527	<param name="written" type="unsigned long" dir="return">
9528	<desc>
9529	Number of bytes written.
9530	</desc>
9531	</param>
9532	</method>
9533
9534	<method name="updateGuestAdditions">
9535	<desc>
9536	Updates already installed Guest Additions in a VM
9537	(Windows guests only).
9538
9539	<result name="VBOX_E_IPRT_ERROR">
9540	Error while updating.
9541	</result>
9542
9543	</desc>
9544	<param name="source" type="wstring" dir="in">
9545	<desc>
9546	Path to the Guest Additions .ISO file to use for the upate.
9547	</desc>
9548	</param>
9549	<param name="flags" type="unsigned long" dir="in">
9550	<desc>
9551	<link to="AdditionsUpdateFlag"/> flags.
9552	</desc>
9553	</param>
9554	<param name="progress" type="IProgress" dir="return">
9555	<desc>Progress object to track the operation completion.</desc>
9556	</param>
9557	</method>
9558
9559	</interface>
9560
9561
9562	<!--
9563	// IProgress
9564	/////////////////////////////////////////////////////////////////////////
9565	-->
9566
9567	<interface
9568	name="IProgress" extends="$unknown"
9569	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9570	wsmap="managed"
9571	>
9572	<desc>
9573	The IProgress interface is used to track and control
9574	asynchronous tasks within VirtualBox.
9575
9576	An instance of this is returned every time VirtualBox starts
9577	an asynchronous task (in other words, a separate thread) which
9578	continues to run after a method call returns. For example,
9579	<link to="IConsole::saveState" />, which saves the state of
9580	a running virtual machine, can take a long time to complete.
9581	To be able to display a progress bar, a user interface such as
9582	the VirtualBox graphical user interface can use the IProgress
9583	object returned by that method.
9584
9585	Note that IProgress is a "read-only" interface in the sense
9586	that only the VirtualBox internals behind the Main API can
9587	create and manipulate progress objects, whereas client code
9588	can only use the IProgress object to monitor a task's
9589	progress and, if <link to="#cancelable" /> is @c true,
9590	cancel the task by calling <link to="#cancel" />.
9591
9592	A task represented by IProgress consists of either one or
9593	several sub-operations that run sequentially, one by one (see
9594	<link to="#operation" /> and <link to="#operationCount" />).
9595	Every operation is identified by a number (starting from 0)
9596	and has a separate description.
9597
9598	You can find the individual percentage of completion of the current
9599	operation in <link to="#operationPercent" /> and the
9600	percentage of completion of the task as a whole
9601	in <link to="#percent" />.
9602
9603	Similarly, you can wait for the completion of a particular
9604	operation via <link to="#waitForOperationCompletion" /> or
9605	for the completion of the whole task via
9606	<link to="#waitForCompletion" />.
9607	</desc>
9608
9609	<attribute name="id" type="uuid" mod="string" readonly="yes">
9610	<desc>ID of the task.</desc>
9611	</attribute>
9612
9613	<attribute name="description" type="wstring" readonly="yes">
9614	<desc>Description of the task.</desc>
9615	</attribute>
9616
9617	<attribute name="initiator" type="$unknown" readonly="yes">
9618	<desc>Initiator of the task.</desc>
9619	</attribute>
9620
9621	<attribute name="cancelable" type="boolean" readonly="yes">
9622	<desc>Whether the task can be interrupted.</desc>
9623	</attribute>
9624
9625	<attribute name="percent" type="unsigned long" readonly="yes">
9626	<desc>
9627	Current progress value of the task as a whole, in percent.
9628	This value depends on how many operations are already complete.
9629	Returns 100 if <link to="#completed" /> is @c true.
9630	</desc>
9631	</attribute>
9632
9633	<attribute name="timeRemaining" type="long" readonly="yes">
9634	<desc>
9635	Estimated remaining time until the task completes, in
9636	seconds. Returns 0 once the task has completed; returns -1
9637	if the remaining time cannot be computed, in particular if
9638	the current progress is 0.
9639
9640	Even if a value is returned, the estimate will be unreliable
9641	for low progress values. It will become more reliable as the
9642	task progresses; it is not recommended to display an ETA
9643	before at least 20% of a task have completed.
9644	</desc>
9645	</attribute>
9646
9647	<attribute name="completed" type="boolean" readonly="yes">
9648	<desc>Whether the task has been completed.</desc>
9649	</attribute>
9650
9651	<attribute name="canceled" type="boolean" readonly="yes">
9652	<desc>Whether the task has been canceled.</desc>
9653	</attribute>
9654
9655	<attribute name="resultCode" type="long" readonly="yes">
9656	<desc>
9657	Result code of the progress task.
9658	Valid only if <link to="#completed"/> is @c true.
9659	</desc>
9660	</attribute>
9661
9662	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9663	<desc>
9664	Extended information about the unsuccessful result of the
9665	progress operation. May be @c null if no extended information
9666	is available.
9667	Valid only if <link to="#completed"/> is @c true and
9668	<link to="#resultCode"/> indicates a failure.
9669	</desc>
9670	</attribute>
9671
9672	<attribute name="operationCount" type="unsigned long" readonly="yes">
9673	<desc>
9674	Number of sub-operations this task is divided into.
9675	Every task consists of at least one suboperation.
9676	</desc>
9677	</attribute>
9678
9679	<attribute name="operation" type="unsigned long" readonly="yes">
9680	<desc>Number of the sub-operation being currently executed.</desc>
9681	</attribute>
9682
9683	<attribute name="operationDescription" type="wstring" readonly="yes">
9684	<desc>
9685	Description of the sub-operation being currently executed.
9686	</desc>
9687	</attribute>
9688
9689	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9690	<desc>Progress value of the current sub-operation only, in percent.</desc>
9691	</attribute>
9692
9693	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9694	<desc>Weight value of the current sub-operation only.</desc>
9695	</attribute>
9696
9697	<attribute name="timeout" type="unsigned long">
9698	<desc>
9699	When non-zero, this specifies the number of milliseconds after which
9700	the operation will automatically be canceled. This can only be set on
9701	cancelable objects.
9702	</desc>
9703	</attribute>
9704
9705	<method name="setCurrentOperationProgress">
9706	<desc>Internal method, not to be called externally.</desc>
9707	<param name="percent" type="unsigned long" dir="in" />
9708	</method>
9709	<method name="setNextOperation">
9710	<desc>Internal method, not to be called externally.</desc>
9711	<param name="nextOperationDescription" type="wstring" dir="in" />
9712	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9713	</method>
9714
9715	<method name="waitForCompletion">
9716	<desc>
9717	Waits until the task is done (including all sub-operations)
9718	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9719
9720	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9721	thread are not processed while waiting. Neglecting event queues may
9722	have dire consequences (degrade performance, resource hogs,
9723	deadlocks, etc.), this is specially so for the main thread on
9724	platforms using XPCOM. Callers are adviced wait for short periods
9725	and service their event queues between calls, or to create a worker
9726	thread to do the waiting.
9727
9728	<result name="VBOX_E_IPRT_ERROR">
9729	Failed to wait for task completion.
9730	</result>
9731	</desc>
9732
9733	<param name="timeout" type="long" dir="in">
9734	<desc>
9735	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9736	</desc>
9737	</param>
9738	</method>
9739
9740	<method name="waitForOperationCompletion">
9741	<desc>
9742	Waits until the given operation is done with a given timeout in
9743	milliseconds; specify -1 for an indefinite wait.
9744
9745	See <link to="#waitForCompletion"> for event queue considerations.</link>
9746
9747	<result name="VBOX_E_IPRT_ERROR">
9748	Failed to wait for operation completion.
9749	</result>
9750
9751	</desc>
9752	<param name="operation" type="unsigned long" dir="in">
9753	<desc>
9754	Number of the operation to wait for.
9755	Must be less than <link to="#operationCount"/>.
9756	</desc>
9757	</param>
9758	<param name="timeout" type="long" dir="in">
9759	<desc>
9760	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9761	</desc>
9762	</param>
9763	</method>
9764
9765	<method name="waitForAsyncProgressCompletion">
9766	<desc>
9767	Waits until the other task is completed (including all
9768	sub-operations) and forward all changes from the other progress to
9769	this progress. This means sub-operation number, description, percent
9770	and so on.
9771
9772	You have to take care on setting up at least the same count on
9773	sub-operations in this progress object like there are in the other
9774	progress object.
9775
9776	If the other progress object supports cancel and this object gets any
9777	cancel request (when here enabled as well), it will be forwarded to
9778	the other progress object.
9779
9780	If there is an error in the other progress, this error isn't
9781	automatically transfered to this progress object. So you have to
9782	check any operation error within the other progress object, after
9783	this method returns.
9784	</desc>
9785
9786	<param name="pProgressAsync" type="IProgress" dir="in">
9787	<desc>
9788	The progress object of the asynchrony process.
9789	</desc>
9790	</param>
9791	</method>
9792
9793	<method name="cancel">
9794	<desc>
9795	Cancels the task.
9796	<note>
9797	If <link to="#cancelable"/> is @c false, then this method will fail.
9798	</note>
9799
9800	<result name="VBOX_E_INVALID_OBJECT_STATE">
9801	Operation cannot be canceled.
9802	</result>
9803
9804	</desc>
9805	</method>
9806
9807	</interface>
9808
9809	<!--
9810	// ISnapshot
9811	/////////////////////////////////////////////////////////////////////////
9812	-->
9813
9814	<interface
9815	name="ISnapshot" extends="$unknown"
9816	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9817	wsmap="managed"
9818	>
9819	<desc>
9820	The ISnapshot interface represents a snapshot of the virtual
9821	machine.
9822
9823	Together with the differencing media that are created
9824	when a snapshot is taken, a machine can be brought back to
9825	the exact state it was in when the snapshot was taken.
9826
9827	The ISnapshot interface has no methods, only attributes; snapshots
9828	are controlled through methods of the <link to="IConsole" /> interface
9829	which also manage the media associated with the snapshot.
9830	The following operations exist:
9831
9832	<ul>
9833	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9834	by creating new, empty differencing images for the machine's
9835	media and saving the VM settings and (if the VM is running)
9836	the current VM state in the snapshot.
9837
9838	The differencing images will then receive all data written to
9839	the machine's media, while their parent (base) images
9840	remain unmodified after the snapshot has been taken (see
9841	<link to="IMedium" /> for details about differencing images).
9842	This simplifies restoring a machine to the state of a snapshot:
9843	only the differencing images need to be deleted.
9844
9845	The current machine state is not changed by taking a snapshot
9846	except that <link to="IMachine::currentSnapshot" /> is set to
9847	the newly created snapshot, which is also added to the machine's
9848	snapshots tree.
9849	</li>
9850
9851	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9852	the state of a previous snapshot by deleting the differencing
9853	image of each of the machine's media and setting the machine's
9854	settings and state to the state that was saved in the snapshot (if any).
9855
9856	This destroys the machine's current state. After calling this,
9857	<link to="IMachine::currentSnapshot" /> points to the snapshot
9858	that was restored.
9859	</li>
9860
9861	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9862	without affecting the current machine state.
9863
9864	This does not change the current machine state, but instead frees the
9865	resources allocated when the snapshot was taken: the settings and machine
9866	state file are deleted (if any), and the snapshot's differencing image for
9867	each of the machine's media gets merged with its parent image.
9868
9869	Neither the current machine state nor other snapshots are affected
9870	by this operation, except that parent media will be modified
9871	to contain the disk data associated with the snapshot being deleted.
9872
9873	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9874	attribute is set to the current snapshot's parent or NULL if it
9875	has no parent. Otherwise the attribute is unchanged.
9876	</li>
9877	</ul>
9878
9879	Each snapshot contains a copy of virtual machine's settings (hardware
9880	configuration etc.). This copy is contained in an immutable (read-only)
9881	instance of <link to="IMachine" /> which is available from the snapshot's
9882	<link to="#machine" /> attribute. When restoring the snapshot, these
9883	settings are copied back to the original machine.
9884
9885	In addition, if the machine was running when the
9886	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9887	the current VM state is saved in the snapshot (similarly to what happens
9888	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9889	because when restoring it, the VM will be running.
9890
9891	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9892	the snapshot receives a copy of the execution state file
9893	(<link to="IMachine::stateFilePath"/>).
9894
9895	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9896	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9897	it then contains a so-called "zero execution state", representing a
9898	machine that is powered off.
9899	</desc>
9900
9901	<attribute name="id" type="uuid" mod="string" readonly="yes">
9902	<desc>UUID of the snapshot.</desc>
9903	</attribute>
9904
9905	<attribute name="name" type="wstring">
9906	<desc>Short name of the snapshot.
9907	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9908	be called implicitly.</note>
9909	</desc>
9910	</attribute>
9911
9912	<attribute name="description" type="wstring">
9913	<desc>Optional description of the snapshot.
9914	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9915	be called implicitly.</note>
9916	</desc>
9917	</attribute>
9918
9919	<attribute name="timeStamp" type="long long" readonly="yes">
9920	<desc>
9921	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9922	</desc>
9923	</attribute>
9924
9925	<attribute name="online" type="boolean" readonly="yes">
9926	<desc>
9927	@c true if this snapshot is an online snapshot and @c false otherwise.
9928
9929	When this attribute is @c true, the
9930	<link to="IMachine::stateFilePath"/> attribute of the
9931	<link to="#machine"/> object associated with this snapshot
9932	will point to the saved state file. Otherwise, it will be
9933	an empty string.
9934	</desc>
9935	</attribute>
9936
9937	<attribute name="machine" type="IMachine" readonly="yes">
9938	<desc>
9939	Virtual machine this snapshot is taken on. This object
9940	stores all settings the machine had when taking this snapshot.
9941	<note>
9942	The returned machine object is immutable, i.e. no
9943	any settings can be changed.
9944	</note>
9945	</desc>
9946	</attribute>
9947
9948	<attribute name="parent" type="ISnapshot" readonly="yes">
9949	<desc>
9950	Parent snapshot (a snapshot this one is based on), or
9951	@c null if the snapshot has no parent (i.e. is the first snapshot).
9952	</desc>
9953	</attribute>
9954
9955	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9956	<desc>
9957	Child snapshots (all snapshots having this one as a parent).
9958	By inspecting this attribute starting with a machine's root snapshot
9959	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9960	with a @c null UUID), a machine's snapshots tree can be iterated over.
9961	</desc>
9962	</attribute>
9963
9964	<method name="getChildrenCount" const="yes">
9965	<desc>
9966	Returns the number of direct childrens of this snapshot.
9967	</desc>
9968	<param name="childrenCount" type="unsigned long" dir="return">
9969	<desc>
9970	</desc>
9971	</param>
9972	</method>
9973
9974	</interface>
9975
9976
9977	<!--
9978	// IMedium
9979	/////////////////////////////////////////////////////////////////////////
9980	-->
9981
9982	<enum
9983	name="MediumState"
9984	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9985	>
9986	<desc>
9987	Virtual medium state.
9988	<see><link to="IMedium"/></see>
9989	</desc>
9990
9991	<const name="NotCreated" value="0">
9992	<desc>
9993	Associated medium storage does not exist (either was not created yet or
9994	was deleted).
9995	</desc>
9996	</const>
9997	<const name="Created" value="1">
9998	<desc>
9999	Associated storage exists and accessible; this gets set if the
10000	accessibility check performed by <link to="IMedium::refreshState" />
10001	was successful.
10002	</desc>
10003	</const>
10004	<const name="LockedRead" value="2">
10005	<desc>
10006	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10007	no data modification is possible.
10008	</desc>
10009	</const>
10010	<const name="LockedWrite" value="3">
10011	<desc>
10012	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10013	no concurrent data reading or modification is possible.
10014	</desc>
10015	</const>
10016	<const name="Inaccessible" value="4">
10017	<desc>
10018	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10019	not yet been performed, or else, associated medium storage is not
10020	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10021	is empty, in the second case, it describes the error that occurred.
10022	</desc>
10023	</const>
10024	<const name="Creating" value="5">
10025	<desc>
10026	Associated medium storage is being created.
10027	</desc>
10028	</const>
10029	<const name="Deleting" value="6">
10030	<desc>
10031	Associated medium storage is being deleted.
10032	</desc>
10033	</const>
10034	</enum>
10035
10036	<enum
10037	name="MediumType"
10038	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10039	>
10040	<desc>
10041	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10042	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10043	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10044	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10045	</desc>
10046
10047	<const name="Normal" value="0">
10048	<desc>
10049	Normal medium (attached directly or indirectly, preserved
10050	when taking snapshots).
10051	</desc>
10052	</const>
10053	<const name="Immutable" value="1">
10054	<desc>
10055	Immutable medium (attached indirectly, changes are wiped out
10056	the next time the virtual machine is started).
10057	</desc>
10058	</const>
10059	<const name="Writethrough" value="2">
10060	<desc>
10061	Write through medium (attached directly, ignored when
10062	taking snapshots).
10063	</desc>
10064	</const>
10065	<const name="Shareable" value="3">
10066	<desc>
10067	Allow using this medium concurrently by several machines.
10068	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10069	</desc>
10070	</const>
10071	<const name="Readonly" value="4">
10072	<desc>
10073	A readonly medium, which can of course be used by several machines.
10074	<note>Present and accepted since VirtualBox 4.0.</note>
10075	</desc>
10076	</const>
10077	<const name="MultiAttach" value="5">
10078	<desc>
10079	A medium which is is indirectly attached, so that one base medium can
10080	be used for several VMs which have their own differencing medium to
10081	store their modifications. In some sense a variant of Immutable
10082	with unset AutoReset flag in each differencing medium.
10083	<note>Present and accepted since VirtualBox 4.0.</note>
10084	</desc>
10085	</const>
10086	</enum>
10087
10088	<enum
10089	name="MediumVariant"
10090	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10091	>
10092	<desc>
10093	Virtual medium image variant. More than one flag may be set.
10094	<see><link to="IMedium"/></see>
10095	</desc>
10096
10097	<const name="Standard" value="0">
10098	<desc>
10099	No particular variant requested, results in using the backend default.
10100	</desc>
10101	</const>
10102	<const name="VmdkSplit2G" value="0x01">
10103	<desc>
10104	VMDK image split in chunks of less than 2GByte.
10105	</desc>
10106	</const>
10107	<const name="VmdkStreamOptimized" value="0x04">
10108	<desc>
10109	VMDK streamOptimized image. Special import/export format which is
10110	read-only/append-only.
10111	</desc>
10112	</const>
10113	<const name="VmdkESX" value="0x08">
10114	<desc>
10115	VMDK format variant used on ESX products.
10116	</desc>
10117	</const>
10118	<const name="Fixed" value="0x10000">
10119	<desc>
10120	Fixed image. Only allowed for base images.
10121	</desc>
10122	</const>
10123	<const name="Diff" value="0x20000">
10124	<desc>
10125	Differencing image. Only allowed for child images.
10126	</desc>
10127	</const>
10128	<const name="NoCreateDir" value="0x40000000">
10129	<desc>
10130	Special flag which suppresses automatic creation of the subdirectory.
10131	Only used when passing the medium variant as an input parameter.
10132	</desc>
10133	</const>
10134	</enum>
10135
10136	<interface
10137	name="IMediumAttachment" extends="$unknown"
10138	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10139	wsmap="struct"
10140	>
10141	<desc>
10142	The IMediumAttachment interface links storage media to virtual machines.
10143	For each medium (<link to="IMedium"/>) which has been attached to a
10144	storage controller (<link to="IStorageController"/>) of a machine
10145	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10146	method, one instance of IMediumAttachment is added to the machine's
10147	<link to="IMachine::mediumAttachments"/> array attribute.
10148
10149	Each medium attachment specifies the storage controller as well as a
10150	port and device number and the IMedium instance representing a virtual
10151	hard disk or floppy or DVD image.
10152
10153	For removable media (DVDs or floppies), there are two additional
10154	options. For one, the IMedium instance can be @c null to represent
10155	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10156	secondly, the medium can be one of the pseudo-media for host drives
10157	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10158
10159	<h3>Attaching Hard Disks</h3>
10160
10161	Hard disks are attached to virtual machines using the
10162	<link to="IMachine::attachDevice"/> method and detached using the
10163	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10164	type (see <link to="IMedium::type" />), hard disks are attached either
10165	<i>directly</i> or <i>indirectly</i>.
10166
10167	When a hard disk is being attached directly, it is associated with the
10168	virtual machine and used for hard disk operations when the machine is
10169	running. When a hard disk is being attached indirectly, a new differencing
10170	hard disk linked to it is implicitly created and this differencing hard
10171	disk is associated with the machine and used for hard disk operations.
10172	This also means that if <link to="IMachine::attachDevice"/> performs
10173	a direct attachment then the same hard disk will be returned in response
10174	to the subsequent <link to="IMachine::getMedium"/> call; however if
10175	an indirect attachment is performed then
10176	<link to="IMachine::getMedium"/> will return the implicitly created
10177	differencing hard disk, not the original one passed to <link
10178	to="IMachine::attachDevice"/>. In detail:
10179
10180	<ul>
10181	<li><b>Normal base</b> hard disks that do not have children (i.e.
10182	differencing hard disks linked to them) and that are not already
10183	attached to virtual machines in snapshots are attached <b>directly</b>.
10184	Otherwise, they are attached <b>indirectly</b> because having
10185	dependent children or being part of the snapshot makes it impossible
10186	to modify hard disk contents without breaking the integrity of the
10187	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10188	quickly determine the kind of the attachment for the given hard
10189	disk. Note that if a normal base hard disk is to be indirectly
10190	attached to a virtual machine with snapshots then a special
10191	procedure called <i>smart attachment</i> is performed (see below).</li>
10192	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10193	they are attached <b>directly</b> if they do not have children and are
10194	not attached to virtual machines in snapshots, and <b>indirectly</b>
10195	otherwise. Note that the smart attachment procedure is never performed
10196	for differencing hard disks.</li>
10197	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10198	they are designed to be non-writable. If an immutable hard disk is
10199	attached to a virtual machine with snapshots then a special
10200	procedure called smart attachment is performed (see below).</li>
10201	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10202	also as designed. This also means that writethrough hard disks cannot
10203	have other hard disks linked to them at all.</li>
10204	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10205	also as designed. This also means that shareable hard disks cannot
10206	have other hard disks linked to them at all. They behave almost
10207	like writethrough hard disks, except that shareable hard disks can
10208	be attached to several virtual machines which are running, allowing
10209	concurrent accesses. You need special cluster software running in
10210	the virtual machines to make use of such disks.</li>
10211	</ul>
10212
10213	Note that the same hard disk, regardless of its type, may be attached to
10214	more than one virtual machine at a time. In this case, the machine that is
10215	started first gains exclusive access to the hard disk and attempts to
10216	start other machines having this hard disk attached will fail until the
10217	first machine is powered down.
10218
10219	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10220	that the given hard disk remains associated with the given machine after a
10221	successful <link to="IMachine::detachDevice"/> call until
10222	<link to="IMachine::saveSettings"/> is called to save all changes to
10223	machine settings to disk. This deferring is necessary to guarantee that
10224	the hard disk configuration may be restored at any time by a call to
10225	<link to="IMachine::discardSettings"/> before the settings
10226	are saved (committed).
10227
10228	Note that if <link to="IMachine::discardSettings"/> is called after
10229	indirectly attaching some hard disks to the machine but before a call to
10230	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10231	all differencing hard disks implicitly created by
10232	<link to="IMachine::attachDevice"/> for these indirect attachments.
10233	Such implicitly created hard disks will also be immediately deleted when
10234	detached explicitly using the <link to="IMachine::detachDevice"/>
10235	call if it is made before <link to="IMachine::saveSettings"/>. This
10236	implicit deletion is safe because newly created differencing hard
10237	disks do not contain any user data.
10238
10239	However, keep in mind that detaching differencing hard disks that were
10240	implicitly created by <link to="IMachine::attachDevice"/>
10241	before the last <link to="IMachine::saveSettings"/> call will
10242	<b>not</b> implicitly delete them as they may already contain some data
10243	(for example, as a result of virtual machine execution). If these hard
10244	disks are no more necessary, the caller can always delete them explicitly
10245	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10246	from this machine by the <link to="IMachine::saveSettings"/> call.
10247
10248	<h3>Smart Attachment</h3>
10249
10250	When normal base or immutable hard disks are indirectly attached to a
10251	virtual machine then some additional steps are performed to make sure the
10252	virtual machine will have the most recent "view" of the hard disk being
10253	attached. These steps include walking through the machine's snapshots
10254	starting from the current one and going through ancestors up to the first
10255	snapshot. Hard disks attached to the virtual machine in all
10256	of the encountered snapshots are checked whether they are descendants of
10257	the given normal base or immutable hard disk. The first found child (which
10258	is the differencing hard disk) will be used instead of the normal base or
10259	immutable hard disk as a parent for creating a new differencing hard disk
10260	that will be actually attached to the machine. And only if no descendants
10261	are found or if the virtual machine does not have any snapshots then the
10262	normal base or immutable hard disk will be used itself as a parent for
10263	this differencing hard disk.
10264
10265	It is easier to explain what smart attachment does using the
10266	following example:
10267	<pre>
10268	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10269
10270	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10271	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10272	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10273	Snapshot 4 (none) Snapshot 4 (none)
10274	CurState (none) CurState (D3->D2.vdi)
10275
10276	NOT
10277	...
10278	CurState (D3->B.vdi)
10279	</pre>
10280	The first column is the virtual machine configuration before the base hard
10281	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10282	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10283	mean that the hard disk that is actually attached to the machine is a
10284	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10285	another hard disk, <tt>B.vdi</tt>.
10286
10287	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10288	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10289	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10290	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10291	it cannot be attached directly and needs an indirect attachment (i.e.
10292	implicit creation of a new differencing hard disk). Due to the smart
10293	attachment procedure, the new differencing hard disk
10294	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10295	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10296	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10297	machine.
10298
10299	Note that if there is more than one descendant hard disk of the given base
10300	hard disk found in a snapshot, and there is an exact device, channel and
10301	bus match, then this exact match will be used. Otherwise, the youngest
10302	descendant will be picked up.
10303
10304	There is one more important aspect of the smart attachment procedure which
10305	is not related to snapshots at all. Before walking through the snapshots
10306	as described above, the backup copy of the current list of hard disk
10307	attachment is searched for descendants. This backup copy is created when
10308	the hard disk configuration is changed for the first time after the last
10309	<link to="IMachine::saveSettings"/> call and used by
10310	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10311	changes. When such a descendant is found in this backup copy, it will be
10312	simply re-attached back, without creating a new differencing hard disk for
10313	it. This optimization is necessary to make it possible to re-attach the
10314	base or immutable hard disk to a different bus, channel or device slot
10315	without losing the contents of the differencing hard disk actually
10316	attached to the machine in place of it.
10317
10318	</desc>
10319
10320	<attribute name="medium" type="IMedium" readonly="yes">
10321	<desc>Medium object associated with this attachment; it
10322	can be @c null for removable devices.</desc>
10323	</attribute>
10324
10325	<attribute name="controller" type="wstring" readonly="yes">
10326	<desc>Name of the storage controller of this attachment; this
10327	refers to one of the controllers in <link to="IMachine::storageControllers" />
10328	by name.</desc>
10329	</attribute>
10330
10331	<attribute name="port" type="long" readonly="yes">
10332	<desc>Port number of this attachment.
10333	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10334	</desc>
10335	</attribute>
10336
10337	<attribute name="device" type="long" readonly="yes">
10338	<desc>Device slot number of this attachment.
10339	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10340	</desc>
10341	</attribute>
10342
10343	<attribute name="type" type="DeviceType" readonly="yes">
10344	<desc>Device type of this attachment.</desc>
10345	</attribute>
10346
10347	<attribute name="passthrough" type="boolean" readonly="yes">
10348	<desc>Pass I/O requests through to a device on the host.</desc>
10349	</attribute>
10350
10351	<attribute name="temporaryEject" type="boolean" readonly="yes">
10352	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10353	</attribute>
10354
10355	<attribute name="isEjected" type="boolean" readonly="yes">
10356	<desc>Signals that the removable medium has been ejected. This is not
10357	necessarily equivalent to having a @c null medium association.</desc>
10358	</attribute>
10359
10360	<attribute name="nonRotational" type="boolean" readonly="yes">
10361	<desc>Whether the associated medium is non-rotational.</desc>
10362	</attribute>
10363
10364	<attribute name="discard" type="boolean" readonly="yes">
10365	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10366	</attribute>
10367
10368	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10369	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10370	</attribute>
10371
10372	</interface>
10373
10374	<interface
10375	name="IMedium" extends="$unknown"
10376	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10377	wsmap="managed"
10378	>
10379	<desc>
10380	The IMedium interface represents virtual storage for a machine's
10381	hard disks, CD/DVD or floppy drives. It will typically represent
10382	a disk image on the host, for example a VDI or VMDK file representing
10383	a virtual hard disk, or an ISO or RAW file representing virtual
10384	removable media, but can also point to a network location (e.g.
10385	for iSCSI targets).
10386
10387	Instances of IMedium are connected to virtual machines by way of medium
10388	attachments, which link the storage medium to a particular device slot
10389	of a storage controller of the virtual machine.
10390	In the VirtualBox API, virtual storage is therefore always represented
10391	by the following chain of object links:
10392
10393	<ul>
10394	<li><link to="IMachine::storageControllers"/> contains an array of
10395	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10396	these are instances of <link to="IStorageController"/>).</li>
10397	<li><link to="IMachine::mediumAttachments"/> contains an array of
10398	medium attachments (instances of <link to="IMediumAttachment"/>
10399	created by <link to="IMachine::attachDevice" />),
10400	each containing a storage controller from the above array, a
10401	port/device specification, and an instance of IMedium representing
10402	the medium storage (image file).
10403
10404	For removable media, the storage medium is optional; a medium
10405	attachment with no medium represents a CD/DVD or floppy drive
10406	with no medium inserted. By contrast, hard disk attachments
10407	will always have an IMedium object attached.</li>
10408	<li>Each IMedium in turn points to a storage unit (such as a file
10409	on the host computer or a network resource) that holds actual
10410	data. This location is represented by the <link to="#location"/>
10411	attribute.</li>
10412	</ul>
10413
10414	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10415	new hard disk media can be created with the VirtualBox API using the
10416	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10417	disks (see below) are usually implicitly created by VirtualBox as
10418	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10419	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10420	should be created with external tools and then opened from within VirtualBox.
10421
10422	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10423	drive. In that case the <link to="#id" /> attribute contains the UUID of
10424	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10425
10426	<h3>Media registries</h3>
10427
10428	When a medium has been opened or created using one of the aforementioned
10429	APIs, it becomes "known" to VirtualBox. Known media can be attached
10430	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10431	They also appear in the global
10432	<link to="IVirtualBox::hardDisks" />,
10433	<link to="IVirtualBox::DVDImages" /> and
10434	<link to="IVirtualBox::floppyImages" /> arrays.
10435
10436	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10437	in the VirtualBox.xml file, which was shared between all machines and made
10438	transporting machines and their media from one host to another difficult.
10439
10440	Starting with VirtualBox 4.0, media are only added to a registry when they are
10441	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10442	backwards compatibility, which registry a medium is added to depends on which
10443	VirtualBox version created a machine:
10444
10445	<ul>
10446	<li>If the medium has first been attached to a machine which was created by
10447	VirtualBox 4.0 or later, it is added to that machine's media registry in
10448	the machine XML settings file. This way all information about a machine's
10449	media attachments is contained in a single file and can be transported
10450	easily.</li>
10451	<li>For older media attachments (i.e. if the medium was first attached to a
10452	machine which was created with a VirtualBox version before 4.0), media
10453	continue to be registered in the global VirtualBox settings file, for
10454	backwards compatibility.</li>
10455	</ul>
10456
10457	See <link to="IVirtualBox::openMedium" /> for more information.
10458
10459	Media are removed from media registries by the <link to="IMedium::close"/>,
10460	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10461
10462	<h3>Accessibility checks</h3>
10463
10464	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10465	method is called explicitly on a medium. This is done to make the VirtualBox object
10466	ready for serving requests as fast as possible and let the end-user
10467	application decide if it needs to check media accessibility right away or not.
10468
10469	As a result, when VirtualBox starts up (e.g. the VirtualBox
10470	object gets created for the first time), all known media are in the
10471	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10472	attribute is an empty string because no actual accessibility check has
10473	been made yet.
10474
10475	After calling <link to="#refreshState" />, a medium is considered
10476	<i>accessible</i> if its storage unit can be read. In that case, the
10477	<link to="#state"/> attribute has a value of "Created". If the storage
10478	unit cannot be read (for example, because it is located on a disconnected
10479	network resource, or was accidentally deleted outside VirtualBox),
10480	the medium is considered <i>inaccessible</i>, which is indicated by the
10481	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10482	obtained by reading the <link to="#lastAccessError"/> attribute.
10483
10484	<h3>Medium types</h3>
10485
10486	There are five types of medium behavior which are stored in the
10487	<link to="#type"/> attribute (see <link to="MediumType" />) and
10488	which define the medium's behavior with attachments and snapshots.
10489
10490	All media can be also divided in two groups: <i>base</i> media and
10491	<i>differencing</i> media. A base medium contains all sectors of the
10492	medium data in its own storage and therefore can be used independently.
10493	In contrast, a differencing medium is a "delta" to some other medium and
10494	contains only those sectors which differ from that other medium, which is
10495	then called a <i>parent</i>. The differencing medium is said to be
10496	<i>linked to</i> that parent. The parent may be itself a differencing
10497	medium, thus forming a chain of linked media. The last element in that
10498	chain must always be a base medium. Note that several differencing
10499	media may be linked to the same parent medium.
10500
10501	Differencing media can be distinguished from base media by querying the
10502	<link to="#parent"/> attribute: base media do not have parents they would
10503	depend on, so the value of this attribute is always @c null for them.
10504	Using this attribute, it is possible to walk up the medium tree (from the
10505	child medium to its parent). It is also possible to walk down the tree
10506	using the <link to="#children"/> attribute.
10507
10508	Note that the type of all differencing media is "normal"; all other
10509	values are meaningless for them. Base media may be of any type.
10510
10511	<h3>Automatic composition of the file name part</h3>
10512
10513	Another extension to the <link to="IMedium::location"/> attribute is that
10514	there is a possibility to cause VirtualBox to compose a unique value for
10515	the file name part of the location using the UUID of the hard disk. This
10516	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10517	e.g. before the storage unit is created, and works as follows. You set the
10518	value of the <link to="IMedium::location"/> attribute to a location
10519	specification which only contains the path specification but not the file
10520	name part and ends with either a forward slash or a backslash character.
10521	In response, VirtualBox will generate a new UUID for the hard disk and
10522	compose the file name using the following pattern:
10523	<pre>
10524	<path>/{<uuid>}.<ext>
10525	</pre>
10526	where <tt><path></tt> is the supplied path specification,
10527	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10528	is the default extension for the storage format of this hard disk. After
10529	that, you may call any of the methods that create a new hard disk storage
10530	unit and they will use the generated UUID and file name.
10531	</desc>
10532
10533	<attribute name="id" type="uuid" mod="string" readonly="yes">
10534	<desc>
10535	UUID of the medium. For a newly created medium, this value is a randomly
10536	generated UUID.
10537
10538	<note>
10539	For media in one of MediumState_NotCreated, MediumState_Creating or
10540	MediumState_Deleting states, the value of this property is undefined
10541	and will most likely be an empty UUID.
10542	</note>
10543	</desc>
10544	</attribute>
10545
10546	<attribute name="description" type="wstring">
10547	<desc>
10548	Optional description of the medium. For a newly created medium the value
10549	of this attribute is an empty string.
10550
10551	Medium types that don't support this attribute will return E_NOTIMPL in
10552	attempt to get or set this attribute's value.
10553
10554	<note>
10555	For some storage types, reading this attribute may return an outdated
10556	(last known) value when <link to="#state"/> is <link
10557	to="MediumState_Inaccessible"/> or <link
10558	to="MediumState_LockedWrite"/> because the value of this attribute is
10559	stored within the storage unit itself. Also note that changing the
10560	attribute value is not possible in such case, as well as when the
10561	medium is the <link to="MediumState_LockedRead"/> state.
10562	</note>
10563	</desc>
10564	</attribute>
10565
10566	<attribute name="state" type="MediumState" readonly="yes">
10567	<desc>
10568	Returns the current medium state, which is the last state set by
10569	the accessibility check performed by <link to="#refreshState"/>.
10570	If that method has not yet been called on the medium, the state
10571	is "Inaccessible"; as opposed to truly inaccessible media, the
10572	value of <link to="#lastAccessError"/> will be an empty string in
10573	that case.
10574
10575	<note>As of version 3.1, this no longer performs an accessibility check
10576	automatically; call <link to="#refreshState"/> for that.
10577	</note>
10578	</desc>
10579	</attribute>
10580
10581	<attribute name="variant" type="unsigned long" readonly="yes">
10582	<desc>
10583	Returns the storage format variant information for this medium
10584	as a combination of the flags described at <link to="MediumVariant" />.
10585	Before <link to="#refreshState"/> is called this method returns
10586	an undefined value.
10587	</desc>
10588	</attribute>
10589
10590	<attribute name="location" type="wstring">
10591	<desc>
10592	Location of the storage unit holding medium data.
10593
10594	The format of the location string is medium type specific. For medium
10595	types using regular files in a host's file system, the location
10596	string is the full file name.
10597
10598	Some medium types may support changing the storage unit location by
10599	simply changing the value of this property. If this operation is not
10600	supported, the implementation will return E_NOTIMPL in attempt to set
10601	this attribute's value.
10602
10603	When setting a value of the location attribute which is a regular file
10604	in the host's file system, the given file name may be either relative to
10605	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10606	absolute. Note that if the given location specification does not contain
10607	the file extension part then a proper default extension will be
10608	automatically appended by the implementation depending on the medium type.
10609	</desc>
10610	</attribute>
10611
10612	<attribute name="name" type="wstring" readonly="yes">
10613	<desc>
10614	Name of the storage unit holding medium data.
10615
10616	The returned string is a short version of the <link to="#location"/>
10617	attribute that is suitable for representing the medium in situations
10618	where the full location specification is too long (such as lists
10619	and comboboxes in GUI frontends). This string is also used by frontends
10620	to sort the media list alphabetically when needed.
10621
10622	For example, for locations that are regular files in the host's file
10623	system, the value of this attribute is just the file name (+ extension),
10624	without the path specification.
10625
10626	Note that as opposed to the <link to="#location"/> attribute, the name
10627	attribute will not necessary be unique for a list of media of the
10628	given type and format.
10629	</desc>
10630	</attribute>
10631
10632	<attribute name="deviceType" type="DeviceType" readonly="yes">
10633	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10634	medium.</desc>
10635	</attribute>
10636
10637	<attribute name="hostDrive" type="boolean" readonly="yes">
10638	<desc>True if this corresponds to a drive on the host.</desc>
10639	</attribute>
10640
10641	<attribute name="size" type="long long" readonly="yes">
10642	<desc>
10643	Physical size of the storage unit used to hold medium data (in bytes).
10644
10645	<note>
10646	For media whose <link to="#state"/> is <link
10647	to="MediumState_Inaccessible"/>, the value of this property is the
10648	last known size. For <link to="MediumState_NotCreated"/> media,
10649	the returned value is zero.
10650	</note>
10651	</desc>
10652	</attribute>
10653
10654	<attribute name="format" type="wstring" readonly="yes">
10655	<desc>
10656	Storage format of this medium.
10657
10658	The value of this attribute is a string that specifies a backend used
10659	to store medium data. The storage format is defined when you create a
10660	new medium or automatically detected when you open an existing medium,
10661	and cannot be changed later.
10662
10663	The list of all storage formats supported by this VirtualBox
10664	installation can be obtained using
10665	<link to="ISystemProperties::mediumFormats"/>.
10666	</desc>
10667	</attribute>
10668
10669	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10670	<desc>
10671	Storage medium format object corresponding to this medium.
10672
10673	The value of this attribute is a reference to the medium format object
10674	that specifies the backend properties used to store medium data. The
10675	storage format is defined when you create a new medium or automatically
10676	detected when you open an existing medium, and cannot be changed later.
10677
10678	<note>@c null is returned if there is no associated medium format
10679	object. This can e.g. happen for medium objects representing host
10680	drives and other special medium objects.</note>
10681	</desc>
10682	</attribute>
10683
10684	<attribute name="type" type="MediumType">
10685	<desc>
10686	Type (role) of this medium.
10687
10688	The following constraints apply when changing the value of this
10689	attribute:
10690	<ul>
10691	<li>If a medium is attached to a virtual machine (either in the
10692	current state or in one of the snapshots), its type cannot be
10693	changed.
10694	</li>
10695	<li>As long as the medium has children, its type cannot be set
10696	to <link to="MediumType_Writethrough"/>.
10697	</li>
10698	<li>The type of all differencing media is
10699	<link to="MediumType_Normal"/> and cannot be changed.
10700	</li>
10701	</ul>
10702
10703	The type of a newly created or opened medium is set to
10704	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10705	which have a type of <link to="MediumType_Writethrough"/>.
10706	</desc>
10707	</attribute>
10708
10709	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10710	<desc>
10711	Returns which medium types can selected for this medium.
10712
10713	<result name="E_NOTIMPL">
10714	This attribute is not implemented at the moment.
10715	</result>
10716	</desc>
10717	</attribute>
10718
10719	<attribute name="parent" type="IMedium" readonly="yes">
10720	<desc>
10721	Parent of this medium (the medium this medium is directly based
10722	on).
10723
10724	Only differencing media have parents. For base (non-differencing)
10725	media, @c null is returned.
10726	</desc>
10727	</attribute>
10728
10729	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10730	<desc>
10731	Children of this medium (all differencing media directly based
10732	on this medium). A @c null array is returned if this medium
10733	does not have any children.
10734	</desc>
10735	</attribute>
10736
10737	<attribute name="base" type="IMedium" readonly="yes">
10738	<desc>
10739	Base medium of this medium.
10740
10741	If this is a differencing medium, its base medium is the medium
10742	the given medium branch starts from. For all other types of media, this
10743	property returns the medium object itself (i.e. the same object this
10744	property is read on).
10745	</desc>
10746	</attribute>
10747
10748	<attribute name="readOnly" type="boolean" readonly="yes">
10749	<desc>
10750	Returns @c true if this medium is read-only and @c false otherwise.
10751
10752	A medium is considered to be read-only when its contents cannot be
10753	modified without breaking the integrity of other parties that depend on
10754	this medium such as its child media or snapshots of virtual machines
10755	where this medium is attached to these machines. If there are no
10756	children and no such snapshots then there is no dependency and the
10757	medium is not read-only.
10758
10759	The value of this attribute can be used to determine the kind of the
10760	attachment that will take place when attaching this medium to a
10761	virtual machine. If the value is @c false then the medium will
10762	be attached directly. If the value is @c true then the medium
10763	will be attached indirectly by creating a new differencing child
10764	medium for that. See the interface description for more information.
10765
10766	Note that all <link to="MediumType_Immutable">Immutable</link> media
10767	are always read-only while all
10768	<link to="MediumType_Writethrough">Writethrough</link> media are
10769	always not.
10770
10771	<note>
10772	The read-only condition represented by this attribute is related to
10773	the medium type and usage, not to the current
10774	<link to="IMedium::state">medium state</link> and not to the read-only
10775	state of the storage unit.
10776	</note>
10777	</desc>
10778	</attribute>
10779
10780	<attribute name="logicalSize" type="long long" readonly="yes">
10781	<desc>
10782	Logical size of this medium (in bytes), as reported to the
10783	guest OS running inside the virtual machine this medium is
10784	attached to. The logical size is defined when the medium is created
10785	and cannot be changed later.
10786
10787	<note>
10788	Reading this property on a differencing medium will return the size
10789	of its <link to="#base"/> medium.
10790	</note>
10791	<note>
10792	For media whose state is <link to="#state"/> is <link
10793	to="MediumState_Inaccessible"/>, the value of this property is the
10794	last known logical size. For <link to="MediumState_NotCreated"/>
10795	media, the returned value is zero.
10796	</note>
10797	</desc>
10798	</attribute>
10799
10800	<attribute name="autoReset" type="boolean">
10801	<desc>
10802	Whether this differencing medium will be automatically reset each
10803	time a virtual machine it is attached to is powered up. This
10804	attribute is automatically set to @c true for the last
10805	differencing image of an "immutable" medium (see
10806	<link to="MediumType" />).
10807
10808	See <link to="#reset"/> for more information about resetting
10809	differencing media.
10810
10811	<note>
10812	Reading this property on a base (non-differencing) medium will
10813	always @c false. Changing the value of this property in this
10814	case is not supported.
10815	</note>
10816
10817	<result name="VBOX_E_NOT_SUPPORTED">
10818	This is not a differencing medium (when changing the attribute
10819	value).
10820	</result>
10821	</desc>
10822	</attribute>
10823
10824	<attribute name="lastAccessError" type="wstring" readonly="yes">
10825	<desc>
10826	Text message that represents the result of the last accessibility
10827	check performed by <link to="#refreshState"/>.
10828
10829	An empty string is returned if the last accessibility check
10830	was successful or has not yet been called. As a result, if
10831	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10832	then <link to="#refreshState"/> has yet to be called; this is the
10833	default value of media after VirtualBox initialization.
10834	A non-empty string indicates a failure and should normally describe
10835	a reason of the failure (for example, a file read error).
10836	</desc>
10837	</attribute>
10838
10839	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10840	<desc>
10841	Array of UUIDs of all machines this medium is attached to.
10842
10843	A @c null array is returned if this medium is not attached to any
10844	machine or to any machine's snapshot.
10845
10846	<note>
10847	The returned array will include a machine even if this medium is not
10848	attached to that machine in the current state but attached to it in
10849	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10850	details.
10851	</note>
10852	</desc>
10853	</attribute>
10854
10855	<method name="setIDs">
10856	<desc>
10857	Changes the UUID and parent UUID for a hard disk medium.
10858	</desc>
10859	<param name="setImageId" type="boolean" dir="in">
10860	<desc>
10861	Select whether a new image UUID is set or not.
10862	</desc>
10863	</param>
10864	<param name="imageId" type="uuid" mod="string" dir="in">
10865	<desc>
10866	New UUID for the image. If an empty string is passed, then a new
10867	UUID is automatically created, provided that @a setImageId is @c true.
10868	Specifying a zero UUID is not allowed.
10869	</desc>
10870	</param>
10871	<param name="setParentId" type="boolean" dir="in">
10872	<desc>
10873	Select whether a new parent UUID is set or not.
10874	</desc>
10875	</param>
10876	<param name="parentId" type="uuid" mod="string" dir="in">
10877	<desc>
10878	New parent UUID for the image. If an empty string is passed, then a
10879	new UUID is automatically created, provided @a setParentId is
10880	@c true. A zero UUID is valid.
10881	</desc>
10882	</param>
10883	<result name="E_INVALIDARG">
10884	Invalid parameter combination.
10885	</result>
10886	<result name="VBOX_E_NOT_SUPPORTED">
10887	Medium is not a hard disk medium.
10888	</result>
10889	</method>
10890
10891	<method name="refreshState">
10892	<desc>
10893	If the current medium state (see <link to="MediumState"/>) is one of
10894	"Created", "Inaccessible" or "LockedRead", then this performs an
10895	accessibility check on the medium and sets the value of the <link to="#state"/>
10896	attribute accordingly; that value is also returned for convenience.
10897
10898	For all other state values, this does not perform a refresh but returns
10899	the state only.
10900
10901	The refresh, if performed, may take a long time (several seconds or even
10902	minutes, depending on the storage unit location and format) because it performs an
10903	accessibility check of the storage unit. This check may cause a significant
10904	delay if the storage unit of the given medium is, for example, a file located
10905	on a network share which is not currently accessible due to connectivity
10906	problems. In that case, the call will not return until a timeout
10907	interval defined by the host OS for this operation expires. For this reason,
10908	it is recommended to never read this attribute on the main UI thread to avoid
10909	making the UI unresponsive.
10910
10911	If the last known state of the medium is "Created" and the accessibility
10912	check fails, then the state would be set to "Inaccessible", and
10913	<link to="#lastAccessError"/> may be used to get more details about the
10914	failure. If the state of the medium is "LockedRead", then it remains the
10915	same, and a non-empty value of <link to="#lastAccessError"/> will
10916	indicate a failed accessibility check in this case.
10917
10918	Note that not all medium states are applicable to all medium types.
10919	</desc>
10920	<param name="state" type="MediumState" dir="return">
10921	<desc>
10922	New medium state.
10923	</desc>
10924	</param>
10925	</method>
10926
10927	<method name="getSnapshotIds">
10928	<desc>
10929	Returns an array of UUIDs of all snapshots of the given machine where
10930	this medium is attached to.
10931
10932	If the medium is attached to the machine in the current state, then the
10933	first element in the array will always be the ID of the queried machine
10934	(i.e. the value equal to the @c machineId argument), followed by
10935	snapshot IDs (if any).
10936
10937	If the medium is not attached to the machine in the current state, then
10938	the array will contain only snapshot IDs.
10939
10940	The returned array may be @c null if this medium is not attached
10941	to the given machine at all, neither in the current state nor in one of
10942	the snapshots.
10943	</desc>
10944	<param name="machineId" type="uuid" mod="string" dir="in">
10945	<desc>
10946	UUID of the machine to query.
10947	</desc>
10948	</param>
10949	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10950	<desc>
10951	Array of snapshot UUIDs of the given machine using this medium.
10952	</desc>
10953	</param>
10954	</method>
10955
10956	<method name="lockRead">
10957	<desc>
10958	Locks this medium for reading.
10959
10960	A read lock is shared: many clients can simultaneously lock the
10961	same medium for reading unless it is already locked for writing (see
10962	<link to="#lockWrite"/>) in which case an error is returned.
10963
10964	When the medium is locked for reading, it cannot be modified
10965	from within VirtualBox. This means that any method that changes
10966	the properties of this medium or contents of the storage unit
10967	will return an error (unless explicitly stated otherwise). That
10968	includes an attempt to start a virtual machine that wants to
10969	write to the the medium.
10970
10971	When the virtual machine is started up, it locks for reading all
10972	media it uses in read-only mode. If some medium cannot be locked
10973	for reading, the startup procedure will fail.
10974	A medium is typically locked for reading while it is used by a running
10975	virtual machine but has a depending differencing image that receives
10976	the actual write operations. This way one base medium can have
10977	multiple child differencing images which can be written to
10978	simultaneously. Read-only media such as DVD and floppy images are
10979	also locked for reading only (so they can be in use by multiple
10980	machines simultaneously).
10981
10982	A medium is also locked for reading when it is the source of a
10983	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10984
10985	The medium locked for reading must be unlocked using the <link
10986	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10987	can be nested and must be followed by the same number of paired
10988	<link to="#unlockRead"/> calls.
10989
10990	This method sets the medium state (see <link to="#state"/>) to
10991	"LockedRead" on success. The medium's previous state must be
10992	one of "Created", "Inaccessible" or "LockedRead".
10993
10994	Locking an inaccessible medium is not an error; this method performs
10995	a logical lock that prevents modifications of this medium through
10996	the VirtualBox API, not a physical file-system lock of the underlying
10997	storage unit.
10998
10999	This method returns the current state of the medium
11000	<i>before</i> the operation.
11001
11002	<result name="VBOX_E_INVALID_OBJECT_STATE">
11003	Invalid medium state (e.g. not created, locked, inaccessible,
11004	creating, deleting).
11005	</result>
11006
11007	</desc>
11008	<param name="state" type="MediumState" dir="return">
11009	<desc>
11010	State of the medium after the operation.
11011	</desc>
11012	</param>
11013	</method>
11014
11015	<method name="unlockRead">
11016	<desc>
11017	Cancels the read lock previously set by <link to="#lockRead"/>.
11018
11019	For both success and failure, this method returns the current state
11020	of the medium <i>after</i> the operation.
11021
11022	See <link to="#lockRead"/> for more details.
11023
11024	<result name="VBOX_E_INVALID_OBJECT_STATE">
11025	Medium not locked for reading.
11026	</result>
11027
11028	</desc>
11029	<param name="state" type="MediumState" dir="return">
11030	<desc>
11031	State of the medium after the operation.
11032	</desc>
11033	</param>
11034	</method>
11035
11036	<method name="lockWrite">
11037	<desc>
11038	Locks this medium for writing.
11039
11040	A write lock, as opposed to <link to="#lockRead"/>, is
11041	exclusive: there may be only one client holding a write lock,
11042	and there may be no read locks while the write lock is held.
11043	As a result, read-locking fails if a write lock is held, and
11044	write-locking fails if either a read or another write lock is held.
11045
11046	When a medium is locked for writing, it cannot be modified
11047	from within VirtualBox, and it is not guaranteed that the values
11048	of its properties are up-to-date. Any method that changes the
11049	properties of this medium or contents of the storage unit will
11050	return an error (unless explicitly stated otherwise).
11051
11052	When a virtual machine is started up, it locks for writing all
11053	media it uses to write data to. If any medium could not be locked
11054	for writing, the startup procedure will fail. If a medium has
11055	differencing images, then while the machine is running, only
11056	the last ("leaf") differencing image is locked for writing,
11057	whereas its parents are locked for reading only.
11058
11059	A medium is also locked for writing when it is the target of a
11060	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11061
11062	The medium locked for writing must be unlocked using the <link
11063	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11064
11065	This method sets the medium state (see <link to="#state"/>) to
11066	"LockedWrite" on success. The medium's previous state must be
11067	either "Created" or "Inaccessible".
11068
11069	Locking an inaccessible medium is not an error; this method performs
11070	a logical lock that prevents modifications of this medium through
11071	the VirtualBox API, not a physical file-system lock of the underlying
11072	storage unit.
11073
11074	For both, success and failure, this method returns the current
11075	state of the medium <i>before</i> the operation.
11076
11077	<result name="VBOX_E_INVALID_OBJECT_STATE">
11078	Invalid medium state (e.g. not created, locked, inaccessible,
11079	creating, deleting).
11080	</result>
11081
11082	</desc>
11083	<param name="state" type="MediumState" dir="return">
11084	<desc>
11085	State of the medium after the operation.
11086	</desc>
11087	</param>
11088	</method>
11089
11090	<method name="unlockWrite">
11091	<desc>
11092	Cancels the write lock previously set by <link to="#lockWrite"/>.
11093
11094	For both success and failure, this method returns the current
11095	state of the medium <i>after</i> the operation.
11096
11097	See <link to="#lockWrite"/> for more details.
11098
11099	<result name="VBOX_E_INVALID_OBJECT_STATE">
11100	Medium not locked for writing.
11101	</result>
11102
11103	</desc>
11104	<param name="state" type="MediumState" dir="return">
11105	<desc>
11106	State of the medium after the operation.
11107	</desc>
11108	</param>
11109	</method>
11110
11111	<method name="close">
11112	<desc>
11113	Closes this medium.
11114
11115	The medium must not be attached to any known virtual machine
11116	and must not have any known child media, otherwise the
11117	operation will fail.
11118
11119	When the medium is successfully closed, it is removed from
11120	the list of registered media, but its storage unit is not
11121	deleted. In particular, this means that this medium can
11122	later be opened again using the <link to="IVirtualBox::openMedium"/>
11123	call.
11124
11125	Note that after this method successfully returns, the given medium
11126	object becomes uninitialized. This means that any attempt
11127	to call any of its methods or attributes will fail with the
11128	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11129
11130	<result name="VBOX_E_INVALID_OBJECT_STATE">
11131	Invalid medium state (other than not created, created or
11132	inaccessible).
11133	</result>
11134	<result name="VBOX_E_OBJECT_IN_USE">
11135	Medium attached to virtual machine.
11136	</result>
11137	<result name="VBOX_E_FILE_ERROR">
11138	Settings file not accessible.
11139	</result>
11140	<result name="VBOX_E_XML_ERROR">
11141	Could not parse the settings file.
11142	</result>
11143
11144	</desc>
11145	</method>
11146
11147	<!-- property methods -->
11148
11149	<method name="getProperty" const="yes">
11150	<desc>
11151	Returns the value of the custom medium property with the given name.
11152
11153	The list of all properties supported by the given medium format can
11154	be obtained with <link to="IMediumFormat::describeProperties"/>.
11155
11156	<note>If this method returns an empty string in @a value, the requested
11157	property is supported but currently not assigned any value.</note>
11158
11159	<result name="VBOX_E_OBJECT_NOT_FOUND">
11160	Requested property does not exist (not supported by the format).
11161	</result>
11162	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11163	</desc>
11164	<param name="name" type="wstring" dir="in">
11165	<desc>Name of the property to get.</desc>
11166	</param>
11167	<param name="value" type="wstring" dir="return">
11168	<desc>Current property value.</desc>
11169	</param>
11170	</method>
11171
11172	<method name="setProperty">
11173	<desc>
11174	Sets the value of the custom medium property with the given name.
11175
11176	The list of all properties supported by the given medium format can
11177	be obtained with <link to="IMediumFormat::describeProperties"/>.
11178
11179	<note>Setting the property value to @c null or an empty string is
11180	equivalent to deleting the existing value. A default value (if it is
11181	defined for this property) will be used by the format backend in this
11182	case.</note>
11183
11184	<result name="VBOX_E_OBJECT_NOT_FOUND">
11185	Requested property does not exist (not supported by the format).
11186	</result>
11187	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11188	</desc>
11189	<param name="name" type="wstring" dir="in">
11190	<desc>Name of the property to set.</desc>
11191	</param>
11192	<param name="value" type="wstring" dir="in">
11193	<desc>Property value to set.</desc>
11194	</param>
11195	</method>
11196
11197	<method name="getProperties" const="yes">
11198	<desc>
11199	Returns values for a group of properties in one call.
11200
11201	The names of the properties to get are specified using the @a names
11202	argument which is a list of comma-separated property names or
11203	an empty string if all properties are to be returned.
11204	<note>Currently the value of this argument is ignored and the method
11205	always returns all existing properties.</note>
11206
11207	The list of all properties supported by the given medium format can
11208	be obtained with <link to="IMediumFormat::describeProperties"/>.
11209
11210	The method returns two arrays, the array of property names corresponding
11211	to the @a names argument and the current values of these properties.
11212	Both arrays have the same number of elements with each element at the
11213	given index in the first array corresponds to an element at the same
11214	index in the second array.
11215
11216	For properties that do not have assigned values, an empty string is
11217	returned at the appropriate index in the @a returnValues array.
11218
11219	</desc>
11220	<param name="names" type="wstring" dir="in">
11221	<desc>
11222	Names of properties to get.
11223	</desc>
11224	</param>
11225	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11226	<desc>Names of returned properties.</desc>
11227	</param>
11228	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11229	<desc>Values of returned properties.</desc>
11230	</param>
11231	</method>
11232
11233	<method name="setProperties">
11234	<desc>
11235	Sets values for a group of properties in one call.
11236
11237	The names of the properties to set are passed in the @a names
11238	array along with the new values for them in the @a values array. Both
11239	arrays have the same number of elements with each element at the given
11240	index in the first array corresponding to an element at the same index
11241	in the second array.
11242
11243	If there is at least one property name in @a names that is not valid,
11244	the method will fail before changing the values of any other properties
11245	from the @a names array.
11246
11247	Using this method over <link to="#setProperty"/> is preferred if you
11248	need to set several properties at once since it is more efficient.
11249
11250	The list of all properties supported by the given medium format can
11251	be obtained with <link to="IMediumFormat::describeProperties"/>.
11252
11253	Setting the property value to @c null or an empty string is equivalent
11254	to deleting the existing value. A default value (if it is defined for
11255	this property) will be used by the format backend in this case.
11256	</desc>
11257	<param name="names" type="wstring" safearray="yes" dir="in">
11258	<desc>Names of properties to set.</desc>
11259	</param>
11260	<param name="values" type="wstring" safearray="yes" dir="in">
11261	<desc>Values of properties to set.</desc>
11262	</param>
11263	</method>
11264
11265	<!-- storage methods -->
11266
11267	<method name="createBaseStorage">
11268	<desc>
11269	Starts creating a hard disk storage unit (fixed/dynamic, according
11270	to the variant flags) in in the background. The previous storage unit
11271	created for this object, if any, must first be deleted using
11272	<link to="#deleteStorage"/>, otherwise the operation will fail.
11273
11274	Before the operation starts, the medium is placed in
11275	<link to="MediumState_Creating"/> state. If the create operation
11276	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11277	state.
11278
11279	After the returned progress object reports that the operation has
11280	successfully completed, the medium state will be set to <link
11281	to="MediumState_Created"/>, the medium will be remembered by this
11282	VirtualBox installation and may be attached to virtual machines.
11283
11284	<result name="VBOX_E_NOT_SUPPORTED">
11285	The variant of storage creation operation is not supported. See <link
11286	to="IMediumFormat::capabilities"/>.
11287	</result>
11288	</desc>
11289	<param name="logicalSize" type="long long" dir="in">
11290	<desc>Maximum logical size of the medium in bytes.</desc>
11291	</param>
11292	<param name="variant" type="unsigned long" dir="in">
11293	<desc>Exact image variant which should be created (as a combination of
11294	<link to="MediumVariant" /> flags).</desc>
11295	</param>
11296	<param name="progress" type="IProgress" dir="return">
11297	<desc>Progress object to track the operation completion.</desc>
11298	</param>
11299	</method>
11300
11301	<method name="deleteStorage">
11302	<desc>
11303	Starts deleting the storage unit of this medium.
11304
11305	The medium must not be attached to any known virtual machine and must
11306	not have any known child media, otherwise the operation will fail.
11307	It will also fail if there is no storage unit to delete or if deletion
11308	is already in progress, or if the medium is being in use (locked for
11309	read or for write) or inaccessible. Therefore, the only valid state for
11310	this operation to succeed is <link to="MediumState_Created"/>.
11311
11312	Before the operation starts, the medium is placed in
11313	<link to="MediumState_Deleting"/> state and gets removed from the list
11314	of remembered hard disks (media registry). If the delete operation
11315	fails, the medium will be remembered again and placed back to
11316	<link to="MediumState_Created"/> state.
11317
11318	After the returned progress object reports that the operation is
11319	complete, the medium state will be set to
11320	<link to="MediumState_NotCreated"/> and you will be able to use one of
11321	the storage creation methods to create it again.
11322
11323	<see><link to="#close"/></see>
11324
11325	<result name="VBOX_E_OBJECT_IN_USE">
11326	Medium is attached to a virtual machine.
11327	</result>
11328	<result name="VBOX_E_NOT_SUPPORTED">
11329	Storage deletion is not allowed because neither of storage creation
11330	operations are supported. See
11331	<link to="IMediumFormat::capabilities"/>.
11332	</result>
11333
11334	<note>
11335	If the deletion operation fails, it is not guaranteed that the storage
11336	unit still exists. You may check the <link to="IMedium::state"/> value
11337	to answer this question.
11338	</note>
11339	</desc>
11340	<param name="progress" type="IProgress" dir="return">
11341	<desc>Progress object to track the operation completion.</desc>
11342	</param>
11343	</method>
11344
11345	<!-- diff methods -->
11346
11347	<method name="createDiffStorage">
11348	<desc>
11349	Starts creating an empty differencing storage unit based on this
11350	medium in the format and at the location defined by the @a target
11351	argument.
11352
11353	The target medium must be in <link to="MediumState_NotCreated"/>
11354	state (i.e. must not have an existing storage unit). Upon successful
11355	completion, this operation will set the type of the target medium to
11356	<link to="MediumType_Normal"/> and create a storage unit necessary to
11357	represent the differencing medium data in the given format (according
11358	to the storage format of the target object).
11359
11360	After the returned progress object reports that the operation is
11361	successfully complete, the target medium gets remembered by this
11362	VirtualBox installation and may be attached to virtual machines.
11363
11364	<note>
11365	The medium will be set to <link to="MediumState_LockedRead"/>
11366	state for the duration of this operation.
11367	</note>
11368	<result name="VBOX_E_OBJECT_IN_USE">
11369	Medium not in @c NotCreated state.
11370	</result>
11371	</desc>
11372	<param name="target" type="IMedium" dir="in">
11373	<desc>Target medium.</desc>
11374	</param>
11375	<param name="variant" type="unsigned long" dir="in">
11376	<desc>Exact image variant which should be created (as a combination of
11377	<link to="MediumVariant" /> flags).</desc>
11378	</param>
11379	<param name="progress" type="IProgress" dir="return">
11380	<desc>Progress object to track the operation completion.</desc>
11381	</param>
11382	</method>
11383
11384	<method name="mergeTo">
11385	<desc>
11386	Starts merging the contents of this medium and all intermediate
11387	differencing media in the chain to the given target medium.
11388
11389	The target medium must be either a descendant of this medium or
11390	its ancestor (otherwise this method will immediately return a failure).
11391	It follows that there are two logical directions of the merge operation:
11392	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11393	ancestor (<i>backward merge</i>). Let us consider the following medium
11394	chain:
11395
11396	<pre>Base <- Diff_1 <- Diff_2</pre>
11397
11398	Here, calling this method on the <tt>Base</tt> medium object with
11399	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11400	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11401	merge. Note that in both cases the contents of the resulting medium
11402	will be the same, the only difference is the medium object that takes
11403	the result of the merge operation. In case of the forward merge in the
11404	above example, the result will be written to <tt>Diff_2</tt>; in case of
11405	the backward merge, the result will be written to <tt>Base</tt>. In
11406	other words, the result of the operation is always stored in the target
11407	medium.
11408
11409	Upon successful operation completion, the storage units of all media in
11410	the chain between this (source) medium and the target medium, including
11411	the source medium itself, will be automatically deleted and the
11412	relevant medium objects (including this medium) will become
11413	uninitialized. This means that any attempt to call any of
11414	their methods or attributes will fail with the
11415	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11416	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11417	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11418	Note that <tt>Diff_2</tt> in this case will become a base medium
11419	itself since it will no longer be based on any other medium.
11420
11421	Considering the above, all of the following conditions must be met in
11422	order for the merge operation to succeed:
11423	<ul>
11424	<li>
11425	Neither this (source) medium nor any intermediate
11426	differencing medium in the chain between it and the target
11427	medium is attached to any virtual machine.
11428	</li>
11429	<li>
11430	Neither the source medium nor the target medium is an
11431	<link to="MediumType_Immutable"/> medium.
11432	</li>
11433	<li>
11434	The part of the medium tree from the source medium to the
11435	target medium is a linear chain, i.e. all medium in this
11436	chain have exactly one child which is the next medium in this
11437	chain. The only exception from this rule is the target medium in
11438	the forward merge operation; it is allowed to have any number of
11439	child media because the merge operation will not change its
11440	logical contents (as it is seen by the guest OS or by children).
11441	</li>
11442	<li>
11443	None of the involved media are in
11444	<link to="MediumState_LockedRead"/> or
11445	<link to="MediumState_LockedWrite"/> state.
11446	</li>
11447	</ul>
11448
11449	<note>
11450	This (source) medium and all intermediates will be placed to <link
11451	to="MediumState_Deleting"/> state and the target medium will be
11452	placed to <link to="MediumState_LockedWrite"/> state and for the
11453	duration of this operation.
11454	</note>
11455	</desc>
11456	<param name="target" type="IMedium" dir="in">
11457	<desc>Target medium.</desc>
11458	</param>
11459	<param name="progress" type="IProgress" dir="return">
11460	<desc>Progress object to track the operation completion.</desc>
11461	</param>
11462	</method>
11463
11464	<!-- clone method -->
11465
11466	<method name="cloneTo">
11467	<desc>
11468	Starts creating a clone of this medium in the format and at the
11469	location defined by the @a target argument.
11470
11471	The target medium must be either in <link to="MediumState_NotCreated"/>
11472	state (i.e. must not have an existing storage unit) or in
11473	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11474	big enough to hold the data or else the copy will be partial). Upon
11475	successful completion, the cloned medium will contain exactly the
11476	same sector data as the medium being cloned, except that in the
11477	first case a new UUID for the clone will be randomly generated, and in
11478	the second case the UUID will remain unchanged.
11479
11480	The @a parent argument defines which medium will be the parent
11481	of the clone. Passing a @c null reference indicates that the clone will
11482	be a base image, i.e. completely independent. It is possible to specify
11483	an arbitrary medium for this parameter, including the parent of the
11484	medium which is being cloned. Even cloning to a child of the source
11485	medium is possible. Note that when cloning to an existing image, the
11486	@a parent argument is ignored.
11487
11488	After the returned progress object reports that the operation is
11489	successfully complete, the target medium gets remembered by this
11490	VirtualBox installation and may be attached to virtual machines.
11491
11492	<note>
11493	This medium will be placed to <link to="MediumState_LockedRead"/>
11494	state for the duration of this operation.
11495	</note>
11496	<result name="E_NOTIMPL">
11497	The specified cloning variant is not supported at the moment.
11498	</result>
11499	</desc>
11500	<param name="target" type="IMedium" dir="in">
11501	<desc>Target medium.</desc>
11502	</param>
11503	<param name="variant" type="unsigned long" dir="in">
11504	<desc>Exact image variant which should be created (as a combination of
11505	<link to="MediumVariant" /> flags).</desc>
11506	</param>
11507	<param name="parent" type="IMedium" dir="in">
11508	<desc>Parent of the cloned medium.</desc>
11509	</param>
11510	<param name="progress" type="IProgress" dir="return">
11511	<desc>Progress object to track the operation completion.</desc>
11512	</param>
11513	</method>
11514
11515	<!-- other methods -->
11516
11517	<method name="compact">
11518	<desc>
11519	Starts compacting of this medium. This means that the medium is
11520	transformed into a possibly more compact storage representation.
11521	This potentially creates temporary images, which can require a
11522	substantial amount of additional disk space.
11523
11524	This medium will be placed to <link to="MediumState_LockedWrite"/>
11525	state and all its parent media (if any) will be placed to
11526	<link to="MediumState_LockedRead"/> state for the duration of this
11527	operation.
11528
11529	Please note that the results can be either returned straight away,
11530	or later as the result of the background operation via the object
11531	returned via the @a progress parameter.
11532
11533	<result name="VBOX_E_NOT_SUPPORTED">
11534	Medium format does not support compacting (but potentially
11535	needs it).
11536	</result>
11537	</desc>
11538	<param name="progress" type="IProgress" dir="return">
11539	<desc>Progress object to track the operation completion.</desc>
11540	</param>
11541	</method>
11542
11543	<method name="resize">
11544	<desc>
11545	Starts resizing this medium. This means that the nominal size of the
11546	medium is set to the new value. Both increasing and decreasing the
11547	size is possible, and there are no safety checks, since VirtualBox
11548	does not make any assumptions about the medium contents.
11549
11550	Resizing usually needs additional disk space, and possibly also
11551	some temporary disk space. Note that resize does not create a full
11552	temporary copy of the medium, so the additional disk space requirement
11553	is usually much lower than using the clone operation.
11554
11555	This medium will be placed to <link to="MediumState_LockedWrite"/>
11556	state for the duration of this operation.
11557
11558	Please note that the results can be either returned straight away,
11559	or later as the result of the background operation via the object
11560	returned via the @a progress parameter.
11561
11562	<result name="VBOX_E_NOT_SUPPORTED">
11563	Medium format does not support resizing.
11564	</result>
11565	</desc>
11566	<param name="logicalSize" type="long long" dir="in">
11567	<desc>New nominal capacity of the medium in bytes.</desc>
11568	</param>
11569	<param name="progress" type="IProgress" dir="return">
11570	<desc>Progress object to track the operation completion.</desc>
11571	</param>
11572	</method>
11573
11574	<method name="reset">
11575	<desc>
11576	Starts erasing the contents of this differencing medium.
11577
11578	This operation will reset the differencing medium to its initial
11579	state when it does not contain any sector data and any read operation is
11580	redirected to its parent medium. This automatically gets called
11581	during VM power-up for every medium whose <link to="#autoReset" />
11582	attribute is @c true.
11583
11584	The medium will be write-locked for the duration of this operation (see
11585	<link to="#lockWrite" />).
11586
11587	<result name="VBOX_E_NOT_SUPPORTED">
11588	This is not a differencing medium.
11589	</result>
11590	<result name="VBOX_E_INVALID_OBJECT_STATE">
11591	Medium is not in <link to="MediumState_Created"/> or
11592	<link to="MediumState_Inaccessible"/> state.
11593	</result>
11594	</desc>
11595	<param name="progress" type="IProgress" dir="return">
11596	<desc>Progress object to track the operation completion.</desc>
11597	</param>
11598	</method>
11599
11600	</interface>
11601
11602
11603	<!--
11604	// IMediumFormat
11605	/////////////////////////////////////////////////////////////////////////
11606	-->
11607
11608	<enum
11609	name="DataType"
11610	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11611	>
11612	<const name="Int32" value="0"/>
11613	<const name="Int8" value="1"/>
11614	<const name="String" value="2"/>
11615	</enum>
11616
11617	<enum
11618	name="DataFlags"
11619	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11620	>
11621	<const name="None" value="0x00"/>
11622	<const name="Mandatory" value="0x01"/>
11623	<const name="Expert" value="0x02"/>
11624	<const name="Array" value="0x04"/>
11625	<const name="FlagMask" value="0x07"/>
11626	</enum>
11627
11628	<enum
11629	name="MediumFormatCapabilities"
11630	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11631	>
11632	<desc>
11633	Medium format capability flags.
11634	</desc>
11635
11636	<const name="Uuid" value="0x01">
11637	<desc>
11638	Supports UUIDs as expected by VirtualBox code.
11639	</desc>
11640	</const>
11641
11642	<const name="CreateFixed" value="0x02">
11643	<desc>
11644	Supports creating fixed size images, allocating all space instantly.
11645	</desc>
11646	</const>
11647
11648	<const name="CreateDynamic" value="0x04">
11649	<desc>
11650	Supports creating dynamically growing images, allocating space on
11651	demand.
11652	</desc>
11653	</const>
11654
11655	<const name="CreateSplit2G" value="0x08">
11656	<desc>
11657	Supports creating images split in chunks of a bit less than 2 GBytes.
11658	</desc>
11659	</const>
11660
11661	<const name="Differencing" value="0x10">
11662	<desc>
11663	Supports being used as a format for differencing media (see <link
11664	to="IMedium::createDiffStorage"/>).
11665	</desc>
11666	</const>
11667
11668	<const name="Asynchronous" value="0x20">
11669	<desc>
11670	Supports asynchronous I/O operations for at least some configurations.
11671	</desc>
11672	</const>
11673
11674	<const name="File" value="0x40">
11675	<desc>
11676	The format backend operates on files (the <link to="IMedium::location"/>
11677	attribute of the medium specifies a file used to store medium
11678	data; for a list of supported file extensions see
11679	<link to="IMediumFormat::describeFileExtensions"/>).
11680	</desc>
11681	</const>
11682
11683	<const name="Properties" value="0x80">
11684	<desc>
11685	The format backend uses the property interface to configure the storage
11686	location and properties (the <link to="IMediumFormat::describeProperties"/>
11687	method is used to get access to properties supported by the given medium format).
11688	</desc>
11689	</const>
11690
11691	<const name="TcpNetworking" value="0x100">
11692	<desc>
11693	The format backend uses the TCP networking interface for network access.
11694	</desc>
11695	</const>
11696
11697	<const name="VFS" value="0x200">
11698	<desc>
11699	The format backend supports virtual filesystem functionality.
11700	</desc>
11701	</const>
11702
11703	<const name="CapabilityMask" value="0x3FF"/>
11704	</enum>
11705
11706	<interface
11707	name="IMediumFormat" extends="$unknown"
11708	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11709	wsmap="managed"
11710	>
11711	<desc>
11712	The IMediumFormat interface represents a medium format.
11713
11714	Each medium format has an associated backend which is used to handle
11715	media stored in this format. This interface provides information
11716	about the properties of the associated backend.
11717
11718	Each medium format is identified by a string represented by the
11719	<link to="#id"/> attribute. This string is used in calls like
11720	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11721	format.
11722
11723	The list of all supported medium formats can be obtained using
11724	<link to="ISystemProperties::mediumFormats"/>.
11725
11726	<see><link to="IMedium"/></see>
11727	</desc>
11728
11729	<attribute name="id" type="wstring" readonly="yes">
11730	<desc>
11731	Identifier of this format.
11732
11733	The format identifier is a non-@c null non-empty ASCII string. Note that
11734	this string is case-insensitive. This means that, for example, all of
11735	the following strings:
11736	<pre>
11737	"VDI"
11738	"vdi"
11739	"VdI"</pre>
11740	refer to the same medium format.
11741
11742	This string is used in methods of other interfaces where it is necessary
11743	to specify a medium format, such as
11744	<link to="IVirtualBox::createHardDisk"/>.
11745	</desc>
11746	</attribute>
11747
11748	<attribute name="name" type="wstring" readonly="yes">
11749	<desc>
11750	Human readable description of this format.
11751
11752	Mainly for use in file open dialogs.
11753	</desc>
11754	</attribute>
11755
11756	<attribute name="capabilities" type="unsigned long" readonly="yes">
11757	<desc>
11758	Capabilities of the format as a set of bit flags.
11759
11760	For the meaning of individual capability flags see
11761	<link to="MediumFormatCapabilities"/>.
11762	</desc>
11763	</attribute>
11764
11765	<method name="describeFileExtensions">
11766	<desc>
11767	Returns two arrays describing the supported file extensions.
11768
11769	The first array contains the supported extensions and the seconds one
11770	the type each extension supports. Both have the same size.
11771
11772	Note that some backends do not work on files, so this array may be
11773	empty.
11774
11775	<see><link to="IMediumFormat::capabilities"/></see>
11776	</desc>
11777	<param name="extensions" type="wstring" safearray="yes" dir="out">
11778	<desc>The array of supported extensions.</desc>
11779	</param>
11780	<param name="type" type="DeviceType" safearray="yes" dir="out">
11781	<desc>The array which indicates the device type for every given extension.</desc>
11782	</param>
11783	</method>
11784
11785	<method name="describeProperties" const="yes">
11786	<desc>
11787	Returns several arrays describing the properties supported by this
11788	format.
11789
11790	An element with the given index in each array describes one
11791	property. Thus, the number of elements in each returned array is the
11792	same and corresponds to the number of supported properties.
11793
11794	The returned arrays are filled in only if the
11795	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11796	All arguments must be non-@c null.
11797
11798	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11799	</desc>
11800
11801	<param name="names" type="wstring" safearray="yes" dir="out">
11802	<desc>Array of property names.</desc>
11803	</param>
11804	<param name="description" type="wstring" safearray="yes" dir="out">
11805	<desc>Array of property descriptions.</desc>
11806	</param>
11807	<param name="types" type="DataType" safearray="yes" dir="out">
11808	<desc>Array of property types.</desc>
11809	</param>
11810	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11811	<desc>Array of property flags.</desc>
11812	</param>
11813	<param name="defaults" type="wstring" safearray="yes" dir="out">
11814	<desc>Array of default property values.</desc>
11815	</param>
11816	</method>
11817
11818	</interface>
11819
11820
11821	<!--
11822	// IKeyboard
11823	/////////////////////////////////////////////////////////////////////////
11824	-->
11825
11826	<interface
11827	name="IKeyboard" extends="$unknown"
11828	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11829	wsmap="managed"
11830	>
11831	<desc>
11832	The IKeyboard interface represents the virtual machine's keyboard. Used
11833	in <link to="IConsole::keyboard"/>.
11834
11835	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11836	to the virtual machine.
11837
11838	</desc>
11839	<method name="putScancode">
11840	<desc>Sends a scancode to the keyboard.
11841
11842	<result name="VBOX_E_IPRT_ERROR">
11843	Could not send scan code to virtual keyboard.
11844	</result>
11845
11846	</desc>
11847	<param name="scancode" type="long" dir="in"/>
11848	</method>
11849
11850	<method name="putScancodes">
11851	<desc>Sends an array of scancodes to the keyboard.
11852
11853	<result name="VBOX_E_IPRT_ERROR">
11854	Could not send all scan codes to virtual keyboard.
11855	</result>
11856
11857	</desc>
11858	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11859	<param name="codesStored" type="unsigned long" dir="return"/>
11860	</method>
11861
11862	<method name="putCAD">
11863	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11864	function is nothing special, it is just a convenience function
11865	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11866
11867	<result name="VBOX_E_IPRT_ERROR">
11868	Could not send all scan codes to virtual keyboard.
11869	</result>
11870
11871	</desc>
11872	</method>
11873
11874	<attribute name="eventSource" type="IEventSource" readonly="yes">
11875	<desc>
11876	Event source for keyboard events.
11877	</desc>
11878	</attribute>
11879
11880	</interface>
11881
11882
11883	<!--
11884	// IMouse
11885	/////////////////////////////////////////////////////////////////////////
11886	-->
11887
11888	<enum
11889	name="MouseButtonState"
11890	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11891	>
11892	<desc>
11893	Mouse button state.
11894	</desc>
11895
11896	<const name="LeftButton" value="0x01"/>
11897	<const name="RightButton" value="0x02"/>
11898	<const name="MiddleButton" value="0x04"/>
11899	<const name="WheelUp" value="0x08"/>
11900	<const name="WheelDown" value="0x10"/>
11901	<const name="XButton1" value="0x20"/>
11902	<const name="XButton2" value="0x40"/>
11903	<const name="MouseStateMask" value="0x7F"/>
11904	</enum>
11905
11906	<interface
11907	name="IMouse" extends="$unknown"
11908	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11909	wsmap="managed"
11910	>
11911	<desc>
11912	The IMouse interface represents the virtual machine's mouse. Used in
11913	<link to="IConsole::mouse"/>.
11914
11915	Through this interface, the virtual machine's virtual mouse can be
11916	controlled.
11917	</desc>
11918
11919	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11920	<desc>
11921	Whether the guest OS supports absolute mouse pointer positioning
11922	or not.
11923	<note>
11924	You can use the <link to="IMouseCapabilityChangedEvent"/>
11925	event to be instantly informed about changes of this attribute
11926	during virtual machine execution.
11927	</note>
11928	<see><link to="#putMouseEventAbsolute"/></see>
11929	</desc>
11930	</attribute>
11931
11932	<attribute name="relativeSupported" type="boolean" readonly="yes">
11933	<desc>
11934	Whether the guest OS supports relative mouse pointer positioning
11935	or not.
11936	<note>
11937	You can use the <link to="IMouseCapabilityChangedEvent"/>
11938	event to be instantly informed about changes of this attribute
11939	during virtual machine execution.
11940	</note>
11941	<see><link to="#putMouseEvent"/></see>
11942	</desc>
11943	</attribute>
11944
11945	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11946	<desc>
11947	Whether the guest OS can currently switch to drawing it's own mouse
11948	cursor on demand.
11949	<note>
11950	You can use the <link to="IMouseCapabilityChangedEvent"/>
11951	event to be instantly informed about changes of this attribute
11952	during virtual machine execution.
11953	</note>
11954	<see><link to="#putMouseEvent"/></see>
11955	</desc>
11956	</attribute>
11957
11958	<method name="putMouseEvent">
11959	<desc>
11960	Initiates a mouse event using relative pointer movements
11961	along x and y axis.
11962
11963	<result name="E_ACCESSDENIED">
11964	Console not powered up.
11965	</result>
11966	<result name="VBOX_E_IPRT_ERROR">
11967	Could not send mouse event to virtual mouse.
11968	</result>
11969
11970	</desc>
11971
11972	<param name="dx" type="long" dir="in">
11973	<desc>
11974	Amount of pixels the mouse should move to the right.
11975	Negative values move the mouse to the left.
11976	</desc>
11977	</param>
11978	<param name="dy" type="long" dir="in">
11979	<desc>
11980	Amount of pixels the mouse should move downwards.
11981	Negative values move the mouse upwards.
11982	</desc>
11983	</param>
11984	<param name="dz" type="long" dir="in">
11985	<desc>
11986	Amount of mouse wheel moves.
11987	Positive values describe clockwise wheel rotations,
11988	negative values describe counterclockwise rotations.
11989	</desc>
11990	</param>
11991	<param name="dw" type="long" dir="in">
11992	<desc>
11993	Amount of horizontal mouse wheel moves.
11994	Positive values describe a movement to the left,
11995	negative values describe a movement to the right.
11996	</desc>
11997	</param>
11998	<param name="buttonState" type="long" dir="in">
11999	<desc>
12000	The current state of mouse buttons. Every bit represents
12001	a mouse button as follows:
12002	<table>
12003	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12004	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12005	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12006	</table>
12007	A value of <tt>1</tt> means the corresponding button is pressed.
12008	otherwise it is released.
12009	</desc>
12010	</param>
12011	</method>
12012
12013	<method name="putMouseEventAbsolute">
12014	<desc>
12015	Positions the mouse pointer using absolute x and y coordinates.
12016	These coordinates are expressed in pixels and
12017	start from <tt>[1,1]</tt> which corresponds to the top left
12018	corner of the virtual display.
12019
12020	<result name="E_ACCESSDENIED">
12021	Console not powered up.
12022	</result>
12023	<result name="VBOX_E_IPRT_ERROR">
12024	Could not send mouse event to virtual mouse.
12025	</result>
12026
12027	<note>
12028	This method will have effect only if absolute mouse
12029	positioning is supported by the guest OS.
12030	</note>
12031
12032	<see><link to="#absoluteSupported"/></see>
12033	</desc>
12034
12035	<param name="x" type="long" dir="in">
12036	<desc>
12037	X coordinate of the pointer in pixels, starting from @c 1.
12038	</desc>
12039	</param>
12040	<param name="y" type="long" dir="in">
12041	<desc>
12042	Y coordinate of the pointer in pixels, starting from @c 1.
12043	</desc>
12044	</param>
12045	<param name="dz" type="long" dir="in">
12046	<desc>
12047	Amount of mouse wheel moves.
12048	Positive values describe clockwise wheel rotations,
12049	negative values describe counterclockwise rotations.
12050	</desc>
12051	</param>
12052	<param name="dw" type="long" dir="in">
12053	<desc>
12054	Amount of horizontal mouse wheel moves.
12055	Positive values describe a movement to the left,
12056	negative values describe a movement to the right.
12057	</desc>
12058	</param>
12059	<param name="buttonState" type="long" dir="in">
12060	<desc>
12061	The current state of mouse buttons. Every bit represents
12062	a mouse button as follows:
12063	<table>
12064	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12065	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12066	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12067	</table>
12068	A value of @c 1 means the corresponding button is pressed.
12069	otherwise it is released.
12070	</desc>
12071	</param>
12072	</method>
12073
12074	<attribute name="eventSource" type="IEventSource" readonly="yes">
12075	<desc>
12076	Event source for mouse events.
12077	</desc>
12078	</attribute>
12079
12080	</interface>
12081
12082	<!--
12083	// IDisplay
12084	/////////////////////////////////////////////////////////////////////////
12085	-->
12086
12087	<enum
12088	name="FramebufferPixelFormat"
12089	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12090	>
12091	<desc>
12092	Format of the video memory buffer. Constants represented by this enum can
12093	be used to test for particular values of <link
12094	to="IFramebuffer::pixelFormat"/>. See also <link
12095	to="IFramebuffer::requestResize"/>.
12096
12097	See also www.fourcc.org for more information about FOURCC pixel formats.
12098	</desc>
12099
12100	<const name="Opaque" value="0">
12101	<desc>
12102	Unknown buffer format (the user may not assume any particular format of
12103	the buffer).
12104	</desc>
12105	</const>
12106	<const name="FOURCC_RGB" value="0x32424752">
12107	<desc>
12108	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12109	bit layout).
12110	</desc>
12111	</const>
12112	</enum>
12113
12114	<interface
12115	name="IFramebuffer" extends="$unknown"
12116	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12117	wsmap="suppress"
12118	>
12119	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12120	<desc>Address of the start byte of the frame buffer.</desc>
12121	</attribute>
12122
12123	<attribute name="width" type="unsigned long" readonly="yes">
12124	<desc>Frame buffer width, in pixels.</desc>
12125	</attribute>
12126
12127	<attribute name="height" type="unsigned long" readonly="yes">
12128	<desc>Frame buffer height, in pixels.</desc>
12129	</attribute>
12130
12131	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12132	<desc>
12133	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12134	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12135	are: 8, 15, 16, 24 and 32.
12136	</desc>
12137	</attribute>
12138
12139	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12140	<desc>
12141	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12142	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12143	size of the scan line must be aligned to 32 bits.
12144	</desc>
12145	</attribute>
12146
12147	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12148	<desc>
12149	Frame buffer pixel format. It's either one of the values defined by <link
12150	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12151	<note>
12152	This attribute must never return <link
12153	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12154	<link to="#address"/> points to must be always known.
12155	</note>
12156	</desc>
12157	</attribute>
12158
12159	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12160	<desc>
12161	Defines whether this frame buffer uses the virtual video card's memory
12162	buffer (guest VRAM) directly or not. See <link
12163	to="IFramebuffer::requestResize"/> for more information.
12164	</desc>
12165	</attribute>
12166
12167	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12168	<desc>
12169	Hint from the frame buffer about how much of the standard
12170	screen height it wants to use for itself. This information is
12171	exposed to the guest through the VESA BIOS and VMMDev interface
12172	so that it can use it for determining its video mode table. It
12173	is not guaranteed that the guest respects the value.
12174	</desc>
12175	</attribute>
12176
12177	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12178	<desc>
12179	An alpha-blended overlay which is superposed over the frame buffer.
12180	The initial purpose is to allow the display of icons providing
12181	information about the VM state, including disk activity, in front
12182	ends which do not have other means of doing that. The overlay is
12183	designed to controlled exclusively by IDisplay. It has no locking
12184	of its own, and any changes made to it are not guaranteed to be
12185	visible until the affected portion of IFramebuffer is updated. The
12186	overlay can be created lazily the first time it is requested. This
12187	attribute can also return @c null to signal that the overlay is not
12188	implemented.
12189	</desc>
12190	</attribute>
12191
12192	<attribute name="winId" type="long long" readonly="yes">
12193	<desc>
12194	Platform-dependent identifier of the window where context of this
12195	frame buffer is drawn, or zero if there's no such window.
12196	</desc>
12197	</attribute>
12198
12199	<method name="lock">
12200	<desc>
12201	Locks the frame buffer.
12202	Gets called by the IDisplay object where this frame buffer is
12203	bound to.
12204	</desc>
12205	</method>
12206
12207	<method name="unlock">
12208	<desc>
12209	Unlocks the frame buffer.
12210	Gets called by the IDisplay object where this frame buffer is
12211	bound to.
12212	</desc>
12213	</method>
12214
12215	<method name="notifyUpdate">
12216	<desc>
12217	Informs about an update.
12218	Gets called by the display object where this buffer is
12219	registered.
12220	</desc>
12221	<param name="x" type="unsigned long" dir="in"/>
12222	<param name="y" type="unsigned long" dir="in"/>
12223	<param name="width" type="unsigned long" dir="in"/>
12224	<param name="height" type="unsigned long" dir="in"/>
12225	</method>
12226
12227	<method name="requestResize">
12228	<desc>
12229	Requests a size and pixel format change.
12230
12231	There are two modes of working with the video buffer of the virtual
12232	machine. The <i>indirect</i> mode implies that the IFramebuffer
12233	implementation allocates a memory buffer for the requested display mode
12234	and provides it to the virtual machine. In <i>direct</i> mode, the
12235	IFramebuffer implementation uses the memory buffer allocated and owned
12236	by the virtual machine. This buffer represents the video memory of the
12237	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12238	usually faster because the implementation gets a raw pointer to the
12239	guest VRAM buffer which it can directly use for visualizing the contents
12240	of the virtual display, as opposed to the indirect mode where the
12241	contents of guest VRAM are copied to the memory buffer provided by
12242	the implementation every time a display update occurs.
12243
12244	It is important to note that the direct mode is really fast only when
12245	the implementation uses the given guest VRAM buffer directly, for
12246	example, by blitting it to the window representing the virtual machine's
12247	display, which saves at least one copy operation comparing to the
12248	indirect mode. However, using the guest VRAM buffer directly is not
12249	always possible: the format and the color depth of this buffer may be
12250	not supported by the target window, or it may be unknown (opaque) as in
12251	case of text or non-linear multi-plane VGA video modes. In this case,
12252	the indirect mode (that is always available) should be used as a
12253	fallback: when the guest VRAM contents are copied to the
12254	implementation-provided memory buffer, color and format conversion is
12255	done automatically by the underlying code.
12256
12257	The @a pixelFormat parameter defines whether the direct mode is
12258	available or not. If @a pixelFormat is <link
12259	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12260	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12261	@a bytesPerLine parameters must be ignored and the implementation must use
12262	the indirect mode (where it provides its own buffer in one of the
12263	supported formats). In all other cases, @a pixelFormat together with
12264	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12265	buffer pointed to by the @a VRAM parameter and the implementation is
12266	free to choose which mode to use. To indicate that this frame buffer uses
12267	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12268	attribute must return @c true and <link to="#address"/> must
12269	return exactly the same address that is passed in the @a VRAM parameter
12270	of this method; otherwise it is assumed that the indirect strategy is
12271	chosen.
12272
12273	The @a width and @a height parameters represent the size of the
12274	requested display mode in both modes. In case of indirect mode, the
12275	provided memory buffer should be big enough to store data of the given
12276	display mode. In case of direct mode, it is guaranteed that the given
12277	@a VRAM buffer contains enough space to represent the display mode of the
12278	given size. Note that this frame buffer's <link to="#width"/> and <link
12279	to="#height"/> attributes must return exactly the same values as
12280	passed to this method after the resize is completed (see below).
12281
12282	The @a finished output parameter determines if the implementation has
12283	finished resizing the frame buffer or not. If, for some reason, the
12284	resize cannot be finished immediately during this call, @a finished
12285	must be set to @c false, and the implementation must call
12286	<link to="IDisplay::resizeCompleted"/> after it has returned from
12287	this method as soon as possible. If @a finished is @c false, the
12288	machine will not call any frame buffer methods until
12289	<link to="IDisplay::resizeCompleted"/> is called.
12290
12291	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12292	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12293	this frame buffer must return exactly the same values as specified in the
12294	parameters of this method, after the resize is completed. If the
12295	indirect mode is chosen, these attributes must return values describing
12296	the format of the implementation's own memory buffer <link
12297	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12298	value must always correlate with <link to="#pixelFormat"/>. Note that
12299	the <link to="#pixelFormat"/> attribute must never return <link
12300	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12301
12302	<note>
12303	This method is called by the IDisplay object under the
12304	<link to="#lock"/> provided by this IFramebuffer
12305	implementation. If this method returns @c false in @a finished, then
12306	this lock is not released until
12307	<link to="IDisplay::resizeCompleted"/> is called.
12308	</note>
12309	</desc>
12310	<param name="screenId" type="unsigned long" dir="in">
12311	<desc>
12312	Logical screen number. Must be used in the corresponding call to
12313	<link to="IDisplay::resizeCompleted"/> if this call is made.
12314	</desc>
12315	</param>
12316	<param name="pixelFormat" type="unsigned long" dir="in">
12317	<desc>
12318	Pixel format of the memory buffer pointed to by @a VRAM.
12319	See also <link to="FramebufferPixelFormat"/>.
12320	</desc>
12321	</param>
12322	<param name="VRAM" type="octet" mod="ptr" dir="in">
12323	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12324	</param>
12325	<param name="bitsPerPixel" type="unsigned long" dir="in">
12326	<desc>Color depth, bits per pixel.</desc>
12327	</param>
12328	<param name="bytesPerLine" type="unsigned long" dir="in">
12329	<desc>Size of one scan line, in bytes.</desc>
12330	</param>
12331	<param name="width" type="unsigned long" dir="in">
12332	<desc>Width of the guest display, in pixels.</desc>
12333	</param>
12334	<param name="height" type="unsigned long" dir="in">
12335	<desc>Height of the guest display, in pixels.</desc>
12336	</param>
12337	<param name="finished" type="boolean" dir="return">
12338	<desc>
12339	Can the VM start using the new frame buffer immediately
12340	after this method returns or it should wait for
12341	<link to="IDisplay::resizeCompleted"/>.
12342	</desc>
12343	</param>
12344	</method>
12345
12346	<method name="videoModeSupported">
12347	<desc>
12348	Returns whether the frame buffer implementation is willing to
12349	support a given video mode. In case it is not able to render
12350	the video mode (or for some reason not willing), it should
12351	return @c false. Usually this method is called when the guest
12352	asks the VMM device whether a given video mode is supported
12353	so the information returned is directly exposed to the guest.
12354	It is important that this method returns very quickly.
12355	</desc>
12356	<param name="width" type="unsigned long" dir="in"/>
12357	<param name="height" type="unsigned long" dir="in"/>
12358	<param name="bpp" type="unsigned long" dir="in"/>
12359	<param name="supported" type="boolean" dir="return"/>
12360	</method>
12361
12362	<method name="getVisibleRegion">
12363	<desc>
12364	Returns the visible region of this frame buffer.
12365
12366	If the @a rectangles parameter is @c null then the value of the
12367	@a count parameter is ignored and the number of elements necessary to
12368	describe the current visible region is returned in @a countCopied.
12369
12370	If @a rectangles is not @c null but @a count is less
12371	than the required number of elements to store region data, the method
12372	will report a failure. If @a count is equal or greater than the
12373	required number of elements, then the actual number of elements copied
12374	to the provided array will be returned in @a countCopied.
12375
12376	<note>
12377	The address of the provided array must be in the process space of
12378	this IFramebuffer object.
12379	</note>
12380	<note>
12381	Method not yet implemented.
12382	</note>
12383	</desc>
12384	<param name="rectangles" type="octet" mod="ptr" dir="in">
12385	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12386	</param>
12387	<param name="count" type="unsigned long" dir="in">
12388	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12389	</param>
12390	<param name="countCopied" type="unsigned long" dir="return">
12391	<desc>Number of elements copied to the @a rectangles array.</desc>
12392	</param>
12393	</method>
12394
12395	<method name="setVisibleRegion">
12396	<desc>
12397	Suggests a new visible region to this frame buffer. This region
12398	represents the area of the VM display which is a union of regions of
12399	all top-level windows of the guest operating system running inside the
12400	VM (if the Guest Additions for this system support this
12401	functionality). This information may be used by the frontends to
12402	implement the seamless desktop integration feature.
12403
12404	<note>
12405	The address of the provided array must be in the process space of
12406	this IFramebuffer object.
12407	</note>
12408	<note>
12409	The IFramebuffer implementation must make a copy of the provided
12410	array of rectangles.
12411	</note>
12412	<note>
12413	Method not yet implemented.
12414	</note>
12415	</desc>
12416	<param name="rectangles" type="octet" mod="ptr" dir="in">
12417	<desc>Pointer to the @c RTRECT array.</desc>
12418	</param>
12419	<param name="count" type="unsigned long" dir="in">
12420	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12421	</param>
12422	</method>
12423
12424	<method name="processVHWACommand">
12425	<desc>
12426	Posts a Video HW Acceleration Command to the frame buffer for processing.
12427	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12428	are posted from quest to the host to be processed by the host hardware.
12429
12430	<note>
12431	The address of the provided command must be in the process space of
12432	this IFramebuffer object.
12433	</note>
12434	</desc>
12435
12436	<param name="command" type="octet" mod="ptr" dir="in">
12437	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12438	</param>
12439	</method>
12440
12441	</interface>
12442
12443	<interface
12444	name="IFramebufferOverlay" extends="IFramebuffer"
12445	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12446	wsmap="suppress"
12447	>
12448	<desc>
12449	The IFramebufferOverlay interface represents an alpha blended overlay
12450	for displaying status icons above an IFramebuffer. It is always created
12451	not visible, so that it must be explicitly shown. It only covers a
12452	portion of the IFramebuffer, determined by its width, height and
12453	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12454	that order) format, and may be written to directly. Do re-read the
12455	width though, after setting it, as it may be adjusted (increased) to
12456	make it more suitable for the front end.
12457	</desc>
12458	<attribute name="x" type="unsigned long" readonly="yes">
12459	<desc>X position of the overlay, relative to the frame buffer.</desc>
12460	</attribute>
12461
12462	<attribute name="y" type="unsigned long" readonly="yes">
12463	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12464	</attribute>
12465
12466	<attribute name="visible" type="boolean" readonly="no">
12467	<desc>
12468	Whether the overlay is currently visible.
12469	</desc>
12470	</attribute>
12471
12472	<attribute name="alpha" type="unsigned long" readonly="no">
12473	<desc>
12474	The global alpha value for the overlay. This may or may not be
12475	supported by a given front end.
12476	</desc>
12477	</attribute>
12478
12479	<method name="move">
12480	<desc>
12481	Changes the overlay's position relative to the IFramebuffer.
12482	</desc>
12483	<param name="x" type="unsigned long" dir="in"/>
12484	<param name="y" type="unsigned long" dir="in"/>
12485	</method>
12486
12487	</interface>
12488
12489	<interface
12490	name="IDisplay" extends="$unknown"
12491	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12492	wsmap="managed"
12493	>
12494	<desc>
12495	The IDisplay interface represents the virtual machine's display.
12496
12497	The object implementing this interface is contained in each
12498	<link to="IConsole::display"/> attribute and represents the visual
12499	output of the virtual machine.
12500
12501	The virtual display supports pluggable output targets represented by the
12502	IFramebuffer interface. Examples of the output target are a window on
12503	the host computer or an RDP session's display on a remote computer.
12504	</desc>
12505	<method name="getScreenResolution">
12506	<desc>Queries display width, height and color depth for given screen.</desc>
12507	<param name="screenId" type="unsigned long" dir="in"/>
12508	<param name="width" type="unsigned long" dir="out"/>
12509	<param name="height" type="unsigned long" dir="out"/>
12510	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12511	</method>
12512
12513	<method name="setFramebuffer">
12514	<desc>
12515	Sets the framebuffer for given screen.
12516	</desc>
12517	<param name="screenId" type="unsigned long" dir="in"/>
12518	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12519	</method>
12520
12521	<method name="getFramebuffer">
12522	<desc>
12523	Queries the framebuffer for given screen.
12524	</desc>
12525	<param name="screenId" type="unsigned long" dir="in"/>
12526	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12527	<param name="xOrigin" type="long" dir="out"/>
12528	<param name="yOrigin" type="long" dir="out"/>
12529	</method>
12530
12531	<method name="setVideoModeHint">
12532	<desc>
12533	Asks VirtualBox to request the given video mode from
12534	the guest. This is just a hint and it cannot be guaranteed
12535	that the requested resolution will be used. Guest Additions
12536	are required for the request to be seen by guests. The caller
12537	should issue the request and wait for a resolution change and
12538	after a timeout retry.
12539
12540	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12541	parameters means that the corresponding values should be taken from the
12542	current video mode (i.e. left unchanged).
12543
12544	If the guest OS supports multi-monitor configuration then the @a display
12545	parameter specifies the number of the guest display to send the hint to:
12546	@c 0 is the primary display, @c 1 is the first secondary and
12547	so on. If the multi-monitor configuration is not supported, @a display
12548	must be @c 0.
12549
12550	<result name="E_INVALIDARG">
12551	The @a display is not associated with any monitor.
12552	</result>
12553
12554	</desc>
12555	<param name="width" type="unsigned long" dir="in"/>
12556	<param name="height" type="unsigned long" dir="in"/>
12557	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12558	<param name="display" type="unsigned long" dir="in"/>
12559	</method>
12560
12561	<method name="setSeamlessMode">
12562	<desc>
12563	Enables or disables seamless guest display rendering (seamless desktop
12564	integration) mode.
12565	<note>
12566	Calling this method has no effect if <link
12567	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12568	does not return @c Active.
12569	</note>
12570	</desc>
12571	<param name="enabled" type="boolean" dir="in"/>
12572	</method>
12573
12574	<method name="takeScreenShot">
12575	<desc>
12576	Takes a screen shot of the requested size and copies it to the
12577	32-bpp buffer allocated by the caller and pointed to by @a address.
12578	A pixel consists of 4 bytes in order: B, G, R, 0.
12579
12580	<note>This API can be used only locally by a VM process through the
12581	COM/XPCOM C++ API as it requires pointer support. It is not
12582	available for scripting langages, Java or any webservice clients.
12583	Unless you are writing a new VM frontend use
12584	<link to="#takeScreenShotToArray" />.
12585	</note>
12586
12587	<result name="E_NOTIMPL">
12588	Feature not implemented.
12589	</result>
12590	<result name="VBOX_E_IPRT_ERROR">
12591	Could not take a screenshot.
12592	</result>
12593
12594	</desc>
12595	<param name="screenId" type="unsigned long" dir="in"/>
12596	<param name="address" type="octet" mod="ptr" dir="in"/>
12597	<param name="width" type="unsigned long" dir="in"/>
12598	<param name="height" type="unsigned long" dir="in"/>
12599	</method>
12600
12601	<method name="takeScreenShotToArray">
12602	<desc>
12603	Takes a guest screen shot of the requested size and returns it as
12604	an array of bytes in uncompressed 32-bit RGBA format.
12605	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12606
12607	This API is slow, but could be the only option to get guest screenshot
12608	for scriptable languages not allowed to manipulate with addresses
12609	directly.
12610
12611	<result name="E_NOTIMPL">
12612	Feature not implemented.
12613	</result>
12614	<result name="VBOX_E_IPRT_ERROR">
12615	Could not take a screenshot.
12616	</result>
12617	</desc>
12618	<param name="screenId" type="unsigned long" dir="in">
12619	<desc>
12620	Monitor to take screenshot from.
12621	</desc>
12622	</param>
12623	<param name="width" type="unsigned long" dir="in">
12624	<desc>
12625	Desired image width.
12626	</desc>
12627	</param>
12628	<param name="height" type="unsigned long" dir="in">
12629	<desc>
12630	Desired image height.
12631	</desc>
12632	</param>
12633	<param name="screenData" type="octet" dir="return" safearray="yes">
12634	<desc>
12635	Array with resulting screen data.
12636	</desc>
12637	</param>
12638	</method>
12639
12640	<method name="takeScreenShotPNGToArray">
12641	<desc>
12642	Takes a guest screen shot of the requested size and returns it as
12643	PNG image in array.
12644
12645	<result name="E_NOTIMPL">
12646	Feature not implemented.
12647	</result>
12648	<result name="VBOX_E_IPRT_ERROR">
12649	Could not take a screenshot.
12650	</result>
12651	</desc>
12652	<param name="screenId" type="unsigned long" dir="in">
12653	<desc>
12654	Monitor to take the screenshot from.
12655	</desc>
12656	</param>
12657	<param name="width" type="unsigned long" dir="in">
12658	<desc>
12659	Desired image width.
12660	</desc>
12661	</param>
12662	<param name="height" type="unsigned long" dir="in">
12663	<desc>
12664	Desired image height.
12665	</desc>
12666	</param>
12667	<param name="screenData" type="octet" dir="return" safearray="yes">
12668	<desc>
12669	Array with resulting screen data.
12670	</desc>
12671	</param>
12672	</method>
12673
12674	<method name="drawToScreen">
12675	<desc>
12676	Draws a 32-bpp image of the specified size from the given buffer
12677	to the given point on the VM display.
12678
12679	<result name="E_NOTIMPL">
12680	Feature not implemented.
12681	</result>
12682	<result name="VBOX_E_IPRT_ERROR">
12683	Could not draw to screen.
12684	</result>
12685
12686	</desc>
12687	<param name="screenId" type="unsigned long" dir="in">
12688	<desc>
12689	Monitor to take the screenshot from.
12690	</desc>
12691	</param>
12692	<param name="address" type="octet" mod="ptr" dir="in">
12693	<desc>
12694	Address to store the screenshot to
12695	</desc>
12696	</param>
12697	<param name="x" type="unsigned long" dir="in">
12698	<desc>
12699	Relative to the screen top left corner.
12700	</desc>
12701	</param>
12702	<param name="y" type="unsigned long" dir="in">
12703	<desc>
12704	Relative to the screen top left corner.
12705	</desc>
12706	</param>
12707	<param name="width" type="unsigned long" dir="in">
12708	<desc>
12709	Desired image width.
12710	</desc>
12711	</param>
12712	<param name="height" type="unsigned long" dir="in">
12713	<desc>
12714	Desired image height.
12715	</desc>
12716	</param>
12717	</method>
12718
12719	<method name="invalidateAndUpdate">
12720	<desc>
12721	Does a full invalidation of the VM display and instructs the VM
12722	to update it.
12723
12724	<result name="VBOX_E_IPRT_ERROR">
12725	Could not invalidate and update screen.
12726	</result>
12727
12728	</desc>
12729	</method>
12730
12731	<method name="resizeCompleted">
12732	<desc>
12733	Signals that a framebuffer has completed the resize operation.
12734
12735	<result name="VBOX_E_NOT_SUPPORTED">
12736	Operation only valid for external frame buffers.
12737	</result>
12738
12739	</desc>
12740	<param name="screenId" type="unsigned long" dir="in"/>
12741	</method>
12742
12743	<method name="completeVHWACommand">
12744	<desc>
12745	Signals that the Video HW Acceleration command has completed.
12746	</desc>
12747
12748	<param name="command" type="octet" mod="ptr" dir="in">
12749	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12750	</param>
12751	</method>
12752
12753	</interface>
12754
12755	<!--
12756	// INetworkAdapter
12757	/////////////////////////////////////////////////////////////////////////
12758	-->
12759
12760	<enum
12761	name="NetworkAttachmentType"
12762	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12763	>
12764	<desc>
12765	Network attachment type.
12766	</desc>
12767
12768	<const name="Null" value="0">
12769	<desc>Null value, also means "not attached".</desc>
12770	</const>
12771	<const name="NAT" value="1"/>
12772	<const name="Bridged" value="2"/>
12773	<const name="Internal" value="3"/>
12774	<const name="HostOnly" value="4"/>
12775	<const name="Generic" value="5"/>
12776	</enum>
12777
12778	<enum
12779	name="NetworkAdapterType"
12780	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12781	>
12782	<desc>
12783	Network adapter type.
12784	</desc>
12785
12786	<const name="Null" value="0">
12787	<desc>Null value (never used by the API).</desc>
12788	</const>
12789	<const name="Am79C970A" value="1">
12790	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12791	</const>
12792	<const name="Am79C973" value="2">
12793	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12794	</const>
12795	<const name="I82540EM" value="3">
12796	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12797	</const>
12798	<const name="I82543GC" value="4">
12799	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12800	</const>
12801	<const name="I82545EM" value="5">
12802	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12803	</const>
12804	<const name="Virtio" value="6">
12805	<desc>Virtio network device.</desc>
12806	</const>
12807	</enum>
12808
12809	<enum
12810	name="NetworkAdapterPromiscModePolicy"
12811	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12812	>
12813	<desc>
12814	The promiscuous mode policy of an interface.
12815	</desc>
12816
12817	<const name="Deny" value="1">
12818	<desc>Deny promiscuous mode requests.</desc>
12819	</const>
12820	<const name="AllowNetwork" value="2">
12821	<desc>
12822	Allow promicuous mode, but restrict the scope it to the internal
12823	network so that it only applies to other VMs.
12824	</desc>
12825	</const>
12826	<const name="AllowAll" value="3">
12827	<desc>
12828	Allow promicuous mode, include unrelated traffic going over the wire
12829	and internally on the host.
12830	</desc>
12831	</const>
12832	</enum>
12833
12834	<interface
12835	name="INetworkAdapter" extends="$unknown"
12836	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12837	wsmap="managed"
12838	>
12839	<desc>
12840	Represents a virtual network adapter that is attached to a virtual machine.
12841	Each virtual machine has a fixed number of network adapter slots with one
12842	instance of this attached to each of them. Call
12843	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12844	is attached to a given slot in a given machine.
12845
12846	Each network adapter can be in one of five attachment modes, which are
12847	represented by the <link to="NetworkAttachmentType" /> enumeration;
12848	see the <link to="#attachmentType" /> attribute.
12849	</desc>
12850
12851	<attribute name="adapterType" type="NetworkAdapterType">
12852	<desc>
12853	Type of the virtual network adapter. Depending on this value,
12854	VirtualBox will provide a different virtual network hardware
12855	to the guest.
12856	</desc>
12857	</attribute>
12858
12859	<attribute name="slot" type="unsigned long" readonly="yes">
12860	<desc>
12861	Slot number this adapter is plugged into. Corresponds to
12862	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12863	to obtain this instance.
12864	</desc>
12865	</attribute>
12866
12867	<attribute name="enabled" type="boolean">
12868	<desc>
12869	Flag whether the network adapter is present in the
12870	guest system. If disabled, the virtual guest hardware will
12871	not contain this network adapter. Can only be changed when
12872	the VM is not running.
12873	</desc>
12874	</attribute>
12875
12876	<attribute name="MACAddress" type="wstring">
12877	<desc>
12878	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12879	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12880	</desc>
12881	</attribute>
12882
12883	<attribute name="attachmentType" type="NetworkAttachmentType">
12884	<desc>
12885	Sets/Gets network attachment type of this network adapter.
12886	</desc>
12887	</attribute>
12888
12889	<attribute name="bridgedInterface" type="wstring">
12890	<desc>
12891	Name of the network interface the VM should be bridged to.
12892	</desc>
12893	</attribute>
12894
12895	<attribute name="hostOnlyInterface" type="wstring">
12896	<desc>
12897	Name of the host only network interface the VM is attached to.
12898	</desc>
12899	</attribute>
12900
12901	<attribute name="internalNetwork" type="wstring">
12902	<desc>
12903	Name of the internal network the VM is attached to.
12904	</desc>
12905	</attribute>
12906
12907	<attribute name="NATNetwork" type="wstring">
12908	<desc>
12909	Name of the NAT network the VM is attached to.
12910	</desc>
12911	</attribute>
12912
12913	<attribute name="genericDriver" type="wstring">
12914	<desc>
12915	Name of the driver to use for the "Generic" network attachment type.
12916	</desc>
12917	</attribute>
12918
12919	<attribute name="cableConnected" type="boolean">
12920	<desc>
12921	Flag whether the adapter reports the cable as connected or not.
12922	It can be used to report offline situations to a VM.
12923	</desc>
12924	</attribute>
12925
12926	<attribute name="lineSpeed" type="unsigned long">
12927	<desc>
12928	Line speed reported by custom drivers, in units of 1 kbps.
12929	</desc>
12930	</attribute>
12931
12932	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12933	<desc>
12934	The promiscuous mode policy of the network adapter when attached to an
12935	internal network, host only network or a bridge.
12936	</desc>
12937	</attribute>
12938
12939	<attribute name="traceEnabled" type="boolean">
12940	<desc>
12941	Flag whether network traffic from/to the network card should be traced.
12942	Can only be toggled when the VM is turned off.
12943	</desc>
12944	</attribute>
12945
12946	<attribute name="traceFile" type="wstring">
12947	<desc>
12948	Filename where a network trace will be stored. If not set, VBox-pid.pcap
12949	will be used.
12950	</desc>
12951	</attribute>
12952
12953	<attribute name="natDriver" type="INATEngine" readonly="yes">
12954	<desc>
12955	Points to the NAT engine which handles the network address translation
12956	for this interface. This is active only when the interface actually uses
12957	NAT.
12958	</desc>
12959	</attribute>
12960
12961	<attribute name="bootPriority" type="unsigned long">
12962	<desc>
12963	Network boot priority of the adapter. Priority 1 is highest. If not set,
12964	the priority is considered to be at the lowest possible setting.
12965	</desc>
12966	</attribute>
12967
12968	<attribute name="bandwidthGroup" type="IBandwidthGroup">
12969	<desc>The bandwidth group this network adapter is assigned to.</desc>
12970	</attribute>
12971
12972	<!-- property methods -->
12973
12974	<method name="getProperty" const="yes">
12975	<desc>
12976	Returns the value of the network attachment property with the given name.
12977
12978	If the requested data @a key does not exist, this function will
12979	succeed and return an empty string in the @a value argument.
12980
12981	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12982	</desc>
12983	<param name="key" type="wstring" dir="in">
12984	<desc>Name of the property to get.</desc>
12985	</param>
12986	<param name="value" type="wstring" dir="return">
12987	<desc>Current property value.</desc>
12988	</param>
12989	</method>
12990
12991	<method name="setProperty">
12992	<desc>
12993	Sets the value of the network attachment property with the given name.
12994
12995	Setting the property value to @c null or an empty string is equivalent
12996	to deleting the existing value.
12997
12998	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12999	</desc>
13000	<param name="key" type="wstring" dir="in">
13001	<desc>Name of the property to set.</desc>
13002	</param>
13003	<param name="value" type="wstring" dir="in">
13004	<desc>Property value to set.</desc>
13005	</param>
13006	</method>
13007
13008	<method name="getProperties" const="yes">
13009	<desc>
13010	Returns values for a group of properties in one call.
13011
13012	The names of the properties to get are specified using the @a names
13013	argument which is a list of comma-separated property names or
13014	an empty string if all properties are to be returned.
13015	<note>Currently the value of this argument is ignored and the method
13016	always returns all existing properties.</note>
13017
13018	The method returns two arrays, the array of property names corresponding
13019	to the @a names argument and the current values of these properties.
13020	Both arrays have the same number of elements with each element at the
13021	given index in the first array corresponds to an element at the same
13022	index in the second array.
13023	</desc>
13024	<param name="names" type="wstring" dir="in">
13025	<desc>
13026	Names of properties to get.
13027	</desc>
13028	</param>
13029	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13030	<desc>Names of returned properties.</desc>
13031	</param>
13032	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13033	<desc>Values of returned properties.</desc>
13034	</param>
13035	</method>
13036
13037	</interface>
13038
13039
13040	<!--
13041	// ISerialPort
13042	/////////////////////////////////////////////////////////////////////////
13043	-->
13044
13045	<enum
13046	name="PortMode"
13047	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13048	>
13049	<desc>
13050	The PortMode enumeration represents possible communication modes for
13051	the virtual serial port device.
13052	</desc>
13053
13054	<const name="Disconnected" value="0">
13055	<desc>Virtual device is not attached to any real host device.</desc>
13056	</const>
13057	<const name="HostPipe" value="1">
13058	<desc>Virtual device is attached to a host pipe.</desc>
13059	</const>
13060	<const name="HostDevice" value="2">
13061	<desc>Virtual device is attached to a host device.</desc>
13062	</const>
13063	<const name="RawFile" value="3">
13064	<desc>Virtual device is attached to a raw file.</desc>
13065	</const>
13066	</enum>
13067
13068	<interface
13069	name="ISerialPort" extends="$unknown"
13070	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13071	wsmap="managed"
13072	>
13073
13074	<desc>
13075	The ISerialPort interface represents the virtual serial port device.
13076
13077	The virtual serial port device acts like an ordinary serial port
13078	inside the virtual machine. This device communicates to the real
13079	serial port hardware in one of two modes: host pipe or host device.
13080
13081	In host pipe mode, the #path attribute specifies the path to the pipe on
13082	the host computer that represents a serial port. The #server attribute
13083	determines if this pipe is created by the virtual machine process at
13084	machine startup or it must already exist before starting machine
13085	execution.
13086
13087	In host device mode, the #path attribute specifies the name of the
13088	serial port device on the host computer.
13089
13090	There is also a third communication mode: the disconnected mode. In this
13091	mode, the guest OS running inside the virtual machine will be able to
13092	detect the serial port, but all port write operations will be discarded
13093	and all port read operations will return no data.
13094
13095	<see><link to="IMachine::getSerialPort"/></see>
13096	</desc>
13097
13098	<attribute name="slot" type="unsigned long" readonly="yes">
13099	<desc>
13100	Slot number this serial port is plugged into. Corresponds to
13101	the value you pass to <link to="IMachine::getSerialPort"/>
13102	to obtain this instance.
13103	</desc>
13104	</attribute>
13105
13106	<attribute name="enabled" type="boolean">
13107	<desc>
13108	Flag whether the serial port is enabled. If disabled,
13109	the serial port will not be reported to the guest OS.
13110	</desc>
13111	</attribute>
13112
13113	<attribute name="IOBase" type="unsigned long">
13114	<desc>Base I/O address of the serial port.</desc>
13115	</attribute>
13116
13117	<attribute name="IRQ" type="unsigned long">
13118	<desc>IRQ number of the serial port.</desc>
13119	</attribute>
13120
13121	<attribute name="hostMode" type="PortMode">
13122	<desc>
13123	How is this port connected to the host.
13124	<note>
13125	Changing this attribute may fail if the conditions for
13126	<link to="#path"/> are not met.
13127	</note>
13128	</desc>
13129	</attribute>
13130
13131	<attribute name="server" type="boolean">
13132	<desc>
13133	Flag whether this serial port acts as a server (creates a new pipe on
13134	the host) or as a client (uses the existing pipe). This attribute is
13135	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13136	</desc>
13137	</attribute>
13138
13139	<attribute name="path" type="wstring">
13140	<desc>
13141	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13142	PortMode_HostPipe, or the host serial device name when
13143	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13144	cases, setting a @c null or empty string as the attribute's value
13145	is an error. Otherwise, the value of this property is ignored.
13146	</desc>
13147	</attribute>
13148
13149	</interface>
13150
13151	<!--
13152	// IParallelPort
13153	/////////////////////////////////////////////////////////////////////////
13154	-->
13155
13156	<interface
13157	name="IParallelPort" extends="$unknown"
13158	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13159	wsmap="managed"
13160	>
13161
13162	<desc>
13163	The IParallelPort interface represents the virtual parallel port device.
13164
13165	The virtual parallel port device acts like an ordinary parallel port
13166	inside the virtual machine. This device communicates to the real
13167	parallel port hardware using the name of the parallel device on the host
13168	computer specified in the #path attribute.
13169
13170	Each virtual parallel port device is assigned a base I/O address and an
13171	IRQ number that will be reported to the guest operating system and used
13172	to operate the given parallel port from within the virtual machine.
13173
13174	<see><link to="IMachine::getParallelPort"/></see>
13175	</desc>
13176
13177	<attribute name="slot" type="unsigned long" readonly="yes">
13178	<desc>
13179	Slot number this parallel port is plugged into. Corresponds to
13180	the value you pass to <link to="IMachine::getParallelPort"/>
13181	to obtain this instance.
13182	</desc>
13183	</attribute>
13184
13185	<attribute name="enabled" type="boolean">
13186	<desc>
13187	Flag whether the parallel port is enabled. If disabled,
13188	the parallel port will not be reported to the guest OS.
13189	</desc>
13190	</attribute>
13191
13192	<attribute name="IOBase" type="unsigned long">
13193	<desc>Base I/O address of the parallel port.</desc>
13194	</attribute>
13195
13196	<attribute name="IRQ" type="unsigned long">
13197	<desc>IRQ number of the parallel port.</desc>
13198	</attribute>
13199
13200	<attribute name="path" type="wstring">
13201	<desc>
13202	Host parallel device name. If this parallel port is enabled, setting a
13203	@c null or an empty string as this attribute's value will result in
13204	an error.
13205	</desc>
13206	</attribute>
13207
13208	</interface>
13209
13210
13211	<!--
13212	// IMachineDebugger
13213	/////////////////////////////////////////////////////////////////////////
13214	-->
13215
13216	<interface
13217	name="IMachineDebugger" extends="$unknown"
13218	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13219	wsmap="suppress"
13220	>
13221	<method name="dumpGuestCore">
13222	<desc>
13223	Takes a core dump of the guest.
13224
13225	See include/VBox/dbgfcorefmt.h for details on the file format.
13226	</desc>
13227	<param name="filename" type="wstring" dir="in">
13228	<desc>
13229	The name of the output file. The file must not exist.
13230	</desc>
13231	</param>
13232	<param name="compression" type="wstring" dir="in">
13233	<desc>
13234	Reserved for future compression method indicator.
13235	</desc>
13236	</param>
13237	</method>
13238
13239	<method name="dumpHostProcessCore">
13240	<desc>
13241	Takes a core dump of the VM process on the host.
13242
13243	This feature is not implemented in the 4.0.0 release but it may show up
13244	in a dot release.
13245	</desc>
13246	<param name="filename" type="wstring" dir="in">
13247	<desc>
13248	The name of the output file. The file must not exist.
13249	</desc>
13250	</param>
13251	<param name="compression" type="wstring" dir="in">
13252	<desc>
13253	Reserved for future compression method indicator.
13254	</desc>
13255	</param>
13256	</method>
13257
13258	<method name="info">
13259	<desc>
13260	Interfaces with the info dumpers (DBGFInfo).
13261
13262	This feature is not implemented in the 4.0.0 release but it may show up
13263	in a dot release.
13264	</desc>
13265	<param name="name" type="wstring" dir="in">
13266	<desc>
13267	The name of the info item.
13268	</desc>
13269	</param>
13270	<param name="args" type="wstring" dir="in">
13271	<desc>
13272	Arguments to the info dumper.
13273	</desc>
13274	</param>
13275	<param name="info" type="wstring" dir="return">
13276	<desc>
13277	The into string.
13278	</desc>
13279	</param>
13280	</method>
13281
13282	<method name="injectNMI">
13283	<desc>
13284	Inject an NMI into a running VT-x/AMD-V VM.
13285	</desc>
13286	</method>
13287
13288	<method name="modifyLogGroups">
13289	<desc>
13290	Modifies the group settings of the debug or release logger.
13291	</desc>
13292	<param name="settings" type="wstring" dir="in">
13293	<desc>
13294	The group settings string. See iprt/log.h for details. To target the
13295	release logger, prefix the string with "release:".
13296	</desc>
13297	</param>
13298	</method>
13299
13300	<method name="modifyLogFlags">
13301	<desc>
13302	Modifies the debug or release logger flags.
13303	</desc>
13304	<param name="settings" type="wstring" dir="in">
13305	<desc>
13306	The flags settings string. See iprt/log.h for details. To target the
13307	release logger, prefix the string with "release:".
13308	</desc>
13309	</param>
13310	</method>
13311
13312	<method name="modifyLogDestinations">
13313	<desc>
13314	Modifies the debug or release logger destinations.
13315	</desc>
13316	<param name="settings" type="wstring" dir="in">
13317	<desc>
13318	The destination settings string. See iprt/log.h for details. To target the
13319	release logger, prefix the string with "release:".
13320	</desc>
13321	</param>
13322	</method>
13323
13324	<method name="readPhysicalMemory">
13325	<desc>
13326	Reads guest physical memory, no side effects (MMIO++).
13327
13328	This feature is not implemented in the 4.0.0 release but may show up
13329	in a dot release.
13330	</desc>
13331	<param name="address" type="long long" dir="in">
13332	<desc>The guest physical address.</desc>
13333	</param>
13334	<param name="size" type="unsigned long" dir="in">
13335	<desc>The number of bytes to read.</desc>
13336	</param>
13337	<param name="bytes" type="octet" safearray="yes" dir="return">
13338	<desc>The bytes read.</desc>
13339	</param>
13340	</method>
13341
13342	<method name="writePhysicalMemory">
13343	<desc>
13344	Writes guest physical memory, access handles (MMIO++) are ignored.
13345
13346	This feature is not implemented in the 4.0.0 release but may show up
13347	in a dot release.
13348	</desc>
13349	<param name="address" type="long long" dir="in">
13350	<desc>The guest physical address.</desc>
13351	</param>
13352	<param name="size" type="unsigned long" dir="in">
13353	<desc>The number of bytes to read.</desc>
13354	</param>
13355	<param name="bytes" type="octet" safearray="yes" dir="in">
13356	<desc>The bytes to write.</desc>
13357	</param>
13358	</method>
13359
13360	<method name="readVirtualMemory">
13361	<desc>
13362	Reads guest virtual memory, no side effects (MMIO++).
13363
13364	This feature is not implemented in the 4.0.0 release but may show up
13365	in a dot release.
13366	</desc>
13367	<param name="cpuId" type="unsigned long" dir="in">
13368	<desc>The identifier of the Virtual CPU.</desc>
13369	</param>
13370	<param name="address" type="long long" dir="in">
13371	<desc>The guest virtual address.</desc>
13372	</param>
13373	<param name="size" type="unsigned long" dir="in">
13374	<desc>The number of bytes to read.</desc>
13375	</param>
13376	<param name="bytes" type="octet" safearray="yes" dir="return">
13377	<desc>The bytes read.</desc>
13378	</param>
13379	</method>
13380
13381	<method name="writeVirtualMemory">
13382	<desc>
13383	Writes guest virtual memory, access handles (MMIO++) are ignored.
13384
13385	This feature is not implemented in the 4.0.0 release but may show up
13386	in a dot release.
13387	</desc>
13388	<param name="cpuId" type="unsigned long" dir="in">
13389	<desc>The identifier of the Virtual CPU.</desc>
13390	</param>
13391	<param name="address" type="long long" dir="in">
13392	<desc>The guest virtual address.</desc>
13393	</param>
13394	<param name="size" type="unsigned long" dir="in">
13395	<desc>The number of bytes to read.</desc>
13396	</param>
13397	<param name="bytes" type="octet" safearray="yes" dir="in">
13398	<desc>The bytes to write.</desc>
13399	</param>
13400	</method>
13401
13402	<method name="detectOS">
13403	<desc>
13404	Tries to (re-)detect the guest OS kernel.
13405
13406	This feature is not implemented in the 4.0.0 release but may show up
13407	in a dot release.
13408	</desc>
13409	<param name="os" type="wstring" dir="return">
13410	<desc>
13411	The detected OS kernel on success.
13412	</desc>
13413	</param>
13414	</method>
13415
13416	<method name="getRegister">
13417	<desc>
13418	Gets one register.
13419
13420	This feature is not implemented in the 4.0.0 release but may show up
13421	in a dot release.
13422	</desc>
13423	<param name="cpuId" type="unsigned long" dir="in">
13424	<desc>The identifier of the Virtual CPU.</desc>
13425	</param>
13426	<param name="name" type="wstring" dir="in">
13427	<desc>The register name, case is ignored.</desc>
13428	</param>
13429	<param name="value" type="wstring" dir="return">
13430	<desc>
13431	The register value. This is usually a hex value (always 0x prefixed)
13432	but other format may be used for floating point registers (TBD).
13433	</desc>
13434	</param>
13435	</method>
13436
13437	<method name="getRegisters">
13438	<desc>
13439	Gets all the registers for the given CPU.
13440
13441	This feature is not implemented in the 4.0.0 release but may show up
13442	in a dot release.
13443	</desc>
13444	<param name="cpuId" type="unsigned long" dir="in">
13445	<desc>The identifier of the Virtual CPU.</desc>
13446	</param>
13447	<param name="names" type="wstring" dir="out" safearray="yes">
13448	<desc>Array containing the lowercase register names.</desc>
13449	</param>
13450	<param name="values" type="wstring" dir="out" safearray="yes">
13451	<desc>
13452	Array paralell to the names holding the register values as if the
13453	register was returned by <link to="IMachineDebugger::getRegister"/>.
13454	</desc>
13455	</param>
13456	</method>
13457
13458	<method name="setRegister">
13459	<desc>
13460	Gets one register.
13461
13462	This feature is not implemented in the 4.0.0 release but may show up
13463	in a dot release.
13464	</desc>
13465	<param name="cpuId" type="unsigned long" dir="in">
13466	<desc>The identifier of the Virtual CPU.</desc>
13467	</param>
13468	<param name="name" type="wstring" dir="in">
13469	<desc>The register name, case is ignored.</desc>
13470	</param>
13471	<param name="value" type="wstring" dir="in">
13472	<desc>
13473	The new register value. Hexadecimal, decimal and octal formattings
13474	are supported in addition to any special formattings returned by
13475	the getters.
13476	</desc>
13477	</param>
13478	</method>
13479
13480	<method name="setRegisters">
13481	<desc>
13482	Sets zero or more registers atomically.
13483
13484	This feature is not implemented in the 4.0.0 release but may show up
13485	in a dot release.
13486	</desc>
13487	<param name="cpuId" type="unsigned long" dir="in">
13488	<desc>The identifier of the Virtual CPU.</desc>
13489	</param>
13490	<param name="names" type="wstring" dir="in" safearray="yes">
13491	<desc>Array containing the register names, case ignored.</desc>
13492	</param>
13493	<param name="values" type="wstring" dir="in" safearray="yes">
13494	<desc>
13495	Array paralell to the names holding the register values. See
13496	<link to="IMachineDebugger::setRegister"/> for formatting
13497	guidelines.
13498	</desc>
13499	</param>
13500	</method>
13501
13502	<method name="dumpGuestStack">
13503	<desc>
13504	Produce a simple stack dump using the current guest state.
13505
13506	This feature is not implemented in the 4.0.0 release but may show up
13507	in a dot release.
13508	</desc>
13509	<param name="cpuId" type="unsigned long" dir="in">
13510	<desc>The identifier of the Virtual CPU.</desc>
13511	</param>
13512	<param name="stack" type="wstring" dir="return">
13513	<desc>String containing the formatted stack dump.</desc>
13514	</param>
13515	</method>
13516
13517	<method name="resetStats">
13518	<desc>
13519	Reset VM statistics.
13520	</desc>
13521	<param name="pattern" type="wstring" dir="in">
13522	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13523	</param>
13524	</method>
13525
13526	<method name="dumpStats">
13527	<desc>
13528	Dumps VM statistics.
13529	</desc>
13530	<param name="pattern" type="wstring" dir="in">
13531	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13532	</param>
13533	</method>
13534
13535	<method name="getStats">
13536	<desc>
13537	Get the VM statistics in a XMLish format.
13538	</desc>
13539	<param name="pattern" type="wstring" dir="in">
13540	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13541	</param>
13542	<param name="withDescriptions" type="boolean" dir="in">
13543	<desc>Whether to include the descriptions.</desc>
13544	</param>
13545	<param name="stats" type="wstring" dir="out">
13546	<desc>The XML document containing the statistics.</desc>
13547	</param>
13548	</method>
13549
13550	<attribute name="singleStep" type="boolean">
13551	<desc>Switch for enabling single-stepping.</desc>
13552	</attribute>
13553
13554	<attribute name="recompileUser" type="boolean">
13555	<desc>Switch for forcing code recompilation for user mode code.</desc>
13556	</attribute>
13557
13558	<attribute name="recompileSupervisor" type="boolean">
13559	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13560	</attribute>
13561
13562	<attribute name="PATMEnabled" type="boolean">
13563	<desc>Switch for enabling and disabling the PATM component.</desc>
13564	</attribute>
13565
13566	<attribute name="CSAMEnabled" type="boolean">
13567	<desc>Switch for enabling and disabling the CSAM component.</desc>
13568	</attribute>
13569
13570	<attribute name="logEnabled" type="boolean">
13571	<desc>Switch for enabling and disabling the debug logger.</desc>
13572	</attribute>
13573
13574	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13575	<desc>The debug logger flags.</desc>
13576	</attribute>
13577
13578	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13579	<desc>The debug logger's group settings.</desc>
13580	</attribute>
13581
13582	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13583	<desc>The debug logger's destination settings.</desc>
13584	</attribute>
13585
13586	<attribute name="logRelFlags" type="wstring" readonly="yes">
13587	<desc>The release logger flags.</desc>
13588	</attribute>
13589
13590	<attribute name="logRelGroups" type="wstring" readonly="yes">
13591	<desc>The release logger's group settings.</desc>
13592	</attribute>
13593
13594	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13595	<desc>The relase logger's destination settings.</desc>
13596	</attribute>
13597
13598	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13599	<desc>
13600	Flag indicating whether the VM is currently making use of CPU hardware
13601	virtualization extensions.
13602	</desc>
13603	</attribute>
13604
13605	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13606	<desc>
13607	Flag indicating whether the VM is currently making use of the nested paging
13608	CPU hardware virtualization extension.
13609	</desc>
13610	</attribute>
13611
13612	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13613	<desc>
13614	Flag indicating whether the VM is currently making use of the VPID
13615	VT-x extension.
13616	</desc>
13617	</attribute>
13618
13619	<attribute name="OSName" type="wstring" readonly="yes">
13620	<desc>
13621	Query the guest OS kernel name as detected by the DBGF.
13622
13623	This feature is not implemented in the 4.0.0 release but may show up
13624	in a dot release.
13625	</desc>
13626	</attribute>
13627
13628	<attribute name="OSVersion" type="wstring" readonly="yes">
13629	<desc>
13630	Query the guest OS kernel version string as detected by the DBGF.
13631
13632	This feature is not implemented in the 4.0.0 release but may show up
13633	in a dot release.
13634	</desc>
13635	</attribute>
13636
13637	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13638	<desc>
13639	Flag indicating whether the VM is currently making use of the Physical
13640	Address Extension CPU feature.
13641	</desc>
13642	</attribute>
13643
13644	<attribute name="virtualTimeRate" type="unsigned long">
13645	<desc>
13646	The rate at which the virtual time runs expressed as a percentage.
13647	The accepted range is 2% to 20000%.
13648	</desc>
13649	</attribute>
13650
13651	<attribute name="VM" type="long long" readonly="yes">
13652	<desc>
13653	Gets the VM handle. This is only for internal use while
13654	we carve the details of this interface.
13655	</desc>
13656	</attribute>
13657
13658	</interface>
13659
13660	<!--
13661	// IUSBController
13662	/////////////////////////////////////////////////////////////////////////
13663	-->
13664
13665	<interface
13666	name="IUSBController" extends="$unknown"
13667	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13668	wsmap="managed"
13669	>
13670	<attribute name="enabled" type="boolean">
13671	<desc>
13672	Flag whether the USB controller is present in the
13673	guest system. If disabled, the virtual guest hardware will
13674	not contain any USB controller. Can only be changed when
13675	the VM is powered off.
13676	</desc>
13677	</attribute>
13678
13679	<attribute name="enabledEhci" type="boolean">
13680	<desc>
13681	Flag whether the USB EHCI controller is present in the
13682	guest system. If disabled, the virtual guest hardware will
13683	not contain a USB EHCI controller. Can only be changed when
13684	the VM is powered off.
13685	</desc>
13686	</attribute>
13687
13688	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13689	<desc>
13690	Flag whether there is an USB proxy available.
13691	</desc>
13692	</attribute>
13693
13694	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13695	<desc>
13696	USB standard version which the controller implements.
13697	This is a BCD which means that the major version is in the
13698	high byte and minor version is in the low byte.
13699	</desc>
13700	</attribute>
13701
13702	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13703	<desc>
13704	List of USB device filters associated with the machine.
13705
13706	If the machine is currently running, these filters are activated
13707	every time a new (supported) USB device is attached to the host
13708	computer that was not ignored by global filters
13709	(<link to="IHost::USBDeviceFilters"/>).
13710
13711	These filters are also activated when the machine is powered up.
13712	They are run against a list of all currently available USB
13713	devices (in states
13714	<link to="USBDeviceState_Available"/>,
13715	<link to="USBDeviceState_Busy"/>,
13716	<link to="USBDeviceState_Held"/>) that were not previously
13717	ignored by global filters.
13718
13719	If at least one filter matches the USB device in question, this
13720	device is automatically captured (attached to) the virtual USB
13721	controller of this machine.
13722
13723	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13724	</desc>
13725	</attribute>
13726
13727	<method name="createDeviceFilter">
13728	<desc>
13729	Creates a new USB device filter. All attributes except
13730	the filter name are set to empty (any match),
13731	<i>active</i> is @c false (the filter is not active).
13732
13733	The created filter can then be added to the list of filters using
13734	<link to="#insertDeviceFilter"/>.
13735
13736	<result name="VBOX_E_INVALID_VM_STATE">
13737	The virtual machine is not mutable.
13738	</result>
13739
13740	<see><link to="#deviceFilters"/></see>
13741	</desc>
13742	<param name="name" type="wstring" dir="in">
13743	<desc>
13744	Filter name. See <link to="IUSBDeviceFilter::name"/>
13745	for more info.
13746	</desc>
13747	</param>
13748	<param name="filter" type="IUSBDeviceFilter" dir="return">
13749	<desc>Created filter object.</desc>
13750	</param>
13751	</method>
13752
13753	<method name="insertDeviceFilter">
13754	<desc>
13755	Inserts the given USB device to the specified position
13756	in the list of filters.
13757
13758	Positions are numbered starting from <tt>0</tt>. If the specified
13759	position is equal to or greater than the number of elements in
13760	the list, the filter is added to the end of the collection.
13761
13762	<note>
13763	Duplicates are not allowed, so an attempt to insert a
13764	filter that is already in the collection, will return an
13765	error.
13766	</note>
13767
13768	<result name="VBOX_E_INVALID_VM_STATE">
13769	Virtual machine is not mutable.
13770	</result>
13771	<result name="E_INVALIDARG">
13772	USB device filter not created within this VirtualBox instance.
13773	</result>
13774	<result name="VBOX_E_INVALID_OBJECT_STATE">
13775	USB device filter already in list.
13776	</result>
13777
13778	<see><link to="#deviceFilters"/></see>
13779	</desc>
13780	<param name="position" type="unsigned long" dir="in">
13781	<desc>Position to insert the filter to.</desc>
13782	</param>
13783	<param name="filter" type="IUSBDeviceFilter" dir="in">
13784	<desc>USB device filter to insert.</desc>
13785	</param>
13786	</method>
13787
13788	<method name="removeDeviceFilter">
13789	<desc>
13790	Removes a USB device filter from the specified position in the
13791	list of filters.
13792
13793	Positions are numbered starting from <tt>0</tt>. Specifying a
13794	position equal to or greater than the number of elements in
13795	the list will produce an error.
13796
13797	<see><link to="#deviceFilters"/></see>
13798
13799	<result name="VBOX_E_INVALID_VM_STATE">
13800	Virtual machine is not mutable.
13801	</result>
13802	<result name="E_INVALIDARG">
13803	USB device filter list empty or invalid @a position.
13804	</result>
13805
13806	</desc>
13807	<param name="position" type="unsigned long" dir="in">
13808	<desc>Position to remove the filter from.</desc>
13809	</param>
13810	<param name="filter" type="IUSBDeviceFilter" dir="return">
13811	<desc>Removed USB device filter.</desc>
13812	</param>
13813	</method>
13814
13815	</interface>
13816
13817
13818	<!--
13819	// IUSBDevice
13820	/////////////////////////////////////////////////////////////////////////
13821	-->
13822
13823	<interface
13824	name="IUSBDevice" extends="$unknown"
13825	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13826	wsmap="managed"
13827	>
13828	<desc>
13829	The IUSBDevice interface represents a virtual USB device attached to the
13830	virtual machine.
13831
13832	A collection of objects implementing this interface is stored in the
13833	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13834	attached to a running virtual machine's USB controller.
13835	</desc>
13836
13837	<attribute name="id" type="uuid" mod="string" readonly="yes">
13838	<desc>
13839	Unique USB device ID. This ID is built from #vendorId,
13840	#productId, #revision and #serialNumber.
13841	</desc>
13842	</attribute>
13843
13844	<attribute name="vendorId" type="unsigned short" readonly="yes">
13845	<desc>Vendor ID.</desc>
13846	</attribute>
13847
13848	<attribute name="productId" type="unsigned short" readonly="yes">
13849	<desc>Product ID.</desc>
13850	</attribute>
13851
13852	<attribute name="revision" type="unsigned short" readonly="yes">
13853	<desc>
13854	Product revision number. This is a packed BCD represented as
13855	unsigned short. The high byte is the integer part and the low
13856	byte is the decimal.
13857	</desc>
13858	</attribute>
13859
13860	<attribute name="manufacturer" type="wstring" readonly="yes">
13861	<desc>Manufacturer string.</desc>
13862	</attribute>
13863
13864	<attribute name="product" type="wstring" readonly="yes">
13865	<desc>Product string.</desc>
13866	</attribute>
13867
13868	<attribute name="serialNumber" type="wstring" readonly="yes">
13869	<desc>Serial number string.</desc>
13870	</attribute>
13871
13872	<attribute name="address" type="wstring" readonly="yes">
13873	<desc>Host specific address of the device.</desc>
13874	</attribute>
13875
13876	<attribute name="port" type="unsigned short" readonly="yes">
13877	<desc>
13878	Host USB port number the device is physically
13879	connected to.
13880	</desc>
13881	</attribute>
13882
13883	<attribute name="version" type="unsigned short" readonly="yes">
13884	<desc>
13885	The major USB version of the device - 1 or 2.
13886	</desc>
13887	</attribute>
13888
13889	<attribute name="portVersion" type="unsigned short" readonly="yes">
13890	<desc>
13891	The major USB version of the host USB port the device is
13892	physically connected to - 1 or 2. For devices not connected to
13893	anything this will have the same value as the version attribute.
13894	</desc>
13895	</attribute>
13896
13897	<attribute name="remote" type="boolean" readonly="yes">
13898	<desc>
13899	Whether the device is physically connected to a remote VRDE
13900	client or to a local host machine.
13901	</desc>
13902	</attribute>
13903
13904	</interface>
13905
13906
13907	<!--
13908	// IUSBDeviceFilter
13909	/////////////////////////////////////////////////////////////////////////
13910	-->
13911
13912	<interface
13913	name="IUSBDeviceFilter" extends="$unknown"
13914	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
13915	wsmap="managed"
13916	>
13917	<desc>
13918	The IUSBDeviceFilter interface represents an USB device filter used
13919	to perform actions on a group of USB devices.
13920
13921	This type of filters is used by running virtual machines to
13922	automatically capture selected USB devices once they are physically
13923	attached to the host computer.
13924
13925	A USB device is matched to the given device filter if and only if all
13926	attributes of the device match the corresponding attributes of the
13927	filter (that is, attributes are joined together using the logical AND
13928	operation). On the other hand, all together, filters in the list of
13929	filters carry the semantics of the logical OR operation. So if it is
13930	desirable to create a match like "this vendor id OR this product id",
13931	one needs to create two filters and specify "any match" (see below)
13932	for unused attributes.
13933
13934	All filter attributes used for matching are strings. Each string
13935	is an expression representing a set of values of the corresponding
13936	device attribute, that will match the given filter. Currently, the
13937	following filtering expressions are supported:
13938
13939	<ul>
13940	<li><i>Interval filters</i>. Used to specify valid intervals for
13941	integer device attributes (Vendor ID, Product ID and Revision).
13942	The format of the string is:
13943
13944	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13945
13946	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
13947	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
13948	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
13949	is omitted before a dash (<tt>-</tt>), the minimum possible integer
13950	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
13951	possible integer is assumed.
13952	</li>
13953	<li><i>Boolean filters</i>. Used to specify acceptable values for
13954	boolean device attributes. The format of the string is:
13955
13956	<tt>true\|false\|yes\|no\|0\|1</tt>
13957
13958	</li>
13959	<li><i>Exact match</i>. Used to specify a single value for the given
13960	device attribute. Any string that doesn't start with <tt>int:</tt>
13961	represents the exact match. String device attributes are compared to
13962	this string including case of symbols. Integer attributes are first
13963	converted to a string (see individual filter attributes) and then
13964	compared ignoring case.
13965
13966	</li>
13967	<li><i>Any match</i>. Any value of the corresponding device attribute
13968	will match the given filter. An empty or @c null string is
13969	used to construct this type of filtering expressions.
13970
13971	</li>
13972	</ul>
13973
13974	<note>
13975	On the Windows host platform, interval filters are not currently
13976	available. Also all string filter attributes
13977	(<link to="#manufacturer"/>, <link to="#product"/>,
13978	<link to="#serialNumber"/>) are ignored, so they behave as
13979	<i>any match</i> no matter what string expression is specified.
13980	</note>
13981
13982	<see><link to="IUSBController::deviceFilters"/>,
13983	<link to="IHostUSBDeviceFilter"/></see>
13984	</desc>
13985
13986	<attribute name="name" type="wstring">
13987	<desc>
13988	Visible name for this filter.
13989	This name is used to visually distinguish one filter from another,
13990	so it can neither be @c null nor an empty string.
13991	</desc>
13992	</attribute>
13993
13994	<attribute name="active" type="boolean">
13995	<desc>Whether this filter active or has been temporarily disabled.</desc>
13996	</attribute>
13997
13998	<attribute name="vendorId" type="wstring">
13999	<desc>
14000	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14001	The string representation for the <i>exact matching</i>
14002	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14003	(including leading zeroes).
14004	</desc>
14005	</attribute>
14006
14007	<attribute name="productId" type="wstring">
14008	<desc>
14009	<link to="IUSBDevice::productId">Product ID</link> filter.
14010	The string representation for the <i>exact matching</i>
14011	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14012	(including leading zeroes).
14013	</desc>
14014	</attribute>
14015
14016	<attribute name="revision" type="wstring">
14017	<desc>
14018	<link to="IUSBDevice::productId">Product revision number</link>
14019	filter. The string representation for the <i>exact matching</i>
14020	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14021	of the integer part of the revision, and <tt>F</tt> is the
14022	decimal digit of its fractional part (including leading and
14023	trailing zeros).
14024	Note that for interval filters, it's best to use the hexadecimal
14025	form, because the revision is stored as a 16 bit packed BCD value;
14026	so the expression <tt>int:0x0100-0x0199</tt> will match any
14027	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14028	</desc>
14029	</attribute>
14030
14031	<attribute name="manufacturer" type="wstring">
14032	<desc>
14033	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14034	</desc>
14035	</attribute>
14036
14037	<attribute name="product" type="wstring">
14038	<desc>
14039	<link to="IUSBDevice::product">Product</link> filter.
14040	</desc>
14041	</attribute>
14042
14043	<attribute name="serialNumber" type="wstring">
14044	<desc>
14045	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14046	</desc>
14047	</attribute>
14048
14049	<attribute name="port" type="wstring">
14050	<desc>
14051	<link to="IUSBDevice::port">Host USB port</link> filter.
14052	</desc>
14053	</attribute>
14054
14055	<attribute name="remote" type="wstring">
14056	<desc>
14057	<link to="IUSBDevice::remote">Remote state</link> filter.
14058	<note>
14059	This filter makes sense only for machine USB filters,
14060	i.e. it is ignored by IHostUSBDeviceFilter objects.
14061	</note>
14062	</desc>
14063	</attribute>
14064
14065	<attribute name="maskedInterfaces" type="unsigned long">
14066	<desc>
14067	This is an advanced option for hiding one or more USB interfaces
14068	from the guest. The value is a bit mask where the bits that are set
14069	means the corresponding USB interface should be hidden, masked off
14070	if you like.
14071	This feature only works on Linux hosts.
14072	</desc>
14073	</attribute>
14074
14075	</interface>
14076
14077
14078	<!--
14079	// IHostUSBDevice
14080	/////////////////////////////////////////////////////////////////////////
14081	-->
14082
14083	<enum
14084	name="USBDeviceState"
14085	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14086	>
14087	<desc>
14088	USB device state. This enumeration represents all possible states
14089	of the USB device physically attached to the host computer regarding
14090	its state on the host computer and availability to guest computers
14091	(all currently running virtual machines).
14092
14093	Once a supported USB device is attached to the host, global USB
14094	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14095	either ignore the device, or put it to USBDeviceState_Held state, or do
14096	nothing. Unless the device is ignored by global filters, filters of all
14097	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14098	activated that can put it to USBDeviceState_Captured state.
14099
14100	If the device was ignored by global filters, or didn't match
14101	any filters at all (including guest ones), it is handled by the host
14102	in a normal way. In this case, the device state is determined by
14103	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14104	or USBDeviceState_Available, depending on the current device usage.
14105
14106	Besides auto-capturing based on filters, the device can be manually
14107	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14108	state is USBDeviceState_Busy, USBDeviceState_Available or
14109	USBDeviceState_Held.
14110
14111	<note>
14112	Due to differences in USB stack implementations in Linux and Win32,
14113	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14114	only to the Linux version of the product. This also means that (<link
14115	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14116	device state is USBDeviceState_Held.
14117	</note>
14118
14119	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14120	</desc>
14121
14122	<const name="NotSupported" value="0">
14123	<desc>
14124	Not supported by the VirtualBox server, not available to guests.
14125	</desc>
14126	</const>
14127	<const name="Unavailable" value="1">
14128	<desc>
14129	Being used by the host computer exclusively,
14130	not available to guests.
14131	</desc>
14132	</const>
14133	<const name="Busy" value="2">
14134	<desc>
14135	Being used by the host computer, potentially available to guests.
14136	</desc>
14137	</const>
14138	<const name="Available" value="3">
14139	<desc>
14140	Not used by the host computer, available to guests (the host computer
14141	can also start using the device at any time).
14142	</desc>
14143	</const>
14144	<const name="Held" value="4">
14145	<desc>
14146	Held by the VirtualBox server (ignored by the host computer),
14147	available to guests.
14148	</desc>
14149	</const>
14150	<const name="Captured" value="5">
14151	<desc>
14152	Captured by one of the guest computers, not available
14153	to anybody else.
14154	</desc>
14155	</const>
14156	</enum>
14157
14158	<interface
14159	name="IHostUSBDevice" extends="IUSBDevice"
14160	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14161	wsmap="managed"
14162	>
14163	<desc>
14164	The IHostUSBDevice interface represents a physical USB device attached
14165	to the host computer.
14166
14167	Besides properties inherited from IUSBDevice, this interface adds the
14168	<link to="#state"/> property that holds the current state of the USB
14169	device.
14170
14171	<see><link to="IHost::USBDevices"/>,
14172	<link to="IHost::USBDeviceFilters"/></see>
14173	</desc>
14174
14175	<attribute name="state" type="USBDeviceState" readonly="yes">
14176	<desc>
14177	Current state of the device.
14178	</desc>
14179	</attribute>
14180
14181	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14182
14183	</interface>
14184
14185
14186	<!--
14187	// IHostUSBDeviceFilter
14188	/////////////////////////////////////////////////////////////////////////
14189	-->
14190
14191	<enum
14192	name="USBDeviceFilterAction"
14193	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14194	>
14195	<desc>
14196	Actions for host USB device filters.
14197	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14198	</desc>
14199
14200	<const name="Null" value="0">
14201	<desc>Null value (never used by the API).</desc>
14202	</const>
14203	<const name="Ignore" value="1">
14204	<desc>Ignore the matched USB device.</desc>
14205	</const>
14206	<const name="Hold" value="2">
14207	<desc>Hold the matched USB device.</desc>
14208	</const>
14209	</enum>
14210
14211	<interface
14212	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14213	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14214	wsmap="managed"
14215	>
14216	<desc>
14217	The IHostUSBDeviceFilter interface represents a global filter for a
14218	physical USB device used by the host computer. Used indirectly in
14219	<link to="IHost::USBDeviceFilters"/>.
14220
14221	Using filters of this type, the host computer determines the initial
14222	state of the USB device after it is physically attached to the
14223	host's USB controller.
14224
14225	<note>
14226	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14227	filters, because it makes sense only for
14228	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14229	</note>
14230
14231	<see><link to="IHost::USBDeviceFilters"/></see>
14232	</desc>
14233
14234	<attribute name="action" type="USBDeviceFilterAction">
14235	<desc>
14236	Action performed by the host when an attached USB device
14237	matches this filter.
14238	</desc>
14239	</attribute>
14240
14241	</interface>
14242
14243	<!--
14244	// IAudioAdapter
14245	/////////////////////////////////////////////////////////////////////////
14246	-->
14247
14248	<enum
14249	name="AudioDriverType"
14250	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14251	>
14252	<desc>
14253	Host audio driver type.
14254	</desc>
14255
14256	<const name="Null" value="0">
14257	<desc>Null value, also means "dummy audio driver".</desc>
14258	</const>
14259	<const name="WinMM" value="1">
14260	<desc>Windows multimedia (Windows hosts only).</desc>
14261	</const>
14262	<const name="OSS" value="2">
14263	<desc>Open Sound System (Linux hosts only).</desc>
14264	</const>
14265	<const name="ALSA" value="3">
14266	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14267	</const>
14268	<const name="DirectSound" value="4">
14269	<desc>DirectSound (Windows hosts only).</desc>
14270	</const>
14271	<const name="CoreAudio" value="5">
14272	<desc>CoreAudio (Mac hosts only).</desc>
14273	</const>
14274	<const name="MMPM" value="6">
14275	<desc>Reserved for historical reasons.</desc>
14276	</const>
14277	<const name="Pulse" value="7">
14278	<desc>PulseAudio (Linux hosts only).</desc>
14279	</const>
14280	<const name="SolAudio" value="8">
14281	<desc>Solaris audio (Solaris hosts only).</desc>
14282	</const>
14283	</enum>
14284
14285	<enum
14286	name="AudioControllerType"
14287	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14288	>
14289	<desc>
14290	Virtual audio controller type.
14291	</desc>
14292
14293	<const name="AC97" value="0"/>
14294	<const name="SB16" value="1"/>
14295	<const name="HDA" value="2"/>
14296	</enum>
14297
14298	<interface
14299	name="IAudioAdapter" extends="$unknown"
14300	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14301	wsmap="managed"
14302	>
14303	<desc>
14304	The IAudioAdapter interface represents the virtual audio adapter of
14305	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14306	</desc>
14307	<attribute name="enabled" type="boolean">
14308	<desc>
14309	Flag whether the audio adapter is present in the
14310	guest system. If disabled, the virtual guest hardware will
14311	not contain any audio adapter. Can only be changed when
14312	the VM is not running.
14313	</desc>
14314	</attribute>
14315	<attribute name="audioController" type="AudioControllerType">
14316	<desc>
14317	The audio hardware we emulate.
14318	</desc>
14319	</attribute>
14320	<attribute name="audioDriver" type="AudioDriverType">
14321	<desc>
14322	Audio driver the adapter is connected to. This setting
14323	can only be changed when the VM is not running.
14324	</desc>
14325	</attribute>
14326	</interface>
14327
14328	<enum
14329	name="AuthType"
14330	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14331	>
14332	<desc>
14333	VirtualBox authentication type.
14334	</desc>
14335
14336	<const name="Null" value="0">
14337	<desc>Null value, also means "no authentication".</desc>
14338	</const>
14339	<const name="External" value="1"/>
14340	<const name="Guest" value="2"/>
14341	</enum>
14342
14343	<!--
14344	// IVRDEServer
14345	/////////////////////////////////////////////////////////////////////////
14346	-->
14347
14348	<interface
14349	name="IVRDEServer" extends="$unknown"
14350	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14351	wsmap="managed"
14352	>
14353	<attribute name="enabled" type="boolean">
14354	<desc>VRDE server status.</desc>
14355	</attribute>
14356
14357	<attribute name="authType" type="AuthType">
14358	<desc>VRDE authentication method.</desc>
14359	</attribute>
14360
14361	<attribute name="authTimeout" type="unsigned long">
14362	<desc>Timeout for guest authentication. Milliseconds.</desc>
14363	</attribute>
14364
14365	<attribute name="allowMultiConnection" type="boolean">
14366	<desc>
14367	Flag whether multiple simultaneous connections to the VM are permitted.
14368	Note that this will be replaced by a more powerful mechanism in the future.
14369	</desc>
14370	</attribute>
14371
14372	<attribute name="reuseSingleConnection" type="boolean">
14373	<desc>
14374	Flag whether the existing connection must be dropped and a new connection
14375	must be established by the VRDE server, when a new client connects in single
14376	connection mode.
14377	</desc>
14378	</attribute>
14379
14380	<attribute name="VRDEExtPack" type="wstring">
14381	<desc>
14382	The name of Extension Pack providing VRDE for this VM. Overrides
14383	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14384	</desc>
14385	</attribute>
14386
14387	<attribute name="authLibrary" type="wstring">
14388	<desc>
14389	Library used for authentication of RDP clients by this VM. Overrides
14390	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14391	</desc>
14392	</attribute>
14393
14394	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14395	<desc>
14396	Array of names of properties, which are supported by this VRDE server.
14397	</desc>
14398	</attribute>
14399
14400	<method name="setVRDEProperty">
14401	<desc>
14402	Sets a VRDE specific property string.
14403
14404	If you pass @c null or empty string as a key @a value, the given @a key
14405	will be deleted.
14406
14407	</desc>
14408	<param name="key" type="wstring" dir="in">
14409	<desc>Name of the key to set.</desc>
14410	</param>
14411	<param name="value" type="wstring" dir="in">
14412	<desc>Value to assign to the key.</desc>
14413	</param>
14414	</method>
14415
14416	<method name="getVRDEProperty" const="yes">
14417	<desc>
14418	Returns a VRDE specific property string.
14419
14420	If the requested data @a key does not exist, this function will
14421	succeed and return an empty string in the @a value argument.
14422
14423	</desc>
14424	<param name="key" type="wstring" dir="in">
14425	<desc>Name of the key to get.</desc>
14426	</param>
14427	<param name="value" type="wstring" dir="return">
14428	<desc>Value of the requested key.</desc>
14429	</param>
14430	</method>
14431
14432	</interface>
14433
14434
14435	<!--
14436	// ISharedFolder
14437	/////////////////////////////////////////////////////////////////////////
14438	-->
14439
14440	<interface
14441	name="ISharedFolder" extends="$unknown"
14442	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14443	wsmap="struct"
14444	>
14445	<desc>
14446	The ISharedFolder interface represents a folder in the host computer's
14447	file system accessible from the guest OS running inside a virtual
14448	machine using an associated logical name.
14449
14450	There are three types of shared folders:
14451	<ul>
14452	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14453	folders available to all virtual machines.</li>
14454	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14455	VM-specific shared folders available to the given virtual machine at
14456	startup.</li>
14457	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14458	VM-specific shared folders created in the session context (for
14459	example, when the virtual machine is running) and automatically
14460	discarded when the session is closed (the VM is powered off).</li>
14461	</ul>
14462
14463	Logical names of shared folders must be unique within the given scope
14464	(global, permanent or transient). However, they do not need to be unique
14465	across scopes. In this case, the definition of the shared folder in a
14466	more specific scope takes precedence over definitions in all other
14467	scopes. The order of precedence is (more specific to more general):
14468	<ol>
14469	<li>Transient definitions</li>
14470	<li>Permanent definitions</li>
14471	<li>Global definitions</li>
14472	</ol>
14473
14474	For example, if MyMachine has a shared folder named
14475	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14476	transient shared folder named <tt>C_DRIVE</tt> (that points
14477	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14478	of <tt>C_DRIVE</tt> in the guest OS so
14479	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14480	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14481	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14482	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14483	to <tt>C:\\</tt> if it still exists.
14484
14485	Note that permanent and transient shared folders of different machines
14486	are in different name spaces, so they don't overlap and don't need to
14487	have unique logical names.
14488
14489	<note>
14490	Global shared folders are not implemented in the current version of the
14491	product.
14492	</note>
14493	</desc>
14494
14495	<attribute name="name" type="wstring" readonly="yes">
14496	<desc>Logical name of the shared folder.</desc>
14497	</attribute>
14498
14499	<attribute name="hostPath" type="wstring" readonly="yes">
14500	<desc>Full path to the shared folder in the host file system.</desc>
14501	</attribute>
14502
14503	<attribute name="accessible" type="boolean" readonly="yes">
14504	<desc>
14505	Whether the folder defined by the host path is currently
14506	accessible or not.
14507	For example, the folder can be inaccessible if it is placed
14508	on the network share that is not available by the time
14509	this property is read.
14510	</desc>
14511	</attribute>
14512
14513	<attribute name="writable" type="boolean" readonly="yes">
14514	<desc>
14515	Whether the folder defined by the host path is writable or
14516	not.
14517	</desc>
14518	</attribute>
14519
14520	<attribute name="autoMount" type="boolean" readonly="yes">
14521	<desc>
14522	Whether the folder gets automatically mounted by the guest or not.
14523	</desc>
14524	</attribute>
14525
14526	<attribute name="lastAccessError" type="wstring" readonly="yes">
14527	<desc>
14528	Text message that represents the result of the last accessibility
14529	check.
14530
14531	Accessibility checks are performed each time the <link to="#accessible"/>
14532	attribute is read. An empty string is returned if the last
14533	accessibility check was successful. A non-empty string indicates a
14534	failure and should normally describe a reason of the failure (for
14535	example, a file read error).
14536	</desc>
14537	</attribute>
14538
14539	</interface>
14540
14541	<!--
14542	// ISession
14543	/////////////////////////////////////////////////////////////////////////
14544	-->
14545
14546	<interface
14547	name="IInternalSessionControl" extends="$unknown"
14548	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
14549	internal="yes"
14550	wsmap="suppress"
14551	>
14552	<method name="getPID">
14553	<desc>PID of the process that has created this Session object.
14554	</desc>
14555	<param name="pid" type="unsigned long" dir="return"/>
14556	</method>
14557
14558	<method name="getRemoteConsole">
14559	<desc>
14560	Returns the console object suitable for remote control.
14561
14562	<result name="VBOX_E_INVALID_VM_STATE">
14563	Session state prevents operation.
14564	</result>
14565	<result name="VBOX_E_INVALID_OBJECT_STATE">
14566	Session type prevents operation.
14567	</result>
14568
14569	</desc>
14570	<param name="console" type="IConsole" dir="return"/>
14571	</method>
14572
14573	<method name="assignMachine">
14574	<desc>
14575	Assigns the machine object associated with this direct-type
14576	session or informs the session that it will be a remote one
14577	(if @a machine == @c null).
14578
14579	<result name="VBOX_E_INVALID_VM_STATE">
14580	Session state prevents operation.
14581	</result>
14582	<result name="VBOX_E_INVALID_OBJECT_STATE">
14583	Session type prevents operation.
14584	</result>
14585
14586	</desc>
14587	<param name="machine" type="IMachine" dir="in"/>
14588	</method>
14589
14590	<method name="assignRemoteMachine">
14591	<desc>
14592	Assigns the machine and the (remote) console object associated with
14593	this remote-type session.
14594
14595	<result name="VBOX_E_INVALID_VM_STATE">
14596	Session state prevents operation.
14597	</result>
14598
14599	</desc>
14600	<param name="machine" type="IMachine" dir="in"/>
14601	<param name="console" type="IConsole" dir="in"/>
14602	</method>
14603
14604	<method name="updateMachineState">
14605	<desc>
14606	Updates the machine state in the VM process.
14607	Must be called only in certain cases
14608	(see the method implementation).
14609
14610	<result name="VBOX_E_INVALID_VM_STATE">
14611	Session state prevents operation.
14612	</result>
14613	<result name="VBOX_E_INVALID_OBJECT_STATE">
14614	Session type prevents operation.
14615	</result>
14616
14617	</desc>
14618	<param name="aMachineState" type="MachineState" dir="in"/>
14619	</method>
14620
14621	<method name="uninitialize">
14622	<desc>
14623	Uninitializes (closes) this session. Used by VirtualBox to close
14624	the corresponding remote session when the direct session dies
14625	or gets closed.
14626
14627	<result name="VBOX_E_INVALID_VM_STATE">
14628	Session state prevents operation.
14629	</result>
14630
14631	</desc>
14632	</method>
14633
14634	<method name="onNetworkAdapterChange">
14635	<desc>
14636	Triggered when settings of a network adapter of the
14637	associated virtual machine have changed.
14638
14639	<result name="VBOX_E_INVALID_VM_STATE">
14640	Session state prevents operation.
14641	</result>
14642	<result name="VBOX_E_INVALID_OBJECT_STATE">
14643	Session type prevents operation.
14644	</result>
14645
14646	</desc>
14647	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14648	<param name="changeAdapter" type="boolean" dir="in"/>
14649	</method>
14650
14651	<method name="onSerialPortChange">
14652	<desc>
14653	Triggered when settings of a serial port of the
14654	associated virtual machine have changed.
14655
14656	<result name="VBOX_E_INVALID_VM_STATE">
14657	Session state prevents operation.
14658	</result>
14659	<result name="VBOX_E_INVALID_OBJECT_STATE">
14660	Session type prevents operation.
14661	</result>
14662
14663	</desc>
14664	<param name="serialPort" type="ISerialPort" dir="in"/>
14665	</method>
14666
14667	<method name="onParallelPortChange">
14668	<desc>
14669	Triggered when settings of a parallel port of the
14670	associated virtual machine have changed.
14671
14672	<result name="VBOX_E_INVALID_VM_STATE">
14673	Session state prevents operation.
14674	</result>
14675	<result name="VBOX_E_INVALID_OBJECT_STATE">
14676	Session type prevents operation.
14677	</result>
14678
14679	</desc>
14680	<param name="parallelPort" type="IParallelPort" dir="in"/>
14681	</method>
14682
14683	<method name="onStorageControllerChange">
14684	<desc>
14685	Triggered when settings of a storage controller of the
14686	associated virtual machine have changed.
14687
14688	<result name="VBOX_E_INVALID_VM_STATE">
14689	Session state prevents operation.
14690	</result>
14691	<result name="VBOX_E_INVALID_OBJECT_STATE">
14692	Session type prevents operation.
14693	</result>
14694
14695	</desc>
14696	</method>
14697
14698	<method name="onMediumChange">
14699	<desc>
14700	Triggered when attached media of the
14701	associated virtual machine have changed.
14702
14703	<result name="VBOX_E_INVALID_VM_STATE">
14704	Session state prevents operation.
14705	</result>
14706	<result name="VBOX_E_INVALID_OBJECT_STATE">
14707	Session type prevents operation.
14708	</result>
14709
14710	</desc>
14711
14712	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14713	<desc>The medium attachment which changed.</desc>
14714	</param>
14715	<param name="force" type="boolean" dir="in">
14716	<desc>If the medium change was forced.</desc>
14717	</param>
14718	</method>
14719
14720	<method name="onStorageDeviceChange">
14721	<desc>
14722	Triggered when attached storage devices of the
14723	associated virtual machine have changed.
14724
14725	<result name="VBOX_E_INVALID_VM_STATE">
14726	Session state prevents operation.
14727	</result>
14728	<result name="VBOX_E_INVALID_OBJECT_STATE">
14729	Session type prevents operation.
14730	</result>
14731
14732	</desc>
14733
14734	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14735	<desc>The medium attachment which changed.</desc>
14736	</param>
14737	<param name="remove" type="boolean" dir="in">
14738	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14739	</param>
14740	</method>
14741
14742	<method name="onCPUChange">
14743	<desc>
14744	Notification when a CPU changes.
14745	</desc>
14746	<param name="cpu" type="unsigned long" dir="in">
14747	<desc>The CPU which changed</desc>
14748	</param>
14749	<param name="add" type="boolean" dir="in">
14750	<desc>Flag whether the CPU was added or removed</desc>
14751	</param>
14752	</method>
14753
14754	<method name="onCPUExecutionCapChange">
14755	<desc>
14756	Notification when the CPU execution cap changes.
14757	</desc>
14758	<param name="executionCap" type="unsigned long" dir="in">
14759	<desc>The new CPU execution cap value. (1-100)</desc>
14760	</param>
14761	</method>
14762
14763	<method name="onVRDEServerChange">
14764	<desc>
14765	Triggered when settings of the VRDE server object of the
14766	associated virtual machine have changed.
14767
14768	<result name="VBOX_E_INVALID_VM_STATE">
14769	Session state prevents operation.
14770	</result>
14771	<result name="VBOX_E_INVALID_OBJECT_STATE">
14772	Session type prevents operation.
14773	</result>
14774
14775	</desc>
14776	<param name="restart" type="boolean" dir="in">
14777	<desc>Flag whether the server must be restarted</desc>
14778	</param>
14779	</method>
14780
14781	<method name="onUSBControllerChange">
14782	<desc>
14783	Triggered when settings of the USB controller object of the
14784	associated virtual machine have changed.
14785
14786	<result name="VBOX_E_INVALID_VM_STATE">
14787	Session state prevents operation.
14788	</result>
14789	<result name="VBOX_E_INVALID_OBJECT_STATE">
14790	Session type prevents operation.
14791	</result>
14792
14793	</desc>
14794	</method>
14795
14796	<method name="onSharedFolderChange">
14797	<desc>
14798	Triggered when a permanent (global or machine) shared folder has been
14799	created or removed.
14800	<note>
14801	We don't pass shared folder parameters in this notification because
14802	the order in which parallel notifications are delivered is not defined,
14803	therefore it could happen that these parameters were outdated by the
14804	time of processing this notification.
14805	</note>
14806
14807	<result name="VBOX_E_INVALID_VM_STATE">
14808	Session state prevents operation.
14809	</result>
14810	<result name="VBOX_E_INVALID_OBJECT_STATE">
14811	Session type prevents operation.
14812	</result>
14813
14814	</desc>
14815	<param name="global" type="boolean" dir="in"/>
14816	</method>
14817
14818	<method name="onUSBDeviceAttach">
14819	<desc>
14820	Triggered when a request to capture a USB device (as a result
14821	of matched USB filters or direct call to
14822	<link to="IConsole::attachUSBDevice"/>) has completed.
14823	A @c null @a error object means success, otherwise it
14824	describes a failure.
14825
14826	<result name="VBOX_E_INVALID_VM_STATE">
14827	Session state prevents operation.
14828	</result>
14829	<result name="VBOX_E_INVALID_OBJECT_STATE">
14830	Session type prevents operation.
14831	</result>
14832
14833	</desc>
14834	<param name="device" type="IUSBDevice" dir="in"/>
14835	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14836	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14837	</method>
14838
14839	<method name="onUSBDeviceDetach">
14840	<desc>
14841	Triggered when a request to release the USB device (as a result
14842	of machine termination or direct call to
14843	<link to="IConsole::detachUSBDevice"/>) has completed.
14844	A @c null @a error object means success, otherwise it
14845	describes a failure.
14846
14847	<result name="VBOX_E_INVALID_VM_STATE">
14848	Session state prevents operation.
14849	</result>
14850	<result name="VBOX_E_INVALID_OBJECT_STATE">
14851	Session type prevents operation.
14852	</result>
14853
14854	</desc>
14855	<param name="id" type="uuid" mod="string" dir="in"/>
14856	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14857	</method>
14858
14859	<method name="onShowWindow">
14860	<desc>
14861	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14862	<link to="IMachine::showConsoleWindow"/> in order to notify
14863	console listeners
14864	<link to="ICanShowWindowEvent"/>
14865	and <link to="IShowWindowEvent"/>.
14866
14867	<result name="VBOX_E_INVALID_OBJECT_STATE">
14868	Session type prevents operation.
14869	</result>
14870
14871	</desc>
14872	<param name="check" type="boolean" dir="in"/>
14873	<param name="canShow" type="boolean" dir="out"/>
14874	<param name="winId" type="long long" dir="out"/>
14875	</method>
14876
14877	<method name="onBandwidthGroupChange">
14878	<desc>
14879	Notification when one of the bandwidth groups change.
14880	</desc>
14881	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14882	<desc>The bandwidth group which changed.</desc>
14883	</param>
14884	</method>
14885
14886	<method name="accessGuestProperty">
14887	<desc>
14888	Called by <link to="IMachine::getGuestProperty"/> and by
14889	<link to="IMachine::setGuestProperty"/> in order to read and
14890	modify guest properties.
14891
14892	<result name="VBOX_E_INVALID_VM_STATE">
14893	Machine session is not open.
14894	</result>
14895	<result name="VBOX_E_INVALID_OBJECT_STATE">
14896	Session type is not direct.
14897	</result>
14898
14899	</desc>
14900	<param name="name" type="wstring" dir="in"/>
14901	<param name="value" type="wstring" dir="in"/>
14902	<param name="flags" type="wstring" dir="in"/>
14903	<param name="isSetter" type="boolean" dir="in"/>
14904	<param name="retValue" type="wstring" dir="out"/>
14905	<param name="retTimestamp" type="long long" dir="out"/>
14906	<param name="retFlags" type="wstring" dir="out"/>
14907	</method>
14908
14909	<method name="enumerateGuestProperties" const="yes">
14910	<desc>
14911	Return a list of the guest properties matching a set of patterns along
14912	with their values, time stamps and flags.
14913
14914	<result name="VBOX_E_INVALID_VM_STATE">
14915	Machine session is not open.
14916	</result>
14917	<result name="VBOX_E_INVALID_OBJECT_STATE">
14918	Session type is not direct.
14919	</result>
14920
14921	</desc>
14922	<param name="patterns" type="wstring" dir="in">
14923	<desc>
14924	The patterns to match the properties against as a comma-separated
14925	string. If this is empty, all properties currently set will be
14926	returned.
14927	</desc>
14928	</param>
14929	<param name="key" type="wstring" dir="out" safearray="yes">
14930	<desc>
14931	The key names of the properties returned.
14932	</desc>
14933	</param>
14934	<param name="value" type="wstring" dir="out" safearray="yes">
14935	<desc>
14936	The values of the properties returned. The array entries match the
14937	corresponding entries in the @a key array.
14938	</desc>
14939	</param>
14940	<param name="timestamp" type="long long" dir="out" safearray="yes">
14941	<desc>
14942	The time stamps of the properties returned. The array entries match
14943	the corresponding entries in the @a key array.
14944	</desc>
14945	</param>
14946	<param name="flags" type="wstring" dir="out" safearray="yes">
14947	<desc>
14948	The flags of the properties returned. The array entries match the
14949	corresponding entries in the @a key array.
14950	</desc>
14951	</param>
14952	</method>
14953
14954	<method name="onlineMergeMedium">
14955	<desc>
14956	Triggers online merging of a hard disk. Used internally when deleting
14957	a snapshot while a VM referring to the same hard disk chain is running.
14958
14959	<result name="VBOX_E_INVALID_VM_STATE">
14960	Machine session is not open.
14961	</result>
14962	<result name="VBOX_E_INVALID_OBJECT_STATE">
14963	Session type is not direct.
14964	</result>
14965
14966	</desc>
14967	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14968	<desc>The medium attachment to identify the medium chain.</desc>
14969	</param>
14970	<param name="sourceIdx" type="unsigned long" dir="in">
14971	<desc>The index of the source image in the chain.
14972	Redundant, but drastically reduces IPC.</desc>
14973	</param>
14974	<param name="targetIdx" type="unsigned long" dir="in">
14975	<desc>The index of the target image in the chain.
14976	Redundant, but drastically reduces IPC.</desc>
14977	</param>
14978	<param name="source" type="IMedium" dir="in">
14979	<desc>Merge source medium.</desc>
14980	</param>
14981	<param name="target" type="IMedium" dir="in">
14982	<desc>Merge target medium.</desc>
14983	</param>
14984	<param name="mergeForward" type="boolean" dir="in">
14985	<desc>Merge direction.</desc>
14986	</param>
14987	<param name="parentForTarget" type="IMedium" dir="in">
14988	<desc>For forward merges: new parent for target medium.</desc>
14989	</param>
14990	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
14991	<desc>For backward merges: list of media which need their parent UUID
14992	updated.</desc>
14993	</param>
14994	<param name="progress" type="IProgress" dir="in">
14995	<desc>
14996	Progress object for this operation.
14997	</desc>
14998	</param>
14999	</method>
15000
15001	</interface>
15002
15003	<interface
15004	name="ISession" extends="$unknown"
15005	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15006	wsmap="managed"
15007	>
15008	<desc>
15009	The ISession interface represents a client process and allows for locking
15010	virtual machines (represented by IMachine objects) to prevent conflicting
15011	changes to the machine.
15012
15013	Any caller wishing to manipulate a virtual machine needs to create a session
15014	object first, which lives in its own process space. Such session objects are
15015	then associated with <link to="IMachine" /> objects living in the VirtualBox
15016	server process to coordinate such changes.
15017
15018	There are two typical scenarios in which sessions are used:
15019
15020	<ul>
15021	<li>To alter machine settings or control a running virtual machine, one
15022	needs to lock a machine for a given session (client process) by calling
15023	<link to="IMachine::lockMachine"/>.
15024
15025	Whereas multiple sessions may control a running virtual machine, only
15026	one process can obtain a write lock on the machine to prevent conflicting
15027	changes. A write lock is also needed if a process wants to actually run a
15028	virtual machine in its own context, such as the VirtualBox GUI or
15029	VBoxHeadless front-ends. They must also lock a machine for their own
15030	sessions before they are allowed to power up the virtual machine.
15031
15032	As a result, no machine settings can be altered while another process is
15033	already using it, either because that process is modifying machine settings
15034	or because the machine is running.
15035	</li>
15036	<li>
15037	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15038	VirtualBox GUI or VBoxHeadless), one would use
15039	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15040	as its first parameter. This session then identifies the caller and lets the
15041	caller control the started machine (for example, pause machine execution or
15042	power it down) as well as be notified about machine execution state changes.
15043	</li>
15044	</ul>
15045
15046	How sessions objects are created in a client process depends on whether you use
15047	the Main API via COM or via the webservice:
15048
15049	<ul>
15050	<li>When using the COM API directly, an object of the Session class from the
15051	VirtualBox type library needs to be created. In regular COM C++ client code,
15052	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15053	This object will then act as a local session object in further calls to open
15054	a session.
15055	</li>
15056
15057	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15058	a session object automatically whenever <link to="IWebsessionManager::logon" />
15059	is called. A managed object reference to that session object can be retrieved by
15060	calling <link to="IWebsessionManager::getSessionObject" />.
15061	</li>
15062	</ul>
15063	</desc>
15064
15065	<attribute name="state" type="SessionState" readonly="yes">
15066	<desc>Current state of this session.</desc>
15067	</attribute>
15068
15069	<attribute name="type" type="SessionType" readonly="yes">
15070	<desc>
15071	Type of this session. The value of this attribute is valid only
15072	if the session currently has a machine locked (i.e. its
15073	<link to="#state" /> is Locked), otherwise an error will be returned.
15074	</desc>
15075	</attribute>
15076
15077	<attribute name="machine" type="IMachine" readonly="yes">
15078	<desc>Machine object associated with this session.</desc>
15079	</attribute>
15080
15081	<attribute name="console" type="IConsole" readonly="yes">
15082	<desc>Console object associated with this session.</desc>
15083	</attribute>
15084
15085	<method name="unlockMachine">
15086	<desc>
15087	Unlocks a machine that was previously locked for the current session.
15088
15089	Calling this method is required every time a machine has been locked
15090	for a particular session using the <link to="IMachine::launchVMProcess" />
15091	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15092	the machine will be set to <link to="MachineState_Aborted" /> on the
15093	server, and changes made to the machine settings will be lost.
15094
15095	Generally, it is recommended to unlock all machines explicitly
15096	before terminating the application (regardless of the reason for
15097	the termination).
15098
15099	<note>
15100	Do not expect the session state (<link to="ISession::state" />
15101	to return to "Unlocked" immediately after you invoke this method,
15102	particularly if you have started a new VM process. The session
15103	state will automatically return to "Unlocked" once the VM is no
15104	longer executing, which can of course take a very long time.
15105	</note>
15106
15107	<result name="E_UNEXPECTED">
15108	Session is not locked.
15109	</result>
15110
15111	</desc>
15112	</method>
15113
15114	</interface>
15115
15116	<!--
15117	// IStorageController
15118	/////////////////////////////////////////////////////////////////////////
15119	-->
15120
15121	<enum
15122	name="StorageBus"
15123	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15124	>
15125	<desc>
15126	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15127	see <link to="IStorageController::bus" />.
15128	</desc>
15129	<const name="Null" value="0">
15130	<desc>@c null value. Never used by the API.</desc>
15131	</const>
15132	<const name="IDE" value="1"/>
15133	<const name="SATA" value="2"/>
15134	<const name="SCSI" value="3"/>
15135	<const name="Floppy" value="4"/>
15136	<const name="SAS" value="5"/>
15137	</enum>
15138
15139	<enum
15140	name="StorageControllerType"
15141	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15142	>
15143	<desc>
15144	The exact variant of storage controller hardware presented
15145	to the guest; see <link to="IStorageController::controllerType" />.
15146	</desc>
15147
15148	<const name="Null" value="0">
15149	<desc>@c null value. Never used by the API.</desc>
15150	</const>
15151	<const name="LsiLogic" value="1">
15152	<desc>A SCSI controller of the LsiLogic variant.</desc>
15153	</const>
15154	<const name="BusLogic" value="2">
15155	<desc>A SCSI controller of the BusLogic variant.</desc>
15156	</const>
15157	<const name="IntelAhci" value="3">
15158	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15159	</const>
15160	<const name="PIIX3" value="4">
15161	<desc>An IDE controller of the PIIX3 variant.</desc>
15162	</const>
15163	<const name="PIIX4" value="5">
15164	<desc>An IDE controller of the PIIX4 variant.</desc>
15165	</const>
15166	<const name="ICH6" value="6">
15167	<desc>An IDE controller of the ICH6 variant.</desc>
15168	</const>
15169	<const name="I82078" value="7">
15170	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15171	</const>
15172	<const name="LsiLogicSas" value="8">
15173	<desc>A variant of the LsiLogic controller using SAS.</desc>
15174	</const>
15175	</enum>
15176
15177	<enum
15178	name="ChipsetType"
15179	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15180	>
15181	<desc>
15182	Type of emulated chipset (mostly southbridge).
15183	</desc>
15184
15185	<const name="Null" value="0">
15186	<desc>@c null value. Never used by the API.</desc>
15187	</const>
15188	<const name="PIIX3" value="1">
15189	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15190	</const>
15191	<const name="ICH9" value="2">
15192	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15193	</const>
15194	</enum>
15195
15196	<interface
15197	name="IStorageController" extends="$unknown"
15198	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15199	wsmap="managed"
15200	>
15201	<desc>
15202	Represents a storage controller that is attached to a virtual machine
15203	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15204	attached to storage controllers in a real computer, virtual drives
15205	(represented by <link to="IMediumAttachment" />) are attached to virtual
15206	storage controllers, represented by this interface.
15207
15208	As opposed to physical hardware, VirtualBox has a very generic concept
15209	of a storage controller, and for purposes of the Main API, all virtual
15210	storage is attached to virtual machines via instances of this interface.
15211	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15212	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15213	is used, certain sub-types may be available and can be selected in
15214	<link to="#controllerType" />.
15215
15216	Depending on these settings, the guest operating system might see
15217	significantly different virtual hardware.
15218	</desc>
15219
15220	<attribute name="name" type="wstring" readonly="yes">
15221	<desc>
15222	Name of the storage controller, as originally specified with
15223	<link to="IMachine::addStorageController" />. This then uniquely
15224	identifies this controller with other method calls such as
15225	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15226	</desc>
15227	</attribute>
15228
15229	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15230	<desc>
15231	Maximum number of devices which can be attached to one port.
15232	</desc>
15233	</attribute>
15234
15235	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15236	<desc>
15237	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15238	</desc>
15239	</attribute>
15240
15241	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15242	<desc>
15243	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15244	</desc>
15245	</attribute>
15246
15247	<attribute name="instance" type="unsigned long">
15248	<desc>
15249	The instance number of the device in the running VM.
15250	</desc>
15251	</attribute>
15252
15253	<attribute name="portCount" type="unsigned long">
15254	<desc>
15255	The number of currently usable ports on the controller.
15256	The minimum and maximum number of ports for one controller are
15257	stored in <link to="IStorageController::minPortCount"/>
15258	and <link to="IStorageController::maxPortCount"/>.
15259	</desc>
15260	</attribute>
15261
15262	<attribute name="bus" type="StorageBus" readonly="yes">
15263	<desc>
15264	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15265	</desc>
15266	</attribute>
15267
15268	<attribute name="controllerType" type="StorageControllerType">
15269	<desc>
15270	The exact variant of storage controller hardware presented
15271	to the guest.
15272	Depending on this value, VirtualBox will provide a different
15273	virtual storage controller hardware to the guest.
15274	For SATA, SAS and floppy controllers, only one variant is
15275	available, but for IDE and SCSI, there are several.
15276
15277	For SCSI controllers, the default type is LsiLogic.
15278	</desc>
15279	</attribute>
15280
15281	<attribute name="useHostIOCache" type="boolean">
15282	<desc>
15283	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15284	caches and use synchronous file APIs on the host. This was the only option in the API before
15285	VirtualBox 3.2 and is still the default for IDE controllers.
15286
15287	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15288	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15289	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15290	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15291	virtual machines are running at the same time to prevent I/O cache related hangs.
15292	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15293	</desc>
15294	</attribute>
15295
15296	<attribute name="bootable" type="boolean" readonly="yes">
15297	<desc>
15298	Returns whether it is possible to boot from disks attached to this controller.
15299	</desc>
15300	</attribute>
15301
15302	<method name="getIDEEmulationPort">
15303	<desc>
15304	Gets the corresponding port number which is emulated as an IDE device.
15305	Works only with SATA controllers.
15306
15307	<result name="E_INVALIDARG">
15308	The @a devicePosition is not in the range 0 to 3.
15309	</result>
15310	<result name="E_NOTIMPL">
15311	The storage controller type is not SATAIntelAhci.
15312	</result>
15313
15314	</desc>
15315	<param name="devicePosition" type="long" dir="in"/>
15316	<param name="portNumber" type="long" dir="return"/>
15317	</method>
15318
15319	<method name="setIDEEmulationPort">
15320	<desc>
15321	Sets the port number which is emulated as an IDE device.
15322	Works only with SATA controllers.
15323
15324	<result name="E_INVALIDARG">
15325	The @a devicePosition is not in the range 0 to 3 or the
15326	@a portNumber is not in the range 0 to 29.
15327	</result>
15328	<result name="E_NOTIMPL">
15329	The storage controller type is not SATAIntelAhci.
15330	</result>
15331
15332	</desc>
15333	<param name="devicePosition" type="long" dir="in"/>
15334	<param name="portNumber" type="long" dir="in"/>
15335	</method>
15336
15337	</interface>
15338
15339	<if target="wsdl">
15340
15341	<!--
15342	// IManagedObjectRef
15343	/////////////////////////////////////////////////////////////////////////
15344	-->
15345
15346	<interface
15347	name="IManagedObjectRef" extends="$unknown"
15348	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15349	internal="yes"
15350	wsmap="managed"
15351	wscpp="hardcoded"
15352	>
15353	<desc>
15354	Managed object reference.
15355
15356	Only within the webservice, a managed object reference (which is really
15357	an opaque number) allows a webservice client to address an object
15358	that lives in the address space of the webservice server.
15359
15360	Behind each managed object reference, there is a COM object that lives
15361	in the webservice server's address space. The COM object is not freed
15362	until the managed object reference is released, either by an explicit
15363	call to <link to="IManagedObjectRef::release" /> or by logging off from
15364	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15365	all objects created during the webservice session.
15366
15367	Whenever a method call of the VirtualBox API returns a COM object, the
15368	webservice representation of that method will instead return a
15369	managed object reference, which can then be used to invoke methods
15370	on that object.
15371	</desc>
15372
15373	<method name="getInterfaceName">
15374	<desc>
15375	Returns the name of the interface that this managed object represents,
15376	for example, "IMachine", as a string.
15377	</desc>
15378	<param name="return" type="wstring" dir="return"/>
15379	</method>
15380
15381	<method name="release">
15382	<desc>
15383	Releases this managed object reference and frees the resources that
15384	were allocated for it in the webservice server process. After calling
15385	this method, the identifier of the reference can no longer be used.
15386	</desc>
15387	</method>
15388
15389	</interface>
15390
15391	<!--
15392	// IWebsessionManager
15393	/////////////////////////////////////////////////////////////////////////
15394	-->
15395
15396	<interface
15397	name="IWebsessionManager" extends="$unknown"
15398	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15399	internal="yes"
15400	wsmap="global"
15401	wscpp="hardcoded"
15402	>
15403	<desc>
15404	Websession manager. This provides essential services
15405	to webservice clients.
15406	</desc>
15407	<method name="logon">
15408	<desc>
15409	Logs a new client onto the webservice and returns a managed object reference to
15410	the IVirtualBox instance, which the client can then use as a basis to further
15411	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15412	interface, in one way or the other.
15413	</desc>
15414	<param name="username" type="wstring" dir="in"/>
15415	<param name="password" type="wstring" dir="in"/>
15416	<param name="return" type="IVirtualBox" dir="return"/>
15417	</method>
15418
15419	<method name="getSessionObject">
15420	<desc>
15421	Returns a managed object reference to the internal ISession object that was created
15422	for this web service session when the client logged on.
15423
15424	<see><link to="ISession"/></see>
15425	</desc>
15426	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15427	<param name="return" type="ISession" dir="return"/>
15428	</method>
15429
15430	<method name="logoff">
15431	<desc>
15432	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
15433	and destroys all resources associated with the session (most importantly, all
15434	managed objects created in the server while the session was active).
15435	</desc>
15436	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15437	</method>
15438
15439	</interface>
15440
15441	</if>
15442
15443	<!--
15444	// IPerformanceCollector & friends
15445	/////////////////////////////////////////////////////////////////////////
15446	-->
15447
15448	<interface
15449	name="IPerformanceMetric" extends="$unknown"
15450	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15451	>
15452	<desc>
15453	The IPerformanceMetric interface represents parameters of the given
15454	performance metric.
15455	</desc>
15456
15457	<attribute name="metricName" type="wstring" readonly="yes">
15458	<desc>
15459	Name of the metric.
15460	</desc>
15461	</attribute>
15462
15463	<attribute name="object" type="$unknown" readonly="yes">
15464	<desc>
15465	Object this metric belongs to.
15466	</desc>
15467	</attribute>
15468
15469	<attribute name="description" type="wstring" readonly="yes">
15470	<desc>
15471	Textual description of the metric.
15472	</desc>
15473	</attribute>
15474
15475	<attribute name="period" type="unsigned long" readonly="yes">
15476	<desc>
15477	Time interval between samples, measured in seconds.
15478	</desc>
15479	</attribute>
15480
15481	<attribute name="count" type="unsigned long" readonly="yes">
15482	<desc>
15483	Number of recent samples retained by the performance collector for this
15484	metric.
15485
15486	When the collected sample count exceeds this number, older samples
15487	are discarded.
15488	</desc>
15489	</attribute>
15490
15491	<attribute name="unit" type="wstring" readonly="yes">
15492	<desc>
15493	Unit of measurement.
15494	</desc>
15495	</attribute>
15496
15497	<attribute name="minimumValue" type="long" readonly="yes">
15498	<desc>
15499	Minimum possible value of this metric.
15500	</desc>
15501	</attribute>
15502
15503	<attribute name="maximumValue" type="long" readonly="yes">
15504	<desc>
15505	Maximum possible value of this metric.
15506	</desc>
15507	</attribute>
15508	</interface>
15509
15510	<interface
15511	name="IPerformanceCollector" extends="$unknown"
15512	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15513	wsmap="managed"
15514	>
15515	<desc>
15516	The IPerformanceCollector interface represents a service that collects
15517	and stores performance metrics data.
15518
15519	Performance metrics are associated with objects of interfaces like IHost
15520	and IMachine. Each object has a distinct set of performance metrics. The
15521	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15522
15523	Metric data is collected at the specified intervals and is retained
15524	internally. The interval and the number of retained samples can be set
15525	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15526	and collection settings are not persistent, they are discarded as soon as
15527	VBoxSVC process terminates. Moreover, metric settings and data associated
15528	with a particular VM only exist while VM is running. They disappear as
15529	soon as VM shuts down. It is not possible to set up metrics for machines
15530	that are powered off. One needs to start VM first, then set up metric
15531	collection parameters.
15532
15533	Metrics are organized hierarchically, with each level separated by a
15534	slash (/) character. Generally, the scheme for metric names is like this:
15535
15536	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15537
15538	"Category/Metric" together form the base metric name. A base metric is
15539	the smallest unit for which a sampling interval and the number of
15540	retained samples can be set. Only base metrics can be enabled and
15541	disabled. All sub-metrics are collected when their base metric is
15542	collected. Collected values for any set of sub-metrics can be queried
15543	with <link to="IPerformanceCollector::queryMetricsData" />.
15544
15545	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15546	category, "Load" metric, "User" submetric, "average" aggregate. An
15547	aggregate function is computed over all retained data. Valid aggregate
15548	functions are:
15549
15550	<ul>
15551	<li>avg -- average</li>
15552	<li>min -- minimum</li>
15553	<li>max -- maximum</li>
15554	</ul>
15555
15556	When setting up metric parameters, querying metric data, enabling or
15557	disabling metrics wildcards can be used in metric names to specify a
15558	subset of metrics. For example, to select all CPU-related metrics
15559	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15560	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15561
15562	The valid names for base metrics are:
15563
15564	<ul>
15565	<li>CPU/Load</li>
15566	<li>CPU/MHz</li>
15567	<li>RAM/Usage</li>
15568	<li>RAM/VMM</li>
15569	</ul>
15570
15571	The general sequence for collecting and retrieving the metrics is:
15572	<ul>
15573	<li>
15574	Obtain an instance of IPerformanceCollector with
15575	<link to="IVirtualBox::performanceCollector" />
15576	</li>
15577	<li>
15578	Allocate and populate an array with references to objects the metrics
15579	will be collected for. Use references to IHost and IMachine objects.
15580	</li>
15581	<li>
15582	Allocate and populate an array with base metric names the data will
15583	be collected for.
15584	</li>
15585	<li>
15586	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15587	the metric data will be collected and stored.
15588	</li>
15589	<li>
15590	Wait for the data to get collected.
15591	</li>
15592	<li>
15593	Allocate and populate an array with references to objects the metric
15594	values will be queried for. You can re-use the object array used for
15595	setting base metrics.
15596	</li>
15597	<li>
15598	Allocate and populate an array with metric names the data will be
15599	collected for. Note that metric names differ from base metric names.
15600	</li>
15601	<li>
15602	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15603	that have been collected so far are returned. Note that the values
15604	are still retained internally and data collection continues.
15605	</li>
15606	</ul>
15607
15608	For an example of usage refer to the following files in VirtualBox SDK:
15609	<ul>
15610	<li>
15611	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15612	</li>
15613	<li>
15614	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15615	</li>
15616	</ul>
15617	</desc>
15618
15619	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15620	<desc>
15621	Array of unique names of metrics.
15622
15623	This array represents all metrics supported by the performance
15624	collector. Individual objects do not necessarily support all of them.
15625	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15626	list of supported metrics for a particular object.
15627	</desc>
15628	</attribute>
15629
15630	<method name="getMetrics">
15631	<desc>
15632	Returns parameters of specified metrics for a set of objects.
15633	<note>
15634	@c Null metrics array means all metrics. @c Null object array means
15635	all existing objects.
15636	</note>
15637	</desc>
15638	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15639	<desc>
15640	Metric name filter. Currently, only a comma-separated list of metrics
15641	is supported.
15642	</desc>
15643	</param>
15644	<param name="objects" type="$unknown" dir="in" safearray="yes">
15645	<desc>
15646	Set of objects to return metric parameters for.
15647	</desc>
15648	</param>
15649	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15650	<desc>
15651	Array of returned metric parameters.
15652	</desc>
15653	</param>
15654	</method>
15655
15656	<method name="setupMetrics">
15657	<desc>
15658	Sets parameters of specified base metrics for a set of objects. Returns
15659	an array of <link to="IPerformanceMetric" /> describing the metrics
15660	have been affected.
15661	<note>
15662	@c Null or empty metric name array means all metrics. @c Null or
15663	empty object array means all existing objects. If metric name array
15664	contains a single element and object array contains many, the single
15665	metric name array element is applied to each object array element to
15666	form metric/object pairs.
15667	</note>
15668	</desc>
15669	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15670	<desc>
15671	Metric name filter. Comma-separated list of metrics with wildcard
15672	support.
15673	</desc>
15674	</param>
15675	<param name="objects" type="$unknown" dir="in" safearray="yes">
15676	<desc>
15677	Set of objects to setup metric parameters for.
15678	</desc>
15679	</param>
15680	<param name="period" type="unsigned long" dir="in">
15681	<desc>
15682	Time interval in seconds between two consecutive samples of
15683	performance data.
15684	</desc>
15685	</param>
15686	<param name="count" type="unsigned long" dir="in">
15687	<desc>
15688	Number of samples to retain in performance data history. Older
15689	samples get discarded.
15690	</desc>
15691	</param>
15692	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15693	<desc>
15694	Array of metrics that have been modified by the call to this method.
15695	</desc>
15696	</param>
15697	</method>
15698
15699	<method name="enableMetrics">
15700	<desc>
15701	Turns on collecting specified base metrics. Returns an array of
15702	<link to="IPerformanceMetric" /> describing the metrics have been
15703	affected.
15704	<note>
15705	@c Null or empty metric name array means all metrics. @c Null or
15706	empty object array means all existing objects. If metric name array
15707	contains a single element and object array contains many, the single
15708	metric name array element is applied to each object array element to
15709	form metric/object pairs.
15710	</note>
15711	</desc>
15712	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15713	<desc>
15714	Metric name filter. Comma-separated list of metrics with wildcard
15715	support.
15716	</desc>
15717	</param>
15718	<param name="objects" type="$unknown" dir="in" safearray="yes">
15719	<desc>
15720	Set of objects to enable metrics for.
15721	</desc>
15722	</param>
15723	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15724	<desc>
15725	Array of metrics that have been modified by the call to this method.
15726	</desc>
15727	</param>
15728	</method>
15729
15730	<method name="disableMetrics">
15731	<desc>
15732	Turns off collecting specified base metrics. Returns an array of
15733	<link to="IPerformanceMetric" /> describing the metrics have been
15734	affected.
15735	<note>
15736	@c Null or empty metric name array means all metrics. @c Null or
15737	empty object array means all existing objects. If metric name array
15738	contains a single element and object array contains many, the single
15739	metric name array element is applied to each object array element to
15740	form metric/object pairs.
15741	</note>
15742	</desc>
15743	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15744	<desc>
15745	Metric name filter. Comma-separated list of metrics with wildcard
15746	support.
15747	</desc>
15748	</param>
15749	<param name="objects" type="$unknown" dir="in" safearray="yes">
15750	<desc>
15751	Set of objects to disable metrics for.
15752	</desc>
15753	</param>
15754	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15755	<desc>
15756	Array of metrics that have been modified by the call to this method.
15757	</desc>
15758	</param>
15759	</method>
15760
15761	<method name="queryMetricsData">
15762	<desc>
15763	Queries collected metrics data for a set of objects.
15764
15765	The data itself and related metric information are returned in seven
15766	parallel and one flattened array of arrays. Elements of
15767	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15768	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15769	the same index describe one set of values corresponding to a single
15770	metric.
15771
15772	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15773	start and length of a sub-array is indicated by
15774	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15775	value for metric <tt>metricNames[i]</tt> is at
15776	<tt>returnData[returnIndices[i]]</tt>.
15777
15778	<note>
15779	@c Null or empty metric name array means all metrics. @c Null or
15780	empty object array means all existing objects. If metric name array
15781	contains a single element and object array contains many, the single
15782	metric name array element is applied to each object array element to
15783	form metric/object pairs.
15784	</note>
15785	<note>
15786	Data collection continues behind the scenes after call to @c
15787	queryMetricsData. The return data can be seen as the snapshot of the
15788	current state at the time of @c queryMetricsData call. The internally
15789	kept metric values are not cleared by the call. This makes possible
15790	querying different subsets of metrics or aggregates with subsequent
15791	calls. If periodic querying is needed it is highly suggested to query
15792	the values with @c interval*count period to avoid confusion. This way
15793	a completely new set of data values will be provided by each query.
15794	</note>
15795	</desc>
15796	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15797	<desc>
15798	Metric name filter. Comma-separated list of metrics with wildcard
15799	support.
15800	</desc>
15801	</param>
15802	<param name="objects" type="$unknown" dir="in" safearray="yes">
15803	<desc>
15804	Set of objects to query metrics for.
15805	</desc>
15806	</param>
15807	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15808	<desc>
15809	Names of metrics returned in @c returnData.
15810	</desc>
15811	</param>
15812	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15813	<desc>
15814	Objects associated with metrics returned in @c returnData.
15815	</desc>
15816	</param>
15817	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15818	<desc>
15819	Units of measurement for each returned metric.
15820	</desc>
15821	</param>
15822	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15823	<desc>
15824	Divisor that should be applied to return values in order to get
15825	floating point values. For example:
15826	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15827	will retrieve the floating point value of i-th sample of the first
15828	metric.
15829	</desc>
15830	</param>
15831	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15832	<desc>
15833	Sequence numbers of the first elements of value sequences of
15834	particular metrics returned in @c returnData. For aggregate metrics
15835	it is the sequence number of the sample the aggregate started
15836	calculation from.
15837	</desc>
15838	</param>
15839	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15840	<desc>
15841	Indices of the first elements of value sequences of particular
15842	metrics returned in @c returnData.
15843	</desc>
15844	</param>
15845	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15846	<desc>
15847	Lengths of value sequences of particular metrics.
15848	</desc>
15849	</param>
15850	<param name="returnData" type="long" dir="return" safearray="yes">
15851	<desc>
15852	Flattened array of all metric data containing sequences of values for
15853	each metric.
15854	</desc>
15855	</param>
15856	</method>
15857
15858	</interface>
15859
15860	<enum
15861	name="NATAliasMode"
15862	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15863	>
15864	<desc></desc>
15865	<const name="AliasLog" value="0x1">
15866	<desc></desc>
15867	</const>
15868	<const name="AliasProxyOnly" value="0x02">
15869	<desc></desc>
15870	</const>
15871	<const name="AliasUseSamePorts" value="0x04">
15872	<desc></desc>
15873	</const>
15874	</enum>
15875
15876	<enum
15877	name="NATProtocol"
15878	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15879	>
15880	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15881	<const name="UDP" value="0">
15882	<desc>Port-forwarding uses UDP protocol.</desc>
15883	</const>
15884	<const name="TCP" value="1">
15885	<desc>Port-forwarding uses TCP protocol.</desc>
15886	</const>
15887	</enum>
15888
15889	<interface
15890	name="INATEngine" extends="$unknown"
15891	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
15892	wsmap="managed"
15893	>
15894	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
15895	allows for changing NAT behavior such as port-forwarding rules. This interface is
15896	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
15897	<attribute name="network" type="wstring">
15898	<desc>The network attribute of the NAT engine (the same value is used with built-in
15899	DHCP server to fill corresponding fields of DHCP leases).</desc>
15900	</attribute>
15901	<attribute name="hostIP" type="wstring">
15902	<desc>IP of host interface to bind all opened sockets to.
15903	<note>Changing this does not change binding of port forwarding.</note>
15904	</desc>
15905	</attribute>
15906	<attribute name="tftpPrefix" type="wstring">
15907	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
15908	the corresponding fields of DHCP leases.</desc>
15909	</attribute>
15910	<attribute name="tftpBootFile" type="wstring">
15911	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
15912	the corresponding fields of DHCP leases.</desc>
15913	</attribute>
15914	<attribute name="tftpNextServer" type="wstring">
15915	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
15916	the corresponding fields of DHCP leases.
15917	<note>The preferred form is IPv4 addresses.</note>
15918	</desc>
15919	</attribute>
15920	<attribute name="aliasMode" type="unsigned long">
15921	<desc></desc>
15922	</attribute>
15923	<attribute name="dnsPassDomain" type="boolean">
15924	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
15925	</attribute>
15926	<attribute name="dnsProxy" type="boolean">
15927	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15928	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
15929	</attribute>
15930	<attribute name="dnsUseHostResolver" type="boolean">
15931	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15932	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
15933	</attribute>
15934	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
15935	<desc>Array of NAT port-forwarding rules in string representation, in the following
15936	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
15937	</attribute>
15938	<method name="setNetworkSettings">
15939	<desc>Sets network configuration of the NAT engine.</desc>
15940	<param name="mtu" type="unsigned long" dir="in">
15941	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
15942	</param>
15943	<param name="sockSnd" type="unsigned long" dir="in">
15944	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
15945	</param>
15946	<param name="sockRcv" type="unsigned long" dir="in">
15947	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
15948	</param>
15949	<param name="TcpWndSnd" type="unsigned long" dir="in">
15950	<desc>Initial size of the NAT engine's sending TCP window in bytes when
15951	establishing a new TCP connection.</desc>
15952	</param>
15953	<param name="TcpWndRcv" type="unsigned long" dir="in">
15954	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
15955	establishing a new TCP connection.</desc>
15956	</param>
15957	</method>
15958	<method name="getNetworkSettings">
15959	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
15960	for parameter descriptions.</desc>
15961	<param name="mtu" type="unsigned long" dir="out" />
15962	<param name="sockSnd" type="unsigned long" dir="out" />
15963	<param name="sockRcv" type="unsigned long" dir="out" />
15964	<param name="TcpWndSnd" type="unsigned long" dir="out" />
15965	<param name="TcpWndRcv" type="unsigned long" dir="out" />
15966	</method>
15967	<method name="addRedirect">
15968	<desc>Adds a new NAT port-forwarding rule.</desc>
15969	<param name="name" type="wstring" dir="in">
15970	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
15971	auto-generates one using the other parameters.</desc>
15972	</param>
15973	<param name="proto" type="NATProtocol" dir="in">
15974	<desc>Protocol handled with the rule.</desc>
15975	</param>
15976	<param name="hostIp" type="wstring" dir="in">
15977	<desc>IP of the host interface to which the rule should apply. An empty ip address is
15978	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
15979	</param>
15980	<param name="hostPort" type="unsigned short" dir="in">
15981	<desc>The port number to listen on.</desc>
15982	</param>
15983	<param name="guestIp" type="wstring" dir="in">
15984	<desc>The IP address of the guest which the NAT engine will forward matching packets
15985	to. An empty IP address is acceptable, in which case the NAT engine will forward
15986	packets to the first DHCP lease (x.x.x.15).</desc>
15987	</param>
15988	<param name="guestPort" type="unsigned short" dir="in">
15989	<desc>The port number to forward.</desc>
15990	</param>
15991	</method>
15992	<method name="removeRedirect">
15993	<desc>Removes a port-forwarding rule that was previously registered.</desc>
15994	<param name="name" type="wstring" dir="in">
15995	<desc>The name of the rule to delete.</desc>
15996	</param>
15997	</method>
15998	</interface>
15999
16000	<!--
16001	// IExtPackManager
16002	/////////////////////////////////////////////////////////////////////////
16003	-->
16004
16005	<interface
16006	name="IExtPackPlugIn" extends="$unknown"
16007	uuid="58000040-e718-4746-bbce-4b86d96da461"
16008	wsmap="suppress"
16009	>
16010	<desc>
16011	Interface for keeping information about a plug-in that ships with an
16012	extension pack.
16013	</desc>
16014	<attribute name="name" type="wstring" readonly="yes">
16015	<desc>The plug-in name.</desc>
16016	</attribute>
16017	<attribute name="description" type="wstring" readonly="yes">
16018	<desc>The plug-in description.</desc>
16019	</attribute>
16020	<attribute name="frontend" type="wstring" readonly="yes">
16021	<desc>
16022	The name of the frontend or component name this plug-in plugs into.
16023	</desc>
16024	</attribute>
16025	<attribute name="modulePath" type="wstring" readonly="yes">
16026	<desc> The module path. </desc>
16027	</attribute>
16028	</interface>
16029
16030	<interface
16031	name="IExtPackBase" extends="$unknown"
16032	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16033	wsmap="suppress"
16034	>
16035	<desc>
16036	Interface for querying information about an extension pack as well as
16037	accessing COM objects within it.
16038	</desc>
16039	<attribute name="name" type="wstring" readonly="yes">
16040	<desc>The extension pack name. This is unique.</desc>
16041	</attribute>
16042	<attribute name="description" type="wstring" readonly="yes">
16043	<desc>The extension pack description.</desc>
16044	</attribute>
16045	<attribute name="version" type="wstring" readonly="yes">
16046	<desc>
16047	The extension pack version string. This is restricted to the dotted
16048	version number and optionally a build indicator. No tree revision or
16049	tag will be included in the string as those things are available as
16050	separate properties. An optional publisher tag may be present like for
16051	<link to="IVirtualBox::version"/>.
16052
16053	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16054	</desc>
16055	</attribute>
16056	<attribute name="revision" type="unsigned long" readonly="yes">
16057	<desc>The extension pack internal revision number.</desc>
16058	</attribute>
16059	<attribute name="edition" type="wstring" readonly="yes">
16060	<desc>
16061	Edition indicator. This is usually empty.
16062
16063	Can for instance be used to help distinguishing between two editions
16064	of the same extension pack where only the license, service contract or
16065	something differs.
16066	</desc>
16067	</attribute>
16068	<attribute name="VRDEModule" type="wstring" readonly="yes">
16069	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16070	</attribute>
16071	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16072	<desc>Plug-ins provided by this extension pack.</desc>
16073	</attribute>
16074	<attribute name="usable" type="boolean" readonly="yes">
16075	<desc>
16076	Indicates whether the extension pack is usable or not.
16077
16078	There are a number of reasons why an extension pack might be unusable,
16079	typical examples would be broken installation/file or that it is
16080	incompatible with the current VirtualBox version.
16081	</desc>
16082	</attribute>
16083	<attribute name="whyUnusable" type="wstring" readonly="yes">
16084	<desc>
16085	String indicating why the extension pack is not usable. This is an
16086	empty string if usable and always a non-empty string if not usable.
16087	</desc>
16088	</attribute>
16089	<attribute name="showLicense" type="boolean" readonly="yes">
16090	<desc>Whether to show the license before installation</desc>
16091	</attribute>
16092	<attribute name="license" type="wstring" readonly="yes">
16093	<desc>
16094	The default HTML license text for the extension pack. Same as
16095	calling <link to="#queryLicense">queryLicense</link> with
16096	preferredLocale and preferredLanguage as empty strings and format set
16097	to html.
16098	</desc>
16099	</attribute>
16100
16101	<method name="queryLicense">
16102	<desc>
16103	Full feature version of the license attribute.
16104	</desc>
16105	<param name="preferredLocale" type="wstring" dir="in">
16106	<desc>
16107	The preferred license locale. Pass an empty string to get the default
16108	license.
16109	</desc>
16110	</param>
16111	<param name="preferredLanguage" type="wstring" dir="in">
16112	<desc>
16113	The preferred license language. Pass an empty string to get the
16114	default language for the locale.
16115	</desc>
16116	</param>
16117	<param name="format" type="wstring" dir="in">
16118	<desc>
16119	The license format: html, rtf or txt. If a license is present there
16120	will always be an HTML of it, the rich text format (RTF) and plain
16121	text (txt) versions are optional. If
16122	</desc>
16123	</param>
16124	<param name="licenseText" type="wstring" dir="return">
16125	<desc>The license text.</desc>
16126	</param>
16127	</method>
16128
16129	</interface>
16130
16131	<interface
16132	name="IExtPack" extends="IExtPackBase"
16133	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16134	wsmap="suppress"
16135	>
16136	<desc>
16137	Interface for querying information about an extension pack as well as
16138	accessing COM objects within it.
16139	</desc>
16140	<method name="queryObject">
16141	<desc>
16142	Queries the IUnknown interface to an object in the extension pack
16143	main module. This allows plug-ins and others to talk directly to an
16144	extension pack.
16145	</desc>
16146	<param name="objUuid" type="wstring" dir="in">
16147	<desc>The object ID. What exactly this is </desc>
16148	</param>
16149	<param name="returnInterface" type="$unknown" dir="return">
16150	<desc>The queried interface.</desc>
16151	</param>
16152	</method>
16153	</interface>
16154
16155	<interface
16156	name="IExtPackFile" extends="IExtPackBase"
16157	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16158	wsmap="suppress"
16159	>
16160	<desc>
16161	Extension pack file (aka tarball, .vbox-extpack) representation returned
16162	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16163	extension pack information with the addition of the file name.
16164	</desc>
16165	<attribute name="filePath" type="wstring" readonly="yes">
16166	<desc>
16167	The path to the extension pack file.
16168	</desc>
16169	</attribute>
16170
16171	<method name="install">
16172	<desc>
16173	Install the extension pack.
16174	</desc>
16175	<param name="replace" type="boolean" dir="in">
16176	<desc>
16177	Set this to automatically uninstall any existing extension pack with
16178	the same name as the one being installed.
16179	</desc>
16180	</param>
16181	<param name="displayInfo" type="wstring" dir="in">
16182	<desc>
16183	Platform specific display information. Reserved for future hacks.
16184	</desc>
16185	</param>
16186	<param name="progess" type="IProgress" dir="return">
16187	<desc>
16188	Progress object for the operation.
16189	</desc>
16190	</param>
16191	</method>
16192	</interface>
16193
16194	<interface
16195	name="IExtPackManager" extends="$unknown"
16196	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16197	wsmap="suppress"
16198	>
16199	<desc>
16200	Interface for managing VirtualBox Extension Packs.
16201
16202	TODO: Describe extension packs, how they are managed and how to create
16203	one.
16204	</desc>
16205
16206	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16207	<desc>
16208	List of the installed extension packs.
16209	</desc>
16210	</attribute>
16211
16212	<method name="find">
16213	<desc>
16214	Returns the extension pack with the specified name if found.
16215
16216	<result name="VBOX_E_OBJECT_NOT_FOUND">
16217	No extension pack matching @a name was found.
16218	</result>
16219	</desc>
16220	<param name="name" type="wstring" dir="in">
16221	<desc>The name of the extension pack to locate.</desc>
16222	</param>
16223	<param name="returnData" type="IExtPack" dir="return">
16224	<desc>The extension pack if found.</desc>
16225	</param>
16226	</method>
16227
16228	<method name="openExtPackFile">
16229	<desc>
16230	Attempts to open an extension pack file in preparation for
16231	installation.
16232	</desc>
16233	<param name="path" type="wstring" dir="in">
16234	<desc>The path of the extension pack tarball. This can optionally be
16235	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16236	</param>
16237	<param name="file" type="IExtPackFile" dir="return">
16238	<desc>The interface of the extension pack file object.</desc>
16239	</param>
16240	</method>
16241
16242	<method name="uninstall">
16243	<desc>Uninstalls an extension pack, removing all related files.</desc>
16244	<param name="name" type="wstring" dir="in">
16245	<desc>The name of the extension pack to uninstall.</desc>
16246	</param>
16247	<param name="forcedRemoval" type="boolean" dir="in">
16248	<desc>
16249	Forced removal of the extension pack. This means that the uninstall
16250	hook will not be called.
16251	</desc>
16252	</param>
16253	<param name="displayInfo" type="wstring" dir="in">
16254	<desc>
16255	Platform specific display information. Reserved for future hacks.
16256	</desc>
16257	</param>
16258	<param name="progess" type="IProgress" dir="return">
16259	<desc>
16260	Progress object for the operation.
16261	</desc>
16262	</param>
16263	</method>
16264
16265	<method name="cleanup">
16266	<desc>Cleans up failed installs and uninstalls</desc>
16267	</method>
16268
16269	<method name="queryAllPlugInsForFrontend">
16270	<desc>
16271	Gets the path to all the plug-in modules for a given frontend.
16272
16273	This is a convenience method that is intended to simplify the plug-in
16274	loading process for a frontend.
16275	</desc>
16276	<param name="frontendName" type="wstring" dir="in">
16277	<desc>The name of the frontend or component.</desc>
16278	</param>
16279	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16280	<desc>Array containing the plug-in modules (full paths).</desc>
16281	</param>
16282	</method>
16283
16284	<method name="isExtPackUsable">
16285	<desc>Check if the given extension pack is loaded and usable.</desc>
16286	<param name="name" type="wstring" dir="in">
16287	<desc>The name of the extension pack to check for.</desc>
16288	</param>
16289	<param name="usable" type="boolean" dir="return">
16290	<desc>Is the given extension pack loaded and usable.</desc>
16291	</param>
16292	</method>
16293
16294	</interface>
16295
16296	<!--
16297	// BandwidthGroupType
16298	/////////////////////////////////////////////////////////////////////////
16299	-->
16300	<enum
16301	name="BandwidthGroupType"
16302	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16303
16304	<desc>
16305	Type of a bandwidth control group.
16306	</desc>
16307
16308	<const name="Null" value="0">
16309	<desc>
16310	Null type, must be first.
16311	</desc>
16312	</const>
16313
16314	<const name="Disk" value="1">
16315	<desc>
16316	The bandwidth group controls disk I/O.
16317	</desc>
16318	</const>
16319
16320	<const name="Network" value="2">
16321	<desc>
16322	The bandwidth group controls network I/O.
16323	</desc>
16324	</const>
16325
16326	</enum>
16327
16328	<!--
16329	// IBandwidthGroup
16330	/////////////////////////////////////////////////////////////////////////
16331	-->
16332	<interface
16333	name="IBandwidthGroup" extends="$unknown"
16334	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16335	wsmap="managed"
16336	>
16337	<desc>Represents one bandwidth group.</desc>
16338
16339	<attribute name="name" type="wstring" readonly="yes">
16340	<desc>Name of the group.</desc>
16341	</attribute>
16342
16343	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16344	<desc>Type of the group.</desc>
16345	</attribute>
16346
16347	<attribute name="reference" type="unsigned long" readonly="yes">
16348	<desc>How many devices/medium attachements use this group.</desc>
16349	</attribute>
16350
16351	<attribute name="maxMbPerSec" type="unsigned long">
16352	<desc>The maximum number of MBytes which can be transfered by all
16353	entities attached to this group during one second.</desc>
16354	</attribute>
16355
16356	</interface>
16357
16358	<!--
16359	// IBandwidthControl
16360	/////////////////////////////////////////////////////////////////////////
16361	-->
16362	<interface
16363	name="IBandwidthControl" extends="$unknown"
16364	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16365	wsmap="managed"
16366	>
16367	<desc>
16368	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16369	This includes network and disk I/O.
16370	</desc>
16371
16372	<attribute name="numGroups" type="unsigned long" readonly="yes">
16373	<desc>
16374	The current number of existing bandwidth groups managed.
16375	</desc>
16376	</attribute>
16377
16378	<method name="createBandwidthGroup">
16379	<desc>
16380	Creates a new bandwidth group.
16381	</desc>
16382
16383	<param name="name" type="wstring" dir="in">
16384	<desc>Name of the bandwidth group.</desc>
16385	</param>
16386	<param name="type" type="BandwidthGroupType" dir="in">
16387	<desc>The type of the bandwidth group (network or disk).</desc>
16388	</param>
16389	<param name="maxMbPerSec" type="unsigned long" dir="in">
16390	<desc>The maximum number of MBytes which can be transfered by all
16391	entities attached to this group during one second.</desc>
16392	</param>
16393	</method>
16394
16395	<method name="deleteBandwidthGroup">
16396	<desc>
16397	Deletes a new bandwidth group.
16398	</desc>
16399
16400	<param name="name" type="wstring" dir="in">
16401	<desc>Name of the bandwidth group to delete.</desc>
16402	</param>
16403	</method>
16404
16405	<method name="getBandwidthGroup" const="yes">
16406	<desc>
16407	Get a bandwidth group by name.
16408	</desc>
16409
16410	<param name="name" type="wstring" dir="in">
16411	<desc>Name of the bandwidth group to get.</desc>
16412	</param>
16413	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16414	<desc>Where to store the bandwidth group on success.</desc>
16415	</param>
16416	</method>
16417
16418	<method name="getAllBandwidthGroups" const="yes">
16419	<desc>
16420	Get all managed bandwidth groups.
16421	</desc>
16422
16423	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16424	<desc>The array of managed bandwidth groups.</desc>
16425	</param>
16426	</method>
16427	</interface>
16428
16429	<!--
16430	// IVirtualBoxClient
16431	/////////////////////////////////////////////////////////////////////////
16432	-->
16433
16434	<interface
16435	name="IVirtualBoxClient" extends="$unknown"
16436	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16437	wsmap="suppress"
16438	>
16439	<desc>
16440	Convenience interface for client applications. Treat this as a
16441	singleton, i.e. never create more than one instance of this interface.
16442
16443	At the moment only available for clients of the local API (not usable
16444	via the webservice). Once the session logic is redesigned this might
16445	change.
16446	</desc>
16447
16448	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16449	<desc>
16450	Reference to the server-side API root object.
16451	</desc>
16452	</attribute>
16453
16454	<attribute name="session" type="ISession" readonly="yes">
16455	<desc>
16456	Create a new session object and return the reference to it.
16457	</desc>
16458	</attribute>
16459
16460	<attribute name="eventSource" type="IEventSource" readonly="yes">
16461	<desc>
16462	Event source for VirtualBoxClient events.
16463	</desc>
16464	</attribute>
16465
16466	</interface>
16467
16468	<!--
16469	// Events
16470	/////////////////////////////////////////////////////////////////////////
16471	-->
16472	<enum
16473	name="VBoxEventType"
16474	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16475	>
16476
16477	<desc>
16478	Type of an event.
16479	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16480	</desc>
16481
16482	<const name="Invalid" value="0">
16483	<desc>
16484	Invalid event, must be first.
16485	</desc>
16486	</const>
16487
16488	<const name="Any" value="1">
16489	<desc>
16490	Wildcard for all events.
16491	Events of this type are never delivered, and only used in
16492	<link to="IEventSource::registerListener"/> call to simplify registration.
16493	</desc>
16494	</const>
16495
16496	<const name="Vetoable" value="2">
16497	<desc>
16498	Wildcard for all vetoable events. Events of this type are never delivered, and only
16499	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16500	</desc>
16501	</const>
16502
16503	<const name="MachineEvent" value="3">
16504	<desc>
16505	Wildcard for all machine events. Events of this type are never delivered, and only used in
16506	<link to="IEventSource::registerListener"/> call to simplify registration.
16507	</desc>
16508	</const>
16509
16510	<const name="SnapshotEvent" value="4">
16511	<desc>
16512	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16513	<link to="IEventSource::registerListener"/> call to simplify registration.
16514	</desc>
16515	</const>
16516
16517	<const name="InputEvent" value="5">
16518	<desc>
16519	Wildcard for all input device (keyboard, mouse) events.
16520	Events of this type are never delivered, and only used in
16521	<link to="IEventSource::registerListener"/> call to simplify registration.
16522	</desc>
16523	</const>
16524
16525	<const name="LastWildcard" value="31">
16526	<desc>
16527	Last wildcard.
16528	</desc>
16529	</const>
16530
16531	<const name="OnMachineStateChanged" value="32">
16532	<desc>
16533	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16534	</desc>
16535	</const>
16536	<const name="OnMachineDataChanged" value="33">
16537	<desc>
16538	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16539	</desc>
16540	</const>
16541	<const name="OnExtraDataChanged" value="34">
16542	<desc>
16543	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16544	</desc>
16545	</const>
16546	<const name="OnExtraDataCanChange" value="35">
16547	<desc>
16548	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16549	</desc>
16550	</const>
16551	<const name="OnMediumRegistered" value="36">
16552	<desc>
16553	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16554	</desc>
16555	</const>
16556	<const name="OnMachineRegistered" value="37">
16557	<desc>
16558	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16559	</desc>
16560	</const>
16561	<const name="OnSessionStateChanged" value="38">
16562	<desc>
16563	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16564	</desc>
16565	</const>
16566	<const name="OnSnapshotTaken" value="39">
16567	<desc>
16568	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16569	</desc>
16570	</const>
16571	<const name="OnSnapshotDeleted" value="40">
16572	<desc>
16573	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16574	</desc>
16575	</const>
16576	<const name="OnSnapshotChanged" value="41">
16577	<desc>
16578	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16579	</desc>
16580	</const>
16581	<const name="OnGuestPropertyChanged" value="42">
16582	<desc>
16583	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16584	</desc>
16585	</const>
16586	<!-- Console events -->
16587	<const name="OnMousePointerShapeChanged" value="43">
16588	<desc>
16589	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16590	</desc>
16591	</const>
16592	<const name="OnMouseCapabilityChanged" value="44">
16593	<desc>
16594	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16595	</desc>
16596	</const>
16597	<const name="OnKeyboardLedsChanged" value="45">
16598	<desc>
16599	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16600	</desc>
16601	</const>
16602	<const name="OnStateChanged" value="46">
16603	<desc>
16604	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16605	</desc>
16606	</const>
16607	<const name="OnAdditionsStateChanged" value="47">
16608	<desc>
16609	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16610	</desc>
16611	</const>
16612	<const name="OnNetworkAdapterChanged" value="48">
16613	<desc>
16614	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16615	</desc>
16616	</const>
16617	<const name="OnSerialPortChanged" value="49">
16618	<desc>
16619	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16620	</desc>
16621	</const>
16622	<const name="OnParallelPortChanged" value="50">
16623	<desc>
16624	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16625	</desc>
16626	</const>
16627	<const name="OnStorageControllerChanged" value="51">
16628	<desc>
16629	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16630	</desc>
16631	</const>
16632	<const name="OnMediumChanged" value="52">
16633	<desc>
16634	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16635	</desc>
16636	</const>
16637	<const name="OnVRDEServerChanged" value="53">
16638	<desc>
16639	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16640	</desc>
16641	</const>
16642	<const name="OnUSBControllerChanged" value="54">
16643	<desc>
16644	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16645	</desc>
16646	</const>
16647	<const name="OnUSBDeviceStateChanged" value="55">
16648	<desc>
16649	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16650	</desc>
16651	</const>
16652	<const name="OnSharedFolderChanged" value="56">
16653	<desc>
16654	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16655	</desc>
16656	</const>
16657	<const name="OnRuntimeError" value="57">
16658	<desc>
16659	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16660	</desc>
16661	</const>
16662	<const name="OnCanShowWindow" value="58">
16663	<desc>
16664	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16665	</desc>
16666	</const>
16667	<const name="OnShowWindow" value="59">
16668	<desc>
16669	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16670	</desc>
16671	</const>
16672	<const name="OnCPUChanged" value="60">
16673	<desc>
16674	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16675	</desc>
16676	</const>
16677	<const name="OnVRDEServerInfoChanged" value="61">
16678	<desc>
16679	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16680	</desc>
16681	</const>
16682	<const name="OnEventSourceChanged" value="62">
16683	<desc>
16684	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16685	</desc>
16686	</const>
16687	<const name="OnCPUExecutionCapChanged" value="63">
16688	<desc>
16689	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16690	</desc>
16691	</const>
16692	<const name="OnGuestKeyboard" value="64">
16693	<desc>
16694	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16695	</desc>
16696	</const>
16697	<const name="OnGuestMouse" value="65">
16698	<desc>
16699	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16700	</desc>
16701	</const>
16702	<const name="OnNATRedirect" value="66">
16703	<desc>
16704	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16705	</desc>
16706	</const>
16707	<const name="OnHostPciDevicePlug" value="67">
16708	<desc>
16709	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16710	</desc>
16711	</const>
16712	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16713	<desc>
16714	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16715	</desc>
16716	</const>
16717	<const name="OnBandwidthGroupChanged" value="69">
16718	<desc>
16719	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16720	</desc>
16721	</const>
16722	<const name="OnGuestMonitorChanged" value="70">
16723	<desc>
16724	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16725	</desc>
16726	</const>
16727	<const name="OnStorageDeviceChanged" value="71">
16728	<desc>
16729	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16730	</desc>
16731	</const>
16732
16733	<!-- Last event marker -->
16734	<const name="Last" value="72">
16735	<desc>
16736	Must be last event, used for iterations and structures relying on numerical event values.
16737	</desc>
16738	</const>
16739
16740	</enum>
16741
16742	<interface
16743	name="IEventSource" extends="$unknown"
16744	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16745	wsmap="managed"
16746	>
16747	<desc>
16748	Event source. Generally, any object which could generate events can be an event source,
16749	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16750	an event source can work with listeners in either active or passive mode. In active mode it is up to
16751	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16752	event source keeps track of pending events for each listener and returns available events on demand.
16753
16754	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16755	</desc>
16756
16757	<method name="createListener">
16758	<desc>
16759	Creates a new listener object, useful for passive mode.
16760	</desc>
16761	<param name="listener" type="IEventListener" dir="return"/>
16762	</method>
16763
16764	<method name="createAggregator">
16765	<desc>
16766	Creates an aggregator event source, collecting events from multiple sources.
16767	This way a single listener can listen for events coming from multiple sources,
16768	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16769	</desc>
16770	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16771	<desc>
16772	Subordinate event source this one aggregatres.
16773	</desc>
16774	</param>
16775	<param name="result" type="IEventSource" dir="return">
16776	<desc>
16777	Event source aggregating passed sources.
16778	</desc>
16779	</param>
16780	</method>
16781
16782	<method name="registerListener">
16783	<desc>
16784	Register an event listener.
16785
16786	<note>
16787	To avoid system overload, the VirtualBox server process checks if passive event
16788	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16789	current implementation, if more than 500 pending events are detected for a passive
16790	event listener, it is forcefully unregistered by the system, and further
16791	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16792	</note>
16793	</desc>
16794	<param name="listener" type="IEventListener" dir="in">
16795	<desc>Listener to register.</desc>
16796	</param>
16797	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16798	<desc>
16799	Event types listener is interested in. One can use wildcards like -
16800	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16801	than one event.
16802	</desc>
16803	</param>
16804	<param name="active" type="boolean" dir="in">
16805	<desc>
16806	Which mode this listener is operating in.
16807	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16808	In passive mode, an internal event queue is created for this this IEventListener.
16809	For each event coming in, it is added to queues for all interested registered passive
16810	listeners. It is then up to the external code to call the listener's
16811	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16812	external code must call <link to="#eventProcessed" />.
16813	</desc>
16814	</param>
16815	</method>
16816
16817	<method name="unregisterListener">
16818	<desc>
16819	Unregister an event listener. If listener is passive, and some waitable events are still
16820	in queue they are marked as processed automatically.
16821	</desc>
16822	<param name="listener" type="IEventListener" dir="in">
16823	<desc>Listener to unregister.</desc>
16824	</param>
16825	</method>
16826
16827	<method name="fireEvent">
16828	<desc>
16829	Fire an event for this source.
16830	</desc>
16831	<param name="event" type="IEvent" dir="in">
16832	<desc>Event to deliver.</desc>
16833	</param>
16834	<param name="timeout" type="long" dir="in">
16835	<desc>
16836	Maximum time to wait for event processing (if event is waitable), in ms;
16837	0 = no wait, -1 = indefinite wait.
16838	</desc>
16839	</param>
16840	<param name="result" type="boolean" dir="return">
16841	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16842	</param>
16843	</method>
16844
16845	<method name="getEvent">
16846	<desc>
16847	Get events from this peer's event queue (for passive mode). Calling this method
16848	regularly is required for passive event listeners to avoid system overload;
16849	see <link to="IEventSource::registerListener" /> for details.
16850
16851	<result name="VBOX_E_OBJECT_NOT_FOUND">
16852	Listener is not registered, or autounregistered.
16853	</result>
16854	</desc>
16855	<param name="listener" type="IEventListener" dir="in">
16856	<desc>Which listener to get data for.</desc>
16857	</param>
16858	<param name="timeout" type="long" dir="in">
16859	<desc>
16860	Maximum time to wait for events, in ms;
16861	0 = no wait, -1 = indefinite wait.
16862	</desc>
16863	</param>
16864	<param name="event" type="IEvent" dir="return">
16865	<desc>Event retrieved, or null if none available.</desc>
16866	</param>
16867	</method>
16868
16869	<method name="eventProcessed">
16870	<desc>
16871	Must be called for waitable events after a particular listener finished its
16872	event processing. When all listeners of a particular event have called this
16873	method, the system will then call <link to="IEvent::setProcessed" />.
16874	</desc>
16875	<param name="listener" type="IEventListener" dir="in">
16876	<desc>Which listener processed event.</desc>
16877	</param>
16878	<param name="event" type="IEvent" dir="in">
16879	<desc>Which event.</desc>
16880	</param>
16881	</method>
16882
16883	</interface>
16884
16885	<interface
16886	name="IEventListener" extends="$unknown"
16887	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
16888	wsmap="managed"
16889	>
16890	<desc>
16891	Event listener. An event listener can work in either active or passive mode, depending on the way
16892	it was registered.
16893	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16894	</desc>
16895
16896	<method name="handleEvent">
16897	<desc>
16898	Handle event callback for active listeners. It is not called for
16899	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
16900	and having received acknowledgement from all passive listeners via
16901	<link to="IEventSource::eventProcessed"/>, the event is marked as
16902	processed and <link to="IEvent::waitProcessed"/> will return
16903	immediately.
16904	</desc>
16905	<param name="event" type="IEvent" dir="in">
16906	<desc>Event available.</desc>
16907	</param>
16908	</method>
16909
16910	</interface>
16911
16912	<interface
16913	name="IEvent" extends="$unknown"
16914	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
16915	wsmap="managed"
16916	>
16917	<desc>
16918	Abstract parent interface for VirtualBox events. Actual events will typically implement
16919	a more specific interface which derives from this (see below).
16920
16921	<b>Introduction to VirtualBox events</b>
16922
16923	Generally speaking, an event (represented by this interface) signals that something
16924	happened, while an event listener (see <link to="IEventListener" />) represents an
16925	entity that is interested in certain events. In order for this to work with
16926	unidirectional protocols (i.e. web services), the concepts of passive and active
16927	listener are used.
16928
16929	Event consumers can register themselves as listeners, providing an array of
16930	events they are interested in (see <link to="IEventSource::registerListener" />).
16931	When an event triggers, the listener is notified about the event. The exact
16932	mechanism of the notification depends on whether the listener was registered as
16933	an active or passive listener:
16934
16935	<ul>
16936	<li>An active listener is very similar to a callback: it is a function invoked
16937	by the API. As opposed to the callbacks that were used in the API before
16938	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
16939	</li>
16940
16941	<li>Passive listeners are somewhat trickier to implement, but do not require
16942	a client function to be callable, which is not an option with scripting
16943	languages or web service clients. Internally the <link to="IEventSource" />
16944	implementation maintains an event queue for each passive listener, and
16945	newly arrived events are put in this queue. When the listener calls
16946	<link to="IEventSource::getEvent"/>, first element from its internal event
16947	queue is returned. When the client completes processing of an event,
16948	the <link to="IEventSource::eventProcessed" /> function must be called,
16949	acknowledging that the event was processed. It supports implementing
16950	waitable events. On passive listener unregistration, all events from its
16951	queue are auto-acknowledged.
16952	</li>
16953	</ul>
16954
16955	Waitable events are useful in situations where the event generator wants to track
16956	delivery or a party wants to wait until all listeners have completed the event. A
16957	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
16958	listeners might veto a certain action, and thus the event producer has to make
16959	sure that all listeners have processed the event and not vetoed before taking
16960	the action.
16961
16962	A given event may have both passive and active listeners at the same time.
16963
16964	<b>Using events</b>
16965
16966	Any VirtualBox object capable of producing externally visible events provides an
16967	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
16968	This event source object is notified by VirtualBox once something has happened, so
16969	consumers may register event listeners with this event source. To register a listener,
16970	an object implementing the <link to="IEventListener" /> interface must be provided.
16971	For active listeners, such an object is typically created by the consumer, while for
16972	passive listeners <link to="IEventSource::createListener" /> should be used. Please
16973	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
16974
16975	Once created, the listener must be registered to listen for the desired events
16976	(see <link to="IEventSource::registerListener" />), providing an array of
16977	<link to="VBoxEventType" /> enums. Those elements can either be the individual
16978	event IDs or wildcards matching multiple event IDs.
16979
16980	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
16981	called automatically when the event is triggered, while passive listeners have to call
16982	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
16983	an event processing loop.
16984
16985	The IEvent interface is an abstract parent interface for all such VirtualBox events
16986	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
16987	or the event processing loop is to check the <link to="#type" /> attribute of the event and
16988	then cast to the appropriate specific interface using @c QueryInterface().
16989	</desc>
16990
16991	<attribute name="type" readonly="yes" type="VBoxEventType">
16992	<desc>
16993	Event type.
16994	</desc>
16995	</attribute>
16996
16997	<attribute name="source" readonly="yes" type="IEventSource">
16998	<desc>
16999	Source of this event.
17000	</desc>
17001	</attribute>
17002
17003	<attribute name="waitable" readonly="yes" type="boolean">
17004	<desc>
17005	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17006	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17007	as no additional overhead associated with waitability imposed.
17008	Waitable events are needed when one need to be able to wait for particular event processed,
17009	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17010	until all consumers confirmed events.
17011	</desc>
17012	</attribute>
17013
17014	<method name="setProcessed">
17015	<desc>
17016	Internal method called by the system when all listeners of a particular event have called
17017	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17018	</desc>
17019	</method>
17020
17021	<method name="waitProcessed">
17022	<desc>
17023	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17024	described semantics, for non-waitable returns true immediately.
17025	</desc>
17026	<param name="timeout" type="long" dir="in">
17027	<desc>
17028	Maximum time to wait for event processeing, in ms;
17029	0 = no wait, -1 = indefinite wait.
17030	</desc>
17031	</param>
17032	<param name="result" type="boolean" dir="return">
17033	<desc>If this event was processed before timeout.</desc>
17034	</param>
17035	</method>
17036	</interface>
17037
17038
17039	<interface
17040	name="IReusableEvent" extends="IEvent"
17041	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17042	wsmap="managed"
17043	>
17044	<desc>Base abstract interface for all reusable events.</desc>
17045
17046	<attribute name="generation" readonly="yes" type="unsigned long">
17047	<desc>Current generation of event, incremented on reuse.</desc>
17048	</attribute>
17049
17050	<method name="reuse">
17051	<desc>
17052	Marks an event as reused, increments 'generation', fields shall no
17053	longer be considered valid.
17054	</desc>
17055	</method>
17056	</interface>
17057
17058	<interface
17059	name="IMachineEvent" extends="IEvent"
17060	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17061	wsmap="managed" id="MachineEvent"
17062	>
17063	<desc>Base abstract interface for all machine events.</desc>
17064
17065	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17066	<desc>ID of the machine this event relates to.</desc>
17067	</attribute>
17068
17069	</interface>
17070
17071	<interface
17072	name="IMachineStateChangedEvent" extends="IMachineEvent"
17073	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17074	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17075	>
17076	<desc>Machine state change event.</desc>
17077
17078	<attribute name="state" readonly="yes" type="MachineState">
17079	<desc>New execution state.</desc>
17080	</attribute>
17081	</interface>
17082
17083	<interface
17084	name="IMachineDataChangedEvent" extends="IMachineEvent"
17085	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17086	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17087	>
17088	<desc>
17089	Any of the settings of the given machine has changed.
17090	</desc>
17091
17092	<attribute name="temporary" readonly="yes" type="boolean">
17093	<desc>@c true if the settings change is temporary. All permanent
17094	settings changes will trigger an event, and only temporary settings
17095	changes for running VMs will trigger an event. Note: sending events
17096	for temporary changes is NOT IMPLEMENTED.</desc>
17097	</attribute>
17098	</interface>
17099
17100	<interface
17101	name="IMediumRegisteredEvent" extends="IEvent"
17102	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17103	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17104	>
17105	<desc>
17106	The given medium was registered or unregistered
17107	within this VirtualBox installation.
17108	</desc>
17109
17110	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17111	<desc>ID of the medium this event relates to.</desc>
17112	</attribute>
17113
17114	<attribute name="mediumType" readonly="yes" type="DeviceType">
17115	<desc>Type of the medium this event relates to.</desc>
17116	</attribute>
17117
17118	<attribute name="registered" type="boolean" readonly="yes">
17119	<desc>
17120	If @c true, the medium was registered, otherwise it was
17121	unregistered.
17122	</desc>
17123	</attribute>
17124	</interface>
17125
17126	<interface
17127	name="IMachineRegisteredEvent" extends="IMachineEvent"
17128	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17129	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17130	>
17131	<desc>
17132	The given machine was registered or unregistered
17133	within this VirtualBox installation.
17134	</desc>
17135
17136	<attribute name="registered" type="boolean" readonly="yes">
17137	<desc>
17138	If @c true, the machine was registered, otherwise it was
17139	unregistered.
17140	</desc>
17141	</attribute>
17142	</interface>
17143
17144	<interface
17145	name="ISessionStateChangedEvent" extends="IMachineEvent"
17146	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17147	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17148	>
17149	<desc>
17150	The state of the session for the given machine was changed.
17151	<see><link to="IMachine::sessionState"/></see>
17152	</desc>
17153
17154	<attribute name="state" type="SessionState" readonly="yes">
17155	<desc>
17156	New session state.
17157	</desc>
17158	</attribute>
17159	</interface>
17160
17161	<interface
17162	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17163	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17164	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17165	>
17166	<desc>
17167	Notification when a guest property has changed.
17168	</desc>
17169
17170	<attribute name="name" readonly="yes" type="wstring">
17171	<desc>
17172	The name of the property that has changed.
17173	</desc>
17174	</attribute>
17175
17176	<attribute name="value" readonly="yes" type="wstring">
17177	<desc>
17178	The new property value.
17179	</desc>
17180	</attribute>
17181
17182	<attribute name="flags" readonly="yes" type="wstring">
17183	<desc>
17184	The new property flags.
17185	</desc>
17186	</attribute>
17187
17188	</interface>
17189
17190	<interface
17191	name="ISnapshotEvent" extends="IMachineEvent"
17192	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17193	wsmap="managed" id="SnapshotEvent"
17194	>
17195	<desc>Base interface for all snapshot events.</desc>
17196
17197	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17198	<desc>ID of the snapshot this event relates to.</desc>
17199	</attribute>
17200
17201	</interface>
17202
17203	<interface
17204	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17205	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17206	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17207	>
17208	<desc>
17209	A new snapshot of the machine has been taken.
17210	<see><link to="ISnapshot"/></see>
17211	</desc>
17212	</interface>
17213
17214	<interface
17215	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17216	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17217	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17218	>
17219	<desc>
17220	Snapshot of the given machine has been deleted.
17221
17222	<note>
17223	This notification is delivered <b>after</b> the snapshot
17224	object has been uninitialized on the server (so that any
17225	attempt to call its methods will return an error).
17226	</note>
17227
17228	<see><link to="ISnapshot"/></see>
17229	</desc>
17230	</interface>
17231
17232	<interface
17233	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17234	uuid="07541941-8079-447a-a33e-47a69c7980db"
17235	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17236	>
17237	<desc>
17238	Snapshot properties (name and/or description) have been changed.
17239	<see><link to="ISnapshot"/></see>
17240	</desc>
17241	</interface>
17242
17243	<interface
17244	name="IMousePointerShapeChangedEvent" extends="IEvent"
17245	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17246	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17247	>
17248	<desc>
17249	Notification when the guest mouse pointer shape has
17250	changed. The new shape data is given.
17251	</desc>
17252
17253	<attribute name="visible" type="boolean" readonly="yes">
17254	<desc>
17255	Flag whether the pointer is visible.
17256	</desc>
17257	</attribute>
17258	<attribute name="alpha" type="boolean" readonly="yes">
17259	<desc>
17260	Flag whether the pointer has an alpha channel.
17261	</desc>
17262	</attribute>
17263	<attribute name="xhot" type="unsigned long" readonly="yes">
17264	<desc>
17265	The pointer hot spot X coordinate.
17266	</desc>
17267	</attribute>
17268	<attribute name="yhot" type="unsigned long" readonly="yes">
17269	<desc>
17270	The pointer hot spot Y coordinate.
17271	</desc>
17272	</attribute>
17273	<attribute name="width" type="unsigned long" readonly="yes">
17274	<desc>
17275	Width of the pointer shape in pixels.
17276	</desc>
17277	</attribute>
17278	<attribute name="height" type="unsigned long" readonly="yes">
17279	<desc>
17280	Height of the pointer shape in pixels.
17281	</desc>
17282	</attribute>
17283	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17284	<desc>
17285	Shape buffer arrays.
17286
17287	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17288	followed by a 32-bpp XOR (color) mask.
17289
17290	For pointers without alpha channel the XOR mask pixels are 32
17291	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17292	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17293
17294	An AND mask is used for pointers with alpha channel, so if the
17295	callback does not support alpha, the pointer could be
17296	displayed as a normal color pointer.
17297
17298	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17299	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17300	height</tt>. The padding bits at the end of each scanline are
17301	undefined.
17302
17303	The XOR mask follows the AND mask on the next 4-byte aligned
17304	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17305	Bytes in the gap between the AND and the XOR mask are undefined.
17306	The XOR mask scanlines have no gap between them and the size of
17307	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17308
17309	<note>
17310	If @a shape is 0, only the pointer visibility is changed.
17311	</note>
17312	</desc>
17313	</attribute>
17314	</interface>
17315
17316	<interface
17317	name="IMouseCapabilityChangedEvent" extends="IEvent"
17318	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17319	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17320	>
17321	<desc>
17322	Notification when the mouse capabilities reported by the
17323	guest have changed. The new capabilities are passed.
17324	</desc>
17325	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17326	<desc>
17327	Supports absolute coordinates.
17328	</desc>
17329	</attribute>
17330	<attribute name="supportsRelative" type="boolean" readonly="yes">
17331	<desc>
17332	Supports relative coordinates.
17333	</desc>
17334	</attribute>
17335	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17336	<desc>
17337	If host cursor is needed.
17338	</desc>
17339	</attribute>
17340	</interface>
17341
17342	<interface
17343	name="IKeyboardLedsChangedEvent" extends="IEvent"
17344	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17345	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17346	>
17347	<desc>
17348	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17349	to alter the state of the keyboard LEDs.
17350	</desc>
17351	<attribute name="numLock" type="boolean" readonly="yes">
17352	<desc>
17353	NumLock status.
17354	</desc>
17355	</attribute>
17356	<attribute name="capsLock" type="boolean" readonly="yes">
17357	<desc>
17358	CapsLock status.
17359	</desc>
17360	</attribute>
17361	<attribute name="scrollLock" type="boolean" readonly="yes">
17362	<desc>
17363	ScrollLock status.
17364	</desc>
17365	</attribute>
17366	</interface>
17367
17368	<interface
17369	name="IStateChangedEvent" extends="IEvent"
17370	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17371	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17372	>
17373	<desc>
17374	Notification when the execution state of the machine has changed.
17375	The new state is given.
17376	</desc>
17377	<attribute name="state" type="MachineState" readonly="yes">
17378	<desc>
17379	New machine state.
17380	</desc>
17381	</attribute>
17382	</interface>
17383
17384	<interface
17385	name="IAdditionsStateChangedEvent" extends="IEvent"
17386	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17387	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17388	>
17389	<desc>
17390	Notification when a Guest Additions property changes.
17391	Interested callees should query IGuest attributes to
17392	find out what has changed.
17393	</desc>
17394	</interface>
17395
17396	<interface
17397	name="INetworkAdapterChangedEvent" extends="IEvent"
17398	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17399	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17400	>
17401	<desc>
17402	Notification when a property of one of the
17403	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17404	changes. Interested callees should use INetworkAdapter methods and
17405	attributes to find out what has changed.
17406	</desc>
17407	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17408	<desc>
17409	Network adapter that is subject to change.
17410	</desc>
17411	</attribute>
17412	</interface>
17413
17414	<interface
17415	name="ISerialPortChangedEvent" extends="IEvent"
17416	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17417	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17418	>
17419	<desc>
17420	Notification when a property of one of the
17421	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17422	Interested callees should use ISerialPort methods and attributes
17423	to find out what has changed.
17424	</desc>
17425	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17426	<desc>
17427	Serial port that is subject to change.
17428	</desc>
17429	</attribute>
17430	</interface>
17431
17432	<interface
17433	name="IParallelPortChangedEvent" extends="IEvent"
17434	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17435	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17436	>
17437	<desc>
17438	Notification when a property of one of the
17439	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17440	changes. Interested callees should use ISerialPort methods and
17441	attributes to find out what has changed.
17442	</desc>
17443	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17444	<desc>
17445	Parallel port that is subject to change.
17446	</desc>
17447	</attribute>
17448	</interface>
17449
17450	<interface
17451	name="IStorageControllerChangedEvent" extends="IEvent"
17452	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17453	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17454	>
17455	<desc>
17456	Notification when a
17457	<link to="IMachine::mediumAttachments">medium attachment</link>
17458	changes.
17459	</desc>
17460	</interface>
17461
17462	<interface
17463	name="IMediumChangedEvent" extends="IEvent"
17464	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17465	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17466	>
17467	<desc>
17468	Notification when a
17469	<link to="IMachine::mediumAttachments">medium attachment</link>
17470	changes.
17471	</desc>
17472	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17473	<desc>
17474	Medium attachment that is subject to change.
17475	</desc>
17476	</attribute>
17477	</interface>
17478
17479	<interface
17480	name="ICPUChangedEvent" extends="IEvent"
17481	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17482	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17483	>
17484	<desc>
17485	Notification when a CPU changes.
17486	</desc>
17487	<attribute name="cpu" type="unsigned long" readonly="yes">
17488	<desc>
17489	The CPU which changed.
17490	</desc>
17491	</attribute>
17492	<attribute name="add" type="boolean" readonly="yes">
17493	<desc>
17494	Flag whether the CPU was added or removed.
17495	</desc>
17496	</attribute>
17497	</interface>
17498
17499	<interface
17500	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17501	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17502	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17503	>
17504	<desc>
17505	Notification when the CPU execution cap changes.
17506	</desc>
17507	<attribute name="executionCap" type="unsigned long" readonly="yes">
17508	<desc>
17509	The new CPU execution cap value. (1-100)
17510	</desc>
17511	</attribute>
17512	</interface>
17513
17514	<interface
17515	name="IGuestKeyboardEvent" extends="IEvent"
17516	uuid="88394258-7006-40d4-b339-472ee3801844"
17517	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17518	>
17519	<desc>
17520	Notification when guest keyboard event happens.
17521	</desc>
17522	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17523	<desc>
17524	Array of scancodes.
17525	</desc>
17526	</attribute>
17527	</interface>
17528
17529	<interface
17530	name="IGuestMouseEvent" extends="IReusableEvent"
17531	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17532	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17533	>
17534	<desc>
17535	Notification when guest mouse event happens.
17536	</desc>
17537
17538	<attribute name="absolute" type="boolean" readonly="yes">
17539	<desc>
17540	If this event is relative or absolute.
17541	</desc>
17542	</attribute>
17543
17544	<attribute name="x" type="long" readonly="yes">
17545	<desc>
17546	New X position, or X delta.
17547	</desc>
17548	</attribute>
17549
17550	<attribute name="y" type="long" readonly="yes">
17551	<desc>
17552	New Y position, or Y delta.
17553	</desc>
17554	</attribute>
17555
17556	<attribute name="z" type="long" readonly="yes">
17557	<desc>
17558	Z delta.
17559	</desc>
17560	</attribute>
17561
17562	<attribute name="w" type="long" readonly="yes">
17563	<desc>
17564	W delta.
17565	</desc>
17566	</attribute>
17567
17568	<attribute name="buttons" type="long" readonly="yes">
17569	<desc>
17570	Button state bitmask.
17571	</desc>
17572	</attribute>
17573
17574	</interface>
17575
17576
17577	<interface
17578	name="IVRDEServerChangedEvent" extends="IEvent"
17579	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17580	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17581	>
17582	<desc>
17583	Notification when a property of the
17584	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17585	Interested callees should use IVRDEServer methods and attributes to
17586	find out what has changed.
17587	</desc>
17588	</interface>
17589
17590	<interface
17591	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17592	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17593	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17594	>
17595	<desc>
17596	Notification when the status of the VRDE server changes. Interested callees
17597	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17598	attributes to find out what is the current status.
17599	</desc>
17600	</interface>
17601
17602	<interface
17603	name="IUSBControllerChangedEvent" extends="IEvent"
17604	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17605	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17606	>
17607	<desc>
17608	Notification when a property of the virtual
17609	<link to="IMachine::USBController">USB controller</link> changes.
17610	Interested callees should use IUSBController methods and attributes to
17611	find out what has changed.
17612	</desc>
17613	</interface>
17614
17615	<interface
17616	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17617	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17618	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17619	>
17620	<desc>
17621	Notification when a USB device is attached to or detached from
17622	the virtual USB controller.
17623
17624	This notification is sent as a result of the indirect
17625	request to attach the device because it matches one of the
17626	machine USB filters, or as a result of the direct request
17627	issued by <link to="IConsole::attachUSBDevice"/> or
17628	<link to="IConsole::detachUSBDevice"/>.
17629
17630	This notification is sent in case of both a succeeded and a
17631	failed request completion. When the request succeeds, the
17632	@a error parameter is @c null, and the given device has been
17633	already added to (when @a attached is @c true) or removed from
17634	(when @a attached is @c false) the collection represented by
17635	<link to="IConsole::USBDevices"/>. On failure, the collection
17636	doesn't change and the @a error parameter represents the error
17637	message describing the failure.
17638	</desc>
17639	<attribute name="device" type="IUSBDevice" readonly="yes">
17640	<desc>
17641	Device that is subject to state change.
17642	</desc>
17643	</attribute>
17644	<attribute name="attached" type="boolean" readonly="yes">
17645	<desc>
17646	@c true if the device was attached and @c false otherwise.
17647	</desc>
17648	</attribute>
17649	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17650	<desc>
17651	@c null on success or an error message object on failure.
17652	</desc>
17653	</attribute>
17654	</interface>
17655
17656	<interface
17657	name="ISharedFolderChangedEvent" extends="IEvent"
17658	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17659	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17660	>
17661	<desc>
17662	Notification when a shared folder is added or removed.
17663	The @a scope argument defines one of three scopes:
17664	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17665	(<link to="Scope_Global">Global</link>),
17666	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17667	the machine (<link to="Scope_Machine">Machine</link>) or <link
17668	to="IConsole::sharedFolders">transient shared folders</link> of the
17669	machine (<link to="Scope_Session">Session</link>). Interested callees
17670	should use query the corresponding collections to find out what has
17671	changed.
17672	</desc>
17673	<attribute name="scope" type="Scope" readonly="yes">
17674	<desc>
17675	Scope of the notification.
17676	</desc>
17677	</attribute>
17678	</interface>
17679
17680	<interface
17681	name="IRuntimeErrorEvent" extends="IEvent"
17682	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17683	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17684	>
17685	<desc>
17686	Notification when an error happens during the virtual
17687	machine execution.
17688
17689	There are three kinds of runtime errors:
17690	<ul>
17691	<li><i>fatal</i></li>
17692	<li><i>non-fatal with retry</i></li>
17693	<li><i>non-fatal warnings</i></li>
17694	</ul>
17695
17696	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17697	to @c true. In case of fatal errors, the virtual machine
17698	execution is always paused before calling this notification, and
17699	the notification handler is supposed either to immediately save
17700	the virtual machine state using <link to="IConsole::saveState"/>
17701	or power it off using <link to="IConsole::powerDown"/>.
17702	Resuming the execution can lead to unpredictable results.
17703
17704	<b>Non-fatal</b> errors and warnings are indicated by the
17705	@a fatal parameter set to @c false. If the virtual machine
17706	is in the Paused state by the time the error notification is
17707	received, it means that the user can <i>try to resume</i> the machine
17708	execution after attempting to solve the problem that caused the
17709	error. In this case, the notification handler is supposed
17710	to show an appropriate message to the user (depending on the
17711	value of the @a id parameter) that offers several actions such
17712	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17713	wants to retry, the notification handler should continue
17714	the machine execution using the <link to="IConsole::resume"/>
17715	call. If the machine execution is not Paused during this
17716	notification, then it means this notification is a <i>warning</i>
17717	(for example, about a fatal condition that can happen very soon);
17718	no immediate action is required from the user, the machine
17719	continues its normal execution.
17720
17721	Note that in either case the notification handler
17722	<b>must not</b> perform any action directly on a thread
17723	where this notification is called. Everything it is allowed to
17724	do is to post a message to another thread that will then talk
17725	to the user and take the corresponding action.
17726
17727	Currently, the following error identifiers are known:
17728	<ul>
17729	<li><tt>"HostMemoryLow"</tt></li>
17730	<li><tt>"HostAudioNotResponding"</tt></li>
17731	<li><tt>"VDIStorageFull"</tt></li>
17732	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17733	</ul>
17734	</desc>
17735	<attribute name="fatal" type="boolean" readonly="yes">
17736	<desc>
17737	Whether the error is fatal or not.
17738	</desc>
17739	</attribute>
17740	<attribute name="id" type="wstring" readonly="yes">
17741	<desc>
17742	Error identifier.
17743	</desc>
17744	</attribute>
17745	<attribute name="message" type="wstring" readonly="yes">
17746	<desc>
17747	Optional error message.
17748	</desc>
17749	</attribute>
17750	</interface>
17751
17752
17753	<interface
17754	name="IEventSourceChangedEvent" extends="IEvent"
17755	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17756	waitable="yes"
17757	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17758	>
17759	<desc>
17760	Notification when an event source state changes (listener added or removed).
17761	</desc>
17762
17763	<attribute name="listener" type="IEventListener" readonly="yes">
17764	<desc>
17765	Event listener which has changed.
17766	</desc>
17767	</attribute>
17768
17769	<attribute name="add" type="boolean" readonly="yes">
17770	<desc>
17771	Flag whether listener was added or removed.
17772	</desc>
17773	</attribute>
17774	</interface>
17775
17776	<interface
17777	name="IExtraDataChangedEvent" extends="IEvent"
17778	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17779	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17780	>
17781	<desc>
17782	Notification when machine specific or global extra data
17783	has changed.
17784	</desc>
17785	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17786	<desc>
17787	ID of the machine this event relates to.
17788	Null for global extra data changes.
17789	</desc>
17790	</attribute>
17791	<attribute name="key" type="wstring" readonly="yes">
17792	<desc>
17793	Extra data key that has changed.
17794	</desc>
17795	</attribute>
17796	<attribute name="value" type="wstring" readonly="yes">
17797	<desc>
17798	Extra data value for the given key.
17799	</desc>
17800	</attribute>
17801	</interface>
17802
17803	<interface
17804	name="IVetoEvent" extends="IEvent"
17805	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17806	wsmap="managed"
17807	>
17808	<desc>Base abstract interface for veto events.</desc>
17809
17810	<method name="addVeto">
17811	<desc>
17812	Adds a veto on this event.
17813	</desc>
17814	<param name="reason" type="wstring" dir="in">
17815	<desc>
17816	Reason for veto, could be null or empty string.
17817	</desc>
17818	</param>
17819	</method>
17820
17821	<method name="isVetoed">
17822	<desc>
17823	If this event was vetoed.
17824	</desc>
17825	<param name="result" type="boolean" dir="return">
17826	<desc>
17827	Reason for veto.
17828	</desc>
17829	</param>
17830	</method>
17831
17832	<method name="getVetos">
17833	<desc>
17834	Current veto reason list, if size is 0 - no veto.
17835	</desc>
17836	<param name="result" type="wstring" dir="return" safearray="yes">
17837	<desc>
17838	Array of reasons for veto provided by different event handlers.
17839	</desc>
17840	</param>
17841	</method>
17842
17843	</interface>
17844
17845	<interface
17846	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17847	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17848	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17849	waitable="true"
17850	>
17851	<desc>
17852	Notification when someone tries to change extra data for
17853	either the given machine or (if @c null) global extra data.
17854	This gives the chance to veto against changes.
17855	</desc>
17856	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17857	<desc>
17858	ID of the machine this event relates to.
17859	Null for global extra data changes.
17860	</desc>
17861	</attribute>
17862	<attribute name="key" type="wstring" readonly="yes">
17863	<desc>
17864	Extra data key that has changed.
17865	</desc>
17866	</attribute>
17867	<attribute name="value" type="wstring" readonly="yes">
17868	<desc>
17869	Extra data value for the given key.
17870	</desc>
17871	</attribute>
17872	</interface>
17873
17874	<interface
17875	name="ICanShowWindowEvent" extends="IVetoEvent"
17876	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17877	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17878	waitable="true"
17879	>
17880	<desc>
17881	Notification when a call to
17882	<link to="IMachine::canShowConsoleWindow"/> is made by a
17883	front-end to check if a subsequent call to
17884	<link to="IMachine::showConsoleWindow"/> can succeed.
17885
17886	The callee should give an answer appropriate to the current
17887	machine state using event veto. This answer must
17888	remain valid at least until the next
17889	<link to="IConsole::state">machine state</link> change.
17890	</desc>
17891	</interface>
17892
17893	<interface
17894	name="IShowWindowEvent" extends="IEvent"
17895	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
17896	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
17897	waitable="true"
17898	>
17899	<desc>
17900	Notification when a call to
17901	<link to="IMachine::showConsoleWindow"/>
17902	requests the console window to be activated and brought to
17903	foreground on the desktop of the host PC.
17904
17905	This notification should cause the VM console process to
17906	perform the requested action as described above. If it is
17907	impossible to do it at a time of this notification, this
17908	method should return a failure.
17909
17910	Note that many modern window managers on many platforms
17911	implement some sort of focus stealing prevention logic, so
17912	that it may be impossible to activate a window without the
17913	help of the currently active application (which is supposedly
17914	an initiator of this notification). In this case, this method
17915	must return a non-zero identifier that represents the
17916	top-level window of the VM console process. The caller, if it
17917	represents a currently active process, is responsible to use
17918	this identifier (in a platform-dependent manner) to perform
17919	actual window activation.
17920
17921	This method must set @a winId to zero if it has performed all
17922	actions necessary to complete the request and the console
17923	window is now active and in foreground, to indicate that no
17924	further action is required on the caller's side.
17925	</desc>
17926	<attribute name="winId" type="long long">
17927	<desc>
17928	Platform-dependent identifier of the top-level VM console
17929	window, or zero if this method has performed all actions
17930	necessary to implement the <i>show window</i> semantics for
17931	the given platform and/or this VirtualBox front-end.
17932	</desc>
17933	</attribute>
17934	</interface>
17935
17936	<interface
17937	name="INATRedirectEvent" extends="IMachineEvent"
17938	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
17939	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
17940	>
17941	<desc>
17942	Notification when NAT redirect rule added or removed.
17943	</desc>
17944	<attribute name="slot" type="unsigned long" readonly="yes">
17945	<desc>
17946	Adapter which NAT attached to.
17947	</desc>
17948	</attribute>
17949	<attribute name="remove" type="boolean" readonly="yes">
17950	<desc>
17951	Whether rule remove or add.
17952	</desc>
17953	</attribute>
17954	<attribute name="name" type="wstring" readonly="yes">
17955	<desc>
17956	Name of the rule.
17957	</desc>
17958	</attribute>
17959	<attribute name="proto" type="NATProtocol" readonly="yes">
17960	<desc>
17961	Protocol (TCP or UDP) of the redirect rule.
17962	</desc>
17963	</attribute>
17964	<attribute name="hostIp" type="wstring" readonly="yes">
17965	<desc>
17966	Host ip address to bind socket on.
17967	</desc>
17968	</attribute>
17969	<attribute name="hostPort" type="long" readonly="yes">
17970	<desc>
17971	Host port to bind socket on.
17972	</desc>
17973	</attribute>
17974	<attribute name="guestIp" type="wstring" readonly="yes">
17975	<desc>
17976	Guest ip address to redirect to.
17977	</desc>
17978	</attribute>
17979	<attribute name="guestPort" type="long" readonly="yes">
17980	<desc>
17981	Guest port to redirect to.
17982	</desc>
17983	</attribute>
17984	</interface>
17985
17986	<interface
17987	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
17988	waitable="yes"
17989	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
17990	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
17991	>
17992	<desc>
17993	Notification when host PCI device is plugged/unplugged. Plugging
17994	usually takes place on VM startup, unplug - when
17995	<link to="IMachine::detachHostPciDevice"/> is called.
17996
17997	<see><link to="IMachine::detachHostPciDevice"/></see>
17998
17999	</desc>
18000
18001	<attribute name="plugged" type="boolean" readonly="yes">
18002	<desc>
18003	If device successfully plugged or unplugged.
18004	</desc>
18005	</attribute>
18006
18007	<attribute name="success" type="boolean" readonly="yes">
18008	<desc>
18009	If operation was successful, if false - 'message' attribute
18010	may be of interest.
18011	</desc>
18012	</attribute>
18013
18014	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18015	<desc>
18016	Attachment info for this device.
18017	</desc>
18018	</attribute>
18019
18020	<attribute name="message" type="wstring" readonly="yes">
18021	<desc>
18022	Optional error message.
18023	</desc>
18024	</attribute>
18025
18026	</interface>
18027
18028	<interface
18029	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18030	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18031	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18032	>
18033	<desc>
18034	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18035	unexpected circumstances) or available again.
18036	</desc>
18037
18038	<attribute name="available" type="boolean" readonly="yes">
18039	<desc>
18040	Whether VBoxSVC is available now.
18041	</desc>
18042	</attribute>
18043	</interface>
18044
18045	<interface
18046	name="IBandwidthGroupChangedEvent" extends="IEvent"
18047	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18048	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18049	>
18050	<desc>
18051	Notification when one of the bandwidth groups changed
18052	</desc>
18053	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18054	<desc>
18055	The changed bandwidth group.
18056	</desc>
18057	</attribute>
18058	</interface>
18059
18060	<enum
18061	name="GuestMonitorChangedEventType"
18062	uuid="ef172985-7e36-4297-95be-e46396968d66"
18063	>
18064
18065	<desc>
18066	How the guest monitor has been changed.
18067	</desc>
18068
18069	<const name="Enabled" value="0">
18070	<desc>
18071	The guest monitor has been enabled by the guest.
18072	</desc>
18073	</const>
18074
18075	<const name="Disabled" value="1">
18076	<desc>
18077	The guest monitor has been disabled by the guest.
18078	</desc>
18079	</const>
18080
18081	<const name="NewOrigin" value="2">
18082	<desc>
18083	The guest monitor origin has changed in the guest.
18084	</desc>
18085	</const>
18086	</enum>
18087
18088	<interface
18089	name="IGuestMonitorChangedEvent" extends="IEvent"
18090	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18091	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18092	>
18093	<desc>
18094	Notification when the guest enables one of its monitors.
18095	</desc>
18096
18097	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18098	<desc>
18099	What was changed for this guest monitor.
18100	</desc>
18101	</attribute>
18102
18103	<attribute name="screenId" type="unsigned long" readonly="yes">
18104	<desc>
18105	The monitor which was changed.
18106	</desc>
18107	</attribute>
18108
18109	<attribute name="originX" type="unsigned long" readonly="yes">
18110	<desc>
18111	Physical X origin relative to the primary screen.
18112	Valid for Enabled and NewOrigin.
18113	</desc>
18114	</attribute>
18115
18116	<attribute name="originY" type="unsigned long" readonly="yes">
18117	<desc>
18118	Physical Y origin relative to the primary screen.
18119	Valid for Enabled and NewOrigin.
18120	</desc>
18121	</attribute>
18122
18123	<attribute name="width" type="unsigned long" readonly="yes">
18124	<desc>
18125	Width of the screen.
18126	Valid for Enabled.
18127	</desc>
18128	</attribute>
18129
18130	<attribute name="height" type="unsigned long" readonly="yes">
18131	<desc>
18132	Height of the screen.
18133	Valid for Enabled.
18134	</desc>
18135	</attribute>
18136
18137	</interface>
18138
18139	<interface
18140	name="IStorageDeviceChangedEvent" extends="IEvent"
18141	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18142	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18143	>
18144	<desc>
18145	Notification when a
18146	<link to="IMachine::mediumAttachments">storage device</link>
18147	is attached or removed.
18148	</desc>
18149	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18150	<desc>
18151	Storage device that is subject to change.
18152	</desc>
18153	</attribute>
18154	<attribute name="removed" type="boolean" readonly="yes">
18155	<desc>
18156	Flag whether the device was removed or added to the VM.
18157	</desc>
18158	</attribute>
18159	</interface>
18160
18161	<module name="VBoxSVC" context="LocalServer">
18162	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18163	namespace="virtualbox.org">
18164	<interface name="IVirtualBox" default="yes"/>
18165	</class>
18166	</module>
18167
18168	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18169	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18170	namespace="virtualbox.org">
18171	<interface name="IVirtualBoxClient" default="yes"/>
18172	</class>
18173
18174	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18175	namespace="virtualbox.org">
18176	<interface name="ISession" default="yes"/>
18177	</class>
18178	</module>
18179
18180	</library>
18181
18182	</idl>
18183
18184	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format