VirtualBox.xidl@ 39933

Last change on this file since 39933 was 39882, checked in by vboxsync, 13 years ago
Config.kmk,VMMDev,Main,QtGui,VBoxManage: Refactored IGuest::additionsVersion and associated acts, splitting it up into additionsVersion and additionsRevision like IVirtualBox and IExtPack handles versioning. Fixed missing saved state in VMMDev where the VMMDevReq_ReportGuestInfo2 info was not saved and Main+Frontends led to believe we were running guest additions older than 3.2. The changes have be subjected to limited testing. Added TODOs for another missing save in VMMDev.
Property svn:eol-style set to `native`
File size: 658.9 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	</desc>
4172	</attribute>
4173
4174	<attribute name="faultToleranceState" type="FaultToleranceState">
4175	<desc>
4176	Fault tolerance state; disabled, source or target.
4177	This property can be changed at any time. If you change it for a running
4178	VM, then the fault tolerance address and port must be set beforehand.
4179	</desc>
4180	</attribute>
4181
4182	<attribute name="faultTolerancePort" type="unsigned long">
4183	<desc>
4184	The TCP port the fault tolerance source or target will use for
4185	communication.
4186	</desc>
4187	</attribute>
4188
4189	<attribute name="faultToleranceAddress" type="wstring">
4190	<desc>
4191	The address the fault tolerance source or target.
4192	</desc>
4193	</attribute>
4194
4195	<attribute name="faultTolerancePassword" type="wstring">
4196	<desc>
4197	The password to check for on the standby VM. This is just a
4198	very basic measure to prevent simple hacks and operators accidentally
4199	choosing the wrong standby VM.
4200	</desc>
4201	</attribute>
4202
4203	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4204	<desc>
4205	The interval in ms used for syncing the state between source and target.
4206	</desc>
4207	</attribute>
4208
4209	<attribute name="RTCUseUTC" type="boolean">
4210	<desc>
4211	When set to @a true, the RTC device of the virtual machine will run
4212	in UTC time, otherwise in local time. Especially Unix guests prefer
4213	the time in UTC.
4214	</desc>
4215	</attribute>
4216
4217	<attribute name="ioCacheEnabled" type="boolean">
4218	<desc>
4219	When set to @a true, the builtin I/O cache of the virtual machine
4220	will be enabled.
4221	</desc>
4222	</attribute>
4223
4224	<attribute name="ioCacheSize" type="unsigned long">
4225	<desc>
4226	Maximum size of the I/O cache in MB.
4227	</desc>
4228	</attribute>
4229
4230	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4231	<desc>
4232	Bandwidth control manager.
4233	</desc>
4234	</attribute>
4235
4236	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4237	<desc>Array of PCI devices assigned to this machine, to get list of all
4238	PCI devices attached to the machine use
4239	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4240	is intended to list only devices additional to what described in
4241	virtual hardware config. Usually, this list keeps host's physical
4242	devices assigned to the particular machine.
4243	</desc>
4244	</attribute>
4245
4246	<method name="lockMachine">
4247	<desc>
4248	Locks the machine for the given session to enable the caller
4249	to make changes to the machine or start the VM or control
4250	VM execution.
4251
4252	There are two ways to lock a machine for such uses:
4253
4254	<ul>
4255	<li>If you want to make changes to the machine settings,
4256	you must obtain an exclusive write lock on the machine
4257	by setting @a lockType to @c Write.
4258
4259	This will only succeed if no other process has locked
4260	the machine to prevent conflicting changes. Only after
4261	an exclusive write lock has been obtained using this method, one
4262	can change all VM settings or execute the VM in the process
4263	space of the session object. (Note that the latter is only of
4264	interest if you actually want to write a new front-end for
4265	virtual machines; but this API gets called internally by
4266	the existing front-ends such as VBoxHeadless and the VirtualBox
4267	GUI to acquire a write lock on the machine that they are running.)
4268
4269	On success, write-locking the machine for a session creates
4270	a second copy of the IMachine object. It is this second object
4271	upon which changes can be made; in VirtualBox terminology, the
4272	second copy is "mutable". It is only this second, mutable machine
4273	object upon which you can call methods that change the
4274	machine state. After having called this method, you can
4275	obtain this second, mutable machine object using the
4276	<link to="ISession::machine" /> attribute.
4277	</li>
4278	<li>If you only want to check the machine state or control
4279	machine execution without actually changing machine
4280	settings (e.g. to get access to VM statistics or take
4281	a snapshot or save the machine state), then set the
4282	@a lockType argument to @c Shared.
4283
4284	If no other session has obtained a lock, you will obtain an
4285	exclusive write lock as described above. However, if another
4286	session has already obtained such a lock, then a link to that
4287	existing session will be established which allows you
4288	to control that existing session.
4289
4290	To find out which type of lock was obtained, you can
4291	inspect <link to="ISession::type" />, which will have been
4292	set to either @c WriteLock or @c Shared.
4293	</li>
4294	</ul>
4295
4296	In either case, you can get access to the <link to="IConsole" />
4297	object which controls VM execution.
4298
4299	Also in all of the above cases, one must always call
4300	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4301	the machine's state will eventually be set to "Aborted".
4302
4303	To change settings on a machine, the following sequence is typically
4304	performed:
4305
4306	<ol>
4307	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4308
4309	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4310
4311	<li>Change the settings of the machine by invoking IMachine methods.</li>
4312
4313	<li>Call <link to="IMachine::saveSettings" />.</li>
4314
4315	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4316	</ol>
4317
4318	<result name="E_UNEXPECTED">
4319	Virtual machine not registered.
4320	</result>
4321	<result name="E_ACCESSDENIED">
4322	Process not started by OpenRemoteSession.
4323	</result>
4324	<result name="VBOX_E_INVALID_OBJECT_STATE">
4325	Session already open or being opened.
4326	</result>
4327	<result name="VBOX_E_VM_ERROR">
4328	Failed to assign machine to session.
4329	</result>
4330	</desc>
4331	<param name="session" type="ISession" dir="in">
4332	<desc>
4333	Session object for which the machine will be locked.
4334	</desc>
4335	</param>
4336	<param name="lockType" type="LockType" dir="in">
4337	<desc>
4338	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4339	If set to @c Shared, then either acquire an exclusive write lock or establish
4340	a link to an existing session.
4341	</desc>
4342	</param>
4343	</method>
4344
4345	<method name="launchVMProcess">
4346	<desc>
4347	Spawns a new process that will execute the virtual machine and obtains a shared
4348	lock on the machine for the calling session.
4349
4350	If launching the VM succeeds, the new VM process will create its own session
4351	and write-lock the machine for it, preventing conflicting changes from other
4352	processes. If the machine is already locked (because it is already running or
4353	because another session has a write lock), launching the VM process will therefore
4354	fail. Reversely, future attempts to obtain a write lock will also fail while the
4355	machine is running.
4356
4357	The caller's session object remains separate from the session opened by the new
4358	VM process. It receives its own <link to="IConsole" /> object which can be used
4359	to control machine execution, but it cannot be used to change all VM settings
4360	which would be available after a <link to="#lockMachine" /> call.
4361
4362	The caller must eventually release the session's shared lock by calling
4363	<link to="ISession::unlockMachine" /> on the local session object once this call
4364	has returned. However, the session's state (see <link to="ISession::state" />)
4365	will not return to "Unlocked" until the remote session has also unlocked
4366	the machine (i.e. the machine has stopped running).
4367
4368	Launching a VM process can take some time (a new VM is started in a new process,
4369	for which memory and other resources need to be set up). Because of this,
4370	an <link to="IProgress" /> object is returned to allow the caller to wait
4371	for this asynchronous operation to be completed. Until then, the caller's
4372	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4373	and <link to="ISession::console" /> attributes cannot be accessed.
4374	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4375	similar calls to wait for completion. Completion is signalled when the VM
4376	is powered on. If launching the VM fails, error messages can be queried
4377	via the progress object, if available.
4378
4379	The progress object will have at least 2 sub-operations. The first
4380	operation covers the period up to the new VM process calls powerUp.
4381	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4382	progress object. Because <link to="IConsole::powerUp"/> may require
4383	some extra sub-operations, the <link to="IProgress::operationCount"/>
4384	may change at the completion of operation.
4385
4386	For details on the teleportation progress operation, see
4387	<link to="IConsole::powerUp"/>.
4388
4389	The @a environment argument is a string containing definitions of
4390	environment variables in the following format:
4391	<pre>
4392	NAME[=VALUE]\n
4393	NAME[=VALUE]\n
4394	...
4395	</pre>
4396	where <tt>\\n</tt> is the new line character. These environment
4397	variables will be appended to the environment of the VirtualBox server
4398	process. If an environment variable exists both in the server process
4399	and in this list, the value from this list takes precedence over the
4400	server's variable. If the value of the environment variable is
4401	omitted, this variable will be removed from the resulting environment.
4402	If the environment string is @c null or empty, the server environment
4403	is inherited by the started process as is.
4404
4405	<result name="E_UNEXPECTED">
4406	Virtual machine not registered.
4407	</result>
4408	<result name="E_INVALIDARG">
4409	Invalid session type @a type.
4410	</result>
4411	<result name="VBOX_E_OBJECT_NOT_FOUND">
4412	No machine matching @a machineId found.
4413	</result>
4414	<result name="VBOX_E_INVALID_OBJECT_STATE">
4415	Session already open or being opened.
4416	</result>
4417	<result name="VBOX_E_IPRT_ERROR">
4418	Launching process for machine failed.
4419	</result>
4420	<result name="VBOX_E_VM_ERROR">
4421	Failed to assign machine to session.
4422	</result>
4423	</desc>
4424	<param name="session" type="ISession" dir="in">
4425	<desc>
4426	Client session object to which the VM process will be connected (this
4427	must be in "Unlocked" state).
4428	</desc>
4429	</param>
4430	<param name="type" type="wstring" dir="in">
4431	<desc>
4432	Front-end to use for the new VM process. The following are currently supported:
4433	<ul>
4434	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4435	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4436	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4437	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4438	the currently running VM or session owner. In this case the
4439	@a session parameter may be @c NULL (if it is non-null it isn't
4440	used in any way), and the @a progress return value will be always
4441	NULL. The operation completes immediately.</li>
4442	</ul>
4443	</desc>
4444	</param>
4445	<param name="environment" type="wstring" dir="in">
4446	<desc>
4447	Environment to pass to the VM process.
4448	</desc>
4449	</param>
4450	<param name="progress" type="IProgress" dir="return">
4451	<desc>Progress object to track the operation completion.</desc>
4452	</param>
4453	</method>
4454
4455	<method name="setBootOrder">
4456	<desc>
4457	Puts the given device to the specified position in
4458	the boot order.
4459
4460	To indicate that no device is associated with the given position,
4461	<link to="DeviceType_Null"/> should be used.
4462
4463	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4464
4465	<result name="E_INVALIDARG">
4466	Boot @a position out of range.
4467	</result>
4468	<result name="E_NOTIMPL">
4469	Booting from USB @a device currently not supported.
4470	</result>
4471
4472	</desc>
4473	<param name="position" type="unsigned long" dir="in">
4474	<desc>
4475	Position in the boot order (@c 1 to the total number of
4476	devices the machine can boot from, as returned by
4477	<link to="ISystemProperties::maxBootPosition"/>).
4478	</desc>
4479	</param>
4480	<param name="device" type="DeviceType" dir="in">
4481	<desc>
4482	The type of the device used to boot at the given position.
4483	</desc>
4484	</param>
4485	</method>
4486
4487	<method name="getBootOrder" const="yes">
4488	<desc>
4489	Returns the device type that occupies the specified
4490	position in the boot order.
4491
4492	@todo [remove?]
4493	If the machine can have more than one device of the returned type
4494	(such as hard disks), then a separate method should be used to
4495	retrieve the individual device that occupies the given position.
4496
4497	If here are no devices at the given position, then
4498	<link to="DeviceType_Null"/> is returned.
4499
4500	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4501
4502	<result name="E_INVALIDARG">
4503	Boot @a position out of range.
4504	</result>
4505
4506	</desc>
4507	<param name="position" type="unsigned long" dir="in">
4508	<desc>
4509	Position in the boot order (@c 1 to the total number of
4510	devices the machine can boot from, as returned by
4511	<link to="ISystemProperties::maxBootPosition"/>).
4512	</desc>
4513	</param>
4514	<param name="device" type="DeviceType" dir="return">
4515	<desc>
4516	Device at the given position.
4517	</desc>
4518	</param>
4519	</method>
4520
4521	<method name="attachDevice">
4522	<desc>
4523	Attaches a device and optionally mounts a medium to the given storage
4524	controller (<link to="IStorageController" />, identified by @a name),
4525	at the indicated port and device.
4526
4527	This method is intended for managing storage devices in general while a
4528	machine is powered off. It can be used to attach and detach fixed
4529	and removable media. The following kind of media can be attached
4530	to a machine:
4531
4532	<ul>
4533	<li>For fixed and removable media, you can pass in a medium that was
4534	previously opened using <link to="IVirtualBox::openMedium" />.
4535	</li>
4536
4537	<li>Only for storage devices supporting removable media (such as
4538	DVDs and floppies), you can also specify a null pointer to
4539	indicate an empty drive or one of the medium objects listed
4540	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4541	arrays to indicate a host drive.
4542	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4543	to change the media while the machine is running.
4544	</li>
4545	</ul>
4546
4547	In a VM's default configuration of virtual machines, the secondary
4548	master of the IDE controller is used for a CD/DVD drive.
4549
4550	After calling this returns successfully, a new instance of
4551	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4552	attachments (see <link to="IMachine::mediumAttachments"/>).
4553
4554	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4555	information about attaching media.
4556
4557	The specified device slot must not have a device attached to it,
4558	or this method will fail.
4559
4560	<note>
4561	You cannot attach a device to a newly created machine until
4562	this machine's settings are saved to disk using
4563	<link to="#saveSettings"/>.
4564	</note>
4565	<note>
4566	If the medium is being attached indirectly, a new differencing medium
4567	will implicitly be created for it and attached instead. If the
4568	changes made to the machine settings (including this indirect
4569	attachment) are later cancelled using <link to="#discardSettings"/>,
4570	this implicitly created differencing medium will implicitly
4571	be deleted.
4572	</note>
4573
4574	<result name="E_INVALIDARG">
4575	SATA device, SATA port, IDE port or IDE slot out of range, or
4576	file or UUID not found.
4577	</result>
4578	<result name="VBOX_E_INVALID_OBJECT_STATE">
4579	Machine must be registered before media can be attached.
4580	</result>
4581	<result name="VBOX_E_INVALID_VM_STATE">
4582	Invalid machine state.
4583	</result>
4584	<result name="VBOX_E_OBJECT_IN_USE">
4585	A medium is already attached to this or another virtual machine.
4586	</result>
4587
4588	</desc>
4589	<param name="name" type="wstring" dir="in">
4590	<desc>Name of the storage controller to attach the device to.</desc>
4591	</param>
4592	<param name="controllerPort" type="long" dir="in">
4593	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4594	the primary controller and 1 specifies the secondary controller.
4595	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4596	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4597	</param>
4598	<param name="device" type="long" dir="in">
4599	<desc>Device slot in the given port to attach the device to. This is only
4600	relevant for IDE controllers, for which 0 specifies the master device and
4601	1 specifies the slave device. For all other controller types, this must
4602	be 0.</desc>
4603	</param>
4604	<param name="type" type="DeviceType" dir="in">
4605	<desc>Device type of the attached device. For media opened by
4606	<link to="IVirtualBox::openMedium" />, this must match the device type
4607	specified there.</desc>
4608	</param>
4609	<param name="medium" type="IMedium" dir="in">
4610	<desc>Medium to mount or NULL for an empty drive.</desc>
4611	</param>
4612	</method>
4613
4614	<method name="detachDevice">
4615	<desc>
4616	Detaches the device attached to a device slot of the specified bus.
4617
4618	Detaching the device from the virtual machine is deferred. This means
4619	that the medium remains associated with the machine when this method
4620	returns and gets actually de-associated only after a successful
4621	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4622	for more detailed information about attaching media.
4623
4624	<note>
4625	You cannot detach a device from a running machine.
4626	</note>
4627	<note>
4628	Detaching differencing media implicitly created by <link
4629	to="#attachDevice"/> for the indirect attachment using this
4630	method will <b>not</b> implicitly delete them. The
4631	<link to="IMedium::deleteStorage"/> operation should be
4632	explicitly performed by the caller after the medium is successfully
4633	detached and the settings are saved with
4634	<link to="#saveSettings"/>, if it is the desired action.
4635	</note>
4636
4637	<result name="VBOX_E_INVALID_VM_STATE">
4638	Attempt to detach medium from a running virtual machine.
4639	</result>
4640	<result name="VBOX_E_OBJECT_NOT_FOUND">
4641	No medium attached to given slot/bus.
4642	</result>
4643	<result name="VBOX_E_NOT_SUPPORTED">
4644	Medium format does not support storage deletion.
4645	</result>
4646
4647	</desc>
4648	<param name="name" type="wstring" dir="in">
4649	<desc>Name of the storage controller to detach the medium from.</desc>
4650	</param>
4651	<param name="controllerPort" type="long" dir="in">
4652	<desc>Port number to detach the medium from.</desc>
4653	</param>
4654	<param name="device" type="long" dir="in">
4655	<desc>Device slot number to detach the medium from.</desc>
4656	</param>
4657	</method>
4658
4659	<method name="passthroughDevice">
4660	<desc>
4661	Sets the passthrough mode of an existing DVD device. Changing the
4662	setting while the VM is running is forbidden. The setting is only used
4663	if at VM start the device is configured as a host DVD drive, in all
4664	other cases it is ignored. The device must already exist; see
4665	<link to="IMachine::attachDevice"/> for how to attach a new device.
4666
4667	The @a controllerPort and @a device parameters specify the device slot and
4668	have have the same meaning as with <link to="IMachine::attachDevice" />.
4669
4670	<result name="E_INVALIDARG">
4671	SATA device, SATA port, IDE port or IDE slot out of range.
4672	</result>
4673	<result name="VBOX_E_INVALID_OBJECT_STATE">
4674	Attempt to modify an unregistered virtual machine.
4675	</result>
4676	<result name="VBOX_E_INVALID_VM_STATE">
4677	Invalid machine state.
4678	</result>
4679
4680	</desc>
4681	<param name="name" type="wstring" dir="in">
4682	<desc>Name of the storage controller.</desc>
4683	</param>
4684	<param name="controllerPort" type="long" dir="in">
4685	<desc>Storage controller port.</desc>
4686	</param>
4687	<param name="device" type="long" dir="in">
4688	<desc>Device slot in the given port.</desc>
4689	</param>
4690	<param name="passthrough" type="boolean" dir="in">
4691	<desc>New value for the passthrough setting.</desc>
4692	</param>
4693	</method>
4694
4695	<method name="temporaryEjectDevice">
4696	<desc>
4697	Sets the behavior for guest-triggered medium eject. In some situations
4698	it is desirable that such ejects update the VM configuration, and in
4699	others the eject should keep the VM configuration. The device must
4700	already exist; see <link to="IMachine::attachDevice"/> for how to
4701	attach a new device.
4702
4703	The @a controllerPort and @a device parameters specify the device slot and
4704	have have the same meaning as with <link to="IMachine::attachDevice" />.
4705
4706	<result name="E_INVALIDARG">
4707	SATA device, SATA port, IDE port or IDE slot out of range.
4708	</result>
4709	<result name="VBOX_E_INVALID_OBJECT_STATE">
4710	Attempt to modify an unregistered virtual machine.
4711	</result>
4712	<result name="VBOX_E_INVALID_VM_STATE">
4713	Invalid machine state.
4714	</result>
4715
4716	</desc>
4717	<param name="name" type="wstring" dir="in">
4718	<desc>Name of the storage controller.</desc>
4719	</param>
4720	<param name="controllerPort" type="long" dir="in">
4721	<desc>Storage controller port.</desc>
4722	</param>
4723	<param name="device" type="long" dir="in">
4724	<desc>Device slot in the given port.</desc>
4725	</param>
4726	<param name="temporaryEject" type="boolean" dir="in">
4727	<desc>New value for the eject behavior.</desc>
4728	</param>
4729	</method>
4730
4731	<method name="nonRotationalDevice">
4732	<desc>
4733	Sets a flag in the device information which indicates that the medium
4734	is not based on rotational technology, i.e. that the access times are
4735	more or less independent of the position on the medium. This may or may
4736	not be supported by a particular drive, and is silently ignored in the
4737	latter case. At the moment only hard disks (which is a misnomer in this
4738	context) accept this setting. Changing the setting while the VM is
4739	running is forbidden. The device must already exist; see
4740	<link to="IMachine::attachDevice"/> for how to attach a new device.
4741
4742	The @a controllerPort and @a device parameters specify the device slot and
4743	have have the same meaning as with <link to="IMachine::attachDevice" />.
4744
4745	<result name="E_INVALIDARG">
4746	SATA device, SATA port, IDE port or IDE slot out of range.
4747	</result>
4748	<result name="VBOX_E_INVALID_OBJECT_STATE">
4749	Attempt to modify an unregistered virtual machine.
4750	</result>
4751	<result name="VBOX_E_INVALID_VM_STATE">
4752	Invalid machine state.
4753	</result>
4754
4755	</desc>
4756	<param name="name" type="wstring" dir="in">
4757	<desc>Name of the storage controller.</desc>
4758	</param>
4759	<param name="controllerPort" type="long" dir="in">
4760	<desc>Storage controller port.</desc>
4761	</param>
4762	<param name="device" type="long" dir="in">
4763	<desc>Device slot in the given port.</desc>
4764	</param>
4765	<param name="nonRotational" type="boolean" dir="in">
4766	<desc>New value for the non-rotational device flag.</desc>
4767	</param>
4768	</method>
4769
4770	<method name="setAutoDiscardForDevice">
4771	<desc>
4772	Sets a flag in the device information which indicates that the medium
4773	supports discarding unsused blocks (called trimming for SATA or unmap
4774	for SCSI devices) .This may or may not be supported by a particular drive,
4775	and is silently ignored in the latter case. At the moment only hard disks
4776	(which is a misnomer in this context) accept this setting. Changing the
4777	setting while the VM is running is forbidden. The device must already
4778	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4779	device.
4780
4781	The @a controllerPort and @a device parameters specify the device slot and
4782	have have the same meaning as with <link to="IMachine::attachDevice" />.
4783
4784	<result name="E_INVALIDARG">
4785	SATA device, SATA port, SCSI port out of range.
4786	</result>
4787	<result name="VBOX_E_INVALID_OBJECT_STATE">
4788	Attempt to modify an unregistered virtual machine.
4789	</result>
4790	<result name="VBOX_E_INVALID_VM_STATE">
4791	Invalid machine state.
4792	</result>
4793
4794	</desc>
4795	<param name="name" type="wstring" dir="in">
4796	<desc>Name of the storage controller.</desc>
4797	</param>
4798	<param name="controllerPort" type="long" dir="in">
4799	<desc>Storage controller port.</desc>
4800	</param>
4801	<param name="device" type="long" dir="in">
4802	<desc>Device slot in the given port.</desc>
4803	</param>
4804	<param name="discard" type="boolean" dir="in">
4805	<desc>New value for the discard device flag.</desc>
4806	</param>
4807	</method>
4808
4809	<method name="setBandwidthGroupForDevice">
4810	<desc>
4811	Sets the bandwidth group of an existing storage device.
4812	The device must already exist; see <link to="IMachine::attachDevice"/>
4813	for how to attach a new device.
4814
4815	The @a controllerPort and @a device parameters specify the device slot and
4816	have have the same meaning as with <link to="IMachine::attachDevice" />.
4817
4818	<result name="E_INVALIDARG">
4819	SATA device, SATA port, IDE port or IDE slot out of range.
4820	</result>
4821	<result name="VBOX_E_INVALID_OBJECT_STATE">
4822	Attempt to modify an unregistered virtual machine.
4823	</result>
4824	<result name="VBOX_E_INVALID_VM_STATE">
4825	Invalid machine state.
4826	</result>
4827
4828	</desc>
4829	<param name="name" type="wstring" dir="in">
4830	<desc>Name of the storage controller.</desc>
4831	</param>
4832	<param name="controllerPort" type="long" dir="in">
4833	<desc>Storage controller port.</desc>
4834	</param>
4835	<param name="device" type="long" dir="in">
4836	<desc>Device slot in the given port.</desc>
4837	</param>
4838	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4839	<desc>New value for the bandwidth group or NULL for no group.</desc>
4840	</param>
4841	</method>
4842
4843	<method name="mountMedium">
4844	<desc>
4845	Mounts a medium (<link to="IMedium" />, identified
4846	by the given UUID @a id) to the given storage controller
4847	(<link to="IStorageController" />, identified by @a name),
4848	at the indicated port and device. The device must already exist;
4849	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4850
4851	This method is intended only for managing removable media, where the
4852	device is fixed but media is changeable at runtime (such as DVDs
4853	and floppies). It cannot be used for fixed media such as hard disks.
4854
4855	The @a controllerPort and @a device parameters specify the device slot and
4856	have have the same meaning as with <link to="IMachine::attachDevice" />.
4857
4858	The specified device slot can have a medium mounted, which will be
4859	unmounted first. Specifying a zero UUID (or an empty string) for
4860	@a medium does just an unmount.
4861
4862	See <link to="IMedium"/> for more detailed information about
4863	attaching media.
4864
4865	<result name="E_INVALIDARG">
4866	SATA device, SATA port, IDE port or IDE slot out of range.
4867	</result>
4868	<result name="VBOX_E_INVALID_OBJECT_STATE">
4869	Attempt to attach medium to an unregistered virtual machine.
4870	</result>
4871	<result name="VBOX_E_INVALID_VM_STATE">
4872	Invalid machine state.
4873	</result>
4874	<result name="VBOX_E_OBJECT_IN_USE">
4875	Medium already attached to this or another virtual machine.
4876	</result>
4877
4878	</desc>
4879	<param name="name" type="wstring" dir="in">
4880	<desc>Name of the storage controller to attach the medium to.</desc>
4881	</param>
4882	<param name="controllerPort" type="long" dir="in">
4883	<desc>Port to attach the medium to.</desc>
4884	</param>
4885	<param name="device" type="long" dir="in">
4886	<desc>Device slot in the given port to attach the medium to.</desc>
4887	</param>
4888	<param name="medium" type="IMedium" dir="in">
4889	<desc>Medium to mount or NULL for an empty drive.</desc>
4890	</param>
4891	<param name="force" type="boolean" dir="in">
4892	<desc>Allows to force unmount/mount of a medium which is locked by
4893	the device slot in the given port to attach the medium to.</desc>
4894	</param>
4895	</method>
4896
4897	<method name="getMedium" const="yes">
4898	<desc>
4899	Returns the virtual medium attached to a device slot of the specified
4900	bus.
4901
4902	Note that if the medium was indirectly attached by
4903	<link to="#mountMedium"/> to the given device slot then this
4904	method will return not the same object as passed to the
4905	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
4906	more detailed information about mounting a medium.
4907
4908	<result name="VBOX_E_OBJECT_NOT_FOUND">
4909	No medium attached to given slot/bus.
4910	</result>
4911
4912	</desc>
4913	<param name="name" type="wstring" dir="in">
4914	<desc>Name of the storage controller the medium is attached to.</desc>
4915	</param>
4916	<param name="controllerPort" type="long" dir="in">
4917	<desc>Port to query.</desc>
4918	</param>
4919	<param name="device" type="long" dir="in">
4920	<desc>Device slot in the given port to query.</desc>
4921	</param>
4922	<param name="medium" type="IMedium" dir="return">
4923	<desc>Attached medium object.</desc>
4924	</param>
4925	</method>
4926
4927	<method name="getMediumAttachmentsOfController" const="yes">
4928	<desc>
4929	Returns an array of medium attachments which are attached to the
4930	the controller with the given name.
4931
4932	<result name="VBOX_E_OBJECT_NOT_FOUND">
4933	A storage controller with given name doesn't exist.
4934	</result>
4935	</desc>
4936	<param name="name" type="wstring" dir="in"/>
4937	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
4938	</method>
4939
4940	<method name="getMediumAttachment" const="yes">
4941	<desc>
4942	Returns a medium attachment which corresponds to the controller with
4943	the given name, on the given port and device slot.
4944
4945	<result name="VBOX_E_OBJECT_NOT_FOUND">
4946	No attachment exists for the given controller/port/device combination.
4947	</result>
4948	</desc>
4949	<param name="name" type="wstring" dir="in"/>
4950	<param name="controllerPort" type="long" dir="in"/>
4951	<param name="device" type="long" dir="in"/>
4952	<param name="attachment" type="IMediumAttachment" dir="return"/>
4953	</method>
4954
4955	<method name="attachHostPciDevice">
4956	<desc>
4957	Attaches host PCI device with the given (host) PCI address to the
4958	PCI bus of the virtual machine. Please note, that this operation
4959	is two phase, as real attachment will happen when VM will start,
4960	and most information will be delivered as IHostPciDevicePlugEvent
4961	on IVirtualBox event source.
4962
4963	<see><link to="IHostPciDevicePlugEvent"/></see>
4964
4965	<result name="VBOX_E_INVALID_VM_STATE">
4966	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4967	</result>
4968	<result name="VBOX_E_PDM_ERROR">
4969	Virtual machine does not have a PCI controller allowing attachment of physical devices.
4970	</result>
4971	<result name="VBOX_E_NOT_SUPPORTED">
4972	Hardware or host OS doesn't allow PCI device passthrought.
4973	</result>
4974	</desc>
4975	<param name="hostAddress" type="long" dir="in">
4976	<desc>Address of the host PCI device.</desc>
4977	</param>
4978	<param name="desiredGuestAddress" type="long" dir="in">
4979	<desc>Desired position of this device on guest PCI bus.</desc>
4980	</param>
4981	<param name="tryToUnbind" type="boolean" dir="in">
4982	<desc>If VMM shall try to unbind existing drivers from the
4983	device before attaching it to the guest.</desc>
4984	</param>
4985	</method>
4986
4987	<method name="detachHostPciDevice">
4988	<desc>
4989	Detach host PCI device from the virtual machine.
4990	Also HostPciDevicePlugEvent on IVirtualBox event source
4991	will be delivered. As currently we don't support hot device
4992	unplug, IHostPciDevicePlugEvent event is delivered immediately.
4993
4994	<see><link to="IHostPciDevicePlugEvent"/></see>
4995
4996	<result name="VBOX_E_INVALID_VM_STATE">
4997	Virtual machine state is not stopped (PCI hotplug not yet implemented).
4998	</result>
4999	<result name="VBOX_E_OBJECT_NOT_FOUND">
5000	This host device is not attached to this machine.
5001	</result>
5002	<result name="VBOX_E_PDM_ERROR">
5003	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5004	</result>
5005	<result name="VBOX_E_NOT_SUPPORTED">
5006	Hardware or host OS doesn't allow PCI device passthrought.
5007	</result>
5008	</desc>
5009	<param name="hostAddress" type="long" dir="in">
5010	<desc>Address of the host PCI device.</desc>
5011	</param>
5012	</method>
5013
5014	<method name="getNetworkAdapter" const="yes">
5015	<desc>
5016	Returns the network adapter associated with the given slot.
5017	Slots are numbered sequentially, starting with zero. The total
5018	number of adapters per machine is defined by the
5019	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5020	so the maximum slot number is one less than that property's value.
5021
5022	<result name="E_INVALIDARG">
5023	Invalid @a slot number.
5024	</result>
5025
5026	</desc>
5027	<param name="slot" type="unsigned long" dir="in"/>
5028	<param name="adapter" type="INetworkAdapter" dir="return"/>
5029	</method>
5030
5031	<method name="addStorageController">
5032	<desc>
5033	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5034	machine and returns it as an instance of
5035	<link to="IStorageController" />.
5036
5037	@a name identifies the controller for subsequent calls such as
5038	<link to="#getStorageControllerByName" />,
5039	<link to="#getStorageControllerByInstance" />,
5040	<link to="#removeStorageController" />,
5041	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5042
5043	After the controller has been added, you can set its exact
5044	type by setting the <link to="IStorageController::controllerType" />.
5045
5046	<result name="VBOX_E_OBJECT_IN_USE">
5047	A storage controller with given name exists already.
5048	</result>
5049	<result name="E_INVALIDARG">
5050	Invalid @a controllerType.
5051	</result>
5052	</desc>
5053	<param name="name" type="wstring" dir="in"/>
5054	<param name="connectionType" type="StorageBus" dir="in"/>
5055	<param name="controller" type="IStorageController" dir="return"/>
5056	</method>
5057
5058	<method name="getStorageControllerByName" const="yes">
5059	<desc>
5060	Returns a storage controller with the given name.
5061
5062	<result name="VBOX_E_OBJECT_NOT_FOUND">
5063	A storage controller with given name doesn't exist.
5064	</result>
5065	</desc>
5066	<param name="name" type="wstring" dir="in"/>
5067	<param name="storageController" type="IStorageController" dir="return"/>
5068	</method>
5069
5070	<method name="getStorageControllerByInstance" const="yes">
5071	<desc>
5072	Returns a storage controller with the given instance number.
5073
5074	<result name="VBOX_E_OBJECT_NOT_FOUND">
5075	A storage controller with given instance number doesn't exist.
5076	</result>
5077	</desc>
5078	<param name="instance" type="unsigned long" dir="in"/>
5079	<param name="storageController" type="IStorageController" dir="return"/>
5080	</method>
5081
5082	<method name="removeStorageController">
5083	<desc>
5084	Removes a storage controller from the machine.
5085
5086	<result name="VBOX_E_OBJECT_NOT_FOUND">
5087	A storage controller with given name doesn't exist.
5088	</result>
5089	</desc>
5090	<param name="name" type="wstring" dir="in"/>
5091	</method>
5092
5093	<method name="setStorageControllerBootable">
5094	<desc>
5095	Sets the bootable flag of the storage controller with the given name.
5096
5097	<result name="VBOX_E_OBJECT_NOT_FOUND">
5098	A storage controller with given name doesn't exist.
5099	</result>
5100	<result name="VBOX_E_OBJECT_IN_USE">
5101	Another storage controller is marked as bootable already.
5102	</result>
5103	</desc>
5104	<param name="name" type="wstring" dir="in"/>
5105	<param name="bootable" type="boolean" dir="in"/>
5106	</method>
5107
5108	<method name="getSerialPort" const="yes">
5109	<desc>
5110	Returns the serial port associated with the given slot.
5111	Slots are numbered sequentially, starting with zero. The total
5112	number of serial ports per machine is defined by the
5113	<link to="ISystemProperties::serialPortCount"/> property,
5114	so the maximum slot number is one less than that property's value.
5115
5116	<result name="E_INVALIDARG">
5117	Invalid @a slot number.
5118	</result>
5119
5120	</desc>
5121	<param name="slot" type="unsigned long" dir="in"/>
5122	<param name="port" type="ISerialPort" dir="return"/>
5123	</method>
5124
5125	<method name="getParallelPort" const="yes">
5126	<desc>
5127	Returns the parallel port associated with the given slot.
5128	Slots are numbered sequentially, starting with zero. The total
5129	number of parallel ports per machine is defined by the
5130	<link to="ISystemProperties::parallelPortCount"/> property,
5131	so the maximum slot number is one less than that property's value.
5132
5133	<result name="E_INVALIDARG">
5134	Invalid @a slot number.
5135	</result>
5136
5137	</desc>
5138	<param name="slot" type="unsigned long" dir="in"/>
5139	<param name="port" type="IParallelPort" dir="return"/>
5140	</method>
5141
5142	<method name="getExtraDataKeys">
5143	<desc>
5144	Returns an array representing the machine-specific extra data keys
5145	which currently have values defined.
5146	</desc>
5147	<param name="value" type="wstring" dir="return" safearray="yes">
5148	<desc>Array of extra data keys.</desc>
5149	</param>
5150	</method>
5151
5152	<method name="getExtraData">
5153	<desc>
5154	Returns associated machine-specific extra data.
5155
5156	If the requested data @a key does not exist, this function will
5157	succeed and return an empty string in the @a value argument.
5158
5159	<result name="VBOX_E_FILE_ERROR">
5160	Settings file not accessible.
5161	</result>
5162	<result name="VBOX_E_XML_ERROR">
5163	Could not parse the settings file.
5164	</result>
5165
5166	</desc>
5167	<param name="key" type="wstring" dir="in">
5168	<desc>Name of the data key to get.</desc>
5169	</param>
5170	<param name="value" type="wstring" dir="return">
5171	<desc>Value of the requested data key.</desc>
5172	</param>
5173	</method>
5174
5175	<method name="setExtraData">
5176	<desc>
5177	Sets associated machine-specific extra data.
5178
5179	If you pass @c null or an empty string as a key @a value, the given
5180	@a key will be deleted.
5181
5182	<note>
5183	Before performing the actual data change, this method will ask all
5184	registered listeners using the
5185	<link to="IExtraDataCanChangeEvent"/>
5186	notification for a permission. If one of the listeners refuses the
5187	new value, the change will not be performed.
5188	</note>
5189	<note>
5190	On success, the
5191	<link to="IExtraDataChangedEvent"/> notification
5192	is called to inform all registered listeners about a successful data
5193	change.
5194	</note>
5195	<note>
5196	This method can be called outside the machine session and therefore
5197	it's a caller's responsibility to handle possible race conditions
5198	when several clients change the same key at the same time.
5199	</note>
5200
5201	<result name="VBOX_E_FILE_ERROR">
5202	Settings file not accessible.
5203	</result>
5204	<result name="VBOX_E_XML_ERROR">
5205	Could not parse the settings file.
5206	</result>
5207
5208	</desc>
5209	<param name="key" type="wstring" dir="in">
5210	<desc>Name of the data key to set.</desc>
5211	</param>
5212	<param name="value" type="wstring" dir="in">
5213	<desc>Value to assign to the key.</desc>
5214	</param>
5215	</method>
5216
5217	<method name="getCPUProperty" const="yes">
5218	<desc>
5219	Returns the virtual CPU boolean value of the specified property.
5220
5221	<result name="E_INVALIDARG">
5222	Invalid property.
5223	</result>
5224
5225	</desc>
5226	<param name="property" type="CPUPropertyType" dir="in">
5227	<desc>
5228	Property type to query.
5229	</desc>
5230	</param>
5231	<param name="value" type="boolean" dir="return">
5232	<desc>
5233	Property value.
5234	</desc>
5235	</param>
5236	</method>
5237
5238	<method name="setCPUProperty">
5239	<desc>
5240	Sets the virtual CPU boolean value of the specified property.
5241
5242	<result name="E_INVALIDARG">
5243	Invalid property.
5244	</result>
5245
5246	</desc>
5247	<param name="property" type="CPUPropertyType" dir="in">
5248	<desc>
5249	Property type to query.
5250	</desc>
5251	</param>
5252	<param name="value" type="boolean" dir="in">
5253	<desc>
5254	Property value.
5255	</desc>
5256	</param>
5257	</method>
5258
5259	<method name="getCPUIDLeaf" const="yes">
5260	<desc>
5261	Returns the virtual CPU cpuid information for the specified leaf.
5262
5263	Currently supported index values for cpuid:
5264	Standard CPUID leafs: 0 - 0xA
5265	Extended CPUID leafs: 0x80000000 - 0x8000000A
5266
5267	See the Intel and AMD programmer's manuals for detailed information
5268	about the cpuid instruction and its leafs.
5269	<result name="E_INVALIDARG">
5270	Invalid id.
5271	</result>
5272
5273	</desc>
5274	<param name="id" type="unsigned long" dir="in">
5275	<desc>
5276	CPUID leaf index.
5277	</desc>
5278	</param>
5279	<param name="valEax" type="unsigned long" dir="out">
5280	<desc>
5281	CPUID leaf value for register eax.
5282	</desc>
5283	</param>
5284	<param name="valEbx" type="unsigned long" dir="out">
5285	<desc>
5286	CPUID leaf value for register ebx.
5287	</desc>
5288	</param>
5289	<param name="valEcx" type="unsigned long" dir="out">
5290	<desc>
5291	CPUID leaf value for register ecx.
5292	</desc>
5293	</param>
5294	<param name="valEdx" type="unsigned long" dir="out">
5295	<desc>
5296	CPUID leaf value for register edx.
5297	</desc>
5298	</param>
5299	</method>
5300
5301	<method name="setCPUIDLeaf">
5302	<desc>
5303	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5304	are not passed unmodified. VirtualBox clears features that it doesn't support.
5305
5306	Currently supported index values for cpuid:
5307	Standard CPUID leafs: 0 - 0xA
5308	Extended CPUID leafs: 0x80000000 - 0x8000000A
5309
5310	See the Intel and AMD programmer's manuals for detailed information
5311	about the cpuid instruction and its leafs.
5312
5313	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5314	random crashes inside VMs.
5315	<result name="E_INVALIDARG">
5316	Invalid id.
5317	</result>
5318
5319	</desc>
5320	<param name="id" type="unsigned long" dir="in">
5321	<desc>
5322	CPUID leaf index.
5323	</desc>
5324	</param>
5325	<param name="valEax" type="unsigned long" dir="in">
5326	<desc>
5327	CPUID leaf value for register eax.
5328	</desc>
5329	</param>
5330	<param name="valEbx" type="unsigned long" dir="in">
5331	<desc>
5332	CPUID leaf value for register ebx.
5333	</desc>
5334	</param>
5335	<param name="valEcx" type="unsigned long" dir="in">
5336	<desc>
5337	CPUID leaf value for register ecx.
5338	</desc>
5339	</param>
5340	<param name="valEdx" type="unsigned long" dir="in">
5341	<desc>
5342	CPUID leaf value for register edx.
5343	</desc>
5344	</param>
5345	</method>
5346
5347	<method name="removeCPUIDLeaf">
5348	<desc>
5349	Removes the virtual CPU cpuid leaf for the specified index
5350
5351	<result name="E_INVALIDARG">
5352	Invalid id.
5353	</result>
5354
5355	</desc>
5356	<param name="id" type="unsigned long" dir="in">
5357	<desc>
5358	CPUID leaf index.
5359	</desc>
5360	</param>
5361	</method>
5362
5363	<method name="removeAllCPUIDLeaves">
5364	<desc>
5365	Removes all the virtual CPU cpuid leaves
5366	</desc>
5367	</method>
5368
5369	<method name="getHWVirtExProperty" const="yes">
5370	<desc>
5371	Returns the value of the specified hardware virtualization boolean property.
5372
5373	<result name="E_INVALIDARG">
5374	Invalid property.
5375	</result>
5376
5377	</desc>
5378	<param name="property" type="HWVirtExPropertyType" dir="in">
5379	<desc>
5380	Property type to query.
5381	</desc>
5382	</param>
5383	<param name="value" type="boolean" dir="return">
5384	<desc>
5385	Property value.
5386	</desc>
5387	</param>
5388	</method>
5389
5390	<method name="setHWVirtExProperty">
5391	<desc>
5392	Sets a new value for the specified hardware virtualization boolean property.
5393
5394	<result name="E_INVALIDARG">
5395	Invalid property.
5396	</result>
5397
5398	</desc>
5399	<param name="property" type="HWVirtExPropertyType" dir="in">
5400	<desc>
5401	Property type to set.
5402	</desc>
5403	</param>
5404	<param name="value" type="boolean" dir="in">
5405	<desc>
5406	New property value.
5407	</desc>
5408	</param>
5409	</method>
5410
5411	<method name="saveSettings">
5412	<desc>
5413	Saves any changes to machine settings made since the session
5414	has been opened or a new machine has been created, or since the
5415	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5416	For registered machines, new settings become visible to all
5417	other VirtualBox clients after successful invocation of this
5418	method.
5419	<note>
5420	The method sends <link to="IMachineDataChangedEvent"/>
5421	notification event after the configuration has been successfully
5422	saved (only for registered machines).
5423	</note>
5424	<note>
5425	Calling this method is only valid on instances returned
5426	by <link to="ISession::machine"/> and on new machines
5427	created by <link to="IVirtualBox::createMachine"/> but not
5428	yet registered, or on unregistered machines after calling
5429	<link to="IMachine::unregister"/>.
5430	</note>
5431
5432	<result name="VBOX_E_FILE_ERROR">
5433	Settings file not accessible.
5434	</result>
5435	<result name="VBOX_E_XML_ERROR">
5436	Could not parse the settings file.
5437	</result>
5438	<result name="E_ACCESSDENIED">
5439	Modification request refused.
5440	</result>
5441
5442	</desc>
5443	</method>
5444
5445	<method name="discardSettings">
5446	<desc>
5447	Discards any changes to the machine settings made since the session
5448	has been opened or since the last call to <link to="#saveSettings"/>
5449	or <link to="#discardSettings"/>.
5450	<note>
5451	Calling this method is only valid on instances returned
5452	by <link to="ISession::machine"/> and on new machines
5453	created by <link to="IVirtualBox::createMachine"/> or
5454	opened by <link to="IVirtualBox::openMachine"/> but not
5455	yet registered, or on unregistered machines after calling
5456	<link to="IMachine::unregister"/>.
5457	</note>
5458
5459	<result name="VBOX_E_INVALID_VM_STATE">
5460	Virtual machine is not mutable.
5461	</result>
5462
5463	</desc>
5464	</method>
5465
5466	<method name="unregister">
5467	<desc>
5468	Unregisters a machine previously registered with
5469	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5470	cleanup before the machine is unregistered.
5471
5472	This method does not delete any files. It only changes the machine configuration and
5473	the list of registered machines in the VirtualBox object. To delete the files which
5474	belonged to the machine, including the XML file of the machine itself, call
5475	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5476	from this method.
5477
5478	How thoroughly this method cleans up the machine configuration before unregistering
5479	the machine depends on the @a cleanupMode argument.
5480
5481	<ul>
5482	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5483	cleanup will be performed. The call will fail if the machine is in "Saved" state
5484	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5485	It is the responsibility of the caller to delete all such configuration in this mode.
5486	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5487	which it replaces.</li>
5488	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5489	state or if it has snapshots or media attached. All media attached to the current machine
5490	state or in snapshots will be detached. No medium objects will be returned;
5491	all of the machine's media will remain open.</li>
5492	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5493	except that all the hard disk medium objects which were detached from the machine will
5494	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5495	API for closing and deletion.</li>
5496	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5497	that all media will be returned in the array, including removable media like DVDs and
5498	floppies. This might be useful if the user wants to inspect in detail which media were
5499	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5500	in that case because users will typically want to preserve ISO and RAW image files.</li>
5501	</ul>
5502
5503	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5504	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5505	deleted with all its saved states and hard disk images, but images for removable
5506	drives (such as ISO and RAW files) will remain on disk.
5507
5508	This API does not verify whether the media files returned in the array are still
5509	attached to other machines (i.e. shared between several machines). If such a shared
5510	image is passed to <link to="#delete" /> however, closing the image will fail there
5511	and the image will be silently skipped.
5512
5513	This API may, however, move media from this machine's media registry to other media
5514	registries (see <link to="IMedium" /> for details on media registries). For machines
5515	created with VirtualBox 4.0 or later, if media from this machine's media registry
5516	are also attached to another machine (shared attachments), each such medium will be
5517	moved to another machine's registry. This is because without this machine's media
5518	registry, the other machine cannot find its media any more and would become inaccessible.
5519
5520	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5521	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5522	if media are moved to other machines' media registries.
5523
5524	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5525	is fired.
5526
5527	The call will fail if the machine is currently locked (see <link to="ISession" />).
5528
5529	<note>
5530	If the given machine is inaccessible (see <link to="#accessible"/>), it
5531	will be unregistered and fully uninitialized right afterwards. As a result,
5532	the returned machine object will be unusable and an attempt to call
5533	<b>any</b> method will return the "Object not ready" error.
5534	</note>
5535
5536	<result name="VBOX_E_INVALID_OBJECT_STATE">
5537	Machine is currently locked for a session.
5538	</result>
5539	</desc>
5540
5541	<param name="cleanupMode" type="CleanupMode" dir="in">
5542	<desc>How to clean up after the machine has been unregistered.</desc>
5543	</param>
5544	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5545	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5546	</param>
5547	</method>
5548
5549	<method name="delete">
5550	<desc>
5551	Deletes the files associated with this machine from disk. If medium objects are passed
5552	in with the @a aMedia argument, they are closed and, if closing was successful, their
5553	storage files are deleted as well. For convenience, this array of media files can be
5554	the same as the one returned from a previous <link to="#unregister" /> call.
5555
5556	This method must only be called on machines which are either write-locked (i.e. on instances
5557	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5558	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5559	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5560
5561	The following files will be deleted by this method:
5562	<ul>
5563	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5564	argument other than "UnregisterOnly", this will delete all saved state files that
5565	the machine had in use; possibly one if the machine was in "Saved" state and one
5566	for each online snapshot that the machine had.</li>
5567	<li>On each medium object passed in the @a aMedia array, this will call
5568	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5569	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5570	in use, e.g. because it is still attached to a second machine; in that case the
5571	storage will not be deleted.</li>
5572	<li>Finally, the machine's own XML file will be deleted.</li>
5573	</ul>
5574
5575	Since deleting large disk image files can be a time-consuming I/O operation, this
5576	method operates asynchronously and returns an IProgress object to allow the caller
5577	to monitor the progress. There will be one sub-operation for each file that is
5578	being deleted (saved state or medium storage file).
5579
5580	<note>
5581	<link to="#settingsModified"/> will return @c true after this
5582	method successfully returns.
5583	</note>
5584
5585	<result name="VBOX_E_INVALID_VM_STATE">
5586	Machine is registered but not write-locked.
5587	</result>
5588	<result name="VBOX_E_IPRT_ERROR">
5589	Could not delete the settings file.
5590	</result>
5591	</desc>
5592	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5593	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5594	</param>
5595	<param name="aProgress" type="IProgress" dir="return">
5596	<desc>Progress object to track the operation completion.</desc>
5597	</param>
5598	</method>
5599
5600	<method name="export">
5601	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5602	steps required to export VirtualBox machines to OVF.
5603	</desc>
5604
5605	<param name="aAppliance" type="IAppliance" dir="in">
5606	<desc>Appliance to export this machine to.</desc>
5607	</param>
5608	<param name="location" type="wstring" dir="in">
5609	<desc>The target location.</desc>
5610	</param>
5611	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5612	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5613	</param>
5614	</method >
5615
5616	<method name="findSnapshot">
5617	<desc>
5618	Returns a snapshot of this machine with the given name or UUID.
5619
5620	Returns a snapshot of this machine with the given UUID.
5621	A @c null argument can be used to obtain the first snapshot
5622	taken on this machine. To traverse the whole tree of snapshots
5623	starting from the root, inspect the root snapshot's
5624	<link to="ISnapshot::children" /> attribute and recurse over those children.
5625
5626	<result name="VBOX_E_OBJECT_NOT_FOUND">
5627	Virtual machine has no snapshots or snapshot not found.
5628	</result>
5629
5630	</desc>
5631	<param name="nameOrId" type="wstring" dir="in">
5632	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5633	</param>
5634	<param name="snapshot" type="ISnapshot" dir="return">
5635	<desc>Snapshot object with the given name.</desc>
5636	</param>
5637	</method>
5638
5639	<method name="createSharedFolder">
5640	<desc>
5641	Creates a new permanent shared folder by associating the given logical
5642	name with the given host path, adds it to the collection of shared
5643	folders and starts sharing it. Refer to the description of
5644	<link to="ISharedFolder"/> to read more about logical names.
5645
5646	<result name="VBOX_E_OBJECT_IN_USE">
5647	Shared folder already exists.
5648	</result>
5649	<result name="VBOX_E_FILE_ERROR">
5650	Shared folder @a hostPath not accessible.
5651	</result>
5652
5653	</desc>
5654	<param name="name" type="wstring" dir="in">
5655	<desc>Unique logical name of the shared folder.</desc>
5656	</param>
5657	<param name="hostPath" type="wstring" dir="in">
5658	<desc>Full path to the shared folder in the host file system.</desc>
5659	</param>
5660	<param name="writable" type="boolean" dir="in">
5661	<desc>Whether the share is writable or readonly.</desc>
5662	</param>
5663	<param name="automount" type="boolean" dir="in">
5664	<desc>Whether the share gets automatically mounted by the guest
5665	or not.</desc>
5666	</param>
5667	</method>
5668
5669	<method name="removeSharedFolder">
5670	<desc>
5671	Removes the permanent shared folder with the given name previously
5672	created by <link to="#createSharedFolder"/> from the collection of
5673	shared folders and stops sharing it.
5674
5675	<result name="VBOX_E_INVALID_VM_STATE">
5676	Virtual machine is not mutable.
5677	</result>
5678	<result name="VBOX_E_OBJECT_NOT_FOUND">
5679	Shared folder @a name does not exist.
5680	</result>
5681
5682	</desc>
5683	<param name="name" type="wstring" dir="in">
5684	<desc>Logical name of the shared folder to remove.</desc>
5685	</param>
5686	</method>
5687
5688	<method name="canShowConsoleWindow">
5689	<desc>
5690	Returns @c true if the VM console process can activate the
5691	console window and bring it to foreground on the desktop of
5692	the host PC.
5693	<note>
5694	This method will fail if a session for this machine is not
5695	currently open.
5696	</note>
5697
5698	<result name="VBOX_E_INVALID_VM_STATE">
5699	Machine session is not open.
5700	</result>
5701
5702	</desc>
5703	<param name="canShow" type="boolean" dir="return">
5704	<desc>
5705	@c true if the console window can be shown and @c false otherwise.
5706	</desc>
5707	</param>
5708	</method>
5709
5710	<method name="showConsoleWindow">
5711	<desc>
5712	Activates the console window and brings it to foreground on
5713	the desktop of the host PC. Many modern window managers on
5714	many platforms implement some sort of focus stealing
5715	prevention logic, so that it may be impossible to activate
5716	a window without the help of the currently active
5717	application. In this case, this method will return a non-zero
5718	identifier that represents the top-level window of the VM
5719	console process. The caller, if it represents a currently
5720	active process, is responsible to use this identifier (in a
5721	platform-dependent manner) to perform actual window
5722	activation.
5723	<note>
5724	This method will fail if a session for this machine is not
5725	currently open.
5726	</note>
5727
5728	<result name="VBOX_E_INVALID_VM_STATE">
5729	Machine session is not open.
5730	</result>
5731
5732	</desc>
5733	<param name="winId" type="long long" dir="return">
5734	<desc>
5735	Platform-dependent identifier of the top-level VM console
5736	window, or zero if this method has performed all actions
5737	necessary to implement the <i>show window</i> semantics for
5738	the given platform and/or VirtualBox front-end.
5739	</desc>
5740	</param>
5741	</method>
5742
5743	<method name="getGuestProperty" const="yes">
5744	<desc>
5745	Reads an entry from the machine's guest property store.
5746
5747	<result name="VBOX_E_INVALID_VM_STATE">
5748	Machine session is not open.
5749	</result>
5750
5751	</desc>
5752	<param name="name" type="wstring" dir="in">
5753	<desc>
5754	The name of the property to read.
5755	</desc>
5756	</param>
5757	<param name="value" type="wstring" dir="out">
5758	<desc>
5759	The value of the property. If the property does not exist then this
5760	will be empty.
5761	</desc>
5762	</param>
5763	<param name="timestamp" type="long long" dir="out">
5764	<desc>
5765	The time at which the property was last modified, as seen by the
5766	server process.
5767	</desc>
5768	</param>
5769	<param name="flags" type="wstring" dir="out">
5770	<desc>
5771	Additional property parameters, passed as a comma-separated list of
5772	"name=value" type entries.
5773	</desc>
5774	</param>
5775	</method>
5776
5777	<method name="getGuestPropertyValue" const="yes">
5778	<desc>
5779	Reads a value from the machine's guest property store.
5780
5781	<result name="VBOX_E_INVALID_VM_STATE">
5782	Machine session is not open.
5783	</result>
5784
5785	</desc>
5786	<param name="property" type="wstring" dir="in">
5787	<desc>
5788	The name of the property to read.
5789	</desc>
5790	</param>
5791	<param name="value" type="wstring" dir="return">
5792	<desc>
5793	The value of the property. If the property does not exist then this
5794	will be empty.
5795	</desc>
5796	</param>
5797	</method>
5798
5799	<method name="getGuestPropertyTimestamp" const="yes">
5800	<desc>
5801	Reads a property timestamp from the machine's guest property store.
5802
5803	<result name="VBOX_E_INVALID_VM_STATE">
5804	Machine session is not open.
5805	</result>
5806
5807	</desc>
5808	<param name="property" type="wstring" dir="in">
5809	<desc>
5810	The name of the property to read.
5811	</desc>
5812	</param>
5813	<param name="value" type="long long" dir="return">
5814	<desc>
5815	The timestamp. If the property does not exist then this will be
5816	empty.
5817	</desc>
5818	</param>
5819	</method>
5820
5821	<method name="setGuestProperty">
5822	<desc>
5823	Sets, changes or deletes an entry in the machine's guest property
5824	store.
5825
5826	<result name="E_ACCESSDENIED">
5827	Property cannot be changed.
5828	</result>
5829	<result name="E_INVALIDARG">
5830	Invalid @a flags.
5831	</result>
5832	<result name="VBOX_E_INVALID_VM_STATE">
5833	Virtual machine is not mutable or session not open.
5834	</result>
5835	<result name="VBOX_E_INVALID_OBJECT_STATE">
5836	Cannot set transient property when machine not running.
5837	</result>
5838
5839	</desc>
5840	<param name="property" type="wstring" dir="in">
5841	<desc>
5842	The name of the property to set, change or delete.
5843	</desc>
5844	</param>
5845	<param name="value" type="wstring" dir="in">
5846	<desc>
5847	The new value of the property to set, change or delete. If the
5848	property does not yet exist and value is non-empty, it will be
5849	created. If the value is @c null or empty, the property will be
5850	deleted if it exists.
5851	</desc>
5852	</param>
5853	<param name="flags" type="wstring" dir="in">
5854	<desc>
5855	Additional property parameters, passed as a comma-separated list of
5856	"name=value" type entries.
5857	</desc>
5858	</param>
5859	</method>
5860
5861	<method name="setGuestPropertyValue">
5862	<desc>
5863	Sets, changes or deletes a value in the machine's guest property
5864	store. The flags field will be left unchanged or created empty for a
5865	new property.
5866
5867	<result name="E_ACCESSDENIED">
5868	Property cannot be changed.
5869	</result>
5870	<result name="VBOX_E_INVALID_VM_STATE">
5871	Virtual machine is not mutable or session not open.
5872	</result>
5873	<result name="VBOX_E_INVALID_OBJECT_STATE">
5874	Cannot set transient property when machine not running.
5875	</result>
5876	</desc>
5877
5878	<param name="property" type="wstring" dir="in">
5879	<desc>
5880	The name of the property to set, change or delete.
5881	</desc>
5882	</param>
5883	<param name="value" type="wstring" dir="in">
5884	<desc>
5885	The new value of the property to set, change or delete. If the
5886	property does not yet exist and value is non-empty, it will be
5887	created. If the value is @c null or empty, the property will be
5888	deleted if it exists.
5889	</desc>
5890	</param>
5891	</method>
5892
5893	<method name="deleteGuestProperty" const="yes">
5894	<desc>
5895	Deletes an entry from the machine's guest property store.
5896
5897	<result name="VBOX_E_INVALID_VM_STATE">
5898	Machine session is not open.
5899	</result>
5900
5901	</desc>
5902	<param name="name" type="wstring" dir="in">
5903	<desc>
5904	The name of the property to delete.
5905	</desc>
5906	</param>
5907	</method>
5908
5909	<method name="enumerateGuestProperties" const="yes">
5910	<desc>
5911	Return a list of the guest properties matching a set of patterns along
5912	with their values, time stamps and flags.
5913	</desc>
5914	<param name="patterns" type="wstring" dir="in">
5915	<desc>
5916	The patterns to match the properties against, separated by '\|'
5917	characters. If this is empty or @c null, all properties will match.
5918	</desc>
5919	</param>
5920	<param name="name" type="wstring" dir="out" safearray="yes">
5921	<desc>
5922	The names of the properties returned.
5923	</desc>
5924	</param>
5925	<param name="value" type="wstring" dir="out" safearray="yes">
5926	<desc>
5927	The values of the properties returned. The array entries match the
5928	corresponding entries in the @a name array.
5929	</desc>
5930	</param>
5931	<param name="timestamp" type="long long" dir="out" safearray="yes">
5932	<desc>
5933	The time stamps of the properties returned. The array entries match
5934	the corresponding entries in the @a name array.
5935	</desc>
5936	</param>
5937	<param name="flags" type="wstring" dir="out" safearray="yes">
5938	<desc>
5939	The flags of the properties returned. The array entries match the
5940	corresponding entries in the @a name array.
5941	</desc>
5942	</param>
5943	</method>
5944
5945	<method name="querySavedGuestSize" const="yes">
5946	<desc>
5947	Returns the guest dimensions from the saved state.
5948	</desc>
5949	<param name="screenId" type="unsigned long" dir="in">
5950	<desc>
5951	Saved guest screen to query info from.
5952	</desc>
5953	</param>
5954	<param name="width" type="unsigned long" dir="out">
5955	<desc>
5956	Guest width at the time of the saved state was taken.
5957	</desc>
5958	</param>
5959	<param name="height" type="unsigned long" dir="out">
5960	<desc>
5961	Guest height at the time of the saved state was taken.
5962	</desc>
5963	</param>
5964	</method>
5965
5966	<method name="querySavedThumbnailSize">
5967	<desc>
5968	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
5969	</desc>
5970	<param name="screenId" type="unsigned long" dir="in">
5971	<desc>
5972	Saved guest screen to query info from.
5973	</desc>
5974	</param>
5975	<param name="size" type="unsigned long" dir="out">
5976	<desc>
5977	Size of buffer required to store the bitmap.
5978	</desc>
5979	</param>
5980	<param name="width" type="unsigned long" dir="out">
5981	<desc>
5982	Bitmap width.
5983	</desc>
5984	</param>
5985	<param name="height" type="unsigned long" dir="out">
5986	<desc>
5987	Bitmap height.
5988	</desc>
5989	</param>
5990	</method>
5991
5992	<method name="readSavedThumbnailToArray">
5993	<desc>
5994	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
5995	</desc>
5996	<param name="screenId" type="unsigned long" dir="in">
5997	<desc>
5998	Saved guest screen to read from.
5999	</desc>
6000	</param>
6001	<param name="BGR" type="boolean" dir="in">
6002	<desc>
6003	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6004	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6005	</desc>
6006	</param>
6007	<param name="width" type="unsigned long" dir="out">
6008	<desc>
6009	Bitmap width.
6010	</desc>
6011	</param>
6012	<param name="height" type="unsigned long" dir="out">
6013	<desc>
6014	Bitmap height.
6015	</desc>
6016	</param>
6017	<param name="data" type="octet" safearray="yes" dir="return">
6018	<desc>
6019	Array with resulting bitmap data.
6020	</desc>
6021	</param>
6022	</method>
6023
6024	<method name="readSavedThumbnailPNGToArray">
6025	<desc>
6026	Thumbnail in PNG format is retrieved to an array of bytes.
6027	</desc>
6028	<param name="screenId" type="unsigned long" dir="in">
6029	<desc>
6030	Saved guest screen to read from.
6031	</desc>
6032	</param>
6033	<param name="width" type="unsigned long" dir="out">
6034	<desc>
6035	Image width.
6036	</desc>
6037	</param>
6038	<param name="height" type="unsigned long" dir="out">
6039	<desc>
6040	Image height.
6041	</desc>
6042	</param>
6043	<param name="data" type="octet" dir="return" safearray="yes">
6044	<desc>
6045	Array with resulting PNG data.
6046	</desc>
6047	</param>
6048	</method>
6049
6050	<method name="querySavedScreenshotPNGSize">
6051	<desc>
6052	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6053	</desc>
6054	<param name="screenId" type="unsigned long" dir="in">
6055	<desc>
6056	Saved guest screen to query info from.
6057	</desc>
6058	</param>
6059	<param name="size" type="unsigned long" dir="out">
6060	<desc>
6061	Size of buffer required to store the PNG binary data.
6062	</desc>
6063	</param>
6064	<param name="width" type="unsigned long" dir="out">
6065	<desc>
6066	Image width.
6067	</desc>
6068	</param>
6069	<param name="height" type="unsigned long" dir="out">
6070	<desc>
6071	Image height.
6072	</desc>
6073	</param>
6074	</method>
6075
6076	<method name="readSavedScreenshotPNGToArray">
6077	<desc>
6078	Screenshot in PNG format is retrieved to an array of bytes.
6079	</desc>
6080	<param name="screenId" type="unsigned long" dir="in">
6081	<desc>
6082	Saved guest screen to read from.
6083	</desc>
6084	</param>
6085	<param name="width" type="unsigned long" dir="out">
6086	<desc>
6087	Image width.
6088	</desc>
6089	</param>
6090	<param name="height" type="unsigned long" dir="out">
6091	<desc>
6092	Image height.
6093	</desc>
6094	</param>
6095	<param name="data" type="octet" dir="return" safearray="yes">
6096	<desc>
6097	Array with resulting PNG data.
6098	</desc>
6099	</param>
6100	</method>
6101
6102	<method name="hotPlugCPU">
6103	<desc>
6104	Plugs a CPU into the machine.
6105	</desc>
6106	<param name="cpu" type="unsigned long" dir="in">
6107	<desc>
6108	The CPU id to insert.
6109	</desc>
6110	</param>
6111	</method>
6112
6113	<method name="hotUnplugCPU">
6114	<desc>
6115	Removes a CPU from the machine.
6116	</desc>
6117	<param name="cpu" type="unsigned long" dir="in">
6118	<desc>
6119	The CPU id to remove.
6120	</desc>
6121	</param>
6122	</method>
6123
6124	<method name="getCPUStatus">
6125	<desc>
6126	Returns the current status of the given CPU.
6127	</desc>
6128	<param name="cpu" type="unsigned long" dir="in">
6129	<desc>
6130	The CPU id to check for.
6131	</desc>
6132	</param>
6133	<param name="attached" type="boolean" dir="return">
6134	<desc>
6135	Status of the CPU.
6136	</desc>
6137	</param>
6138	</method>
6139
6140	<method name="queryLogFilename">
6141	<desc>
6142	Queries for the VM log file name of an given index. Returns an empty
6143	string if a log file with that index doesn't exists.
6144	</desc>
6145	<param name="idx" type="unsigned long" dir="in">
6146	<desc>
6147	Which log file name to query. 0=current log file.
6148	</desc>
6149	</param>
6150	<param name="filename" type="wstring" dir="return">
6151	<desc>
6152	On return the full path to the log file or an empty string on error.
6153	</desc>
6154	</param>
6155	</method>
6156
6157	<method name="readLog">
6158	<desc>
6159	Reads the VM log file. The chunk size is limited, so even if you
6160	ask for a big piece there might be less data returned.
6161	</desc>
6162	<param name="idx" type="unsigned long" dir="in">
6163	<desc>
6164	Which log file to read. 0=current log file.
6165	</desc>
6166	</param>
6167	<param name="offset" type="long long" dir="in">
6168	<desc>
6169	Offset in the log file.
6170	</desc>
6171	</param>
6172	<param name="size" type="long long" dir="in">
6173	<desc>
6174	Chunk size to read in the log file.
6175	</desc>
6176	</param>
6177	<param name="data" type="octet" dir="return" safearray="yes">
6178	<desc>
6179	Data read from the log file. A data size of 0 means end of file
6180	if the requested chunk size was not 0. This is the unprocessed
6181	file data, i.e. the line ending style depends on the platform of
6182	the system the server is running on.
6183	</desc>
6184	</param>
6185	</method>
6186
6187	<method name="cloneTo">
6188	<desc>
6189	Creates a clone of this machine, either as a full clone (which means
6190	creating independent copies of the hard disk media, save states and so
6191	on), or as a linked clone (which uses its own differencing media,
6192	sharing the parent media with the source machine).
6193
6194	The target machine object must have been created previously with <link
6195	to="IVirtualBox::createMachine"/>, and all the settings will be
6196	transferred except the VM name and the hardware UUID. You can set the
6197	VM name and the new hardware UUID when creating the target machine. The
6198	network MAC addresses are newly created for all newtwork adapters. You
6199	can change that behaviour with the options parameter. The operation is
6200	performed asynchronously, so the machine object will be not be usable
6201	until the @a progress object signals completion.
6202
6203	<result name="E_INVALIDARG">
6204	@a target is @c null.
6205	</result>
6206	</desc>
6207
6208	<param name="target" type="IMachine" dir="in">
6209	<desc>Target machine object.</desc>
6210	</param>
6211	<param name="mode" type="CloneMode" dir="in">
6212	<desc>Which states should be cloned.</desc>
6213	</param>
6214	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6215	<desc>Options for the cloning operation.</desc>
6216	</param>
6217	<param name="progress" type="IProgress" dir="return">
6218	<desc>Progress object to track the operation completion.</desc>
6219	</param>
6220	</method>
6221
6222	</interface>
6223
6224	<!--
6225	// IConsole
6226	/////////////////////////////////////////////////////////////////////////
6227	-->
6228
6229	<interface
6230	name="IVRDEServerInfo" extends="$unknown"
6231	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6232	wsmap="struct"
6233	>
6234	<desc>
6235	Contains information about the remote desktop (VRDE) server capabilities and status.
6236	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6237	</desc>
6238
6239	<attribute name="active" type="boolean" readonly="yes">
6240	<desc>
6241	Whether the remote desktop connection is active.
6242	</desc>
6243	</attribute>
6244
6245	<attribute name="port" type="long" readonly="yes">
6246	<desc>
6247	VRDE server port number. If this property is equal to <tt>0</tt>, then
6248	the VRDE server failed to start, usually because there are no free IP
6249	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6250	server has not yet been started.
6251	</desc>
6252	</attribute>
6253
6254	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6255	<desc>
6256	How many times a client connected.
6257	</desc>
6258	</attribute>
6259
6260	<attribute name="beginTime" type="long long" readonly="yes">
6261	<desc>
6262	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6263	</desc>
6264	</attribute>
6265
6266	<attribute name="endTime" type="long long" readonly="yes">
6267	<desc>
6268	When the last connection was terminated or the current time, if
6269	connection is still active, in milliseconds since 1970-01-01 UTC.
6270	</desc>
6271	</attribute>
6272
6273	<attribute name="bytesSent" type="long long" readonly="yes">
6274	<desc>
6275	How many bytes were sent in last or current, if still active, connection.
6276	</desc>
6277	</attribute>
6278
6279	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6280	<desc>
6281	How many bytes were sent in all connections.
6282	</desc>
6283	</attribute>
6284
6285	<attribute name="bytesReceived" type="long long" readonly="yes">
6286	<desc>
6287	How many bytes were received in last or current, if still active, connection.
6288	</desc>
6289	</attribute>
6290
6291	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6292	<desc>
6293	How many bytes were received in all connections.
6294	</desc>
6295	</attribute>
6296
6297	<attribute name="user" type="wstring" readonly="yes">
6298	<desc>
6299	Login user name supplied by the client.
6300	</desc>
6301	</attribute>
6302
6303	<attribute name="domain" type="wstring" readonly="yes">
6304	<desc>
6305	Login domain name supplied by the client.
6306	</desc>
6307	</attribute>
6308
6309	<attribute name="clientName" type="wstring" readonly="yes">
6310	<desc>
6311	The client name supplied by the client.
6312	</desc>
6313	</attribute>
6314
6315	<attribute name="clientIP" type="wstring" readonly="yes">
6316	<desc>
6317	The IP address of the client.
6318	</desc>
6319	</attribute>
6320
6321	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6322	<desc>
6323	The client software version number.
6324	</desc>
6325	</attribute>
6326
6327	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6328	<desc>
6329	Public key exchange method used when connection was established.
6330	Values: 0 - RDP4 public key exchange scheme.
6331	1 - X509 certificates were sent to client.
6332	</desc>
6333	</attribute>
6334
6335	</interface>
6336
6337	<interface
6338	name="IConsole" extends="$unknown"
6339	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6340	wsmap="managed"
6341	>
6342	<desc>
6343	The IConsole interface represents an interface to control virtual
6344	machine execution.
6345
6346	A console object gets created when a machine has been locked for a
6347	particular session (client process) using <link to="IMachine::lockMachine" />
6348	or <link to="IMachine::launchVMProcess"/>. The console object can
6349	then be found in the session's <link to="ISession::console" /> attribute.
6350
6351	Methods of the IConsole interface allow the caller to query the current
6352	virtual machine execution state, pause the machine or power it down, save
6353	the machine state or take a snapshot, attach and detach removable media
6354	and so on.
6355
6356	<see><link to="ISession"/></see>
6357	</desc>
6358
6359	<attribute name="machine" type="IMachine" readonly="yes">
6360	<desc>
6361	Machine object for this console session.
6362	<note>
6363	This is a convenience property, it has the same value as
6364	<link to="ISession::machine"/> of the corresponding session
6365	object.
6366	</note>
6367	</desc>
6368	</attribute>
6369
6370	<attribute name="state" type="MachineState" readonly="yes">
6371	<desc>
6372	Current execution state of the machine.
6373	<note>
6374	This property always returns the same value as the corresponding
6375	property of the IMachine object for this console session.
6376	For the process that owns (executes) the VM, this is the
6377	preferable way of querying the VM state, because no IPC
6378	calls are made.
6379	</note>
6380	</desc>
6381	</attribute>
6382
6383	<attribute name="guest" type="IGuest" readonly="yes">
6384	<desc>Guest object.</desc>
6385	</attribute>
6386
6387	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6388	<desc>
6389	Virtual keyboard object.
6390	<note>
6391	If the machine is not running, any attempt to use
6392	the returned object will result in an error.
6393	</note>
6394	</desc>
6395	</attribute>
6396
6397	<attribute name="mouse" type="IMouse" readonly="yes">
6398	<desc>
6399	Virtual mouse object.
6400	<note>
6401	If the machine is not running, any attempt to use
6402	the returned object will result in an error.
6403	</note>
6404	</desc>
6405	</attribute>
6406
6407	<attribute name="display" type="IDisplay" readonly="yes">
6408	<desc>Virtual display object.
6409	<note>
6410	If the machine is not running, any attempt to use
6411	the returned object will result in an error.
6412	</note>
6413	</desc>
6414	</attribute>
6415
6416	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6417	<desc>Debugging interface.</desc>
6418	</attribute>
6419
6420	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6421	<desc>
6422	Collection of USB devices currently attached to the virtual
6423	USB controller.
6424	<note>
6425	The collection is empty if the machine is not running.
6426	</note>
6427	</desc>
6428	</attribute>
6429
6430	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6431	<desc>
6432	List of USB devices currently attached to the remote VRDE client.
6433	Once a new device is physically attached to the remote host computer,
6434	it appears in this list and remains there until detached.
6435	</desc>
6436	</attribute>
6437
6438	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6439	<desc>
6440	Collection of shared folders for the current session. These folders
6441	are called transient shared folders because they are available to the
6442	guest OS running inside the associated virtual machine only for the
6443	duration of the session (as opposed to
6444	<link to="IMachine::sharedFolders"/> which represent permanent shared
6445	folders). When the session is closed (e.g. the machine is powered down),
6446	these folders are automatically discarded.
6447
6448	New shared folders are added to the collection using
6449	<link to="#createSharedFolder"/>. Existing shared folders can be
6450	removed using <link to="#removeSharedFolder"/>.
6451	</desc>
6452	</attribute>
6453
6454	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6455	<desc>
6456	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6457	</desc>
6458	</attribute>
6459
6460	<attribute name="eventSource" type="IEventSource" readonly="yes">
6461	<desc>
6462	Event source for console events.
6463	</desc>
6464	</attribute>
6465
6466	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6467	<desc>Array of PCI devices attached to this machine.</desc>
6468	</attribute>
6469
6470	<attribute name="useHostClipboard" type="boolean">
6471	<desc>
6472	Whether the guest clipboard should be connected to the host one or
6473	whether it should only be allowed access to the VRDE clipboard. This
6474	setting may not affect existing guest clipboard connections which
6475	are already connected to the host clipboard.
6476	</desc>
6477	</attribute>
6478
6479	<method name="powerUp">
6480	<desc>
6481	Starts the virtual machine execution using the current machine
6482	state (that is, its current execution state, current settings and
6483	current storage devices).
6484
6485	<note>
6486	This method is only useful for front-ends that want to actually
6487	execute virtual machines in their own process (like the VirtualBox
6488	or VBoxSDL front-ends). Unless you are intending to write such a
6489	front-end, do not call this method. If you simply want to
6490	start virtual machine execution using one of the existing front-ends
6491	(for example the VirtualBox GUI or headless server), use
6492	<link to="IMachine::launchVMProcess"/> instead; these
6493	front-ends will power up the machine automatically for you.
6494	</note>
6495
6496	If the machine is powered off or aborted, the execution will
6497	start from the beginning (as if the real hardware were just
6498	powered on).
6499
6500	If the machine is in the <link to="MachineState_Saved"/> state,
6501	it will continue its execution the point where the state has
6502	been saved.
6503
6504	If the machine <link to="IMachine::teleporterEnabled"/> property is
6505	enabled on the machine being powered up, the machine will wait for an
6506	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6507	state. The returned progress object will have at least three
6508	operations where the last three are defined as: (1) powering up and
6509	starting TCP server, (2) waiting for incoming teleportations, and
6510	(3) perform teleportation. These operations will be reflected as the
6511	last three operations of the progress objected returned by
6512	<link to="IMachine::launchVMProcess"/> as well.
6513
6514	<see><link to="#saveState"/></see>
6515
6516	<result name="VBOX_E_INVALID_VM_STATE">
6517	Virtual machine already running.
6518	</result>
6519	<result name="VBOX_E_HOST_ERROR">
6520	Host interface does not exist or name not set.
6521	</result>
6522	<result name="VBOX_E_FILE_ERROR">
6523	Invalid saved state file.
6524	</result>
6525	</desc>
6526	<param name="progress" type="IProgress" dir="return">
6527	<desc>Progress object to track the operation completion.</desc>
6528	</param>
6529	</method>
6530
6531	<method name="powerUpPaused">
6532	<desc>
6533	Identical to powerUp except that the VM will enter the
6534	<link to="MachineState_Paused"/> state, instead of
6535	<link to="MachineState_Running"/>.
6536
6537	<see><link to="#powerUp"/></see>
6538	<result name="VBOX_E_INVALID_VM_STATE">
6539	Virtual machine already running.
6540	</result>
6541	<result name="VBOX_E_HOST_ERROR">
6542	Host interface does not exist or name not set.
6543	</result>
6544	<result name="VBOX_E_FILE_ERROR">
6545	Invalid saved state file.
6546	</result>
6547	</desc>
6548	<param name="progress" type="IProgress" dir="return">
6549	<desc>Progress object to track the operation completion.</desc>
6550	</param>
6551	</method>
6552
6553	<method name="powerDown">
6554	<desc>
6555	Initiates the power down procedure to stop the virtual machine
6556	execution.
6557
6558	The completion of the power down procedure is tracked using the returned
6559	IProgress object. After the operation is complete, the machine will go
6560	to the PoweredOff state.
6561	<result name="VBOX_E_INVALID_VM_STATE">
6562	Virtual machine must be Running, Paused or Stuck to be powered down.
6563	</result>
6564	</desc>
6565	<param name="progress" type="IProgress" dir="return">
6566	<desc>Progress object to track the operation completion.</desc>
6567	</param>
6568	</method>
6569
6570	<method name="reset">
6571	<desc>Resets the virtual machine.
6572	<result name="VBOX_E_INVALID_VM_STATE">
6573	Virtual machine not in Running state.
6574	</result>
6575	<result name="VBOX_E_VM_ERROR">
6576	Virtual machine error in reset operation.
6577	</result>
6578	</desc>
6579	</method>
6580
6581	<method name="pause">
6582	<desc>Pauses the virtual machine execution.
6583	<result name="VBOX_E_INVALID_VM_STATE">
6584	Virtual machine not in Running state.
6585	</result>
6586	<result name="VBOX_E_VM_ERROR">
6587	Virtual machine error in suspend operation.
6588	</result>
6589	</desc>
6590	</method>
6591
6592	<method name="resume">
6593	<desc>Resumes the virtual machine execution.
6594	<result name="VBOX_E_INVALID_VM_STATE">
6595	Virtual machine not in Paused state.
6596	</result>
6597	<result name="VBOX_E_VM_ERROR">
6598	Virtual machine error in resume operation.
6599	</result>
6600	</desc>
6601	</method>
6602
6603	<method name="powerButton">
6604	<desc>Sends the ACPI power button event to the guest.
6605	<result name="VBOX_E_INVALID_VM_STATE">
6606	Virtual machine not in Running state.
6607	</result>
6608	<result name="VBOX_E_PDM_ERROR">
6609	Controlled power off failed.
6610	</result>
6611	</desc>
6612	</method>
6613
6614	<method name="sleepButton">
6615	<desc>Sends the ACPI sleep button event to the guest.
6616	<result name="VBOX_E_INVALID_VM_STATE">
6617	Virtual machine not in Running state.
6618	</result>
6619	<result name="VBOX_E_PDM_ERROR">
6620	Sending sleep button event failed.
6621	</result>
6622	</desc>
6623	</method>
6624
6625	<method name="getPowerButtonHandled">
6626	<desc>Checks if the last power button event was handled by guest.
6627	<result name="VBOX_E_PDM_ERROR">
6628	Checking if the event was handled by the guest OS failed.
6629	</result>
6630	</desc>
6631	<param name="handled" type="boolean" dir="return"/>
6632	</method>
6633
6634	<method name="getGuestEnteredACPIMode">
6635	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6636	G1 (sleeping). If this method returns @c false, the guest will
6637	most likely not respond to external ACPI events.
6638	<result name="VBOX_E_INVALID_VM_STATE">
6639	Virtual machine not in Running state.
6640	</result>
6641	</desc>
6642	<param name="entered" type="boolean" dir="return"/>
6643	</method>
6644
6645	<method name="saveState">
6646	<desc>
6647	Saves the current execution state of a running virtual machine
6648	and stops its execution.
6649
6650	After this operation completes, the machine will go to the
6651	Saved state. Next time it is powered up, this state will
6652	be restored and the machine will continue its execution from
6653	the place where it was saved.
6654
6655	This operation differs from taking a snapshot to the effect
6656	that it doesn't create new differencing media. Also, once
6657	the machine is powered up from the state saved using this method,
6658	the saved state is deleted, so it will be impossible to return
6659	to this state later.
6660
6661	<note>
6662	On success, this method implicitly calls
6663	<link to="IMachine::saveSettings"/> to save all current machine
6664	settings (including runtime changes to the DVD medium, etc.).
6665	Together with the impossibility to change any VM settings when it is
6666	in the Saved state, this guarantees adequate hardware
6667	configuration of the machine when it is restored from the saved
6668	state file.
6669	</note>
6670
6671	<note>
6672	The machine must be in the Running or Paused state, otherwise
6673	the operation will fail.
6674	</note>
6675	<result name="VBOX_E_INVALID_VM_STATE">
6676	Virtual machine state neither Running nor Paused.
6677	</result>
6678	<result name="VBOX_E_FILE_ERROR">
6679	Failed to create directory for saved state file.
6680	</result>
6681
6682	<see><link to="#takeSnapshot"/></see>
6683	</desc>
6684	<param name="progress" type="IProgress" dir="return">
6685	<desc>Progress object to track the operation completion.</desc>
6686	</param>
6687	</method>
6688
6689	<method name="adoptSavedState">
6690	<desc>
6691	Associates the given saved state file to the virtual machine.
6692
6693	On success, the machine will go to the Saved state. Next time it is
6694	powered up, it will be restored from the adopted saved state and
6695	continue execution from the place where the saved state file was
6696	created.
6697
6698	The specified saved state file path may be absolute or relative to the
6699	folder the VM normally saves the state to (usually,
6700	<link to="IMachine::snapshotFolder"/>).
6701
6702	<note>
6703	It's a caller's responsibility to make sure the given saved state
6704	file is compatible with the settings of this virtual machine that
6705	represent its virtual hardware (memory size, storage disk configuration
6706	etc.). If there is a mismatch, the behavior of the virtual machine
6707	is undefined.
6708	</note>
6709	<result name="VBOX_E_INVALID_VM_STATE">
6710	Virtual machine state neither PoweredOff nor Aborted.
6711	</result>
6712	</desc>
6713	<param name="savedStateFile" type="wstring" dir="in">
6714	<desc>Path to the saved state file to adopt.</desc>
6715	</param>
6716	</method>
6717
6718	<method name="discardSavedState">
6719	<desc>
6720	Forcibly resets the machine to "Powered Off" state if it is
6721	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6722	Next time the machine is powered up, a clean boot will occur.
6723	<note>
6724	This operation is equivalent to resetting or powering off
6725	the machine without doing a proper shutdown of the guest
6726	operating system; as with resetting a running phyiscal
6727	computer, it can can lead to data loss.
6728	</note>
6729	If @a fRemoveFile is @c true, the file in the machine directory
6730	into which the machine state was saved is also deleted. If
6731	this is @c false, then the state can be recovered and later
6732	re-inserted into a machine using <link to="#adoptSavedState" />.
6733	The location of the file can be found in the
6734	<link to="IMachine::stateFilePath" /> attribute.
6735	<result name="VBOX_E_INVALID_VM_STATE">
6736	Virtual machine not in state Saved.
6737	</result>
6738	</desc>
6739	<param name="fRemoveFile" type="boolean" dir="in" >
6740	<desc>Whether to also remove the saved state file.</desc>
6741	</param>
6742	</method>
6743
6744	<method name="getDeviceActivity">
6745	<desc>
6746	Gets the current activity type of a given device or device group.
6747	<result name="E_INVALIDARG">
6748	Invalid device type.
6749	</result>
6750	</desc>
6751	<param name="type" type="DeviceType" dir="in"/>
6752	<param name="activity" type="DeviceActivity" dir="return"/>
6753	</method>
6754
6755	<method name="attachUSBDevice">
6756	<desc>
6757	Attaches a host USB device with the given UUID to the
6758	USB controller of the virtual machine.
6759
6760	The device needs to be in one of the following states:
6761	<link to="USBDeviceState_Busy"/>,
6762	<link to="USBDeviceState_Available"/> or
6763	<link to="USBDeviceState_Held"/>,
6764	otherwise an error is immediately returned.
6765
6766	When the device state is
6767	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6768	be returned if the host computer refuses to release it for some reason.
6769
6770	<see><link to="IUSBController::deviceFilters"/>,
6771	<link to="USBDeviceState"/></see>
6772	<result name="VBOX_E_INVALID_VM_STATE">
6773	Virtual machine state neither Running nor Paused.
6774	</result>
6775	<result name="VBOX_E_PDM_ERROR">
6776	Virtual machine does not have a USB controller.
6777	</result>
6778	</desc>
6779	<param name="id" type="uuid" mod="string" dir="in">
6780	<desc>UUID of the host USB device to attach.</desc>
6781	</param>
6782	</method>
6783
6784	<method name="detachUSBDevice">
6785	<desc>
6786	Detaches an USB device with the given UUID from the USB controller
6787	of the virtual machine.
6788
6789	After this method succeeds, the VirtualBox server re-initiates
6790	all USB filters as if the device were just physically attached
6791	to the host, but filters of this machine are ignored to avoid
6792	a possible automatic re-attachment.
6793
6794	<see><link to="IUSBController::deviceFilters"/>,
6795	<link to="USBDeviceState"/></see>
6796
6797	<result name="VBOX_E_PDM_ERROR">
6798	Virtual machine does not have a USB controller.
6799	</result>
6800	<result name="E_INVALIDARG">
6801	USB device not attached to this virtual machine.
6802	</result>
6803	</desc>
6804	<param name="id" type="uuid" mod="string" dir="in">
6805	<desc>UUID of the USB device to detach.</desc>
6806	</param>
6807	<param name="device" type="IUSBDevice" dir="return">
6808	<desc>Detached USB device.</desc>
6809	</param>
6810	</method>
6811
6812	<method name="findUSBDeviceByAddress">
6813	<desc>
6814	Searches for a USB device with the given host address.
6815
6816	<result name="VBOX_E_OBJECT_NOT_FOUND">
6817	Given @c name does not correspond to any USB device.
6818	</result>
6819
6820	<see><link to="IUSBDevice::address"/></see>
6821	</desc>
6822	<param name="name" type="wstring" dir="in">
6823	<desc>
6824	Address of the USB device (as assigned by the host) to
6825	search for.
6826	</desc>
6827	</param>
6828	<param name="device" type="IUSBDevice" dir="return">
6829	<desc>Found USB device object.</desc>
6830	</param>
6831	</method>
6832
6833	<method name="findUSBDeviceById">
6834	<desc>
6835	Searches for a USB device with the given UUID.
6836
6837	<result name="VBOX_E_OBJECT_NOT_FOUND">
6838	Given @c id does not correspond to any USB device.
6839	</result>
6840
6841	<see><link to="IUSBDevice::id"/></see>
6842	</desc>
6843	<param name="id" type="uuid" mod="string" dir="in">
6844	<desc>UUID of the USB device to search for.</desc>
6845	</param>
6846	<param name="device" type="IUSBDevice" dir="return">
6847	<desc>Found USB device object.</desc>
6848	</param>
6849	</method>
6850
6851	<method name="createSharedFolder">
6852	<desc>
6853	Creates a transient new shared folder by associating the given logical
6854	name with the given host path, adds it to the collection of shared
6855	folders and starts sharing it. Refer to the description of
6856	<link to="ISharedFolder"/> to read more about logical names.
6857
6858	<result name="VBOX_E_INVALID_VM_STATE">
6859	Virtual machine in Saved state or currently changing state.
6860	</result>
6861	<result name="VBOX_E_FILE_ERROR">
6862	Shared folder already exists or not accessible.
6863	</result>
6864	</desc>
6865	<param name="name" type="wstring" dir="in">
6866	<desc>Unique logical name of the shared folder.</desc>
6867	</param>
6868	<param name="hostPath" type="wstring" dir="in">
6869	<desc>Full path to the shared folder in the host file system.</desc>
6870	</param>
6871	<param name="writable" type="boolean" dir="in">
6872	<desc>Whether the share is writable or readonly</desc>
6873	</param>
6874	<param name="automount" type="boolean" dir="in">
6875	<desc>Whether the share gets automatically mounted by the guest
6876	or not.</desc>
6877	</param>
6878	</method>
6879
6880	<method name="removeSharedFolder">
6881	<desc>
6882	Removes a transient shared folder with the given name previously
6883	created by <link to="#createSharedFolder"/> from the collection of
6884	shared folders and stops sharing it.
6885	<result name="VBOX_E_INVALID_VM_STATE">
6886	Virtual machine in Saved state or currently changing state.
6887	</result>
6888	<result name="VBOX_E_FILE_ERROR">
6889	Shared folder does not exists.
6890	</result>
6891	</desc>
6892	<param name="name" type="wstring" dir="in">
6893	<desc>Logical name of the shared folder to remove.</desc>
6894	</param>
6895	</method>
6896
6897	<method name="takeSnapshot">
6898	<desc>
6899	Saves the current execution state
6900	and all settings of the machine and creates differencing images
6901	for all normal (non-independent) media.
6902	See <link to="ISnapshot" /> for an introduction to snapshots.
6903
6904	This method can be called for a PoweredOff, Saved (see
6905	<link to="#saveState"/>), Running or
6906	Paused virtual machine. When the machine is PoweredOff, an
6907	offline snapshot is created. When the machine is Running a live
6908	snapshot is created, and an online snapshot is is created when Paused.
6909
6910	The taken snapshot is always based on the
6911	<link to="IMachine::currentSnapshot">current snapshot</link>
6912	of the associated virtual machine and becomes a new current snapshot.
6913
6914	<note>
6915	This method implicitly calls <link to="IMachine::saveSettings"/> to
6916	save all current machine settings before taking an offline snapshot.
6917	</note>
6918
6919	<result name="VBOX_E_INVALID_VM_STATE">
6920	Virtual machine currently changing state.
6921	</result>
6922	</desc>
6923	<param name="name" type="wstring" dir="in">
6924	<desc>Short name for the snapshot.</desc>
6925	</param>
6926	<param name="description" type="wstring" dir="in">
6927	<desc>Optional description of the snapshot.</desc>
6928	</param>
6929	<param name="progress" type="IProgress" dir="return">
6930	<desc>Progress object to track the operation completion.</desc>
6931	</param>
6932	</method>
6933
6934	<method name="deleteSnapshot">
6935	<desc>
6936	Starts deleting the specified snapshot asynchronously.
6937	See <link to="ISnapshot" /> for an introduction to snapshots.
6938
6939	The execution state and settings of the associated machine stored in
6940	the snapshot will be deleted. The contents of all differencing media of
6941	this snapshot will be merged with the contents of their dependent child
6942	media to keep the medium chain valid (in other words, all changes
6943	represented by media being deleted will be propagated to their child
6944	medium). After that, this snapshot's differencing medium will be
6945	deleted. The parent of this snapshot will become a new parent for all
6946	its child snapshots.
6947
6948	If the deleted snapshot is the current one, its parent snapshot will
6949	become a new current snapshot. The current machine state is not directly
6950	affected in this case, except that currently attached differencing
6951	media based on media of the deleted snapshot will be also merged as
6952	described above.
6953
6954	If the deleted snapshot is the first or current snapshot, then the
6955	respective IMachine attributes will be adjusted. Deleting the current
6956	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
6957	to make all current machine settings permanent.
6958
6959	Deleting a snapshot has the following preconditions:
6960
6961	<ul>
6962	<li>Child media of all normal media of the deleted snapshot
6963	must be accessible (see <link to="IMedium::state"/>) for this
6964	operation to succeed. If only one running VM refers to all images
6965	which participates in merging the operation can be performed while
6966	the VM is running. Otherwise all virtual machines whose media are
6967	directly or indirectly based on the media of deleted snapshot must
6968	be powered off. In any case, online snapshot deleting usually is
6969	slower than the same operation without any running VM.</li>
6970
6971	<li>You cannot delete the snapshot if a medium attached to it has
6972	more than one child medium (differencing images) because otherwise
6973	merging would be impossible. This might be the case if there is
6974	more than one child snapshot or differencing images were created
6975	for other reason (e.g. implicitly because of multiple machine
6976	attachments).</li>
6977	</ul>
6978
6979	The virtual machine's <link to="IMachine::state">state</link> is
6980	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
6981	"DeletingSnapshotPaused" while this operation is in progress.
6982
6983	<note>
6984	Merging medium contents can be very time and disk space
6985	consuming, if these media are big in size and have many
6986	children. However, if the snapshot being deleted is the last
6987	(head) snapshot on the branch, the operation will be rather
6988	quick.
6989	</note>
6990	<result name="VBOX_E_INVALID_VM_STATE">
6991	The running virtual machine prevents deleting this snapshot. This
6992	happens only in very specific situations, usually snapshots can be
6993	deleted without trouble while a VM is running. The error message
6994	text explains the reason for the failure.
6995	</result>
6996	</desc>
6997	<param name="id" type="uuid" mod="string" dir="in">
6998	<desc>UUID of the snapshot to delete.</desc>
6999	</param>
7000	<param name="progress" type="IProgress" dir="return">
7001	<desc>Progress object to track the operation completion.</desc>
7002	</param>
7003	</method>
7004
7005	<method name="deleteSnapshotAndAllChildren">
7006	<desc>
7007	Starts deleting the specified snapshot and all its children
7008	asynchronously. See <link to="ISnapshot" /> for an introduction to
7009	snapshots. The conditions and many details are the same as with
7010	<link to="#deleteSnapshot"/>.
7011
7012	This operation is very fast if the snapshot subtree does not include
7013	the current state. It is still significantly faster than deleting the
7014	snapshots one by one if the current state is in the subtree and there
7015	are more than one snapshots from current state to the snapshot which
7016	marks the subtree, since it eliminates the incremental image merging.
7017
7018	<note>This API method is right now not implemented!</note>
7019
7020	<result name="VBOX_E_INVALID_VM_STATE">
7021	The running virtual machine prevents deleting this snapshot. This
7022	happens only in very specific situations, usually snapshots can be
7023	deleted without trouble while a VM is running. The error message
7024	text explains the reason for the failure.
7025	</result>
7026	<result name="E_NOTIMPL">
7027	The method is not implemented yet.
7028	</result>
7029	</desc>
7030	<param name="id" type="uuid" mod="string" dir="in">
7031	<desc>UUID of the snapshot to delete, including all its children.</desc>
7032	</param>
7033	<param name="progress" type="IProgress" dir="return">
7034	<desc>Progress object to track the operation completion.</desc>
7035	</param>
7036	</method>
7037
7038	<method name="deleteSnapshotRange">
7039	<desc>
7040	Starts deleting the specified snapshot range. This is limited to
7041	linear snapshot lists, which means there may not be any other child
7042	snapshots other than the direct sequence between the start and end
7043	snapshot. If the start and end snapshot point to the same snapshot this
7044	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7045	<link to="ISnapshot" /> for an introduction to snapshots. The
7046	conditions and many details are the same as with
7047	<link to="#deleteSnapshot"/>.
7048
7049	This operation is generally faster than deleting snapshots one by one
7050	and often also needs less extra disk space before freeing up disk space
7051	by deleting the removed disk images corresponding to the snapshot.
7052
7053	<note>This API method is right now not implemented!</note>
7054
7055	<result name="VBOX_E_INVALID_VM_STATE">
7056	The running virtual machine prevents deleting this snapshot. This
7057	happens only in very specific situations, usually snapshots can be
7058	deleted without trouble while a VM is running. The error message
7059	text explains the reason for the failure.
7060	</result>
7061	<result name="E_NOTIMPL">
7062	The method is not implemented yet.
7063	</result>
7064	</desc>
7065	<param name="startId" type="uuid" mod="string" dir="in">
7066	<desc>UUID of the first snapshot to delete.</desc>
7067	</param>
7068	<param name="endId" type="uuid" mod="string" dir="in">
7069	<desc>UUID of the last snapshot to delete.</desc>
7070	</param>
7071	<param name="progress" type="IProgress" dir="return">
7072	<desc>Progress object to track the operation completion.</desc>
7073	</param>
7074	</method>
7075
7076	<method name="restoreSnapshot">
7077	<desc>
7078	Starts resetting the machine's current state to the state contained
7079	in the given snapshot, asynchronously. All current settings of the
7080	machine will be reset and changes stored in differencing media
7081	will be lost.
7082	See <link to="ISnapshot" /> for an introduction to snapshots.
7083
7084	After this operation is successfully completed, new empty differencing
7085	media are created for all normal media of the machine.
7086
7087	If the given snapshot is an online snapshot, the machine will go to
7088	the <link to="MachineState_Saved"> saved state</link>, so that the
7089	next time it is powered on, the execution state will be restored
7090	from the state of the snapshot.
7091
7092	<note>
7093	The machine must not be running, otherwise the operation will fail.
7094	</note>
7095
7096	<note>
7097	If the machine state is <link to="MachineState_Saved">Saved</link>
7098	prior to this operation, the saved state file will be implicitly
7099	deleted (as if <link to="IConsole::discardSavedState"/> were
7100	called).
7101	</note>
7102
7103	<result name="VBOX_E_INVALID_VM_STATE">
7104	Virtual machine is running.
7105	</result>
7106	</desc>
7107	<param name="snapshot" type="ISnapshot" dir="in">
7108	<desc>The snapshot to restore the VM state from.</desc>
7109	</param>
7110	<param name="progress" type="IProgress" dir="return">
7111	<desc>Progress object to track the operation completion.</desc>
7112	</param>
7113	</method>
7114
7115	<method name="teleport">
7116	<desc>
7117	Teleport the VM to a different host machine or process.
7118
7119	TODO explain the details.
7120
7121	<result name="VBOX_E_INVALID_VM_STATE">
7122	Virtual machine not running or paused.
7123	</result>
7124	</desc>
7125	<param name="hostname" type="wstring" dir="in">
7126	<desc>The name or IP of the host to teleport to.</desc>
7127	</param>
7128	<param name="tcpport" type="unsigned long" dir="in">
7129	<desc>The TCP port to connect to (1..65535).</desc>
7130	</param>
7131	<param name="password" type="wstring" dir="in">
7132	<desc>The password.</desc>
7133	</param>
7134	<param name="maxDowntime" type="unsigned long" dir="in">
7135	<desc>
7136	The maximum allowed downtime given as milliseconds. 0 is not a valid
7137	value. Recommended value: 250 ms.
7138
7139	The higher the value is, the greater the chance for a successful
7140	teleportation. A small value may easily result in the teleportation
7141	process taking hours and eventually fail.
7142
7143	<note>
7144	The current implementation treats this a guideline, not as an
7145	absolute rule.
7146	</note>
7147	</desc>
7148	</param>
7149	<param name="progress" type="IProgress" dir="return">
7150	<desc>Progress object to track the operation completion.</desc>
7151	</param>
7152	</method>
7153
7154	</interface>
7155
7156	<!--
7157	// IHost
7158	/////////////////////////////////////////////////////////////////////////
7159	-->
7160
7161	<enum
7162	name="HostNetworkInterfaceMediumType"
7163	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7164	>
7165	<desc>
7166	Type of encapsulation. Ethernet encapsulation includes both wired and
7167	wireless Ethernet connections.
7168	<see><link to="IHostNetworkInterface"/></see>
7169	</desc>
7170
7171	<const name="Unknown" value="0">
7172	<desc>
7173	The type of interface cannot be determined.
7174	</desc>
7175	</const>
7176	<const name="Ethernet" value="1">
7177	<desc>
7178	Ethernet frame encapsulation.
7179	</desc>
7180	</const>
7181	<const name="PPP" value="2">
7182	<desc>
7183	Point-to-point protocol encapsulation.
7184	</desc>
7185	</const>
7186	<const name="SLIP" value="3">
7187	<desc>
7188	Serial line IP encapsulation.
7189	</desc>
7190	</const>
7191	</enum>
7192
7193	<enum
7194	name="HostNetworkInterfaceStatus"
7195	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7196	>
7197	<desc>
7198	Current status of the interface.
7199	<see><link to="IHostNetworkInterface"/></see>
7200	</desc>
7201
7202	<const name="Unknown" value="0">
7203	<desc>
7204	The state of interface cannot be determined.
7205	</desc>
7206	</const>
7207	<const name="Up" value="1">
7208	<desc>
7209	The interface is fully operational.
7210	</desc>
7211	</const>
7212	<const name="Down" value="2">
7213	<desc>
7214	The interface is not functioning.
7215	</desc>
7216	</const>
7217	</enum>
7218
7219	<enum
7220	name="HostNetworkInterfaceType"
7221	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7222	>
7223	<desc>
7224	Network interface type.
7225	</desc>
7226	<const name="Bridged" value="1"/>
7227	<const name="HostOnly" value="2"/>
7228	</enum>
7229
7230	<interface
7231	name="IHostNetworkInterface" extends="$unknown"
7232	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7233	wsmap="managed"
7234	>
7235	<desc>
7236	Represents one of host's network interfaces. IP V6 address and network
7237	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7238	separated by colons.
7239	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7240	</desc>
7241	<attribute name="name" type="wstring" readonly="yes">
7242	<desc>Returns the host network interface name.</desc>
7243	</attribute>
7244
7245	<attribute name="id" type="uuid" mod="string" readonly="yes">
7246	<desc>Returns the interface UUID.</desc>
7247	</attribute>
7248
7249	<attribute name="networkName" type="wstring" readonly="yes">
7250	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7251	</attribute>
7252
7253	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7254	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7255	</attribute>
7256
7257	<attribute name="IPAddress" type="wstring" readonly="yes">
7258	<desc>Returns the IP V4 address of the interface.</desc>
7259	</attribute>
7260
7261	<attribute name="networkMask" type="wstring" readonly="yes">
7262	<desc>Returns the network mask of the interface.</desc>
7263	</attribute>
7264
7265	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7266	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7267	</attribute>
7268
7269	<attribute name="IPV6Address" type="wstring" readonly="yes">
7270	<desc>Returns the IP V6 address of the interface.</desc>
7271	</attribute>
7272
7273	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7274	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7275	</attribute>
7276
7277	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7278	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7279	</attribute>
7280
7281	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7282	<desc>Type of protocol encapsulation used.</desc>
7283	</attribute>
7284
7285	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7286	<desc>Status of the interface.</desc>
7287	</attribute>
7288
7289	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7290	<desc>specifies the host interface type.</desc>
7291	</attribute>
7292
7293	<method name="enableStaticIpConfig">
7294	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7295	<param name="IPAddress" type="wstring" dir="in">
7296	<desc>
7297	IP address.
7298	</desc>
7299	</param>
7300	<param name="networkMask" type="wstring" dir="in">
7301	<desc>
7302	network mask.
7303	</desc>
7304	</param>
7305	</method>
7306
7307	<method name="enableStaticIpConfigV6">
7308	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7309	<param name="IPV6Address" type="wstring" dir="in">
7310	<desc>
7311	IP address.
7312	</desc>
7313	</param>
7314	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7315	<desc>
7316	network mask.
7317	</desc>
7318	</param>
7319	</method>
7320
7321	<method name="enableDynamicIpConfig">
7322	<desc>enables the dynamic IP configuration.</desc>
7323	</method>
7324
7325	<method name="dhcpRediscover">
7326	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7327	</method>
7328
7329	</interface>
7330
7331	<interface
7332	name="IHost" extends="$unknown"
7333	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7334	wsmap="managed"
7335	>
7336	<desc>
7337	The IHost interface represents the physical machine that this VirtualBox
7338	installation runs on.
7339
7340	An object implementing this interface is returned by the
7341	<link to="IVirtualBox::host" /> attribute. This interface contains
7342	read-only information about the host's physical hardware (such as what
7343	processors and disks are available, what the host operating system is,
7344	and so on) and also allows for manipulating some of the host's hardware,
7345	such as global USB device filters and host interface networking.
7346
7347	</desc>
7348	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7349	<desc>List of DVD drives available on the host.</desc>
7350	</attribute>
7351
7352	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7353	<desc>List of floppy drives available on the host.</desc>
7354	</attribute>
7355
7356	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7357	<desc>
7358	List of USB devices currently attached to the host.
7359	Once a new device is physically attached to the host computer,
7360	it appears in this list and remains there until detached.
7361
7362	<note>
7363	If USB functionality is not available in the given edition of
7364	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7365	</note>
7366	</desc>
7367	</attribute>
7368
7369	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7370	<desc>
7371	List of USB device filters in action.
7372	When a new device is physically attached to the host computer,
7373	filters from this list are applied to it (in order they are stored
7374	in the list). The first matched filter will determine the
7375	<link to="IHostUSBDeviceFilter::action">action</link>
7376	performed on the device.
7377
7378	Unless the device is ignored by these filters, filters of all
7379	currently running virtual machines
7380	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7381
7382	<note>
7383	If USB functionality is not available in the given edition of
7384	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7385	</note>
7386
7387	<see><link to="IHostUSBDeviceFilter"/>,
7388	<link to="USBDeviceState"/></see>
7389	</desc>
7390	</attribute>
7391
7392	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7393	<desc>List of host network interfaces currently defined on the host.</desc>
7394	</attribute>
7395
7396	<attribute name="processorCount" type="unsigned long" readonly="yes">
7397	<desc>Number of (logical) CPUs installed in the host system.</desc>
7398	</attribute>
7399
7400	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7401	<desc>Number of (logical) CPUs online in the host system.</desc>
7402	</attribute>
7403
7404	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7405	<desc>Number of physical processor cores installed in the host system.</desc>
7406	</attribute>
7407
7408	<method name="getProcessorSpeed">
7409	<desc>Query the (approximate) maximum speed of a specified host CPU in
7410	Megahertz.
7411	</desc>
7412	<param name="cpuId" type="unsigned long" dir="in">
7413	<desc>
7414	Identifier of the CPU.
7415	</desc>
7416	</param>
7417	<param name="speed" type="unsigned long" dir="return">
7418	<desc>
7419	Speed value. 0 is returned if value is not known or @a cpuId is
7420	invalid.
7421	</desc>
7422	</param>
7423	</method>
7424
7425	<method name="getProcessorFeature">
7426	<desc>Query whether a CPU feature is supported or not.</desc>
7427	<param name="feature" type="ProcessorFeature" dir="in">
7428	<desc>
7429	CPU Feature identifier.
7430	</desc>
7431	</param>
7432	<param name="supported" type="boolean" dir="return">
7433	<desc>
7434	Feature is supported or not.
7435	</desc>
7436	</param>
7437	</method>
7438
7439	<method name="getProcessorDescription">
7440	<desc>Query the model string of a specified host CPU.
7441	</desc>
7442	<param name="cpuId" type="unsigned long" dir="in">
7443	<desc>
7444	Identifier of the CPU.
7445	<note>
7446	The current implementation might not necessarily return the
7447	description for this exact CPU.
7448	</note>
7449	</desc>
7450	</param>
7451	<param name="description" type="wstring" dir="return">
7452	<desc>
7453	Model string. An empty string is returned if value is not known or
7454	@a cpuId is invalid.
7455	</desc>
7456	</param>
7457	</method>
7458
7459	<method name="getProcessorCPUIDLeaf">
7460	<desc>
7461	Returns the CPU cpuid information for the specified leaf.
7462	</desc>
7463	<param name="cpuId" type="unsigned long" dir="in">
7464	<desc>
7465	Identifier of the CPU. The CPU most be online.
7466	<note>
7467	The current implementation might not necessarily return the
7468	description for this exact CPU.
7469	</note>
7470	</desc>
7471	</param>
7472	<param name="leaf" type="unsigned long" dir="in">
7473	<desc>
7474	CPUID leaf index (eax).
7475	</desc>
7476	</param>
7477	<param name="subLeaf" type="unsigned long" dir="in">
7478	<desc>
7479	CPUID leaf sub index (ecx). This currently only applies to cache
7480	information on Intel CPUs. Use 0 if retrieving values for
7481	<link to="IMachine::setCPUIDLeaf"/>.
7482	</desc>
7483	</param>
7484	<param name="valEax" type="unsigned long" dir="out">
7485	<desc>
7486	CPUID leaf value for register eax.
7487	</desc>
7488	</param>
7489	<param name="valEbx" type="unsigned long" dir="out">
7490	<desc>
7491	CPUID leaf value for register ebx.
7492	</desc>
7493	</param>
7494	<param name="valEcx" type="unsigned long" dir="out">
7495	<desc>
7496	CPUID leaf value for register ecx.
7497	</desc>
7498	</param>
7499	<param name="valEdx" type="unsigned long" dir="out">
7500	<desc>
7501	CPUID leaf value for register edx.
7502	</desc>
7503	</param>
7504	</method>
7505
7506	<attribute name="memorySize" type="unsigned long" readonly="yes">
7507	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7508	</attribute>
7509
7510	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7511	<desc>Available system memory in the host system.</desc>
7512	</attribute>
7513
7514	<attribute name="operatingSystem" type="wstring" readonly="yes">
7515	<desc>Name of the host system's operating system.</desc>
7516	</attribute>
7517
7518	<attribute name="OSVersion" type="wstring" readonly="yes">
7519	<desc>Host operating system's version string.</desc>
7520	</attribute>
7521
7522	<attribute name="UTCTime" type="long long" readonly="yes">
7523	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7524	</attribute>
7525
7526	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7527	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7528	</attribute>
7529
7530	<method name="createHostOnlyNetworkInterface">
7531	<desc>
7532	Creates a new adapter for Host Only Networking.
7533	<result name="E_INVALIDARG">
7534	Host network interface @a name already exists.
7535	</result>
7536	</desc>
7537	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7538	<desc>
7539	Created host interface object.
7540	</desc>
7541	</param>
7542	<param name="progress" type="IProgress" dir="return">
7543	<desc>
7544	Progress object to track the operation completion.
7545	</desc>
7546	</param>
7547	</method>
7548
7549	<method name="removeHostOnlyNetworkInterface">
7550	<desc>
7551	Removes the given Host Only Networking interface.
7552	<result name="VBOX_E_OBJECT_NOT_FOUND">
7553	No host network interface matching @a id found.
7554	</result>
7555	</desc>
7556	<param name="id" type="uuid" mod="string" dir="in">
7557	<desc>
7558	Adapter GUID.
7559	</desc>
7560	</param>
7561	<param name="progress" type="IProgress" dir="return">
7562	<desc>
7563	Progress object to track the operation completion.
7564	</desc>
7565	</param>
7566	</method>
7567
7568	<method name="createUSBDeviceFilter">
7569	<desc>
7570	Creates a new USB device filter. All attributes except
7571	the filter name are set to empty (any match),
7572	<i>active</i> is @c false (the filter is not active).
7573
7574	The created filter can be added to the list of filters using
7575	<link to="#insertUSBDeviceFilter"/>.
7576
7577	<see><link to="#USBDeviceFilters"/></see>
7578	</desc>
7579	<param name="name" type="wstring" dir="in">
7580	<desc>
7581	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7582	</desc>
7583	</param>
7584	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7585	<desc>Created filter object.</desc>
7586	</param>
7587	</method>
7588
7589	<method name="insertUSBDeviceFilter">
7590	<desc>
7591	Inserts the given USB device to the specified position
7592	in the list of filters.
7593
7594	Positions are numbered starting from @c 0. If the specified
7595	position is equal to or greater than the number of elements in
7596	the list, the filter is added at the end of the collection.
7597
7598	<note>
7599	Duplicates are not allowed, so an attempt to insert a
7600	filter already in the list is an error.
7601	</note>
7602	<note>
7603	If USB functionality is not available in the given edition of
7604	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7605	</note>
7606
7607	<see><link to="#USBDeviceFilters"/></see>
7608
7609	<result name="VBOX_E_INVALID_OBJECT_STATE">
7610	USB device filter is not created within this VirtualBox instance.
7611	</result>
7612	<result name="E_INVALIDARG">
7613	USB device filter already in list.
7614	</result>
7615
7616	</desc>
7617	<param name="position" type="unsigned long" dir="in">
7618	<desc>Position to insert the filter to.</desc>
7619	</param>
7620	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7621	<desc>USB device filter to insert.</desc>
7622	</param>
7623	</method>
7624
7625	<method name="removeUSBDeviceFilter">
7626	<desc>
7627	Removes a USB device filter from the specified position in the
7628	list of filters.
7629
7630	Positions are numbered starting from @c 0. Specifying a
7631	position equal to or greater than the number of elements in
7632	the list will produce an error.
7633
7634	<note>
7635	If USB functionality is not available in the given edition of
7636	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7637	</note>
7638
7639	<see><link to="#USBDeviceFilters"/></see>
7640
7641	<result name="E_INVALIDARG">
7642	USB device filter list empty or invalid @a position.
7643	</result>
7644
7645	</desc>
7646	<param name="position" type="unsigned long" dir="in">
7647	<desc>Position to remove the filter from.</desc>
7648	</param>
7649	</method>
7650
7651	<method name="findHostDVDDrive">
7652	<desc>
7653	Searches for a host DVD drive with the given @c name.
7654
7655	<result name="VBOX_E_OBJECT_NOT_FOUND">
7656	Given @c name does not correspond to any host drive.
7657	</result>
7658
7659	</desc>
7660	<param name="name" type="wstring" dir="in">
7661	<desc>Name of the host drive to search for</desc>
7662	</param>
7663	<param name="drive" type="IMedium" dir="return">
7664	<desc>Found host drive object</desc>
7665	</param>
7666	</method>
7667
7668	<method name="findHostFloppyDrive">
7669	<desc>
7670	Searches for a host floppy drive with the given @c name.
7671
7672	<result name="VBOX_E_OBJECT_NOT_FOUND">
7673	Given @c name does not correspond to any host floppy drive.
7674	</result>
7675
7676	</desc>
7677	<param name="name" type="wstring" dir="in">
7678	<desc>Name of the host floppy drive to search for</desc>
7679	</param>
7680	<param name="drive" type="IMedium" dir="return">
7681	<desc>Found host floppy drive object</desc>
7682	</param>
7683	</method>
7684
7685	<method name="findHostNetworkInterfaceByName">
7686	<desc>
7687	Searches through all host network interfaces for an interface with
7688	the given @c name.
7689	<note>
7690	The method returns an error if the given @c name does not
7691	correspond to any host network interface.
7692	</note>
7693	</desc>
7694	<param name="name" type="wstring" dir="in">
7695	<desc>Name of the host network interface to search for.</desc>
7696	</param>
7697	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7698	<desc>Found host network interface object.</desc>
7699	</param>
7700	</method>
7701	<method name="findHostNetworkInterfaceById">
7702	<desc>
7703	Searches through all host network interfaces for an interface with
7704	the given GUID.
7705	<note>
7706	The method returns an error if the given GUID does not
7707	correspond to any host network interface.
7708	</note>
7709	</desc>
7710	<param name="id" type="uuid" mod="string" dir="in">
7711	<desc>GUID of the host network interface to search for.</desc>
7712	</param>
7713	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7714	<desc>Found host network interface object.</desc>
7715	</param>
7716	</method>
7717	<method name="findHostNetworkInterfacesOfType">
7718	<desc>
7719	Searches through all host network interfaces and returns a list of interfaces of the specified type
7720	</desc>
7721	<param name="type" type="HostNetworkInterfaceType" dir="in">
7722	<desc>type of the host network interfaces to search for.</desc>
7723	</param>
7724	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7725	<desc>Found host network interface objects.</desc>
7726	</param>
7727	</method>
7728
7729	<method name="findUSBDeviceById">
7730	<desc>
7731	Searches for a USB device with the given UUID.
7732
7733	<result name="VBOX_E_OBJECT_NOT_FOUND">
7734	Given @c id does not correspond to any USB device.
7735	</result>
7736
7737	<see><link to="IUSBDevice::id"/></see>
7738	</desc>
7739	<param name="id" type="uuid" mod="string" dir="in">
7740	<desc>UUID of the USB device to search for.</desc>
7741	</param>
7742	<param name="device" type="IHostUSBDevice" dir="return">
7743	<desc>Found USB device object.</desc>
7744	</param>
7745	</method>
7746
7747	<method name="findUSBDeviceByAddress">
7748	<desc>
7749	Searches for a USB device with the given host address.
7750
7751	<result name="VBOX_E_OBJECT_NOT_FOUND">
7752	Given @c name does not correspond to any USB device.
7753	</result>
7754
7755	<see><link to="IUSBDevice::address"/></see>
7756	</desc>
7757	<param name="name" type="wstring" dir="in">
7758	<desc>
7759	Address of the USB device (as assigned by the host) to
7760	search for.
7761	</desc>
7762	</param>
7763	<param name="device" type="IHostUSBDevice" dir="return">
7764	<desc>Found USB device object.</desc>
7765	</param>
7766	</method>
7767
7768	<method name="generateMACAddress">
7769	<desc>
7770	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7771	</desc>
7772	<param name="address" type="wstring" dir="return">
7773	<desc>New Ethernet MAC address.</desc>
7774	</param>
7775	</method>
7776
7777	</interface>
7778
7779	<!--
7780	// ISystemProperties
7781	/////////////////////////////////////////////////////////////////////////
7782	-->
7783
7784	<interface
7785	name="ISystemProperties"
7786	extends="$unknown"
7787	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7788	wsmap="managed"
7789	>
7790	<desc>
7791	The ISystemProperties interface represents global properties of the given
7792	VirtualBox installation.
7793
7794	These properties define limits and default values for various attributes
7795	and parameters. Most of the properties are read-only, but some can be
7796	changed by a user.
7797	</desc>
7798
7799	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7800	<desc>Minimum guest system memory in Megabytes.</desc>
7801	</attribute>
7802
7803	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7804	<desc>Maximum guest system memory in Megabytes.</desc>
7805	</attribute>
7806
7807	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7808	<desc>Minimum guest video memory in Megabytes.</desc>
7809	</attribute>
7810
7811	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7812	<desc>Maximum guest video memory in Megabytes.</desc>
7813	</attribute>
7814
7815	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7816	<desc>Minimum CPU count.</desc>
7817	</attribute>
7818
7819	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7820	<desc>Maximum CPU count.</desc>
7821	</attribute>
7822
7823	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7824	<desc>Maximum of monitors which could be connected.</desc>
7825	</attribute>
7826
7827	<attribute name="infoVDSize" type="long long" readonly="yes">
7828	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7829	does not reflect the limits of any virtual disk image format.</desc>
7830	</attribute>
7831
7832	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7833	<desc>
7834	Maximum number of serial ports associated with every
7835	<link to="IMachine"/> instance.
7836	</desc>
7837	</attribute>
7838
7839	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7840	<desc>
7841	Maximum number of parallel ports associated with every
7842	<link to="IMachine"/> instance.
7843	</desc>
7844	</attribute>
7845
7846	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7847	<desc>
7848	Maximum device position in the boot order. This value corresponds
7849	to the total number of devices a machine can boot from, to make it
7850	possible to include all possible devices to the boot list.
7851	<see><link to="IMachine::setBootOrder"/></see>
7852	</desc>
7853	</attribute>
7854
7855	<attribute name="defaultMachineFolder" type="wstring">
7856	<desc>
7857	Full path to the default directory used to create new or open
7858	existing machines when a machine settings file name contains no
7859	path.
7860
7861	Starting with VirtualBox 4.0, by default, this attribute contains
7862	the full path of folder named "VirtualBox VMs" in the user's
7863	home directory, which depends on the host platform.
7864
7865	When setting this attribute, a full path must be specified.
7866	Setting this property to @c null or an empty string or the
7867	special value "Machines" (for compatibility reasons) will restore
7868	that default value.
7869
7870	If the folder specified herein does not exist, it will be created
7871	automatically as needed.
7872
7873	<see>
7874	<link to="IVirtualBox::createMachine"/>,
7875	<link to="IVirtualBox::openMachine"/>
7876	</see>
7877	</desc>
7878	</attribute>
7879
7880	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7881	<desc>
7882	List of all medium storage formats supported by this VirtualBox
7883	installation.
7884
7885	Keep in mind that the medium format identifier
7886	(<link to="IMediumFormat::id"/>) used in other API calls like
7887	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7888	medium format is a case-insensitive string. This means that, for
7889	example, all of the following strings:
7890	<pre>
7891	"VDI"
7892	"vdi"
7893	"VdI"</pre>
7894	refer to the same medium format.
7895
7896	Note that the virtual medium framework is backend-based, therefore
7897	the list of supported formats depends on what backends are currently
7898	installed.
7899
7900	<see><link to="IMediumFormat"/></see>
7901	</desc>
7902	</attribute>
7903
7904	<attribute name="defaultHardDiskFormat" type="wstring">
7905	<desc>
7906	Identifier of the default medium format used by VirtualBox.
7907
7908	The medium format set by this attribute is used by VirtualBox
7909	when the medium format was not specified explicitly. One example is
7910	<link to="IVirtualBox::createHardDisk"/> with the empty
7911	format argument. A more complex example is implicit creation of
7912	differencing media when taking a snapshot of a virtual machine:
7913	this operation will try to use a format of the parent medium first
7914	and if this format does not support differencing media the default
7915	format specified by this argument will be used.
7916
7917	The list of supported medium formats may be obtained by the
7918	<link to="#mediumFormats"/> call. Note that the default medium
7919	format must have a capability to create differencing media;
7920	otherwise operations that create media implicitly may fail
7921	unexpectedly.
7922
7923	The initial value of this property is <tt>"VDI"</tt> in the current
7924	version of the VirtualBox product, but may change in the future.
7925
7926	<note>
7927	Setting this property to @c null or empty string will restore the
7928	initial value.
7929	</note>
7930
7931	<see>
7932	<link to="#mediumFormats"/>,
7933	<link to="IMediumFormat::id"/>,
7934	<link to="IVirtualBox::createHardDisk"/>
7935	</see>
7936	</desc>
7937	</attribute>
7938
7939	<attribute name="freeDiskSpaceWarning" type="long long">
7940	<desc>Issue a warning if the free disk space is below (or in some disk
7941	intensive operation is expected to go below) the given size in
7942	bytes.</desc>
7943	</attribute>
7944
7945	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
7946	<desc>Issue a warning if the free disk space is below (or in some disk
7947	intensive operation is expected to go below) the given percentage.</desc>
7948	</attribute>
7949
7950	<attribute name="freeDiskSpaceError" type="long long">
7951	<desc>Issue an error if the free disk space is below (or in some disk
7952	intensive operation is expected to go below) the given size in
7953	bytes.</desc>
7954	</attribute>
7955
7956	<attribute name="freeDiskSpacePercentError" type="unsigned long">
7957	<desc>Issue an error if the free disk space is below (or in some disk
7958	intensive operation is expected to go below) the given percentage.</desc>
7959	</attribute>
7960
7961	<attribute name="VRDEAuthLibrary" type="wstring">
7962	<desc>
7963	Library that provides authentication for Remote Desktop clients. The library
7964	is used if a virtual machine's authentication type is set to "external"
7965	in the VM RemoteDisplay configuration.
7966
7967	The system library extension (".DLL" or ".so") must be omitted.
7968	A full path can be specified; if not, then the library must reside on the
7969	system's default library path.
7970
7971	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
7972	of that name in one of the default VirtualBox library directories.
7973
7974	For details about VirtualBox authentication libraries and how to implement
7975	them, please refer to the VirtualBox manual.
7976
7977	<note>
7978	Setting this property to @c null or empty string will restore the
7979	initial value.
7980	</note>
7981	</desc>
7982	</attribute>
7983
7984	<attribute name="webServiceAuthLibrary" type="wstring">
7985	<desc>
7986	Library that provides authentication for webservice clients. The library
7987	is used if a virtual machine's authentication type is set to "external"
7988	in the VM RemoteDisplay configuration and will be called from
7989	within the <link to="IWebsessionManager::logon" /> implementation.
7990
7991	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
7992	there is no per-VM setting for this, as the webservice is a global
7993	resource (if it is running). Only for this setting (for the webservice),
7994	setting this value to a literal <tt>"null"</tt> string disables authentication,
7995	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
7996	no matter what user name and password are supplied.
7997
7998	The initial value of this property is <tt>"VBoxAuth"</tt>,
7999	meaning that the webservice will use the same authentication
8000	library that is used by default for VRDE (again, see
8001	<link to="ISystemProperties::VRDEAuthLibrary" />).
8002	The format and calling convention of authentication libraries
8003	is the same for the webservice as it is for VRDE.
8004
8005	<note>
8006	Setting this property to @c null or empty string will restore the
8007	initial value.
8008	</note>
8009	</desc>
8010	</attribute>
8011
8012	<attribute name="defaultVRDEExtPack" type="wstring">
8013	<desc>
8014	The name of the extension pack providing the default VRDE.
8015
8016	This attribute is for choosing between multiple extension packs
8017	providing VRDE. If only one is installed, it will automatically be the
8018	default one. The attribute value can be empty if no VRDE extension
8019	pack is installed.
8020
8021	For details about VirtualBox Remote Desktop Extension and how to
8022	implement one, please refer to the VirtualBox SDK.
8023	</desc>
8024	</attribute>
8025
8026	<attribute name="logHistoryCount" type="unsigned long">
8027	<desc>
8028	This value specifies how many old release log files are kept.
8029	</desc>
8030	</attribute>
8031
8032	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8033	<desc>This value hold the default audio driver for the current
8034	system.</desc>
8035	</attribute>
8036
8037
8038	<method name="getMaxNetworkAdapters">
8039	<desc>
8040	Maximum total number of network adapters associated with every
8041	<link to="IMachine"/> instance.
8042	</desc>
8043
8044	<param name="chipset" type="ChipsetType" dir="in">
8045	<desc>The chipset type to get the value for.</desc>
8046	</param>
8047
8048
8049	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8050	<desc>The maximum total number of network adapters allowed.</desc>
8051	</param>
8052
8053	</method>
8054
8055	<method name="getMaxNetworkAdaptersOfType">
8056	<desc>
8057	Maximum number of network adapters of a given attachment type,
8058	associated with every <link to="IMachine"/> instance.
8059	</desc>
8060
8061	<param name="chipset" type="ChipsetType" dir="in">
8062	<desc>The chipset type to get the value for.</desc>
8063	</param>
8064
8065	<param name="type" type="NetworkAttachmentType" dir="in">
8066	<desc>Type of attachment.</desc>
8067	</param>
8068
8069	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8070	<desc>The maximum number of network adapters allowed for
8071	particular chipset and attachment type.</desc>
8072	</param>
8073
8074	</method>
8075
8076
8077	<method name="getMaxDevicesPerPortForStorageBus">
8078	<desc>Returns the maximum number of devices which can be attached to a port
8079	for the given storage bus.</desc>
8080
8081	<param name="bus" type="StorageBus" dir="in">
8082	<desc>The storage bus type to get the value for.</desc>
8083	</param>
8084
8085	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8086	<desc>The maximum number of devices which can be attached to the port for the given
8087	storage bus.</desc>
8088	</param>
8089	</method>
8090
8091	<method name="getMinPortCountForStorageBus">
8092	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8093
8094	<param name="bus" type="StorageBus" dir="in">
8095	<desc>The storage bus type to get the value for.</desc>
8096	</param>
8097
8098	<param name="minPortCount" type="unsigned long" dir="return">
8099	<desc>The minimum number of ports for the given storage bus.</desc>
8100	</param>
8101	</method>
8102
8103	<method name="getMaxPortCountForStorageBus">
8104	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8105
8106	<param name="bus" type="StorageBus" dir="in">
8107	<desc>The storage bus type to get the value for.</desc>
8108	</param>
8109
8110	<param name="maxPortCount" type="unsigned long" dir="return">
8111	<desc>The maximum number of ports for the given storage bus.</desc>
8112	</param>
8113	</method>
8114
8115	<method name="getMaxInstancesOfStorageBus">
8116	<desc>Returns the maximum number of storage bus instances which
8117	can be configured for each VM. This corresponds to the number of
8118	storage controllers one can have. Value may depend on chipset type
8119	used.</desc>
8120
8121	<param name="chipset" type="ChipsetType" dir="in">
8122	<desc>The chipset type to get the value for.</desc>
8123	</param>
8124
8125	<param name="bus" type="StorageBus" dir="in">
8126	<desc>The storage bus type to get the value for.</desc>
8127	</param>
8128
8129	<param name="maxInstances" type="unsigned long" dir="return">
8130	<desc>The maximum number of instances for the given storage bus.</desc>
8131	</param>
8132	</method>
8133
8134	<method name="getDeviceTypesForStorageBus">
8135	<desc>Returns list of all the supported device types
8136	(<link to="DeviceType"/>) for the given type of storage
8137	bus.</desc>
8138
8139	<param name="bus" type="StorageBus" dir="in">
8140	<desc>The storage bus type to get the value for.</desc>
8141	</param>
8142
8143	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8144	<desc>The list of all supported device types for the given storage bus.</desc>
8145	</param>
8146	</method>
8147
8148	<method name="getDefaultIoCacheSettingForStorageController">
8149	<desc>Returns the default I/O cache setting for the
8150	given storage controller</desc>
8151
8152	<param name="controllerType" type="StorageControllerType" dir="in">
8153	<desc>The storage controller to the setting for.</desc>
8154	</param>
8155
8156	<param name="enabled" type="boolean" dir="return">
8157	<desc>Returned flag indicating the default value</desc>
8158	</param>
8159	</method>
8160	</interface>
8161
8162	<!--
8163	// IGuest
8164	/////////////////////////////////////////////////////////////////////////
8165	-->
8166
8167	<interface
8168	name="IGuestOSType" extends="$unknown"
8169	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8170	wsmap="struct"
8171	>
8172	<desc>
8173	</desc>
8174
8175	<attribute name="familyId" type="wstring" readonly="yes">
8176	<desc>Guest OS family identifier string.</desc>
8177	</attribute>
8178
8179	<attribute name="familyDescription" type="wstring" readonly="yes">
8180	<desc>Human readable description of the guest OS family.</desc>
8181	</attribute>
8182
8183	<attribute name="id" type="wstring" readonly="yes">
8184	<desc>Guest OS identifier string.</desc>
8185	</attribute>
8186
8187	<attribute name="description" type="wstring" readonly="yes">
8188	<desc>Human readable description of the guest OS.</desc>
8189	</attribute>
8190
8191	<attribute name="is64Bit" type="boolean" readonly="yes">
8192	<desc>Returns @c true if the given OS is 64-bit</desc>
8193	</attribute>
8194
8195	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8196	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8197	</attribute>
8198
8199	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8200	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8201	</attribute>
8202
8203	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8204	<desc>Recommended RAM size in Megabytes.</desc>
8205	</attribute>
8206
8207	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8208	<desc>Recommended video RAM size in Megabytes.</desc>
8209	</attribute>
8210
8211	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8212	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8213	</attribute>
8214
8215	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8216	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8217	</attribute>
8218
8219	<attribute name="recommendedHDD" type="long long" readonly="yes">
8220	<desc>Recommended hard disk size in bytes.</desc>
8221	</attribute>
8222
8223	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8224	<desc>Returns recommended network adapter for this OS type.</desc>
8225	</attribute>
8226
8227	<attribute name="recommendedPae" type="boolean" readonly="yes">
8228	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8229	</attribute>
8230
8231	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8232	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8233	</attribute>
8234
8235	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8236	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8237	</attribute>
8238
8239	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8240	<desc>Recommended storage controller type for HD drives.</desc>
8241	</attribute>
8242
8243	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8244	<desc>Recommended storage bus type for HD drives.</desc>
8245	</attribute>
8246
8247	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8248	<desc>Recommended firmware type.</desc>
8249	</attribute>
8250
8251	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8252	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8253	</attribute>
8254
8255	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8256	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8257	</attribute>
8258
8259	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8260	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8261	</attribute>
8262
8263	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8264	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8265	</attribute>
8266
8267	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8268	<desc>Recommended chipset type.</desc>
8269	</attribute>
8270
8271	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8272	<desc>Recommended audio type.</desc>
8273	</attribute>
8274
8275	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8276	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8277	</attribute>
8278
8279	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8280	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8281	</attribute>
8282
8283	</interface>
8284
8285	<enum
8286	name="AdditionsFacilityType"
8287	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8288	>
8289	<desc>
8290	Guest Additions facility IDs.
8291	</desc>
8292
8293	<const name="None" value="0">
8294	<desc>No/invalid facility.</desc>
8295	</const>
8296	<const name="VBoxGuestDriver" value="20">
8297	<desc>VirtualBox base driver (VBoxGuest).</desc>
8298	</const>
8299	<const name="VBoxService" value="100">
8300	<desc>VirtualBox system service (VBoxService).</desc>
8301	</const>
8302	<const name="VBoxTrayClient" value="101">
8303	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8304	</const>
8305	<const name="Seamless" value="1000">
8306	<desc>Seamless guest desktop integration.</desc>
8307	</const>
8308	<const name="Graphics" value="1100">
8309	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8310	are not immediately acted on and guest display resizes are probably not initiated by
8311	the guest additions.
8312	</desc>
8313	</const>
8314	<const name="All" value="2147483646">
8315	<desc>All facilities selected.</desc>
8316	</const>
8317	</enum>
8318
8319	<enum
8320	name="AdditionsFacilityClass"
8321	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8322	>
8323	<desc>
8324	Guest Additions facility classes.
8325	</desc>
8326
8327	<const name="None" value="0">
8328	<desc>No/invalid class.</desc>
8329	</const>
8330	<const name="Driver" value="10">
8331	<desc>Driver.</desc>
8332	</const>
8333	<const name="Service" value="30">
8334	<desc>System service.</desc>
8335	</const>
8336	<const name="Program" value="50">
8337	<desc>Program.</desc>
8338	</const>
8339	<const name="Feature" value="100">
8340	<desc>Feature.</desc>
8341	</const>
8342	<const name="ThirdParty" value="999">
8343	<desc>Third party.</desc>
8344	</const>
8345	<const name="All" value="2147483646">
8346	<desc>All facility classes selected.</desc>
8347	</const>
8348	</enum>
8349
8350	<enum
8351	name="AdditionsFacilityStatus"
8352	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8353	>
8354	<desc>
8355	Guest Additions facility states.
8356	</desc>
8357
8358	<const name="Inactive" value="0">
8359	<desc>Facility is not active.</desc>
8360	</const>
8361	<const name="Paused" value="1">
8362	<desc>Facility has been paused.</desc>
8363	</const>
8364	<const name="PreInit" value="20">
8365	<desc>Facility is preparing to initialize.</desc>
8366	</const>
8367	<const name="Init" value="30">
8368	<desc>Facility is initializing.</desc>
8369	</const>
8370	<const name="Active" value="50">
8371	<desc>Facility is up and running.</desc>
8372	</const>
8373	<const name="Terminating" value="100">
8374	<desc>Facility is shutting down.</desc>
8375	</const>
8376	<const name="Terminated" value="101">
8377	<desc>Facility successfully shut down.</desc>
8378	</const>
8379	<const name="Failed" value="800">
8380	<desc>Facility failed to start.</desc>
8381	</const>
8382	<const name="Unknown" value="999">
8383	<desc>Facility status is unknown.</desc>
8384	</const>
8385	</enum>
8386
8387	<interface
8388	name="IAdditionsFacility" extends="$unknown"
8389	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8390	wsmap="struct"
8391	>
8392	<desc>
8393	Structure representing a Guest Additions facility.
8394	</desc>
8395
8396	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8397	<desc>The class this facility is part of.</desc>
8398	</attribute>
8399
8400	<attribute name="lastUpdated" type="long long" readonly="yes">
8401	<desc>
8402	Time stamp of the last status update,
8403	in milliseconds since 1970-01-01 UTC.
8404	</desc>
8405	</attribute>
8406
8407	<attribute name="name" type="wstring" readonly="yes">
8408	<desc>The facility's friendly name.</desc>
8409	</attribute>
8410
8411	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8412	<desc>The current status.</desc>
8413	</attribute>
8414
8415	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8416	<desc>The facility's type ID.</desc>
8417	</attribute>
8418	</interface>
8419
8420	<enum
8421	name="AdditionsRunLevelType"
8422	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8423	>
8424	<desc>
8425	Guest Additions run level type.
8426	</desc>
8427
8428	<const name="None" value="0">
8429	<desc>Guest Additions are not loaded.</desc>
8430	</const>
8431	<const name="System" value="1">
8432	<desc>Guest drivers are loaded.</desc>
8433	</const>
8434	<const name="Userland" value="2">
8435	<desc>Common components (such as application services) are loaded.</desc>
8436	</const>
8437	<const name="Desktop" value="3">
8438	<desc>Per-user desktop components are loaded.</desc>
8439	</const>
8440	</enum>
8441
8442	<enum
8443	name="AdditionsUpdateFlag"
8444	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8445	>
8446	<desc>
8447	Guest Additions update flags.
8448	</desc>
8449
8450	<const name="None" value="0">
8451	<desc>No flag set.</desc>
8452	</const>
8453	<const name="WaitForUpdateStartOnly" value="1">
8454	<desc>Only wait for the update process being started and do not
8455	wait while peforming the actual update.</desc>
8456	</const>
8457	</enum>
8458
8459	<enum
8460	name="ExecuteProcessFlag"
8461	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8462	>
8463	<desc>
8464	Guest process execution flags.
8465	</desc>
8466
8467	<const name="None" value="0">
8468	<desc>No flag set.</desc>
8469	</const>
8470	<const name="WaitForProcessStartOnly" value="1">
8471	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8472	process itself then uses an infinite timeout.</desc>
8473	</const>
8474	<const name="IgnoreOrphanedProcesses" value="2">
8475	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8476	</const>
8477	<const name="Hidden" value="4">
8478	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8479	</const>
8480	<const name="NoProfile" value="8">
8481	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8482	</const>
8483	<const name="WaitForStdOut" value="16">
8484	<desc>The guest process waits until all data from stdout is read out.</desc>
8485	</const>
8486	<const name="WaitForStdErr" value="32">
8487	<desc>The guest process waits until all data from stderr is read out.</desc>
8488	</const>
8489	</enum>
8490
8491	<enum
8492	name="ExecuteProcessStatus"
8493	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8494	>
8495	<desc>
8496	Guest process execution status.
8497	</desc>
8498	<const name="Undefined" value="0">
8499	<desc>Process is in an undefined state.</desc>
8500	</const>
8501
8502	<const name="Started" value="1">
8503	<desc>Process has been started.</desc>
8504	</const>
8505	<const name="TerminatedNormally" value="2">
8506	<desc>Process terminated normally.</desc>
8507	</const>
8508	<const name="TerminatedSignal" value="3">
8509	<desc>Process terminated via signal.</desc>
8510	</const>
8511	<const name="TerminatedAbnormally" value="4">
8512	<desc>Process terminated abnormally.</desc>
8513	</const>
8514	<const name="TimedOutKilled" value="5">
8515	<desc>Process timed out and was killed.</desc>
8516	</const>
8517	<const name="TimedOutAbnormally" value="6">
8518	<desc>Process timed out and was not killed successfully.</desc>
8519	</const>
8520	<const name="Down" value="7">
8521	<desc>Service/OS is stopping, process was killed.</desc>
8522	</const>
8523	<const name="Error" value="8">
8524	<desc>Something went wrong (error code in flags).</desc>
8525	</const>
8526	</enum>
8527
8528	<enum
8529	name="ProcessInputFlag"
8530	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8531	>
8532	<desc>
8533	Guest process input flags.
8534	</desc>
8535	<const name="None" value="0">
8536	<desc>No flag set.</desc>
8537	</const>
8538	<const name="EndOfFile" value="1">
8539	<desc>End of file (input) reached.</desc>
8540	</const>
8541	</enum>
8542
8543	<enum
8544	name="ProcessOutputFlag"
8545	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8546	>
8547	<desc>
8548	Guest process output flags for specifying which
8549	type of output to retrieve.
8550	</desc>
8551	<const name="None" value="0">
8552	<desc>No flags set. Get output from stdout.</desc>
8553	</const>
8554	<const name="StdErr" value="1">
8555	<desc>Get output from stderr.</desc>
8556	</const>
8557	</enum>
8558
8559	<enum
8560	name="CopyFileFlag"
8561	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8562	>
8563	<desc>
8564	Host/Guest copy flags. At the moment none of these flags
8565	are implemented.
8566	</desc>
8567	<const name="None" value="0">
8568	<desc>No flag set.</desc>
8569	</const>
8570	<const name="Recursive" value="1">
8571	<desc>Copy directories recursively.</desc>
8572	</const>
8573	<const name="Update" value="2">
8574	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8575	</const>
8576	<const name="FollowLinks" value="4">
8577	<desc>Follow symbolic links.</desc>
8578	</const>
8579	</enum>
8580
8581	<enum
8582	name="DirectoryCreateFlag"
8583	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8584	>
8585	<desc>
8586	Directory creation flags.
8587	</desc>
8588	<const name="None" value="0">
8589	<desc>No flag set.</desc>
8590	</const>
8591	<const name="Parents" value="1">
8592	<desc>No error if existing, make parent directories as needed.</desc>
8593	</const>
8594	</enum>
8595
8596	<enum
8597	name="DragAndDropAction"
8598	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8599	>
8600	<desc>
8601	Possible actions within an Drag and Drop operation.
8602	</desc>
8603
8604	<const name="Ignore" value="0">
8605	<desc>Do nothing.</desc>
8606	</const>
8607
8608	<const name="Copy" value="1">
8609	<desc>Copy the item to the target.</desc>
8610	</const>
8611
8612	<const name="Move" value="2">
8613	<desc>Move the item to the target.</desc>
8614	</const>
8615
8616	<const name="Link" value="3">
8617	<desc>Link the item from within the target.</desc>
8618	</const>
8619	</enum>
8620
8621	<enum
8622	name="DirectoryOpenFlag"
8623	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8624	>
8625	<desc>
8626	Directory open flags.
8627	</desc>
8628	<const name="None" value="0">
8629	<desc>No flag set.</desc>
8630	</const>
8631	</enum>
8632
8633	<enum
8634	name="GuestDirEntryType"
8635	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8636	>
8637	<desc>
8638	Guest directory entry type.
8639	</desc>
8640	<const name="Unknown" value="0">
8641	<desc>Unknown.</desc>
8642	</const>
8643	<const name="Directory" value="4">
8644	<desc>Regular file.</desc>
8645	</const>
8646	<const name="File" value="10">
8647	<desc>Regular file.</desc>
8648	</const>
8649	<const name="Symlink" value="12">
8650	<desc>Symbolic link.</desc>
8651	</const>
8652	</enum>
8653
8654	<interface
8655	name="IGuestDirEntry" extends="$unknown"
8656	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8657	wsmap="struct"
8658	>
8659	<desc>
8660	Structure representing a directory entry on the guest OS.
8661	</desc>
8662	<attribute name="nodeId" type="long long" readonly="yes">
8663	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8664	</attribute>
8665	<attribute name="name" type="wstring" readonly="yes">
8666	<desc>The filename.</desc>
8667	</attribute>
8668	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8669	<desc>The entry type.</desc>
8670	</attribute>
8671	</interface>
8672
8673	<interface
8674	name="IGuest" extends="$unknown"
8675	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8676	wsmap="managed"
8677	>
8678	<desc>
8679	The IGuest interface represents information about the operating system
8680	running inside the virtual machine. Used in
8681	<link to="IConsole::guest"/>.
8682
8683	IGuest provides information about the guest operating system, whether
8684	Guest Additions are installed and other OS-specific virtual machine
8685	properties.
8686	</desc>
8687
8688	<attribute name="OSTypeId" type="wstring" readonly="yes">
8689	<desc>
8690	Identifier of the Guest OS type as reported by the Guest
8691	Additions.
8692	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8693	an IGuestOSType object representing details about the given
8694	Guest OS type.
8695	<note>
8696	If Guest Additions are not installed, this value will be
8697	the same as <link to="IMachine::OSTypeId"/>.
8698	</note>
8699	</desc>
8700	</attribute>
8701
8702	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8703	<desc>
8704	Current run level of the Guest Additions.
8705	</desc>
8706	</attribute>
8707
8708	<attribute name="additionsVersion" type="wstring" readonly="yes">
8709	<desc>
8710	Version of the Guest Additions in the same format as
8711	<link to="IVirtualBox::version"/>.
8712	</desc>
8713	</attribute>
8714
8715	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8716	<desc>
8717	The internal build revision number of the additions.
8718
8719	See also <link to="IVirtualBox::revision"/>.
8720	</desc>
8721	</attribute>
8722
8723	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8724	<desc>
8725	Array of current known facilities. Only returns facilities where a status is known,
8726	e.g. facilities with an unknown status will not be returned.
8727	</desc>
8728	</attribute>
8729
8730	<attribute name="memoryBalloonSize" type="unsigned long">
8731	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8732	</attribute>
8733
8734	<attribute name="statisticsUpdateInterval" type="unsigned long">
8735	<desc>Interval to update guest statistics in seconds.</desc>
8736	</attribute>
8737
8738	<method name="internalGetStatistics">
8739	<desc>
8740	Internal method; do not use as it might change at any time.
8741	</desc>
8742	<param name="cpuUser" type="unsigned long" dir="out">
8743	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8744	</param>
8745	<param name="cpuKernel" type="unsigned long" dir="out">
8746	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8747	</param>
8748	<param name="cpuIdle" type="unsigned long" dir="out">
8749	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8750	</param>
8751	<param name="memTotal" type="unsigned long" dir="out">
8752	<desc>Total amount of physical guest RAM.</desc>
8753	</param>
8754	<param name="memFree" type="unsigned long" dir="out">
8755	<desc>Free amount of physical guest RAM.</desc>
8756	</param>
8757	<param name="memBalloon" type="unsigned long" dir="out">
8758	<desc>Amount of ballooned physical guest RAM.</desc>
8759	</param>
8760	<param name="memShared" type="unsigned long" dir="out">
8761	<desc>Amount of shared physical guest RAM.</desc>
8762	</param>
8763	<param name="memCache" type="unsigned long" dir="out">
8764	<desc>Total amount of guest (disk) cache memory.</desc>
8765	</param>
8766	<param name="pagedTotal" type="unsigned long" dir="out">
8767	<desc>Total amount of space in the page file.</desc>
8768	</param>
8769	<param name="memAllocTotal" type="unsigned long" dir="out">
8770	<desc>Total amount of memory allocated by the hypervisor.</desc>
8771	</param>
8772	<param name="memFreeTotal" type="unsigned long" dir="out">
8773	<desc>Total amount of free memory available in the hypervisor.</desc>
8774	</param>
8775	<param name="memBalloonTotal" type="unsigned long" dir="out">
8776	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8777	</param>
8778	<param name="memSharedTotal" type="unsigned long" dir="out">
8779	<desc>Total amount of shared memory in the hypervisor.</desc>
8780	</param>
8781	</method>
8782
8783	<method name="getFacilityStatus">
8784	<desc>
8785	Get the current status of a Guest Additions facility.
8786	</desc>
8787	<param name="facility" type="AdditionsFacilityType" dir="in">
8788	<desc>Facility to check status for.</desc>
8789	</param>
8790	<param name="timestamp" type="long long" dir="out">
8791	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8792	</param>
8793	<param name="status" type="AdditionsFacilityStatus" dir="return">
8794	<desc>The current (latest) facility status.</desc>
8795	</param>
8796	</method>
8797
8798	<method name="getAdditionsStatus">
8799	<desc>
8800	Retrieve the current status of a certain Guest Additions run level.
8801
8802	<result name="VBOX_E_NOT_SUPPORTED">
8803	Wrong status level specified.
8804	</result>
8805
8806	</desc>
8807	<param name="level" type="AdditionsRunLevelType" dir="in">
8808	<desc>Status level to check</desc>
8809	</param>
8810	<param name="active" type="boolean" dir="return">
8811	<desc>Flag whether the status level has been reached or not</desc>
8812	</param>
8813	</method>
8814
8815	<method name="setCredentials">
8816	<desc>
8817	Store login credentials that can be queried by guest operating
8818	systems with Additions installed. The credentials are transient
8819	to the session and the guest may also choose to erase them. Note
8820	that the caller cannot determine whether the guest operating system
8821	has queried or made use of the credentials.
8822
8823	<result name="VBOX_E_VM_ERROR">
8824	VMM device is not available.
8825	</result>
8826
8827	</desc>
8828	<param name="userName" type="wstring" dir="in">
8829	<desc>User name string, can be empty</desc>
8830	</param>
8831	<param name="password" type="wstring" dir="in">
8832	<desc>Password string, can be empty</desc>
8833	</param>
8834	<param name="domain" type="wstring" dir="in">
8835	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8836	</param>
8837	<param name="allowInteractiveLogon" type="boolean" dir="in">
8838	<desc>
8839	Flag whether the guest should alternatively allow the user to
8840	interactively specify different credentials. This flag might
8841	not be supported by all versions of the Additions.
8842	</desc>
8843	</param>
8844	</method>
8845
8846	<method name="dragHGEnter">
8847	<desc>
8848	Informs the guest about a Drag and Drop enter event.
8849
8850	This is used in Host - Guest direction.
8851
8852	<result name="VBOX_E_VM_ERROR">
8853	VMM device is not available.
8854	</result>
8855
8856	</desc>
8857	<param name="screenId" type="unsigned long" dir="in">
8858	<desc>The screen id where the Drag and Drop event occured.</desc>
8859	</param>
8860	<param name="y" type="unsigned long" dir="in">
8861	<desc>y-position of the event.</desc>
8862	</param>
8863	<param name="x" type="unsigned long" dir="in">
8864	<desc>x-position of the event.</desc>
8865	</param>
8866	<param name="defaultAction" type="DragAndDropAction" dir="in">
8867	<desc>The default action to use.</desc>
8868	</param>
8869	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8870	<desc>The actions which are allowed.</desc>
8871	</param>
8872	<param name="formats" type="wstring" dir="in" safearray="yes">
8873	<desc>The supported mime types.</desc>
8874	</param>
8875	<param name="resultAction" type="DragAndDropAction" dir="return">
8876	<desc>The resulting action of this event.</desc>
8877	</param>
8878	</method>
8879
8880	<method name="dragHGMove">
8881	<desc>
8882	Informs the guest about a Drag and Drop move event.
8883
8884	This is used in Host - Guest direction.
8885
8886	<result name="VBOX_E_VM_ERROR">
8887	VMM device is not available.
8888	</result>
8889
8890	</desc>
8891	<param name="screenId" type="unsigned long" dir="in">
8892	<desc>The screen id where the Drag and Drop event occured.</desc>
8893	</param>
8894	<param name="x" type="unsigned long" dir="in">
8895	<desc>x-position of the event.</desc>
8896	</param>
8897	<param name="y" type="unsigned long" dir="in">
8898	<desc>y-position of the event.</desc>
8899	</param>
8900	<param name="defaultAction" type="DragAndDropAction" dir="in">
8901	<desc>The default action to use.</desc>
8902	</param>
8903	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8904	<desc>The actions which are allowed.</desc>
8905	</param>
8906	<param name="formats" type="wstring" dir="in" safearray="yes">
8907	<desc>The supported mime types.</desc>
8908	</param>
8909	<param name="resultAction" type="DragAndDropAction" dir="return">
8910	<desc>The resulting action of this event.</desc>
8911	</param>
8912	</method>
8913
8914	<method name="dragHGLeave">
8915	<desc>
8916	Informs the guest about a Drag and Drop leave event.
8917
8918	This is used in Host - Guest direction.
8919
8920	<result name="VBOX_E_VM_ERROR">
8921	VMM device is not available.
8922	</result>
8923
8924	</desc>
8925	<param name="screenId" type="unsigned long" dir="in">
8926	<desc>The screen id where the Drag and Drop event occured.</desc>
8927	</param>
8928	</method>
8929
8930	<method name="dragHGDrop">
8931	<desc>
8932	Informs the guest about a drop event.
8933
8934	This is used in Host - Guest direction.
8935
8936	<result name="VBOX_E_VM_ERROR">
8937	VMM device is not available.
8938	</result>
8939
8940	</desc>
8941	<param name="screenId" type="unsigned long" dir="in">
8942	<desc>The screen id where the Drag and Drop event occured.</desc>
8943	</param>
8944	<param name="x" type="unsigned long" dir="in">
8945	<desc>x-position of the event.</desc>
8946	</param>
8947	<param name="y" type="unsigned long" dir="in">
8948	<desc>y-position of the event.</desc>
8949	</param>
8950	<param name="defaultAction" type="DragAndDropAction" dir="in">
8951	<desc>The default action to use.</desc>
8952	</param>
8953	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8954	<desc>The actions which are allowed.</desc>
8955	</param>
8956	<param name="formats" type="wstring" dir="in" safearray="yes">
8957	<desc>The supported mime types.</desc>
8958	</param>
8959	<param name="format" type="wstring" dir="out">
8960	<desc>The resulting format of this event.</desc>
8961	</param>
8962	<param name="resultAction" type="DragAndDropAction" dir="return">
8963	<desc>The resulting action of this event.</desc>
8964	</param>
8965	</method>
8966
8967	<method name="dragHGPutData">
8968	<desc>
8969	Informs the guest about a drop data event.
8970
8971	This is used in Host - Guest direction.
8972
8973	<result name="VBOX_E_VM_ERROR">
8974	VMM device is not available.
8975	</result>
8976
8977	</desc>
8978	<param name="screenId" type="unsigned long" dir="in">
8979	<desc>The screen id where the Drag and Drop event occured.</desc>
8980	</param>
8981	<param name="format" type="wstring" dir="in">
8982	<desc>The mime type the data is in.</desc>
8983	</param>
8984	<param name="data" type="octet" dir="in" safearray="yes">
8985	<desc>The actual data.</desc>
8986	</param>
8987	<param name="progress" type="IProgress" dir="return">
8988	<desc>Progress object to track the operation completion.</desc>
8989	</param>
8990	</method>
8991
8992	<method name="dragGHPending">
8993	<desc>
8994	Ask the guest if there is any Drag and Drop operation pending in the guest.
8995
8996	If no Drag and Drop operation is pending currently, Ignore is returned.
8997
8998	This is used in Guest - Host direction.
8999
9000	<result name="VBOX_E_VM_ERROR">
9001	VMM device is not available.
9002	</result>
9003
9004	</desc>
9005	<param name="screenId" type="unsigned long" dir="in">
9006	<desc>The screen id where the Drag and Drop event occured.</desc>
9007	</param>
9008	<param name="format" type="wstring" dir="out" safearray="yes">
9009	<desc>On return the supported mime types.</desc>
9010	</param>
9011	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9012	<desc>On return the actions which are allowed.</desc>
9013	</param>
9014	<param name="defaultAction" type="DragAndDropAction" dir="return">
9015	<desc>On return the default action to use.</desc>
9016	</param>
9017	</method>
9018
9019	<method name="dragGHDropped">
9020	<desc>
9021	Informs the guest that a drop event occured for a pending Drag and Drop event.
9022
9023	This is used in Guest - Host direction.
9024
9025	<result name="VBOX_E_VM_ERROR">
9026	VMM device is not available.
9027	</result>
9028
9029	</desc>
9030
9031	<param name="format" type="wstring" dir="in">
9032	<desc>The mime type the data must be in.</desc>
9033	</param>
9034	<param name="action" type="DragAndDropAction" dir="in">
9035	<desc>The action to use.</desc>
9036	</param>
9037	<param name="progress" type="IProgress" dir="return">
9038	<desc>Progress object to track the operation completion.</desc>
9039	</param>
9040	</method>
9041
9042	<method name="dragGHGetData">
9043	<desc>
9044	Fetch the data of a previously Drag and Drop event from the guest.
9045
9046	This is used in Guest - Host direction.
9047
9048	<result name="VBOX_E_VM_ERROR">
9049	VMM device is not available.
9050	</result>
9051
9052	</desc>
9053
9054	<param name="data" type="octet" safearray="yes" dir="return">
9055	<desc>The actual data.</desc>
9056	</param>
9057	</method>
9058
9059	<method name="executeProcess">
9060	<desc>
9061	Executes an existing program inside the guest VM.
9062
9063	<note>
9064	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9065	to serve up to 25 guest processes at a time. If all 25 guest processes
9066	are still active and running, starting a new guest process will result in an
9067	appropriate error message.
9068
9069	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9070	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9071	set, the guest process will not exit until all data from the specified
9072	stream(s) is/are read out.
9073
9074	To raise or lower the guest process execution limit, either the guest property
9075	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9076	command line by specifying "--control-procs-max-kept" needs to be modified.
9077	A restart of the guest OS is required afterwards. To serve unlimited guest
9078	processes, a value of "0" needs to be set (not recommended).
9079	</note>
9080
9081	<result name="VBOX_E_IPRT_ERROR">
9082	Could not execute process.
9083	</result>
9084
9085	</desc>
9086	<param name="execName" type="wstring" dir="in">
9087	<desc>
9088	Full path name of the command to execute on the guest; the
9089	commands has to exists in the guest VM in order to be executed.
9090	</desc>
9091	</param>
9092	<param name="flags" type="unsigned long" dir="in">
9093	<desc>
9094	<link to="ExecuteProcessFlag"/> flags.
9095	</desc>
9096	</param>
9097	<param name="arguments" type="wstring" safearray="yes" dir="in">
9098	<desc>
9099	Array of arguments passed to the execution command.
9100	</desc>
9101	</param>
9102	<param name="environment" type="wstring" safearray="yes" dir="in">
9103	<desc>
9104	Environment variables that can be set while the command is being
9105	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9106	variable just set its name ("NAME") without a value.
9107	</desc>
9108	</param>
9109	<param name="userName" type="wstring" dir="in">
9110	<desc>
9111	User name under which the command will be executed; has to exist
9112	and have the appropriate rights to execute programs in the VM.
9113	</desc>
9114	</param>
9115	<param name="password" type="wstring" dir="in">
9116	<desc>
9117	Password of the user account specified.
9118	</desc>
9119	</param>
9120	<param name="timeoutMS" type="unsigned long" dir="in">
9121	<desc>
9122	The maximum timeout value (in msec) to wait for finished program
9123	execution. Pass 0 for an infinite timeout.
9124	</desc>
9125	</param>
9126	<param name="pid" type="unsigned long" dir="out">
9127	<desc>
9128	The PID (process ID) of the started command for later reference.
9129	</desc>
9130	</param>
9131	<param name="progress" type="IProgress" dir="return">
9132	<desc>Progress object to track the operation completion.</desc>
9133	</param>
9134	</method>
9135
9136	<method name="getProcessOutput">
9137	<desc>
9138	Retrieves output of a formerly started and running guest process.
9139
9140	<note>
9141	Starting with VirtualBox 4.1.8 this only will return output data
9142	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9143	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9144	<link to="ExecuteProcessFlag"/> is set in the
9145	former <link to="#executeProcess"/> call for this guest process.
9146	</note>
9147
9148	<result name="VBOX_E_IPRT_ERROR">
9149	Could not retrieve output.
9150	</result>
9151
9152	</desc>
9153	<param name="pid" type="unsigned long" dir="in">
9154	<desc>
9155	Process id returned by earlier <link to="#executeProcess"/> call.
9156	</desc>
9157	</param>
9158	<param name="flags" type="unsigned long" dir="in">
9159	<desc>
9160	<link to="ProcessOutputFlag"/> flags.
9161	</desc>
9162	</param>
9163	<param name="timeoutMS" type="unsigned long" dir="in">
9164	<desc>
9165	The maximum timeout value (in msec) to wait for output
9166	data. Pass 0 for an infinite timeout.
9167	</desc>
9168	</param>
9169	<param name="size" type="long long" dir="in">
9170	<desc>
9171	Size in bytes to read in the buffer.
9172	</desc>
9173	</param>
9174	<param name="data" type="octet" safearray="yes" dir="return">
9175	<desc>
9176	Buffer for retrieving the actual output. A data size of 0 means end of file
9177	if the requested size was not 0. This is the unprocessed
9178	output data, i.e. the line ending style depends on the platform of
9179	the system the server is running on.
9180	</desc>
9181	</param>
9182	</method>
9183
9184	<method name="getProcessStatus">
9185	<desc>
9186	Retrieves status, exit code and the exit reason of a formerly started
9187	guest process. If a guest process exited or got terminated this function
9188	returns its final status and removes this process from the list of
9189	known guest processes for further retrieval.
9190
9191	<result name="VBOX_E_IPRT_ERROR">
9192	Process with specified PID was not found.
9193	</result>
9194
9195	</desc>
9196	<param name="pid" type="unsigned long" dir="in">
9197	<desc>
9198	Process id returned by earlier <link to="#executeProcess"/> call.
9199	</desc>
9200	</param>
9201	<param name="exitcode" type="unsigned long" dir="out">
9202	<desc>
9203	The exit code (if available).
9204	</desc>
9205	</param>
9206	<param name="flags" type="unsigned long" dir="out">
9207	<desc>
9208	Additional flags of process status. Not used at the moment and
9209	must be set to 0.
9210	</desc>
9211	</param>
9212	<param name="reason" type="ExecuteProcessStatus" dir="return">
9213	<desc>
9214	The current process status.
9215	</desc>
9216	</param>
9217	</method>
9218
9219	<method name="copyFromGuest">
9220	<desc>
9221	Copies files/directories from guest to the host.
9222
9223	<result name="VBOX_E_IPRT_ERROR">
9224	Error while copying.
9225	</result>
9226
9227	</desc>
9228	<param name="source" type="wstring" dir="in">
9229	<desc>
9230	Source file on the guest to copy.
9231	</desc>
9232	</param>
9233	<param name="dest" type="wstring" dir="in">
9234	<desc>
9235	Destination path on the host.
9236	</desc>
9237	</param>
9238	<param name="userName" type="wstring" dir="in">
9239	<desc>
9240	User name under which the copy command will be executed; the
9241	user has to exist and have the appropriate rights to read from
9242	the source path.
9243	</desc>
9244	</param>
9245	<param name="password" type="wstring" dir="in">
9246	<desc>
9247	Password of the user account specified.
9248	</desc>
9249	</param>
9250	<param name="flags" type="unsigned long" dir="in">
9251	<desc>
9252	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9253	</desc>
9254	</param>
9255	<param name="progress" type="IProgress" dir="return">
9256	<desc>Progress object to track the operation completion.</desc>
9257	</param>
9258	</method>
9259
9260	<method name="copyToGuest">
9261	<desc>
9262	Copies files/directories from host to the guest.
9263
9264	<result name="VBOX_E_IPRT_ERROR">
9265	Error while copying.
9266	</result>
9267
9268	</desc>
9269	<param name="source" type="wstring" dir="in">
9270	<desc>
9271	Source file on the host to copy.
9272	</desc>
9273	</param>
9274	<param name="dest" type="wstring" dir="in">
9275	<desc>
9276	Destination path on the guest.
9277	</desc>
9278	</param>
9279	<param name="userName" type="wstring" dir="in">
9280	<desc>
9281	User name under which the copy command will be executed; the
9282	user has to exist and have the appropriate rights to write to
9283	the destination path.
9284	</desc>
9285	</param>
9286	<param name="password" type="wstring" dir="in">
9287	<desc>
9288	Password of the user account specified.
9289	</desc>
9290	</param>
9291	<param name="flags" type="unsigned long" dir="in">
9292	<desc>
9293	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9294	</desc>
9295	</param>
9296	<param name="progress" type="IProgress" dir="return">
9297	<desc>Progress object to track the operation completion.</desc>
9298	</param>
9299	</method>
9300
9301	<method name="directoryClose">
9302	<desc>
9303	Closes a formerly opened guest directory.
9304
9305	<result name="VBOX_E_IPRT_ERROR">
9306	Error while closing directory.
9307	</result>
9308
9309	</desc>
9310	<param name="handle" type="unsigned long" dir="in">
9311	<desc>
9312	Handle of opened directory to close.
9313	</desc>
9314	</param>
9315	</method>
9316
9317	<method name="directoryCreate">
9318	<desc>
9319	Creates a directory on the guest.
9320
9321	<result name="VBOX_E_IPRT_ERROR">
9322	Error while creating directory.
9323	</result>
9324
9325	</desc>
9326	<param name="directory" type="wstring" dir="in">
9327	<desc>
9328	Directory to create.
9329	</desc>
9330	</param>
9331	<param name="userName" type="wstring" dir="in">
9332	<desc>
9333	User name under which the directory creation will be executed; the
9334	user has to exist and have the appropriate rights to create the
9335	desired directory.
9336	</desc>
9337	</param>
9338	<param name="password" type="wstring" dir="in">
9339	<desc>
9340	Password of the user account specified.
9341	</desc>
9342	</param>
9343	<param name="mode" type="unsigned long" dir="in">
9344	<desc>
9345	File mode.
9346	</desc>
9347	</param>
9348	<param name="flags" type="unsigned long" dir="in">
9349	<desc>
9350	<link to="DirectoryCreateFlag"/> flags.
9351	</desc>
9352	</param>
9353	</method>
9354
9355	<method name="directoryOpen">
9356	<desc>
9357	Opens a directory on the guest.
9358
9359	<result name="VBOX_E_IPRT_ERROR">
9360	Error while opening / reading directory.
9361	</result>
9362
9363	</desc>
9364	<param name="directory" type="wstring" dir="in">
9365	<desc>
9366	Directory to read.
9367	</desc>
9368	</param>
9369	<param name="filter" type="wstring" dir="in">
9370	<desc>
9371	Directory filter (DOS style wildcards). Set to empty
9372	string if no filter required.
9373	</desc>
9374	</param>
9375	<param name="flags" type="unsigned long" dir="in">
9376	<desc>
9377	<link to="DirectoryOpenFlag"/> flags.
9378	</desc>
9379	</param>
9380	<param name="userName" type="wstring" dir="in">
9381	<desc>
9382	User name under which the directory reading will be performed; the
9383	user has to exist and have the appropriate rights to access / read the
9384	desired directory.
9385	</desc>
9386	</param>
9387	<param name="password" type="wstring" dir="in">
9388	<desc>
9389	Password of the user account specified.
9390	</desc>
9391	</param>
9392	<param name="handle" type="unsigned long" dir="return">
9393	<desc>
9394	Handle of opened directory returned by openDirectory.
9395	</desc>
9396	</param>
9397	</method>
9398
9399	<method name="directoryRead">
9400	<desc>
9401	Reads the next directory entry of an opened guest directory.
9402
9403	<result name="E_ABORT">
9404	When the end of the directory has been reached.
9405	</result>
9406
9407	<result name="VBOX_E_IPRT_ERROR">
9408	Error while opening / reading directory.
9409	</result>
9410
9411	</desc>
9412	<param name="handle" type="unsigned long" dir="in">
9413	<desc>
9414	Handle of opened directory returned by openDirectory.
9415	</desc>
9416	</param>
9417	<param name="entry" type="IGuestDirEntry" dir="return">
9418	<desc>
9419	Information about next directory entry on success.
9420	</desc>
9421	</param>
9422	</method>
9423
9424	<method name="fileExists">
9425	<desc>
9426	Checks if the specified file name exists and is a regular file.
9427
9428	If the file name ends with a slash or backslash, the function assumes
9429	it's a directory and will check if the specified directory exists and
9430	is a regular directory.
9431
9432	<result name="VBOX_E_IPRT_ERROR">
9433	Error while looking up information.
9434	</result>
9435
9436	</desc>
9437	<param name="file" type="wstring" dir="in">
9438	<desc>
9439	Full path of file to check.
9440	</desc>
9441	</param>
9442	<param name="userName" type="wstring" dir="in">
9443	<desc>
9444	User name under which the lookup will be performed; the
9445	user has to exist and have the appropriate rights to access / read the
9446	desired directory.
9447	</desc>
9448	</param>
9449	<param name="password" type="wstring" dir="in">
9450	<desc>
9451	Password of the user account specified.
9452	</desc>
9453	</param>
9454	<param name="exists" type="boolean" dir="return">
9455	<desc>
9456	True if it's a regular file, false if it isn't (or doesn't exist).
9457	</desc>
9458	</param>
9459	</method>
9460
9461	<method name="fileQuerySize">
9462	<desc>
9463	Queries the size of a file, given the path to it.
9464
9465	<result name="VBOX_E_IPRT_ERROR">
9466	Error while looking up information.
9467	</result>
9468
9469	</desc>
9470	<param name="file" type="wstring" dir="in">
9471	<desc>
9472	Full path of file to query file size for.
9473	</desc>
9474	</param>
9475	<param name="userName" type="wstring" dir="in">
9476	<desc>
9477	User name under which the lookup will be performed; the
9478	user has to exist and have the appropriate rights to access / read the
9479	desired directory.
9480	</desc>
9481	</param>
9482	<param name="password" type="wstring" dir="in">
9483	<desc>
9484	Password of the user account specified.
9485	</desc>
9486	</param>
9487	<param name="size" type="long long" dir="return">
9488	<desc>
9489	Size (in bytes) of file specified.
9490	</desc>
9491	</param>
9492	</method>
9493
9494	<method name="setProcessInput">
9495	<desc>
9496	Sends input into a formerly started process.
9497
9498	<result name="VBOX_E_IPRT_ERROR">
9499	Could not send input.
9500	</result>
9501
9502	</desc>
9503	<param name="pid" type="unsigned long" dir="in">
9504	<desc>
9505	Process id returned by earlier <link to="#executeProcess"/> call.
9506	</desc>
9507	</param>
9508	<param name="flags" type="unsigned long" dir="in">
9509	<desc>
9510	<link to="ProcessInputFlag"/> flags.
9511	</desc>
9512	</param>
9513	<param name="timeoutMS" type="unsigned long" dir="in">
9514	<desc>
9515	The maximum timeout value (in msec) to wait for getting the
9516	data transfered to the guest. Pass 0 for an infinite timeout.
9517	</desc>
9518	</param>
9519	<param name="data" type="octet" dir="in" safearray="yes">
9520	<desc>
9521	Buffer of input data to send to the started process to.
9522	</desc>
9523	</param>
9524	<param name="written" type="unsigned long" dir="return">
9525	<desc>
9526	Number of bytes written.
9527	</desc>
9528	</param>
9529	</method>
9530
9531	<method name="updateGuestAdditions">
9532	<desc>
9533	Updates already installed Guest Additions in a VM
9534	(Windows guests only).
9535
9536	<result name="VBOX_E_IPRT_ERROR">
9537	Error while updating.
9538	</result>
9539
9540	</desc>
9541	<param name="source" type="wstring" dir="in">
9542	<desc>
9543	Path to the Guest Additions .ISO file to use for the upate.
9544	</desc>
9545	</param>
9546	<param name="flags" type="unsigned long" dir="in">
9547	<desc>
9548	<link to="AdditionsUpdateFlag"/> flags.
9549	</desc>
9550	</param>
9551	<param name="progress" type="IProgress" dir="return">
9552	<desc>Progress object to track the operation completion.</desc>
9553	</param>
9554	</method>
9555
9556	</interface>
9557
9558
9559	<!--
9560	// IProgress
9561	/////////////////////////////////////////////////////////////////////////
9562	-->
9563
9564	<interface
9565	name="IProgress" extends="$unknown"
9566	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9567	wsmap="managed"
9568	>
9569	<desc>
9570	The IProgress interface is used to track and control
9571	asynchronous tasks within VirtualBox.
9572
9573	An instance of this is returned every time VirtualBox starts
9574	an asynchronous task (in other words, a separate thread) which
9575	continues to run after a method call returns. For example,
9576	<link to="IConsole::saveState" />, which saves the state of
9577	a running virtual machine, can take a long time to complete.
9578	To be able to display a progress bar, a user interface such as
9579	the VirtualBox graphical user interface can use the IProgress
9580	object returned by that method.
9581
9582	Note that IProgress is a "read-only" interface in the sense
9583	that only the VirtualBox internals behind the Main API can
9584	create and manipulate progress objects, whereas client code
9585	can only use the IProgress object to monitor a task's
9586	progress and, if <link to="#cancelable" /> is @c true,
9587	cancel the task by calling <link to="#cancel" />.
9588
9589	A task represented by IProgress consists of either one or
9590	several sub-operations that run sequentially, one by one (see
9591	<link to="#operation" /> and <link to="#operationCount" />).
9592	Every operation is identified by a number (starting from 0)
9593	and has a separate description.
9594
9595	You can find the individual percentage of completion of the current
9596	operation in <link to="#operationPercent" /> and the
9597	percentage of completion of the task as a whole
9598	in <link to="#percent" />.
9599
9600	Similarly, you can wait for the completion of a particular
9601	operation via <link to="#waitForOperationCompletion" /> or
9602	for the completion of the whole task via
9603	<link to="#waitForCompletion" />.
9604	</desc>
9605
9606	<attribute name="id" type="uuid" mod="string" readonly="yes">
9607	<desc>ID of the task.</desc>
9608	</attribute>
9609
9610	<attribute name="description" type="wstring" readonly="yes">
9611	<desc>Description of the task.</desc>
9612	</attribute>
9613
9614	<attribute name="initiator" type="$unknown" readonly="yes">
9615	<desc>Initiator of the task.</desc>
9616	</attribute>
9617
9618	<attribute name="cancelable" type="boolean" readonly="yes">
9619	<desc>Whether the task can be interrupted.</desc>
9620	</attribute>
9621
9622	<attribute name="percent" type="unsigned long" readonly="yes">
9623	<desc>
9624	Current progress value of the task as a whole, in percent.
9625	This value depends on how many operations are already complete.
9626	Returns 100 if <link to="#completed" /> is @c true.
9627	</desc>
9628	</attribute>
9629
9630	<attribute name="timeRemaining" type="long" readonly="yes">
9631	<desc>
9632	Estimated remaining time until the task completes, in
9633	seconds. Returns 0 once the task has completed; returns -1
9634	if the remaining time cannot be computed, in particular if
9635	the current progress is 0.
9636
9637	Even if a value is returned, the estimate will be unreliable
9638	for low progress values. It will become more reliable as the
9639	task progresses; it is not recommended to display an ETA
9640	before at least 20% of a task have completed.
9641	</desc>
9642	</attribute>
9643
9644	<attribute name="completed" type="boolean" readonly="yes">
9645	<desc>Whether the task has been completed.</desc>
9646	</attribute>
9647
9648	<attribute name="canceled" type="boolean" readonly="yes">
9649	<desc>Whether the task has been canceled.</desc>
9650	</attribute>
9651
9652	<attribute name="resultCode" type="long" readonly="yes">
9653	<desc>
9654	Result code of the progress task.
9655	Valid only if <link to="#completed"/> is @c true.
9656	</desc>
9657	</attribute>
9658
9659	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9660	<desc>
9661	Extended information about the unsuccessful result of the
9662	progress operation. May be @c null if no extended information
9663	is available.
9664	Valid only if <link to="#completed"/> is @c true and
9665	<link to="#resultCode"/> indicates a failure.
9666	</desc>
9667	</attribute>
9668
9669	<attribute name="operationCount" type="unsigned long" readonly="yes">
9670	<desc>
9671	Number of sub-operations this task is divided into.
9672	Every task consists of at least one suboperation.
9673	</desc>
9674	</attribute>
9675
9676	<attribute name="operation" type="unsigned long" readonly="yes">
9677	<desc>Number of the sub-operation being currently executed.</desc>
9678	</attribute>
9679
9680	<attribute name="operationDescription" type="wstring" readonly="yes">
9681	<desc>
9682	Description of the sub-operation being currently executed.
9683	</desc>
9684	</attribute>
9685
9686	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9687	<desc>Progress value of the current sub-operation only, in percent.</desc>
9688	</attribute>
9689
9690	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9691	<desc>Weight value of the current sub-operation only.</desc>
9692	</attribute>
9693
9694	<attribute name="timeout" type="unsigned long">
9695	<desc>
9696	When non-zero, this specifies the number of milliseconds after which
9697	the operation will automatically be canceled. This can only be set on
9698	cancelable objects.
9699	</desc>
9700	</attribute>
9701
9702	<method name="setCurrentOperationProgress">
9703	<desc>Internal method, not to be called externally.</desc>
9704	<param name="percent" type="unsigned long" dir="in" />
9705	</method>
9706	<method name="setNextOperation">
9707	<desc>Internal method, not to be called externally.</desc>
9708	<param name="nextOperationDescription" type="wstring" dir="in" />
9709	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9710	</method>
9711
9712	<method name="waitForCompletion">
9713	<desc>
9714	Waits until the task is done (including all sub-operations)
9715	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9716
9717	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9718	thread are not processed while waiting. Neglecting event queues may
9719	have dire consequences (degrade performance, resource hogs,
9720	deadlocks, etc.), this is specially so for the main thread on
9721	platforms using XPCOM. Callers are adviced wait for short periods
9722	and service their event queues between calls, or to create a worker
9723	thread to do the waiting.
9724
9725	<result name="VBOX_E_IPRT_ERROR">
9726	Failed to wait for task completion.
9727	</result>
9728	</desc>
9729
9730	<param name="timeout" type="long" dir="in">
9731	<desc>
9732	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9733	</desc>
9734	</param>
9735	</method>
9736
9737	<method name="waitForOperationCompletion">
9738	<desc>
9739	Waits until the given operation is done with a given timeout in
9740	milliseconds; specify -1 for an indefinite wait.
9741
9742	See <link to="#waitForCompletion"> for event queue considerations.</link>
9743
9744	<result name="VBOX_E_IPRT_ERROR">
9745	Failed to wait for operation completion.
9746	</result>
9747
9748	</desc>
9749	<param name="operation" type="unsigned long" dir="in">
9750	<desc>
9751	Number of the operation to wait for.
9752	Must be less than <link to="#operationCount"/>.
9753	</desc>
9754	</param>
9755	<param name="timeout" type="long" dir="in">
9756	<desc>
9757	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9758	</desc>
9759	</param>
9760	</method>
9761
9762	<method name="waitForAsyncProgressCompletion">
9763	<desc>
9764	Waits until the other task is completed (including all
9765	sub-operations) and forward all changes from the other progress to
9766	this progress. This means sub-operation number, description, percent
9767	and so on.
9768
9769	You have to take care on setting up at least the same count on
9770	sub-operations in this progress object like there are in the other
9771	progress object.
9772
9773	If the other progress object supports cancel and this object gets any
9774	cancel request (when here enabled as well), it will be forwarded to
9775	the other progress object.
9776
9777	If there is an error in the other progress, this error isn't
9778	automatically transfered to this progress object. So you have to
9779	check any operation error within the other progress object, after
9780	this method returns.
9781	</desc>
9782
9783	<param name="pProgressAsync" type="IProgress" dir="in">
9784	<desc>
9785	The progress object of the asynchrony process.
9786	</desc>
9787	</param>
9788	</method>
9789
9790	<method name="cancel">
9791	<desc>
9792	Cancels the task.
9793	<note>
9794	If <link to="#cancelable"/> is @c false, then this method will fail.
9795	</note>
9796
9797	<result name="VBOX_E_INVALID_OBJECT_STATE">
9798	Operation cannot be canceled.
9799	</result>
9800
9801	</desc>
9802	</method>
9803
9804	</interface>
9805
9806	<!--
9807	// ISnapshot
9808	/////////////////////////////////////////////////////////////////////////
9809	-->
9810
9811	<interface
9812	name="ISnapshot" extends="$unknown"
9813	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9814	wsmap="managed"
9815	>
9816	<desc>
9817	The ISnapshot interface represents a snapshot of the virtual
9818	machine.
9819
9820	Together with the differencing media that are created
9821	when a snapshot is taken, a machine can be brought back to
9822	the exact state it was in when the snapshot was taken.
9823
9824	The ISnapshot interface has no methods, only attributes; snapshots
9825	are controlled through methods of the <link to="IConsole" /> interface
9826	which also manage the media associated with the snapshot.
9827	The following operations exist:
9828
9829	<ul>
9830	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9831	by creating new, empty differencing images for the machine's
9832	media and saving the VM settings and (if the VM is running)
9833	the current VM state in the snapshot.
9834
9835	The differencing images will then receive all data written to
9836	the machine's media, while their parent (base) images
9837	remain unmodified after the snapshot has been taken (see
9838	<link to="IMedium" /> for details about differencing images).
9839	This simplifies restoring a machine to the state of a snapshot:
9840	only the differencing images need to be deleted.
9841
9842	The current machine state is not changed by taking a snapshot
9843	except that <link to="IMachine::currentSnapshot" /> is set to
9844	the newly created snapshot, which is also added to the machine's
9845	snapshots tree.
9846	</li>
9847
9848	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9849	the state of a previous snapshot by deleting the differencing
9850	image of each of the machine's media and setting the machine's
9851	settings and state to the state that was saved in the snapshot (if any).
9852
9853	This destroys the machine's current state. After calling this,
9854	<link to="IMachine::currentSnapshot" /> points to the snapshot
9855	that was restored.
9856	</li>
9857
9858	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9859	without affecting the current machine state.
9860
9861	This does not change the current machine state, but instead frees the
9862	resources allocated when the snapshot was taken: the settings and machine
9863	state file are deleted (if any), and the snapshot's differencing image for
9864	each of the machine's media gets merged with its parent image.
9865
9866	Neither the current machine state nor other snapshots are affected
9867	by this operation, except that parent media will be modified
9868	to contain the disk data associated with the snapshot being deleted.
9869
9870	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9871	attribute is set to the current snapshot's parent or NULL if it
9872	has no parent. Otherwise the attribute is unchanged.
9873	</li>
9874	</ul>
9875
9876	Each snapshot contains a copy of virtual machine's settings (hardware
9877	configuration etc.). This copy is contained in an immutable (read-only)
9878	instance of <link to="IMachine" /> which is available from the snapshot's
9879	<link to="#machine" /> attribute. When restoring the snapshot, these
9880	settings are copied back to the original machine.
9881
9882	In addition, if the machine was running when the
9883	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9884	the current VM state is saved in the snapshot (similarly to what happens
9885	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9886	because when restoring it, the VM will be running.
9887
9888	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9889	the snapshot receives a copy of the execution state file
9890	(<link to="IMachine::stateFilePath"/>).
9891
9892	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9893	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9894	it then contains a so-called "zero execution state", representing a
9895	machine that is powered off.
9896	</desc>
9897
9898	<attribute name="id" type="uuid" mod="string" readonly="yes">
9899	<desc>UUID of the snapshot.</desc>
9900	</attribute>
9901
9902	<attribute name="name" type="wstring">
9903	<desc>Short name of the snapshot.
9904	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9905	be called implicitly.</note>
9906	</desc>
9907	</attribute>
9908
9909	<attribute name="description" type="wstring">
9910	<desc>Optional description of the snapshot.
9911	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
9912	be called implicitly.</note>
9913	</desc>
9914	</attribute>
9915
9916	<attribute name="timeStamp" type="long long" readonly="yes">
9917	<desc>
9918	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
9919	</desc>
9920	</attribute>
9921
9922	<attribute name="online" type="boolean" readonly="yes">
9923	<desc>
9924	@c true if this snapshot is an online snapshot and @c false otherwise.
9925
9926	When this attribute is @c true, the
9927	<link to="IMachine::stateFilePath"/> attribute of the
9928	<link to="#machine"/> object associated with this snapshot
9929	will point to the saved state file. Otherwise, it will be
9930	an empty string.
9931	</desc>
9932	</attribute>
9933
9934	<attribute name="machine" type="IMachine" readonly="yes">
9935	<desc>
9936	Virtual machine this snapshot is taken on. This object
9937	stores all settings the machine had when taking this snapshot.
9938	<note>
9939	The returned machine object is immutable, i.e. no
9940	any settings can be changed.
9941	</note>
9942	</desc>
9943	</attribute>
9944
9945	<attribute name="parent" type="ISnapshot" readonly="yes">
9946	<desc>
9947	Parent snapshot (a snapshot this one is based on), or
9948	@c null if the snapshot has no parent (i.e. is the first snapshot).
9949	</desc>
9950	</attribute>
9951
9952	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
9953	<desc>
9954	Child snapshots (all snapshots having this one as a parent).
9955	By inspecting this attribute starting with a machine's root snapshot
9956	(which can be obtained by calling <link to="IMachine::findSnapshot" />
9957	with a @c null UUID), a machine's snapshots tree can be iterated over.
9958	</desc>
9959	</attribute>
9960
9961	<method name="getChildrenCount" const="yes">
9962	<desc>
9963	Returns the number of direct childrens of this snapshot.
9964	</desc>
9965	<param name="childrenCount" type="unsigned long" dir="return">
9966	<desc>
9967	</desc>
9968	</param>
9969	</method>
9970
9971	</interface>
9972
9973
9974	<!--
9975	// IMedium
9976	/////////////////////////////////////////////////////////////////////////
9977	-->
9978
9979	<enum
9980	name="MediumState"
9981	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
9982	>
9983	<desc>
9984	Virtual medium state.
9985	<see><link to="IMedium"/></see>
9986	</desc>
9987
9988	<const name="NotCreated" value="0">
9989	<desc>
9990	Associated medium storage does not exist (either was not created yet or
9991	was deleted).
9992	</desc>
9993	</const>
9994	<const name="Created" value="1">
9995	<desc>
9996	Associated storage exists and accessible; this gets set if the
9997	accessibility check performed by <link to="IMedium::refreshState" />
9998	was successful.
9999	</desc>
10000	</const>
10001	<const name="LockedRead" value="2">
10002	<desc>
10003	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10004	no data modification is possible.
10005	</desc>
10006	</const>
10007	<const name="LockedWrite" value="3">
10008	<desc>
10009	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10010	no concurrent data reading or modification is possible.
10011	</desc>
10012	</const>
10013	<const name="Inaccessible" value="4">
10014	<desc>
10015	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10016	not yet been performed, or else, associated medium storage is not
10017	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10018	is empty, in the second case, it describes the error that occurred.
10019	</desc>
10020	</const>
10021	<const name="Creating" value="5">
10022	<desc>
10023	Associated medium storage is being created.
10024	</desc>
10025	</const>
10026	<const name="Deleting" value="6">
10027	<desc>
10028	Associated medium storage is being deleted.
10029	</desc>
10030	</const>
10031	</enum>
10032
10033	<enum
10034	name="MediumType"
10035	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10036	>
10037	<desc>
10038	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10039	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10040	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10041	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10042	</desc>
10043
10044	<const name="Normal" value="0">
10045	<desc>
10046	Normal medium (attached directly or indirectly, preserved
10047	when taking snapshots).
10048	</desc>
10049	</const>
10050	<const name="Immutable" value="1">
10051	<desc>
10052	Immutable medium (attached indirectly, changes are wiped out
10053	the next time the virtual machine is started).
10054	</desc>
10055	</const>
10056	<const name="Writethrough" value="2">
10057	<desc>
10058	Write through medium (attached directly, ignored when
10059	taking snapshots).
10060	</desc>
10061	</const>
10062	<const name="Shareable" value="3">
10063	<desc>
10064	Allow using this medium concurrently by several machines.
10065	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10066	</desc>
10067	</const>
10068	<const name="Readonly" value="4">
10069	<desc>
10070	A readonly medium, which can of course be used by several machines.
10071	<note>Present and accepted since VirtualBox 4.0.</note>
10072	</desc>
10073	</const>
10074	<const name="MultiAttach" value="5">
10075	<desc>
10076	A medium which is is indirectly attached, so that one base medium can
10077	be used for several VMs which have their own differencing medium to
10078	store their modifications. In some sense a variant of Immutable
10079	with unset AutoReset flag in each differencing medium.
10080	<note>Present and accepted since VirtualBox 4.0.</note>
10081	</desc>
10082	</const>
10083	</enum>
10084
10085	<enum
10086	name="MediumVariant"
10087	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10088	>
10089	<desc>
10090	Virtual medium image variant. More than one flag may be set.
10091	<see><link to="IMedium"/></see>
10092	</desc>
10093
10094	<const name="Standard" value="0">
10095	<desc>
10096	No particular variant requested, results in using the backend default.
10097	</desc>
10098	</const>
10099	<const name="VmdkSplit2G" value="0x01">
10100	<desc>
10101	VMDK image split in chunks of less than 2GByte.
10102	</desc>
10103	</const>
10104	<const name="VmdkStreamOptimized" value="0x04">
10105	<desc>
10106	VMDK streamOptimized image. Special import/export format which is
10107	read-only/append-only.
10108	</desc>
10109	</const>
10110	<const name="VmdkESX" value="0x08">
10111	<desc>
10112	VMDK format variant used on ESX products.
10113	</desc>
10114	</const>
10115	<const name="Fixed" value="0x10000">
10116	<desc>
10117	Fixed image. Only allowed for base images.
10118	</desc>
10119	</const>
10120	<const name="Diff" value="0x20000">
10121	<desc>
10122	Differencing image. Only allowed for child images.
10123	</desc>
10124	</const>
10125	<const name="NoCreateDir" value="0x40000000">
10126	<desc>
10127	Special flag which suppresses automatic creation of the subdirectory.
10128	Only used when passing the medium variant as an input parameter.
10129	</desc>
10130	</const>
10131	</enum>
10132
10133	<interface
10134	name="IMediumAttachment" extends="$unknown"
10135	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10136	wsmap="struct"
10137	>
10138	<desc>
10139	The IMediumAttachment interface links storage media to virtual machines.
10140	For each medium (<link to="IMedium"/>) which has been attached to a
10141	storage controller (<link to="IStorageController"/>) of a machine
10142	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10143	method, one instance of IMediumAttachment is added to the machine's
10144	<link to="IMachine::mediumAttachments"/> array attribute.
10145
10146	Each medium attachment specifies the storage controller as well as a
10147	port and device number and the IMedium instance representing a virtual
10148	hard disk or floppy or DVD image.
10149
10150	For removable media (DVDs or floppies), there are two additional
10151	options. For one, the IMedium instance can be @c null to represent
10152	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10153	secondly, the medium can be one of the pseudo-media for host drives
10154	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10155
10156	<h3>Attaching Hard Disks</h3>
10157
10158	Hard disks are attached to virtual machines using the
10159	<link to="IMachine::attachDevice"/> method and detached using the
10160	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10161	type (see <link to="IMedium::type" />), hard disks are attached either
10162	<i>directly</i> or <i>indirectly</i>.
10163
10164	When a hard disk is being attached directly, it is associated with the
10165	virtual machine and used for hard disk operations when the machine is
10166	running. When a hard disk is being attached indirectly, a new differencing
10167	hard disk linked to it is implicitly created and this differencing hard
10168	disk is associated with the machine and used for hard disk operations.
10169	This also means that if <link to="IMachine::attachDevice"/> performs
10170	a direct attachment then the same hard disk will be returned in response
10171	to the subsequent <link to="IMachine::getMedium"/> call; however if
10172	an indirect attachment is performed then
10173	<link to="IMachine::getMedium"/> will return the implicitly created
10174	differencing hard disk, not the original one passed to <link
10175	to="IMachine::attachDevice"/>. In detail:
10176
10177	<ul>
10178	<li><b>Normal base</b> hard disks that do not have children (i.e.
10179	differencing hard disks linked to them) and that are not already
10180	attached to virtual machines in snapshots are attached <b>directly</b>.
10181	Otherwise, they are attached <b>indirectly</b> because having
10182	dependent children or being part of the snapshot makes it impossible
10183	to modify hard disk contents without breaking the integrity of the
10184	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10185	quickly determine the kind of the attachment for the given hard
10186	disk. Note that if a normal base hard disk is to be indirectly
10187	attached to a virtual machine with snapshots then a special
10188	procedure called <i>smart attachment</i> is performed (see below).</li>
10189	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10190	they are attached <b>directly</b> if they do not have children and are
10191	not attached to virtual machines in snapshots, and <b>indirectly</b>
10192	otherwise. Note that the smart attachment procedure is never performed
10193	for differencing hard disks.</li>
10194	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10195	they are designed to be non-writable. If an immutable hard disk is
10196	attached to a virtual machine with snapshots then a special
10197	procedure called smart attachment is performed (see below).</li>
10198	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10199	also as designed. This also means that writethrough hard disks cannot
10200	have other hard disks linked to them at all.</li>
10201	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10202	also as designed. This also means that shareable hard disks cannot
10203	have other hard disks linked to them at all. They behave almost
10204	like writethrough hard disks, except that shareable hard disks can
10205	be attached to several virtual machines which are running, allowing
10206	concurrent accesses. You need special cluster software running in
10207	the virtual machines to make use of such disks.</li>
10208	</ul>
10209
10210	Note that the same hard disk, regardless of its type, may be attached to
10211	more than one virtual machine at a time. In this case, the machine that is
10212	started first gains exclusive access to the hard disk and attempts to
10213	start other machines having this hard disk attached will fail until the
10214	first machine is powered down.
10215
10216	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10217	that the given hard disk remains associated with the given machine after a
10218	successful <link to="IMachine::detachDevice"/> call until
10219	<link to="IMachine::saveSettings"/> is called to save all changes to
10220	machine settings to disk. This deferring is necessary to guarantee that
10221	the hard disk configuration may be restored at any time by a call to
10222	<link to="IMachine::discardSettings"/> before the settings
10223	are saved (committed).
10224
10225	Note that if <link to="IMachine::discardSettings"/> is called after
10226	indirectly attaching some hard disks to the machine but before a call to
10227	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10228	all differencing hard disks implicitly created by
10229	<link to="IMachine::attachDevice"/> for these indirect attachments.
10230	Such implicitly created hard disks will also be immediately deleted when
10231	detached explicitly using the <link to="IMachine::detachDevice"/>
10232	call if it is made before <link to="IMachine::saveSettings"/>. This
10233	implicit deletion is safe because newly created differencing hard
10234	disks do not contain any user data.
10235
10236	However, keep in mind that detaching differencing hard disks that were
10237	implicitly created by <link to="IMachine::attachDevice"/>
10238	before the last <link to="IMachine::saveSettings"/> call will
10239	<b>not</b> implicitly delete them as they may already contain some data
10240	(for example, as a result of virtual machine execution). If these hard
10241	disks are no more necessary, the caller can always delete them explicitly
10242	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10243	from this machine by the <link to="IMachine::saveSettings"/> call.
10244
10245	<h3>Smart Attachment</h3>
10246
10247	When normal base or immutable hard disks are indirectly attached to a
10248	virtual machine then some additional steps are performed to make sure the
10249	virtual machine will have the most recent "view" of the hard disk being
10250	attached. These steps include walking through the machine's snapshots
10251	starting from the current one and going through ancestors up to the first
10252	snapshot. Hard disks attached to the virtual machine in all
10253	of the encountered snapshots are checked whether they are descendants of
10254	the given normal base or immutable hard disk. The first found child (which
10255	is the differencing hard disk) will be used instead of the normal base or
10256	immutable hard disk as a parent for creating a new differencing hard disk
10257	that will be actually attached to the machine. And only if no descendants
10258	are found or if the virtual machine does not have any snapshots then the
10259	normal base or immutable hard disk will be used itself as a parent for
10260	this differencing hard disk.
10261
10262	It is easier to explain what smart attachment does using the
10263	following example:
10264	<pre>
10265	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10266
10267	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10268	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10269	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10270	Snapshot 4 (none) Snapshot 4 (none)
10271	CurState (none) CurState (D3->D2.vdi)
10272
10273	NOT
10274	...
10275	CurState (D3->B.vdi)
10276	</pre>
10277	The first column is the virtual machine configuration before the base hard
10278	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10279	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10280	mean that the hard disk that is actually attached to the machine is a
10281	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10282	another hard disk, <tt>B.vdi</tt>.
10283
10284	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10285	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10286	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10287	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10288	it cannot be attached directly and needs an indirect attachment (i.e.
10289	implicit creation of a new differencing hard disk). Due to the smart
10290	attachment procedure, the new differencing hard disk
10291	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10292	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10293	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10294	machine.
10295
10296	Note that if there is more than one descendant hard disk of the given base
10297	hard disk found in a snapshot, and there is an exact device, channel and
10298	bus match, then this exact match will be used. Otherwise, the youngest
10299	descendant will be picked up.
10300
10301	There is one more important aspect of the smart attachment procedure which
10302	is not related to snapshots at all. Before walking through the snapshots
10303	as described above, the backup copy of the current list of hard disk
10304	attachment is searched for descendants. This backup copy is created when
10305	the hard disk configuration is changed for the first time after the last
10306	<link to="IMachine::saveSettings"/> call and used by
10307	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10308	changes. When such a descendant is found in this backup copy, it will be
10309	simply re-attached back, without creating a new differencing hard disk for
10310	it. This optimization is necessary to make it possible to re-attach the
10311	base or immutable hard disk to a different bus, channel or device slot
10312	without losing the contents of the differencing hard disk actually
10313	attached to the machine in place of it.
10314
10315	</desc>
10316
10317	<attribute name="medium" type="IMedium" readonly="yes">
10318	<desc>Medium object associated with this attachment; it
10319	can be @c null for removable devices.</desc>
10320	</attribute>
10321
10322	<attribute name="controller" type="wstring" readonly="yes">
10323	<desc>Name of the storage controller of this attachment; this
10324	refers to one of the controllers in <link to="IMachine::storageControllers" />
10325	by name.</desc>
10326	</attribute>
10327
10328	<attribute name="port" type="long" readonly="yes">
10329	<desc>Port number of this attachment.
10330	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10331	</desc>
10332	</attribute>
10333
10334	<attribute name="device" type="long" readonly="yes">
10335	<desc>Device slot number of this attachment.
10336	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10337	</desc>
10338	</attribute>
10339
10340	<attribute name="type" type="DeviceType" readonly="yes">
10341	<desc>Device type of this attachment.</desc>
10342	</attribute>
10343
10344	<attribute name="passthrough" type="boolean" readonly="yes">
10345	<desc>Pass I/O requests through to a device on the host.</desc>
10346	</attribute>
10347
10348	<attribute name="temporaryEject" type="boolean" readonly="yes">
10349	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10350	</attribute>
10351
10352	<attribute name="isEjected" type="boolean" readonly="yes">
10353	<desc>Signals that the removable medium has been ejected. This is not
10354	necessarily equivalent to having a @c null medium association.</desc>
10355	</attribute>
10356
10357	<attribute name="nonRotational" type="boolean" readonly="yes">
10358	<desc>Whether the associated medium is non-rotational.</desc>
10359	</attribute>
10360
10361	<attribute name="discard" type="boolean" readonly="yes">
10362	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10363	</attribute>
10364
10365	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10366	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10367	</attribute>
10368
10369	</interface>
10370
10371	<interface
10372	name="IMedium" extends="$unknown"
10373	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10374	wsmap="managed"
10375	>
10376	<desc>
10377	The IMedium interface represents virtual storage for a machine's
10378	hard disks, CD/DVD or floppy drives. It will typically represent
10379	a disk image on the host, for example a VDI or VMDK file representing
10380	a virtual hard disk, or an ISO or RAW file representing virtual
10381	removable media, but can also point to a network location (e.g.
10382	for iSCSI targets).
10383
10384	Instances of IMedium are connected to virtual machines by way of medium
10385	attachments, which link the storage medium to a particular device slot
10386	of a storage controller of the virtual machine.
10387	In the VirtualBox API, virtual storage is therefore always represented
10388	by the following chain of object links:
10389
10390	<ul>
10391	<li><link to="IMachine::storageControllers"/> contains an array of
10392	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10393	these are instances of <link to="IStorageController"/>).</li>
10394	<li><link to="IMachine::mediumAttachments"/> contains an array of
10395	medium attachments (instances of <link to="IMediumAttachment"/>
10396	created by <link to="IMachine::attachDevice" />),
10397	each containing a storage controller from the above array, a
10398	port/device specification, and an instance of IMedium representing
10399	the medium storage (image file).
10400
10401	For removable media, the storage medium is optional; a medium
10402	attachment with no medium represents a CD/DVD or floppy drive
10403	with no medium inserted. By contrast, hard disk attachments
10404	will always have an IMedium object attached.</li>
10405	<li>Each IMedium in turn points to a storage unit (such as a file
10406	on the host computer or a network resource) that holds actual
10407	data. This location is represented by the <link to="#location"/>
10408	attribute.</li>
10409	</ul>
10410
10411	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10412	new hard disk media can be created with the VirtualBox API using the
10413	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10414	disks (see below) are usually implicitly created by VirtualBox as
10415	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10416	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10417	should be created with external tools and then opened from within VirtualBox.
10418
10419	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10420	drive. In that case the <link to="#id" /> attribute contains the UUID of
10421	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10422
10423	<h3>Media registries</h3>
10424
10425	When a medium has been opened or created using one of the aforementioned
10426	APIs, it becomes "known" to VirtualBox. Known media can be attached
10427	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10428	They also appear in the global
10429	<link to="IVirtualBox::hardDisks" />,
10430	<link to="IVirtualBox::DVDImages" /> and
10431	<link to="IVirtualBox::floppyImages" /> arrays.
10432
10433	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10434	in the VirtualBox.xml file, which was shared between all machines and made
10435	transporting machines and their media from one host to another difficult.
10436
10437	Starting with VirtualBox 4.0, media are only added to a registry when they are
10438	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10439	backwards compatibility, which registry a medium is added to depends on which
10440	VirtualBox version created a machine:
10441
10442	<ul>
10443	<li>If the medium has first been attached to a machine which was created by
10444	VirtualBox 4.0 or later, it is added to that machine's media registry in
10445	the machine XML settings file. This way all information about a machine's
10446	media attachments is contained in a single file and can be transported
10447	easily.</li>
10448	<li>For older media attachments (i.e. if the medium was first attached to a
10449	machine which was created with a VirtualBox version before 4.0), media
10450	continue to be registered in the global VirtualBox settings file, for
10451	backwards compatibility.</li>
10452	</ul>
10453
10454	See <link to="IVirtualBox::openMedium" /> for more information.
10455
10456	Media are removed from media registries by the <link to="IMedium::close"/>,
10457	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10458
10459	<h3>Accessibility checks</h3>
10460
10461	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10462	method is called explicitly on a medium. This is done to make the VirtualBox object
10463	ready for serving requests as fast as possible and let the end-user
10464	application decide if it needs to check media accessibility right away or not.
10465
10466	As a result, when VirtualBox starts up (e.g. the VirtualBox
10467	object gets created for the first time), all known media are in the
10468	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10469	attribute is an empty string because no actual accessibility check has
10470	been made yet.
10471
10472	After calling <link to="#refreshState" />, a medium is considered
10473	<i>accessible</i> if its storage unit can be read. In that case, the
10474	<link to="#state"/> attribute has a value of "Created". If the storage
10475	unit cannot be read (for example, because it is located on a disconnected
10476	network resource, or was accidentally deleted outside VirtualBox),
10477	the medium is considered <i>inaccessible</i>, which is indicated by the
10478	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10479	obtained by reading the <link to="#lastAccessError"/> attribute.
10480
10481	<h3>Medium types</h3>
10482
10483	There are five types of medium behavior which are stored in the
10484	<link to="#type"/> attribute (see <link to="MediumType" />) and
10485	which define the medium's behavior with attachments and snapshots.
10486
10487	All media can be also divided in two groups: <i>base</i> media and
10488	<i>differencing</i> media. A base medium contains all sectors of the
10489	medium data in its own storage and therefore can be used independently.
10490	In contrast, a differencing medium is a "delta" to some other medium and
10491	contains only those sectors which differ from that other medium, which is
10492	then called a <i>parent</i>. The differencing medium is said to be
10493	<i>linked to</i> that parent. The parent may be itself a differencing
10494	medium, thus forming a chain of linked media. The last element in that
10495	chain must always be a base medium. Note that several differencing
10496	media may be linked to the same parent medium.
10497
10498	Differencing media can be distinguished from base media by querying the
10499	<link to="#parent"/> attribute: base media do not have parents they would
10500	depend on, so the value of this attribute is always @c null for them.
10501	Using this attribute, it is possible to walk up the medium tree (from the
10502	child medium to its parent). It is also possible to walk down the tree
10503	using the <link to="#children"/> attribute.
10504
10505	Note that the type of all differencing media is "normal"; all other
10506	values are meaningless for them. Base media may be of any type.
10507
10508	<h3>Automatic composition of the file name part</h3>
10509
10510	Another extension to the <link to="IMedium::location"/> attribute is that
10511	there is a possibility to cause VirtualBox to compose a unique value for
10512	the file name part of the location using the UUID of the hard disk. This
10513	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10514	e.g. before the storage unit is created, and works as follows. You set the
10515	value of the <link to="IMedium::location"/> attribute to a location
10516	specification which only contains the path specification but not the file
10517	name part and ends with either a forward slash or a backslash character.
10518	In response, VirtualBox will generate a new UUID for the hard disk and
10519	compose the file name using the following pattern:
10520	<pre>
10521	<path>/{<uuid>}.<ext>
10522	</pre>
10523	where <tt><path></tt> is the supplied path specification,
10524	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10525	is the default extension for the storage format of this hard disk. After
10526	that, you may call any of the methods that create a new hard disk storage
10527	unit and they will use the generated UUID and file name.
10528	</desc>
10529
10530	<attribute name="id" type="uuid" mod="string" readonly="yes">
10531	<desc>
10532	UUID of the medium. For a newly created medium, this value is a randomly
10533	generated UUID.
10534
10535	<note>
10536	For media in one of MediumState_NotCreated, MediumState_Creating or
10537	MediumState_Deleting states, the value of this property is undefined
10538	and will most likely be an empty UUID.
10539	</note>
10540	</desc>
10541	</attribute>
10542
10543	<attribute name="description" type="wstring">
10544	<desc>
10545	Optional description of the medium. For a newly created medium the value
10546	of this attribute is an empty string.
10547
10548	Medium types that don't support this attribute will return E_NOTIMPL in
10549	attempt to get or set this attribute's value.
10550
10551	<note>
10552	For some storage types, reading this attribute may return an outdated
10553	(last known) value when <link to="#state"/> is <link
10554	to="MediumState_Inaccessible"/> or <link
10555	to="MediumState_LockedWrite"/> because the value of this attribute is
10556	stored within the storage unit itself. Also note that changing the
10557	attribute value is not possible in such case, as well as when the
10558	medium is the <link to="MediumState_LockedRead"/> state.
10559	</note>
10560	</desc>
10561	</attribute>
10562
10563	<attribute name="state" type="MediumState" readonly="yes">
10564	<desc>
10565	Returns the current medium state, which is the last state set by
10566	the accessibility check performed by <link to="#refreshState"/>.
10567	If that method has not yet been called on the medium, the state
10568	is "Inaccessible"; as opposed to truly inaccessible media, the
10569	value of <link to="#lastAccessError"/> will be an empty string in
10570	that case.
10571
10572	<note>As of version 3.1, this no longer performs an accessibility check
10573	automatically; call <link to="#refreshState"/> for that.
10574	</note>
10575	</desc>
10576	</attribute>
10577
10578	<attribute name="variant" type="unsigned long" readonly="yes">
10579	<desc>
10580	Returns the storage format variant information for this medium
10581	as a combination of the flags described at <link to="MediumVariant" />.
10582	Before <link to="#refreshState"/> is called this method returns
10583	an undefined value.
10584	</desc>
10585	</attribute>
10586
10587	<attribute name="location" type="wstring">
10588	<desc>
10589	Location of the storage unit holding medium data.
10590
10591	The format of the location string is medium type specific. For medium
10592	types using regular files in a host's file system, the location
10593	string is the full file name.
10594
10595	Some medium types may support changing the storage unit location by
10596	simply changing the value of this property. If this operation is not
10597	supported, the implementation will return E_NOTIMPL in attempt to set
10598	this attribute's value.
10599
10600	When setting a value of the location attribute which is a regular file
10601	in the host's file system, the given file name may be either relative to
10602	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10603	absolute. Note that if the given location specification does not contain
10604	the file extension part then a proper default extension will be
10605	automatically appended by the implementation depending on the medium type.
10606	</desc>
10607	</attribute>
10608
10609	<attribute name="name" type="wstring" readonly="yes">
10610	<desc>
10611	Name of the storage unit holding medium data.
10612
10613	The returned string is a short version of the <link to="#location"/>
10614	attribute that is suitable for representing the medium in situations
10615	where the full location specification is too long (such as lists
10616	and comboboxes in GUI frontends). This string is also used by frontends
10617	to sort the media list alphabetically when needed.
10618
10619	For example, for locations that are regular files in the host's file
10620	system, the value of this attribute is just the file name (+ extension),
10621	without the path specification.
10622
10623	Note that as opposed to the <link to="#location"/> attribute, the name
10624	attribute will not necessary be unique for a list of media of the
10625	given type and format.
10626	</desc>
10627	</attribute>
10628
10629	<attribute name="deviceType" type="DeviceType" readonly="yes">
10630	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10631	medium.</desc>
10632	</attribute>
10633
10634	<attribute name="hostDrive" type="boolean" readonly="yes">
10635	<desc>True if this corresponds to a drive on the host.</desc>
10636	</attribute>
10637
10638	<attribute name="size" type="long long" readonly="yes">
10639	<desc>
10640	Physical size of the storage unit used to hold medium data (in bytes).
10641
10642	<note>
10643	For media whose <link to="#state"/> is <link
10644	to="MediumState_Inaccessible"/>, the value of this property is the
10645	last known size. For <link to="MediumState_NotCreated"/> media,
10646	the returned value is zero.
10647	</note>
10648	</desc>
10649	</attribute>
10650
10651	<attribute name="format" type="wstring" readonly="yes">
10652	<desc>
10653	Storage format of this medium.
10654
10655	The value of this attribute is a string that specifies a backend used
10656	to store medium data. The storage format is defined when you create a
10657	new medium or automatically detected when you open an existing medium,
10658	and cannot be changed later.
10659
10660	The list of all storage formats supported by this VirtualBox
10661	installation can be obtained using
10662	<link to="ISystemProperties::mediumFormats"/>.
10663	</desc>
10664	</attribute>
10665
10666	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10667	<desc>
10668	Storage medium format object corresponding to this medium.
10669
10670	The value of this attribute is a reference to the medium format object
10671	that specifies the backend properties used to store medium data. The
10672	storage format is defined when you create a new medium or automatically
10673	detected when you open an existing medium, and cannot be changed later.
10674
10675	<note>@c null is returned if there is no associated medium format
10676	object. This can e.g. happen for medium objects representing host
10677	drives and other special medium objects.</note>
10678	</desc>
10679	</attribute>
10680
10681	<attribute name="type" type="MediumType">
10682	<desc>
10683	Type (role) of this medium.
10684
10685	The following constraints apply when changing the value of this
10686	attribute:
10687	<ul>
10688	<li>If a medium is attached to a virtual machine (either in the
10689	current state or in one of the snapshots), its type cannot be
10690	changed.
10691	</li>
10692	<li>As long as the medium has children, its type cannot be set
10693	to <link to="MediumType_Writethrough"/>.
10694	</li>
10695	<li>The type of all differencing media is
10696	<link to="MediumType_Normal"/> and cannot be changed.
10697	</li>
10698	</ul>
10699
10700	The type of a newly created or opened medium is set to
10701	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10702	which have a type of <link to="MediumType_Writethrough"/>.
10703	</desc>
10704	</attribute>
10705
10706	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10707	<desc>
10708	Returns which medium types can selected for this medium.
10709
10710	<result name="E_NOTIMPL">
10711	This attribute is not implemented at the moment.
10712	</result>
10713	</desc>
10714	</attribute>
10715
10716	<attribute name="parent" type="IMedium" readonly="yes">
10717	<desc>
10718	Parent of this medium (the medium this medium is directly based
10719	on).
10720
10721	Only differencing media have parents. For base (non-differencing)
10722	media, @c null is returned.
10723	</desc>
10724	</attribute>
10725
10726	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10727	<desc>
10728	Children of this medium (all differencing media directly based
10729	on this medium). A @c null array is returned if this medium
10730	does not have any children.
10731	</desc>
10732	</attribute>
10733
10734	<attribute name="base" type="IMedium" readonly="yes">
10735	<desc>
10736	Base medium of this medium.
10737
10738	If this is a differencing medium, its base medium is the medium
10739	the given medium branch starts from. For all other types of media, this
10740	property returns the medium object itself (i.e. the same object this
10741	property is read on).
10742	</desc>
10743	</attribute>
10744
10745	<attribute name="readOnly" type="boolean" readonly="yes">
10746	<desc>
10747	Returns @c true if this medium is read-only and @c false otherwise.
10748
10749	A medium is considered to be read-only when its contents cannot be
10750	modified without breaking the integrity of other parties that depend on
10751	this medium such as its child media or snapshots of virtual machines
10752	where this medium is attached to these machines. If there are no
10753	children and no such snapshots then there is no dependency and the
10754	medium is not read-only.
10755
10756	The value of this attribute can be used to determine the kind of the
10757	attachment that will take place when attaching this medium to a
10758	virtual machine. If the value is @c false then the medium will
10759	be attached directly. If the value is @c true then the medium
10760	will be attached indirectly by creating a new differencing child
10761	medium for that. See the interface description for more information.
10762
10763	Note that all <link to="MediumType_Immutable">Immutable</link> media
10764	are always read-only while all
10765	<link to="MediumType_Writethrough">Writethrough</link> media are
10766	always not.
10767
10768	<note>
10769	The read-only condition represented by this attribute is related to
10770	the medium type and usage, not to the current
10771	<link to="IMedium::state">medium state</link> and not to the read-only
10772	state of the storage unit.
10773	</note>
10774	</desc>
10775	</attribute>
10776
10777	<attribute name="logicalSize" type="long long" readonly="yes">
10778	<desc>
10779	Logical size of this medium (in bytes), as reported to the
10780	guest OS running inside the virtual machine this medium is
10781	attached to. The logical size is defined when the medium is created
10782	and cannot be changed later.
10783
10784	<note>
10785	Reading this property on a differencing medium will return the size
10786	of its <link to="#base"/> medium.
10787	</note>
10788	<note>
10789	For media whose state is <link to="#state"/> is <link
10790	to="MediumState_Inaccessible"/>, the value of this property is the
10791	last known logical size. For <link to="MediumState_NotCreated"/>
10792	media, the returned value is zero.
10793	</note>
10794	</desc>
10795	</attribute>
10796
10797	<attribute name="autoReset" type="boolean">
10798	<desc>
10799	Whether this differencing medium will be automatically reset each
10800	time a virtual machine it is attached to is powered up. This
10801	attribute is automatically set to @c true for the last
10802	differencing image of an "immutable" medium (see
10803	<link to="MediumType" />).
10804
10805	See <link to="#reset"/> for more information about resetting
10806	differencing media.
10807
10808	<note>
10809	Reading this property on a base (non-differencing) medium will
10810	always @c false. Changing the value of this property in this
10811	case is not supported.
10812	</note>
10813
10814	<result name="VBOX_E_NOT_SUPPORTED">
10815	This is not a differencing medium (when changing the attribute
10816	value).
10817	</result>
10818	</desc>
10819	</attribute>
10820
10821	<attribute name="lastAccessError" type="wstring" readonly="yes">
10822	<desc>
10823	Text message that represents the result of the last accessibility
10824	check performed by <link to="#refreshState"/>.
10825
10826	An empty string is returned if the last accessibility check
10827	was successful or has not yet been called. As a result, if
10828	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10829	then <link to="#refreshState"/> has yet to be called; this is the
10830	default value of media after VirtualBox initialization.
10831	A non-empty string indicates a failure and should normally describe
10832	a reason of the failure (for example, a file read error).
10833	</desc>
10834	</attribute>
10835
10836	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10837	<desc>
10838	Array of UUIDs of all machines this medium is attached to.
10839
10840	A @c null array is returned if this medium is not attached to any
10841	machine or to any machine's snapshot.
10842
10843	<note>
10844	The returned array will include a machine even if this medium is not
10845	attached to that machine in the current state but attached to it in
10846	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10847	details.
10848	</note>
10849	</desc>
10850	</attribute>
10851
10852	<method name="setIDs">
10853	<desc>
10854	Changes the UUID and parent UUID for a hard disk medium.
10855	</desc>
10856	<param name="setImageId" type="boolean" dir="in">
10857	<desc>
10858	Select whether a new image UUID is set or not.
10859	</desc>
10860	</param>
10861	<param name="imageId" type="uuid" mod="string" dir="in">
10862	<desc>
10863	New UUID for the image. If an empty string is passed, then a new
10864	UUID is automatically created, provided that @a setImageId is @c true.
10865	Specifying a zero UUID is not allowed.
10866	</desc>
10867	</param>
10868	<param name="setParentId" type="boolean" dir="in">
10869	<desc>
10870	Select whether a new parent UUID is set or not.
10871	</desc>
10872	</param>
10873	<param name="parentId" type="uuid" mod="string" dir="in">
10874	<desc>
10875	New parent UUID for the image. If an empty string is passed, then a
10876	new UUID is automatically created, provided @a setParentId is
10877	@c true. A zero UUID is valid.
10878	</desc>
10879	</param>
10880	<result name="E_INVALIDARG">
10881	Invalid parameter combination.
10882	</result>
10883	<result name="VBOX_E_NOT_SUPPORTED">
10884	Medium is not a hard disk medium.
10885	</result>
10886	</method>
10887
10888	<method name="refreshState">
10889	<desc>
10890	If the current medium state (see <link to="MediumState"/>) is one of
10891	"Created", "Inaccessible" or "LockedRead", then this performs an
10892	accessibility check on the medium and sets the value of the <link to="#state"/>
10893	attribute accordingly; that value is also returned for convenience.
10894
10895	For all other state values, this does not perform a refresh but returns
10896	the state only.
10897
10898	The refresh, if performed, may take a long time (several seconds or even
10899	minutes, depending on the storage unit location and format) because it performs an
10900	accessibility check of the storage unit. This check may cause a significant
10901	delay if the storage unit of the given medium is, for example, a file located
10902	on a network share which is not currently accessible due to connectivity
10903	problems. In that case, the call will not return until a timeout
10904	interval defined by the host OS for this operation expires. For this reason,
10905	it is recommended to never read this attribute on the main UI thread to avoid
10906	making the UI unresponsive.
10907
10908	If the last known state of the medium is "Created" and the accessibility
10909	check fails, then the state would be set to "Inaccessible", and
10910	<link to="#lastAccessError"/> may be used to get more details about the
10911	failure. If the state of the medium is "LockedRead", then it remains the
10912	same, and a non-empty value of <link to="#lastAccessError"/> will
10913	indicate a failed accessibility check in this case.
10914
10915	Note that not all medium states are applicable to all medium types.
10916	</desc>
10917	<param name="state" type="MediumState" dir="return">
10918	<desc>
10919	New medium state.
10920	</desc>
10921	</param>
10922	</method>
10923
10924	<method name="getSnapshotIds">
10925	<desc>
10926	Returns an array of UUIDs of all snapshots of the given machine where
10927	this medium is attached to.
10928
10929	If the medium is attached to the machine in the current state, then the
10930	first element in the array will always be the ID of the queried machine
10931	(i.e. the value equal to the @c machineId argument), followed by
10932	snapshot IDs (if any).
10933
10934	If the medium is not attached to the machine in the current state, then
10935	the array will contain only snapshot IDs.
10936
10937	The returned array may be @c null if this medium is not attached
10938	to the given machine at all, neither in the current state nor in one of
10939	the snapshots.
10940	</desc>
10941	<param name="machineId" type="uuid" mod="string" dir="in">
10942	<desc>
10943	UUID of the machine to query.
10944	</desc>
10945	</param>
10946	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
10947	<desc>
10948	Array of snapshot UUIDs of the given machine using this medium.
10949	</desc>
10950	</param>
10951	</method>
10952
10953	<method name="lockRead">
10954	<desc>
10955	Locks this medium for reading.
10956
10957	A read lock is shared: many clients can simultaneously lock the
10958	same medium for reading unless it is already locked for writing (see
10959	<link to="#lockWrite"/>) in which case an error is returned.
10960
10961	When the medium is locked for reading, it cannot be modified
10962	from within VirtualBox. This means that any method that changes
10963	the properties of this medium or contents of the storage unit
10964	will return an error (unless explicitly stated otherwise). That
10965	includes an attempt to start a virtual machine that wants to
10966	write to the the medium.
10967
10968	When the virtual machine is started up, it locks for reading all
10969	media it uses in read-only mode. If some medium cannot be locked
10970	for reading, the startup procedure will fail.
10971	A medium is typically locked for reading while it is used by a running
10972	virtual machine but has a depending differencing image that receives
10973	the actual write operations. This way one base medium can have
10974	multiple child differencing images which can be written to
10975	simultaneously. Read-only media such as DVD and floppy images are
10976	also locked for reading only (so they can be in use by multiple
10977	machines simultaneously).
10978
10979	A medium is also locked for reading when it is the source of a
10980	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
10981
10982	The medium locked for reading must be unlocked using the <link
10983	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
10984	can be nested and must be followed by the same number of paired
10985	<link to="#unlockRead"/> calls.
10986
10987	This method sets the medium state (see <link to="#state"/>) to
10988	"LockedRead" on success. The medium's previous state must be
10989	one of "Created", "Inaccessible" or "LockedRead".
10990
10991	Locking an inaccessible medium is not an error; this method performs
10992	a logical lock that prevents modifications of this medium through
10993	the VirtualBox API, not a physical file-system lock of the underlying
10994	storage unit.
10995
10996	This method returns the current state of the medium
10997	<i>before</i> the operation.
10998
10999	<result name="VBOX_E_INVALID_OBJECT_STATE">
11000	Invalid medium state (e.g. not created, locked, inaccessible,
11001	creating, deleting).
11002	</result>
11003
11004	</desc>
11005	<param name="state" type="MediumState" dir="return">
11006	<desc>
11007	State of the medium after the operation.
11008	</desc>
11009	</param>
11010	</method>
11011
11012	<method name="unlockRead">
11013	<desc>
11014	Cancels the read lock previously set by <link to="#lockRead"/>.
11015
11016	For both success and failure, this method returns the current state
11017	of the medium <i>after</i> the operation.
11018
11019	See <link to="#lockRead"/> for more details.
11020
11021	<result name="VBOX_E_INVALID_OBJECT_STATE">
11022	Medium not locked for reading.
11023	</result>
11024
11025	</desc>
11026	<param name="state" type="MediumState" dir="return">
11027	<desc>
11028	State of the medium after the operation.
11029	</desc>
11030	</param>
11031	</method>
11032
11033	<method name="lockWrite">
11034	<desc>
11035	Locks this medium for writing.
11036
11037	A write lock, as opposed to <link to="#lockRead"/>, is
11038	exclusive: there may be only one client holding a write lock,
11039	and there may be no read locks while the write lock is held.
11040	As a result, read-locking fails if a write lock is held, and
11041	write-locking fails if either a read or another write lock is held.
11042
11043	When a medium is locked for writing, it cannot be modified
11044	from within VirtualBox, and it is not guaranteed that the values
11045	of its properties are up-to-date. Any method that changes the
11046	properties of this medium or contents of the storage unit will
11047	return an error (unless explicitly stated otherwise).
11048
11049	When a virtual machine is started up, it locks for writing all
11050	media it uses to write data to. If any medium could not be locked
11051	for writing, the startup procedure will fail. If a medium has
11052	differencing images, then while the machine is running, only
11053	the last ("leaf") differencing image is locked for writing,
11054	whereas its parents are locked for reading only.
11055
11056	A medium is also locked for writing when it is the target of a
11057	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11058
11059	The medium locked for writing must be unlocked using the <link
11060	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11061
11062	This method sets the medium state (see <link to="#state"/>) to
11063	"LockedWrite" on success. The medium's previous state must be
11064	either "Created" or "Inaccessible".
11065
11066	Locking an inaccessible medium is not an error; this method performs
11067	a logical lock that prevents modifications of this medium through
11068	the VirtualBox API, not a physical file-system lock of the underlying
11069	storage unit.
11070
11071	For both, success and failure, this method returns the current
11072	state of the medium <i>before</i> the operation.
11073
11074	<result name="VBOX_E_INVALID_OBJECT_STATE">
11075	Invalid medium state (e.g. not created, locked, inaccessible,
11076	creating, deleting).
11077	</result>
11078
11079	</desc>
11080	<param name="state" type="MediumState" dir="return">
11081	<desc>
11082	State of the medium after the operation.
11083	</desc>
11084	</param>
11085	</method>
11086
11087	<method name="unlockWrite">
11088	<desc>
11089	Cancels the write lock previously set by <link to="#lockWrite"/>.
11090
11091	For both success and failure, this method returns the current
11092	state of the medium <i>after</i> the operation.
11093
11094	See <link to="#lockWrite"/> for more details.
11095
11096	<result name="VBOX_E_INVALID_OBJECT_STATE">
11097	Medium not locked for writing.
11098	</result>
11099
11100	</desc>
11101	<param name="state" type="MediumState" dir="return">
11102	<desc>
11103	State of the medium after the operation.
11104	</desc>
11105	</param>
11106	</method>
11107
11108	<method name="close">
11109	<desc>
11110	Closes this medium.
11111
11112	The medium must not be attached to any known virtual machine
11113	and must not have any known child media, otherwise the
11114	operation will fail.
11115
11116	When the medium is successfully closed, it is removed from
11117	the list of registered media, but its storage unit is not
11118	deleted. In particular, this means that this medium can
11119	later be opened again using the <link to="IVirtualBox::openMedium"/>
11120	call.
11121
11122	Note that after this method successfully returns, the given medium
11123	object becomes uninitialized. This means that any attempt
11124	to call any of its methods or attributes will fail with the
11125	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11126
11127	<result name="VBOX_E_INVALID_OBJECT_STATE">
11128	Invalid medium state (other than not created, created or
11129	inaccessible).
11130	</result>
11131	<result name="VBOX_E_OBJECT_IN_USE">
11132	Medium attached to virtual machine.
11133	</result>
11134	<result name="VBOX_E_FILE_ERROR">
11135	Settings file not accessible.
11136	</result>
11137	<result name="VBOX_E_XML_ERROR">
11138	Could not parse the settings file.
11139	</result>
11140
11141	</desc>
11142	</method>
11143
11144	<!-- property methods -->
11145
11146	<method name="getProperty" const="yes">
11147	<desc>
11148	Returns the value of the custom medium property with the given name.
11149
11150	The list of all properties supported by the given medium format can
11151	be obtained with <link to="IMediumFormat::describeProperties"/>.
11152
11153	<note>If this method returns an empty string in @a value, the requested
11154	property is supported but currently not assigned any value.</note>
11155
11156	<result name="VBOX_E_OBJECT_NOT_FOUND">
11157	Requested property does not exist (not supported by the format).
11158	</result>
11159	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11160	</desc>
11161	<param name="name" type="wstring" dir="in">
11162	<desc>Name of the property to get.</desc>
11163	</param>
11164	<param name="value" type="wstring" dir="return">
11165	<desc>Current property value.</desc>
11166	</param>
11167	</method>
11168
11169	<method name="setProperty">
11170	<desc>
11171	Sets the value of the custom medium property with the given name.
11172
11173	The list of all properties supported by the given medium format can
11174	be obtained with <link to="IMediumFormat::describeProperties"/>.
11175
11176	<note>Setting the property value to @c null or an empty string is
11177	equivalent to deleting the existing value. A default value (if it is
11178	defined for this property) will be used by the format backend in this
11179	case.</note>
11180
11181	<result name="VBOX_E_OBJECT_NOT_FOUND">
11182	Requested property does not exist (not supported by the format).
11183	</result>
11184	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11185	</desc>
11186	<param name="name" type="wstring" dir="in">
11187	<desc>Name of the property to set.</desc>
11188	</param>
11189	<param name="value" type="wstring" dir="in">
11190	<desc>Property value to set.</desc>
11191	</param>
11192	</method>
11193
11194	<method name="getProperties" const="yes">
11195	<desc>
11196	Returns values for a group of properties in one call.
11197
11198	The names of the properties to get are specified using the @a names
11199	argument which is a list of comma-separated property names or
11200	an empty string if all properties are to be returned.
11201	<note>Currently the value of this argument is ignored and the method
11202	always returns all existing properties.</note>
11203
11204	The list of all properties supported by the given medium format can
11205	be obtained with <link to="IMediumFormat::describeProperties"/>.
11206
11207	The method returns two arrays, the array of property names corresponding
11208	to the @a names argument and the current values of these properties.
11209	Both arrays have the same number of elements with each element at the
11210	given index in the first array corresponds to an element at the same
11211	index in the second array.
11212
11213	For properties that do not have assigned values, an empty string is
11214	returned at the appropriate index in the @a returnValues array.
11215
11216	</desc>
11217	<param name="names" type="wstring" dir="in">
11218	<desc>
11219	Names of properties to get.
11220	</desc>
11221	</param>
11222	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11223	<desc>Names of returned properties.</desc>
11224	</param>
11225	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11226	<desc>Values of returned properties.</desc>
11227	</param>
11228	</method>
11229
11230	<method name="setProperties">
11231	<desc>
11232	Sets values for a group of properties in one call.
11233
11234	The names of the properties to set are passed in the @a names
11235	array along with the new values for them in the @a values array. Both
11236	arrays have the same number of elements with each element at the given
11237	index in the first array corresponding to an element at the same index
11238	in the second array.
11239
11240	If there is at least one property name in @a names that is not valid,
11241	the method will fail before changing the values of any other properties
11242	from the @a names array.
11243
11244	Using this method over <link to="#setProperty"/> is preferred if you
11245	need to set several properties at once since it is more efficient.
11246
11247	The list of all properties supported by the given medium format can
11248	be obtained with <link to="IMediumFormat::describeProperties"/>.
11249
11250	Setting the property value to @c null or an empty string is equivalent
11251	to deleting the existing value. A default value (if it is defined for
11252	this property) will be used by the format backend in this case.
11253	</desc>
11254	<param name="names" type="wstring" safearray="yes" dir="in">
11255	<desc>Names of properties to set.</desc>
11256	</param>
11257	<param name="values" type="wstring" safearray="yes" dir="in">
11258	<desc>Values of properties to set.</desc>
11259	</param>
11260	</method>
11261
11262	<!-- storage methods -->
11263
11264	<method name="createBaseStorage">
11265	<desc>
11266	Starts creating a hard disk storage unit (fixed/dynamic, according
11267	to the variant flags) in in the background. The previous storage unit
11268	created for this object, if any, must first be deleted using
11269	<link to="#deleteStorage"/>, otherwise the operation will fail.
11270
11271	Before the operation starts, the medium is placed in
11272	<link to="MediumState_Creating"/> state. If the create operation
11273	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11274	state.
11275
11276	After the returned progress object reports that the operation has
11277	successfully completed, the medium state will be set to <link
11278	to="MediumState_Created"/>, the medium will be remembered by this
11279	VirtualBox installation and may be attached to virtual machines.
11280
11281	<result name="VBOX_E_NOT_SUPPORTED">
11282	The variant of storage creation operation is not supported. See <link
11283	to="IMediumFormat::capabilities"/>.
11284	</result>
11285	</desc>
11286	<param name="logicalSize" type="long long" dir="in">
11287	<desc>Maximum logical size of the medium in bytes.</desc>
11288	</param>
11289	<param name="variant" type="unsigned long" dir="in">
11290	<desc>Exact image variant which should be created (as a combination of
11291	<link to="MediumVariant" /> flags).</desc>
11292	</param>
11293	<param name="progress" type="IProgress" dir="return">
11294	<desc>Progress object to track the operation completion.</desc>
11295	</param>
11296	</method>
11297
11298	<method name="deleteStorage">
11299	<desc>
11300	Starts deleting the storage unit of this medium.
11301
11302	The medium must not be attached to any known virtual machine and must
11303	not have any known child media, otherwise the operation will fail.
11304	It will also fail if there is no storage unit to delete or if deletion
11305	is already in progress, or if the medium is being in use (locked for
11306	read or for write) or inaccessible. Therefore, the only valid state for
11307	this operation to succeed is <link to="MediumState_Created"/>.
11308
11309	Before the operation starts, the medium is placed in
11310	<link to="MediumState_Deleting"/> state and gets removed from the list
11311	of remembered hard disks (media registry). If the delete operation
11312	fails, the medium will be remembered again and placed back to
11313	<link to="MediumState_Created"/> state.
11314
11315	After the returned progress object reports that the operation is
11316	complete, the medium state will be set to
11317	<link to="MediumState_NotCreated"/> and you will be able to use one of
11318	the storage creation methods to create it again.
11319
11320	<see><link to="#close"/></see>
11321
11322	<result name="VBOX_E_OBJECT_IN_USE">
11323	Medium is attached to a virtual machine.
11324	</result>
11325	<result name="VBOX_E_NOT_SUPPORTED">
11326	Storage deletion is not allowed because neither of storage creation
11327	operations are supported. See
11328	<link to="IMediumFormat::capabilities"/>.
11329	</result>
11330
11331	<note>
11332	If the deletion operation fails, it is not guaranteed that the storage
11333	unit still exists. You may check the <link to="IMedium::state"/> value
11334	to answer this question.
11335	</note>
11336	</desc>
11337	<param name="progress" type="IProgress" dir="return">
11338	<desc>Progress object to track the operation completion.</desc>
11339	</param>
11340	</method>
11341
11342	<!-- diff methods -->
11343
11344	<method name="createDiffStorage">
11345	<desc>
11346	Starts creating an empty differencing storage unit based on this
11347	medium in the format and at the location defined by the @a target
11348	argument.
11349
11350	The target medium must be in <link to="MediumState_NotCreated"/>
11351	state (i.e. must not have an existing storage unit). Upon successful
11352	completion, this operation will set the type of the target medium to
11353	<link to="MediumType_Normal"/> and create a storage unit necessary to
11354	represent the differencing medium data in the given format (according
11355	to the storage format of the target object).
11356
11357	After the returned progress object reports that the operation is
11358	successfully complete, the target medium gets remembered by this
11359	VirtualBox installation and may be attached to virtual machines.
11360
11361	<note>
11362	The medium will be set to <link to="MediumState_LockedRead"/>
11363	state for the duration of this operation.
11364	</note>
11365	<result name="VBOX_E_OBJECT_IN_USE">
11366	Medium not in @c NotCreated state.
11367	</result>
11368	</desc>
11369	<param name="target" type="IMedium" dir="in">
11370	<desc>Target medium.</desc>
11371	</param>
11372	<param name="variant" type="unsigned long" dir="in">
11373	<desc>Exact image variant which should be created (as a combination of
11374	<link to="MediumVariant" /> flags).</desc>
11375	</param>
11376	<param name="progress" type="IProgress" dir="return">
11377	<desc>Progress object to track the operation completion.</desc>
11378	</param>
11379	</method>
11380
11381	<method name="mergeTo">
11382	<desc>
11383	Starts merging the contents of this medium and all intermediate
11384	differencing media in the chain to the given target medium.
11385
11386	The target medium must be either a descendant of this medium or
11387	its ancestor (otherwise this method will immediately return a failure).
11388	It follows that there are two logical directions of the merge operation:
11389	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11390	ancestor (<i>backward merge</i>). Let us consider the following medium
11391	chain:
11392
11393	<pre>Base <- Diff_1 <- Diff_2</pre>
11394
11395	Here, calling this method on the <tt>Base</tt> medium object with
11396	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11397	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11398	merge. Note that in both cases the contents of the resulting medium
11399	will be the same, the only difference is the medium object that takes
11400	the result of the merge operation. In case of the forward merge in the
11401	above example, the result will be written to <tt>Diff_2</tt>; in case of
11402	the backward merge, the result will be written to <tt>Base</tt>. In
11403	other words, the result of the operation is always stored in the target
11404	medium.
11405
11406	Upon successful operation completion, the storage units of all media in
11407	the chain between this (source) medium and the target medium, including
11408	the source medium itself, will be automatically deleted and the
11409	relevant medium objects (including this medium) will become
11410	uninitialized. This means that any attempt to call any of
11411	their methods or attributes will fail with the
11412	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11413	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11414	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11415	Note that <tt>Diff_2</tt> in this case will become a base medium
11416	itself since it will no longer be based on any other medium.
11417
11418	Considering the above, all of the following conditions must be met in
11419	order for the merge operation to succeed:
11420	<ul>
11421	<li>
11422	Neither this (source) medium nor any intermediate
11423	differencing medium in the chain between it and the target
11424	medium is attached to any virtual machine.
11425	</li>
11426	<li>
11427	Neither the source medium nor the target medium is an
11428	<link to="MediumType_Immutable"/> medium.
11429	</li>
11430	<li>
11431	The part of the medium tree from the source medium to the
11432	target medium is a linear chain, i.e. all medium in this
11433	chain have exactly one child which is the next medium in this
11434	chain. The only exception from this rule is the target medium in
11435	the forward merge operation; it is allowed to have any number of
11436	child media because the merge operation will not change its
11437	logical contents (as it is seen by the guest OS or by children).
11438	</li>
11439	<li>
11440	None of the involved media are in
11441	<link to="MediumState_LockedRead"/> or
11442	<link to="MediumState_LockedWrite"/> state.
11443	</li>
11444	</ul>
11445
11446	<note>
11447	This (source) medium and all intermediates will be placed to <link
11448	to="MediumState_Deleting"/> state and the target medium will be
11449	placed to <link to="MediumState_LockedWrite"/> state and for the
11450	duration of this operation.
11451	</note>
11452	</desc>
11453	<param name="target" type="IMedium" dir="in">
11454	<desc>Target medium.</desc>
11455	</param>
11456	<param name="progress" type="IProgress" dir="return">
11457	<desc>Progress object to track the operation completion.</desc>
11458	</param>
11459	</method>
11460
11461	<!-- clone method -->
11462
11463	<method name="cloneTo">
11464	<desc>
11465	Starts creating a clone of this medium in the format and at the
11466	location defined by the @a target argument.
11467
11468	The target medium must be either in <link to="MediumState_NotCreated"/>
11469	state (i.e. must not have an existing storage unit) or in
11470	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11471	big enough to hold the data or else the copy will be partial). Upon
11472	successful completion, the cloned medium will contain exactly the
11473	same sector data as the medium being cloned, except that in the
11474	first case a new UUID for the clone will be randomly generated, and in
11475	the second case the UUID will remain unchanged.
11476
11477	The @a parent argument defines which medium will be the parent
11478	of the clone. Passing a @c null reference indicates that the clone will
11479	be a base image, i.e. completely independent. It is possible to specify
11480	an arbitrary medium for this parameter, including the parent of the
11481	medium which is being cloned. Even cloning to a child of the source
11482	medium is possible. Note that when cloning to an existing image, the
11483	@a parent argument is ignored.
11484
11485	After the returned progress object reports that the operation is
11486	successfully complete, the target medium gets remembered by this
11487	VirtualBox installation and may be attached to virtual machines.
11488
11489	<note>
11490	This medium will be placed to <link to="MediumState_LockedRead"/>
11491	state for the duration of this operation.
11492	</note>
11493	<result name="E_NOTIMPL">
11494	The specified cloning variant is not supported at the moment.
11495	</result>
11496	</desc>
11497	<param name="target" type="IMedium" dir="in">
11498	<desc>Target medium.</desc>
11499	</param>
11500	<param name="variant" type="unsigned long" dir="in">
11501	<desc>Exact image variant which should be created (as a combination of
11502	<link to="MediumVariant" /> flags).</desc>
11503	</param>
11504	<param name="parent" type="IMedium" dir="in">
11505	<desc>Parent of the cloned medium.</desc>
11506	</param>
11507	<param name="progress" type="IProgress" dir="return">
11508	<desc>Progress object to track the operation completion.</desc>
11509	</param>
11510	</method>
11511
11512	<!-- other methods -->
11513
11514	<method name="compact">
11515	<desc>
11516	Starts compacting of this medium. This means that the medium is
11517	transformed into a possibly more compact storage representation.
11518	This potentially creates temporary images, which can require a
11519	substantial amount of additional disk space.
11520
11521	This medium will be placed to <link to="MediumState_LockedWrite"/>
11522	state and all its parent media (if any) will be placed to
11523	<link to="MediumState_LockedRead"/> state for the duration of this
11524	operation.
11525
11526	Please note that the results can be either returned straight away,
11527	or later as the result of the background operation via the object
11528	returned via the @a progress parameter.
11529
11530	<result name="VBOX_E_NOT_SUPPORTED">
11531	Medium format does not support compacting (but potentially
11532	needs it).
11533	</result>
11534	</desc>
11535	<param name="progress" type="IProgress" dir="return">
11536	<desc>Progress object to track the operation completion.</desc>
11537	</param>
11538	</method>
11539
11540	<method name="resize">
11541	<desc>
11542	Starts resizing this medium. This means that the nominal size of the
11543	medium is set to the new value. Both increasing and decreasing the
11544	size is possible, and there are no safety checks, since VirtualBox
11545	does not make any assumptions about the medium contents.
11546
11547	Resizing usually needs additional disk space, and possibly also
11548	some temporary disk space. Note that resize does not create a full
11549	temporary copy of the medium, so the additional disk space requirement
11550	is usually much lower than using the clone operation.
11551
11552	This medium will be placed to <link to="MediumState_LockedWrite"/>
11553	state for the duration of this operation.
11554
11555	Please note that the results can be either returned straight away,
11556	or later as the result of the background operation via the object
11557	returned via the @a progress parameter.
11558
11559	<result name="VBOX_E_NOT_SUPPORTED">
11560	Medium format does not support resizing.
11561	</result>
11562	</desc>
11563	<param name="logicalSize" type="long long" dir="in">
11564	<desc>New nominal capacity of the medium in bytes.</desc>
11565	</param>
11566	<param name="progress" type="IProgress" dir="return">
11567	<desc>Progress object to track the operation completion.</desc>
11568	</param>
11569	</method>
11570
11571	<method name="reset">
11572	<desc>
11573	Starts erasing the contents of this differencing medium.
11574
11575	This operation will reset the differencing medium to its initial
11576	state when it does not contain any sector data and any read operation is
11577	redirected to its parent medium. This automatically gets called
11578	during VM power-up for every medium whose <link to="#autoReset" />
11579	attribute is @c true.
11580
11581	The medium will be write-locked for the duration of this operation (see
11582	<link to="#lockWrite" />).
11583
11584	<result name="VBOX_E_NOT_SUPPORTED">
11585	This is not a differencing medium.
11586	</result>
11587	<result name="VBOX_E_INVALID_OBJECT_STATE">
11588	Medium is not in <link to="MediumState_Created"/> or
11589	<link to="MediumState_Inaccessible"/> state.
11590	</result>
11591	</desc>
11592	<param name="progress" type="IProgress" dir="return">
11593	<desc>Progress object to track the operation completion.</desc>
11594	</param>
11595	</method>
11596
11597	</interface>
11598
11599
11600	<!--
11601	// IMediumFormat
11602	/////////////////////////////////////////////////////////////////////////
11603	-->
11604
11605	<enum
11606	name="DataType"
11607	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11608	>
11609	<const name="Int32" value="0"/>
11610	<const name="Int8" value="1"/>
11611	<const name="String" value="2"/>
11612	</enum>
11613
11614	<enum
11615	name="DataFlags"
11616	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11617	>
11618	<const name="None" value="0x00"/>
11619	<const name="Mandatory" value="0x01"/>
11620	<const name="Expert" value="0x02"/>
11621	<const name="Array" value="0x04"/>
11622	<const name="FlagMask" value="0x07"/>
11623	</enum>
11624
11625	<enum
11626	name="MediumFormatCapabilities"
11627	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11628	>
11629	<desc>
11630	Medium format capability flags.
11631	</desc>
11632
11633	<const name="Uuid" value="0x01">
11634	<desc>
11635	Supports UUIDs as expected by VirtualBox code.
11636	</desc>
11637	</const>
11638
11639	<const name="CreateFixed" value="0x02">
11640	<desc>
11641	Supports creating fixed size images, allocating all space instantly.
11642	</desc>
11643	</const>
11644
11645	<const name="CreateDynamic" value="0x04">
11646	<desc>
11647	Supports creating dynamically growing images, allocating space on
11648	demand.
11649	</desc>
11650	</const>
11651
11652	<const name="CreateSplit2G" value="0x08">
11653	<desc>
11654	Supports creating images split in chunks of a bit less than 2 GBytes.
11655	</desc>
11656	</const>
11657
11658	<const name="Differencing" value="0x10">
11659	<desc>
11660	Supports being used as a format for differencing media (see <link
11661	to="IMedium::createDiffStorage"/>).
11662	</desc>
11663	</const>
11664
11665	<const name="Asynchronous" value="0x20">
11666	<desc>
11667	Supports asynchronous I/O operations for at least some configurations.
11668	</desc>
11669	</const>
11670
11671	<const name="File" value="0x40">
11672	<desc>
11673	The format backend operates on files (the <link to="IMedium::location"/>
11674	attribute of the medium specifies a file used to store medium
11675	data; for a list of supported file extensions see
11676	<link to="IMediumFormat::describeFileExtensions"/>).
11677	</desc>
11678	</const>
11679
11680	<const name="Properties" value="0x80">
11681	<desc>
11682	The format backend uses the property interface to configure the storage
11683	location and properties (the <link to="IMediumFormat::describeProperties"/>
11684	method is used to get access to properties supported by the given medium format).
11685	</desc>
11686	</const>
11687
11688	<const name="TcpNetworking" value="0x100">
11689	<desc>
11690	The format backend uses the TCP networking interface for network access.
11691	</desc>
11692	</const>
11693
11694	<const name="VFS" value="0x200">
11695	<desc>
11696	The format backend supports virtual filesystem functionality.
11697	</desc>
11698	</const>
11699
11700	<const name="CapabilityMask" value="0x3FF"/>
11701	</enum>
11702
11703	<interface
11704	name="IMediumFormat" extends="$unknown"
11705	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11706	wsmap="managed"
11707	>
11708	<desc>
11709	The IMediumFormat interface represents a medium format.
11710
11711	Each medium format has an associated backend which is used to handle
11712	media stored in this format. This interface provides information
11713	about the properties of the associated backend.
11714
11715	Each medium format is identified by a string represented by the
11716	<link to="#id"/> attribute. This string is used in calls like
11717	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11718	format.
11719
11720	The list of all supported medium formats can be obtained using
11721	<link to="ISystemProperties::mediumFormats"/>.
11722
11723	<see><link to="IMedium"/></see>
11724	</desc>
11725
11726	<attribute name="id" type="wstring" readonly="yes">
11727	<desc>
11728	Identifier of this format.
11729
11730	The format identifier is a non-@c null non-empty ASCII string. Note that
11731	this string is case-insensitive. This means that, for example, all of
11732	the following strings:
11733	<pre>
11734	"VDI"
11735	"vdi"
11736	"VdI"</pre>
11737	refer to the same medium format.
11738
11739	This string is used in methods of other interfaces where it is necessary
11740	to specify a medium format, such as
11741	<link to="IVirtualBox::createHardDisk"/>.
11742	</desc>
11743	</attribute>
11744
11745	<attribute name="name" type="wstring" readonly="yes">
11746	<desc>
11747	Human readable description of this format.
11748
11749	Mainly for use in file open dialogs.
11750	</desc>
11751	</attribute>
11752
11753	<attribute name="capabilities" type="unsigned long" readonly="yes">
11754	<desc>
11755	Capabilities of the format as a set of bit flags.
11756
11757	For the meaning of individual capability flags see
11758	<link to="MediumFormatCapabilities"/>.
11759	</desc>
11760	</attribute>
11761
11762	<method name="describeFileExtensions">
11763	<desc>
11764	Returns two arrays describing the supported file extensions.
11765
11766	The first array contains the supported extensions and the seconds one
11767	the type each extension supports. Both have the same size.
11768
11769	Note that some backends do not work on files, so this array may be
11770	empty.
11771
11772	<see><link to="IMediumFormat::capabilities"/></see>
11773	</desc>
11774	<param name="extensions" type="wstring" safearray="yes" dir="out">
11775	<desc>The array of supported extensions.</desc>
11776	</param>
11777	<param name="type" type="DeviceType" safearray="yes" dir="out">
11778	<desc>The array which indicates the device type for every given extension.</desc>
11779	</param>
11780	</method>
11781
11782	<method name="describeProperties" const="yes">
11783	<desc>
11784	Returns several arrays describing the properties supported by this
11785	format.
11786
11787	An element with the given index in each array describes one
11788	property. Thus, the number of elements in each returned array is the
11789	same and corresponds to the number of supported properties.
11790
11791	The returned arrays are filled in only if the
11792	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11793	All arguments must be non-@c null.
11794
11795	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11796	</desc>
11797
11798	<param name="names" type="wstring" safearray="yes" dir="out">
11799	<desc>Array of property names.</desc>
11800	</param>
11801	<param name="description" type="wstring" safearray="yes" dir="out">
11802	<desc>Array of property descriptions.</desc>
11803	</param>
11804	<param name="types" type="DataType" safearray="yes" dir="out">
11805	<desc>Array of property types.</desc>
11806	</param>
11807	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11808	<desc>Array of property flags.</desc>
11809	</param>
11810	<param name="defaults" type="wstring" safearray="yes" dir="out">
11811	<desc>Array of default property values.</desc>
11812	</param>
11813	</method>
11814
11815	</interface>
11816
11817
11818	<!--
11819	// IKeyboard
11820	/////////////////////////////////////////////////////////////////////////
11821	-->
11822
11823	<interface
11824	name="IKeyboard" extends="$unknown"
11825	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11826	wsmap="managed"
11827	>
11828	<desc>
11829	The IKeyboard interface represents the virtual machine's keyboard. Used
11830	in <link to="IConsole::keyboard"/>.
11831
11832	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11833	to the virtual machine.
11834
11835	</desc>
11836	<method name="putScancode">
11837	<desc>Sends a scancode to the keyboard.
11838
11839	<result name="VBOX_E_IPRT_ERROR">
11840	Could not send scan code to virtual keyboard.
11841	</result>
11842
11843	</desc>
11844	<param name="scancode" type="long" dir="in"/>
11845	</method>
11846
11847	<method name="putScancodes">
11848	<desc>Sends an array of scancodes to the keyboard.
11849
11850	<result name="VBOX_E_IPRT_ERROR">
11851	Could not send all scan codes to virtual keyboard.
11852	</result>
11853
11854	</desc>
11855	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11856	<param name="codesStored" type="unsigned long" dir="return"/>
11857	</method>
11858
11859	<method name="putCAD">
11860	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11861	function is nothing special, it is just a convenience function
11862	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11863
11864	<result name="VBOX_E_IPRT_ERROR">
11865	Could not send all scan codes to virtual keyboard.
11866	</result>
11867
11868	</desc>
11869	</method>
11870
11871	<attribute name="eventSource" type="IEventSource" readonly="yes">
11872	<desc>
11873	Event source for keyboard events.
11874	</desc>
11875	</attribute>
11876
11877	</interface>
11878
11879
11880	<!--
11881	// IMouse
11882	/////////////////////////////////////////////////////////////////////////
11883	-->
11884
11885	<enum
11886	name="MouseButtonState"
11887	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11888	>
11889	<desc>
11890	Mouse button state.
11891	</desc>
11892
11893	<const name="LeftButton" value="0x01"/>
11894	<const name="RightButton" value="0x02"/>
11895	<const name="MiddleButton" value="0x04"/>
11896	<const name="WheelUp" value="0x08"/>
11897	<const name="WheelDown" value="0x10"/>
11898	<const name="XButton1" value="0x20"/>
11899	<const name="XButton2" value="0x40"/>
11900	<const name="MouseStateMask" value="0x7F"/>
11901	</enum>
11902
11903	<interface
11904	name="IMouse" extends="$unknown"
11905	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
11906	wsmap="managed"
11907	>
11908	<desc>
11909	The IMouse interface represents the virtual machine's mouse. Used in
11910	<link to="IConsole::mouse"/>.
11911
11912	Through this interface, the virtual machine's virtual mouse can be
11913	controlled.
11914	</desc>
11915
11916	<attribute name="absoluteSupported" type="boolean" readonly="yes">
11917	<desc>
11918	Whether the guest OS supports absolute mouse pointer positioning
11919	or not.
11920	<note>
11921	You can use the <link to="IMouseCapabilityChangedEvent"/>
11922	event to be instantly informed about changes of this attribute
11923	during virtual machine execution.
11924	</note>
11925	<see><link to="#putMouseEventAbsolute"/></see>
11926	</desc>
11927	</attribute>
11928
11929	<attribute name="relativeSupported" type="boolean" readonly="yes">
11930	<desc>
11931	Whether the guest OS supports relative mouse pointer positioning
11932	or not.
11933	<note>
11934	You can use the <link to="IMouseCapabilityChangedEvent"/>
11935	event to be instantly informed about changes of this attribute
11936	during virtual machine execution.
11937	</note>
11938	<see><link to="#putMouseEvent"/></see>
11939	</desc>
11940	</attribute>
11941
11942	<attribute name="needsHostCursor" type="boolean" readonly="yes">
11943	<desc>
11944	Whether the guest OS can currently switch to drawing it's own mouse
11945	cursor on demand.
11946	<note>
11947	You can use the <link to="IMouseCapabilityChangedEvent"/>
11948	event to be instantly informed about changes of this attribute
11949	during virtual machine execution.
11950	</note>
11951	<see><link to="#putMouseEvent"/></see>
11952	</desc>
11953	</attribute>
11954
11955	<method name="putMouseEvent">
11956	<desc>
11957	Initiates a mouse event using relative pointer movements
11958	along x and y axis.
11959
11960	<result name="E_ACCESSDENIED">
11961	Console not powered up.
11962	</result>
11963	<result name="VBOX_E_IPRT_ERROR">
11964	Could not send mouse event to virtual mouse.
11965	</result>
11966
11967	</desc>
11968
11969	<param name="dx" type="long" dir="in">
11970	<desc>
11971	Amount of pixels the mouse should move to the right.
11972	Negative values move the mouse to the left.
11973	</desc>
11974	</param>
11975	<param name="dy" type="long" dir="in">
11976	<desc>
11977	Amount of pixels the mouse should move downwards.
11978	Negative values move the mouse upwards.
11979	</desc>
11980	</param>
11981	<param name="dz" type="long" dir="in">
11982	<desc>
11983	Amount of mouse wheel moves.
11984	Positive values describe clockwise wheel rotations,
11985	negative values describe counterclockwise rotations.
11986	</desc>
11987	</param>
11988	<param name="dw" type="long" dir="in">
11989	<desc>
11990	Amount of horizontal mouse wheel moves.
11991	Positive values describe a movement to the left,
11992	negative values describe a movement to the right.
11993	</desc>
11994	</param>
11995	<param name="buttonState" type="long" dir="in">
11996	<desc>
11997	The current state of mouse buttons. Every bit represents
11998	a mouse button as follows:
11999	<table>
12000	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12001	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12002	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12003	</table>
12004	A value of <tt>1</tt> means the corresponding button is pressed.
12005	otherwise it is released.
12006	</desc>
12007	</param>
12008	</method>
12009
12010	<method name="putMouseEventAbsolute">
12011	<desc>
12012	Positions the mouse pointer using absolute x and y coordinates.
12013	These coordinates are expressed in pixels and
12014	start from <tt>[1,1]</tt> which corresponds to the top left
12015	corner of the virtual display.
12016
12017	<result name="E_ACCESSDENIED">
12018	Console not powered up.
12019	</result>
12020	<result name="VBOX_E_IPRT_ERROR">
12021	Could not send mouse event to virtual mouse.
12022	</result>
12023
12024	<note>
12025	This method will have effect only if absolute mouse
12026	positioning is supported by the guest OS.
12027	</note>
12028
12029	<see><link to="#absoluteSupported"/></see>
12030	</desc>
12031
12032	<param name="x" type="long" dir="in">
12033	<desc>
12034	X coordinate of the pointer in pixels, starting from @c 1.
12035	</desc>
12036	</param>
12037	<param name="y" type="long" dir="in">
12038	<desc>
12039	Y coordinate of the pointer in pixels, starting from @c 1.
12040	</desc>
12041	</param>
12042	<param name="dz" type="long" dir="in">
12043	<desc>
12044	Amount of mouse wheel moves.
12045	Positive values describe clockwise wheel rotations,
12046	negative values describe counterclockwise rotations.
12047	</desc>
12048	</param>
12049	<param name="dw" type="long" dir="in">
12050	<desc>
12051	Amount of horizontal mouse wheel moves.
12052	Positive values describe a movement to the left,
12053	negative values describe a movement to the right.
12054	</desc>
12055	</param>
12056	<param name="buttonState" type="long" dir="in">
12057	<desc>
12058	The current state of mouse buttons. Every bit represents
12059	a mouse button as follows:
12060	<table>
12061	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12062	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12063	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12064	</table>
12065	A value of @c 1 means the corresponding button is pressed.
12066	otherwise it is released.
12067	</desc>
12068	</param>
12069	</method>
12070
12071	<attribute name="eventSource" type="IEventSource" readonly="yes">
12072	<desc>
12073	Event source for mouse events.
12074	</desc>
12075	</attribute>
12076
12077	</interface>
12078
12079	<!--
12080	// IDisplay
12081	/////////////////////////////////////////////////////////////////////////
12082	-->
12083
12084	<enum
12085	name="FramebufferPixelFormat"
12086	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12087	>
12088	<desc>
12089	Format of the video memory buffer. Constants represented by this enum can
12090	be used to test for particular values of <link
12091	to="IFramebuffer::pixelFormat"/>. See also <link
12092	to="IFramebuffer::requestResize"/>.
12093
12094	See also www.fourcc.org for more information about FOURCC pixel formats.
12095	</desc>
12096
12097	<const name="Opaque" value="0">
12098	<desc>
12099	Unknown buffer format (the user may not assume any particular format of
12100	the buffer).
12101	</desc>
12102	</const>
12103	<const name="FOURCC_RGB" value="0x32424752">
12104	<desc>
12105	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12106	bit layout).
12107	</desc>
12108	</const>
12109	</enum>
12110
12111	<interface
12112	name="IFramebuffer" extends="$unknown"
12113	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12114	wsmap="suppress"
12115	>
12116	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12117	<desc>Address of the start byte of the frame buffer.</desc>
12118	</attribute>
12119
12120	<attribute name="width" type="unsigned long" readonly="yes">
12121	<desc>Frame buffer width, in pixels.</desc>
12122	</attribute>
12123
12124	<attribute name="height" type="unsigned long" readonly="yes">
12125	<desc>Frame buffer height, in pixels.</desc>
12126	</attribute>
12127
12128	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12129	<desc>
12130	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12131	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12132	are: 8, 15, 16, 24 and 32.
12133	</desc>
12134	</attribute>
12135
12136	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12137	<desc>
12138	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12139	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12140	size of the scan line must be aligned to 32 bits.
12141	</desc>
12142	</attribute>
12143
12144	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12145	<desc>
12146	Frame buffer pixel format. It's either one of the values defined by <link
12147	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12148	<note>
12149	This attribute must never return <link
12150	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12151	<link to="#address"/> points to must be always known.
12152	</note>
12153	</desc>
12154	</attribute>
12155
12156	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12157	<desc>
12158	Defines whether this frame buffer uses the virtual video card's memory
12159	buffer (guest VRAM) directly or not. See <link
12160	to="IFramebuffer::requestResize"/> for more information.
12161	</desc>
12162	</attribute>
12163
12164	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12165	<desc>
12166	Hint from the frame buffer about how much of the standard
12167	screen height it wants to use for itself. This information is
12168	exposed to the guest through the VESA BIOS and VMMDev interface
12169	so that it can use it for determining its video mode table. It
12170	is not guaranteed that the guest respects the value.
12171	</desc>
12172	</attribute>
12173
12174	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12175	<desc>
12176	An alpha-blended overlay which is superposed over the frame buffer.
12177	The initial purpose is to allow the display of icons providing
12178	information about the VM state, including disk activity, in front
12179	ends which do not have other means of doing that. The overlay is
12180	designed to controlled exclusively by IDisplay. It has no locking
12181	of its own, and any changes made to it are not guaranteed to be
12182	visible until the affected portion of IFramebuffer is updated. The
12183	overlay can be created lazily the first time it is requested. This
12184	attribute can also return @c null to signal that the overlay is not
12185	implemented.
12186	</desc>
12187	</attribute>
12188
12189	<attribute name="winId" type="long long" readonly="yes">
12190	<desc>
12191	Platform-dependent identifier of the window where context of this
12192	frame buffer is drawn, or zero if there's no such window.
12193	</desc>
12194	</attribute>
12195
12196	<method name="lock">
12197	<desc>
12198	Locks the frame buffer.
12199	Gets called by the IDisplay object where this frame buffer is
12200	bound to.
12201	</desc>
12202	</method>
12203
12204	<method name="unlock">
12205	<desc>
12206	Unlocks the frame buffer.
12207	Gets called by the IDisplay object where this frame buffer is
12208	bound to.
12209	</desc>
12210	</method>
12211
12212	<method name="notifyUpdate">
12213	<desc>
12214	Informs about an update.
12215	Gets called by the display object where this buffer is
12216	registered.
12217	</desc>
12218	<param name="x" type="unsigned long" dir="in"/>
12219	<param name="y" type="unsigned long" dir="in"/>
12220	<param name="width" type="unsigned long" dir="in"/>
12221	<param name="height" type="unsigned long" dir="in"/>
12222	</method>
12223
12224	<method name="requestResize">
12225	<desc>
12226	Requests a size and pixel format change.
12227
12228	There are two modes of working with the video buffer of the virtual
12229	machine. The <i>indirect</i> mode implies that the IFramebuffer
12230	implementation allocates a memory buffer for the requested display mode
12231	and provides it to the virtual machine. In <i>direct</i> mode, the
12232	IFramebuffer implementation uses the memory buffer allocated and owned
12233	by the virtual machine. This buffer represents the video memory of the
12234	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12235	usually faster because the implementation gets a raw pointer to the
12236	guest VRAM buffer which it can directly use for visualizing the contents
12237	of the virtual display, as opposed to the indirect mode where the
12238	contents of guest VRAM are copied to the memory buffer provided by
12239	the implementation every time a display update occurs.
12240
12241	It is important to note that the direct mode is really fast only when
12242	the implementation uses the given guest VRAM buffer directly, for
12243	example, by blitting it to the window representing the virtual machine's
12244	display, which saves at least one copy operation comparing to the
12245	indirect mode. However, using the guest VRAM buffer directly is not
12246	always possible: the format and the color depth of this buffer may be
12247	not supported by the target window, or it may be unknown (opaque) as in
12248	case of text or non-linear multi-plane VGA video modes. In this case,
12249	the indirect mode (that is always available) should be used as a
12250	fallback: when the guest VRAM contents are copied to the
12251	implementation-provided memory buffer, color and format conversion is
12252	done automatically by the underlying code.
12253
12254	The @a pixelFormat parameter defines whether the direct mode is
12255	available or not. If @a pixelFormat is <link
12256	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12257	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12258	@a bytesPerLine parameters must be ignored and the implementation must use
12259	the indirect mode (where it provides its own buffer in one of the
12260	supported formats). In all other cases, @a pixelFormat together with
12261	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12262	buffer pointed to by the @a VRAM parameter and the implementation is
12263	free to choose which mode to use. To indicate that this frame buffer uses
12264	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12265	attribute must return @c true and <link to="#address"/> must
12266	return exactly the same address that is passed in the @a VRAM parameter
12267	of this method; otherwise it is assumed that the indirect strategy is
12268	chosen.
12269
12270	The @a width and @a height parameters represent the size of the
12271	requested display mode in both modes. In case of indirect mode, the
12272	provided memory buffer should be big enough to store data of the given
12273	display mode. In case of direct mode, it is guaranteed that the given
12274	@a VRAM buffer contains enough space to represent the display mode of the
12275	given size. Note that this frame buffer's <link to="#width"/> and <link
12276	to="#height"/> attributes must return exactly the same values as
12277	passed to this method after the resize is completed (see below).
12278
12279	The @a finished output parameter determines if the implementation has
12280	finished resizing the frame buffer or not. If, for some reason, the
12281	resize cannot be finished immediately during this call, @a finished
12282	must be set to @c false, and the implementation must call
12283	<link to="IDisplay::resizeCompleted"/> after it has returned from
12284	this method as soon as possible. If @a finished is @c false, the
12285	machine will not call any frame buffer methods until
12286	<link to="IDisplay::resizeCompleted"/> is called.
12287
12288	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12289	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12290	this frame buffer must return exactly the same values as specified in the
12291	parameters of this method, after the resize is completed. If the
12292	indirect mode is chosen, these attributes must return values describing
12293	the format of the implementation's own memory buffer <link
12294	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12295	value must always correlate with <link to="#pixelFormat"/>. Note that
12296	the <link to="#pixelFormat"/> attribute must never return <link
12297	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12298
12299	<note>
12300	This method is called by the IDisplay object under the
12301	<link to="#lock"/> provided by this IFramebuffer
12302	implementation. If this method returns @c false in @a finished, then
12303	this lock is not released until
12304	<link to="IDisplay::resizeCompleted"/> is called.
12305	</note>
12306	</desc>
12307	<param name="screenId" type="unsigned long" dir="in">
12308	<desc>
12309	Logical screen number. Must be used in the corresponding call to
12310	<link to="IDisplay::resizeCompleted"/> if this call is made.
12311	</desc>
12312	</param>
12313	<param name="pixelFormat" type="unsigned long" dir="in">
12314	<desc>
12315	Pixel format of the memory buffer pointed to by @a VRAM.
12316	See also <link to="FramebufferPixelFormat"/>.
12317	</desc>
12318	</param>
12319	<param name="VRAM" type="octet" mod="ptr" dir="in">
12320	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12321	</param>
12322	<param name="bitsPerPixel" type="unsigned long" dir="in">
12323	<desc>Color depth, bits per pixel.</desc>
12324	</param>
12325	<param name="bytesPerLine" type="unsigned long" dir="in">
12326	<desc>Size of one scan line, in bytes.</desc>
12327	</param>
12328	<param name="width" type="unsigned long" dir="in">
12329	<desc>Width of the guest display, in pixels.</desc>
12330	</param>
12331	<param name="height" type="unsigned long" dir="in">
12332	<desc>Height of the guest display, in pixels.</desc>
12333	</param>
12334	<param name="finished" type="boolean" dir="return">
12335	<desc>
12336	Can the VM start using the new frame buffer immediately
12337	after this method returns or it should wait for
12338	<link to="IDisplay::resizeCompleted"/>.
12339	</desc>
12340	</param>
12341	</method>
12342
12343	<method name="videoModeSupported">
12344	<desc>
12345	Returns whether the frame buffer implementation is willing to
12346	support a given video mode. In case it is not able to render
12347	the video mode (or for some reason not willing), it should
12348	return @c false. Usually this method is called when the guest
12349	asks the VMM device whether a given video mode is supported
12350	so the information returned is directly exposed to the guest.
12351	It is important that this method returns very quickly.
12352	</desc>
12353	<param name="width" type="unsigned long" dir="in"/>
12354	<param name="height" type="unsigned long" dir="in"/>
12355	<param name="bpp" type="unsigned long" dir="in"/>
12356	<param name="supported" type="boolean" dir="return"/>
12357	</method>
12358
12359	<method name="getVisibleRegion">
12360	<desc>
12361	Returns the visible region of this frame buffer.
12362
12363	If the @a rectangles parameter is @c null then the value of the
12364	@a count parameter is ignored and the number of elements necessary to
12365	describe the current visible region is returned in @a countCopied.
12366
12367	If @a rectangles is not @c null but @a count is less
12368	than the required number of elements to store region data, the method
12369	will report a failure. If @a count is equal or greater than the
12370	required number of elements, then the actual number of elements copied
12371	to the provided array will be returned in @a countCopied.
12372
12373	<note>
12374	The address of the provided array must be in the process space of
12375	this IFramebuffer object.
12376	</note>
12377	<note>
12378	Method not yet implemented.
12379	</note>
12380	</desc>
12381	<param name="rectangles" type="octet" mod="ptr" dir="in">
12382	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12383	</param>
12384	<param name="count" type="unsigned long" dir="in">
12385	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12386	</param>
12387	<param name="countCopied" type="unsigned long" dir="return">
12388	<desc>Number of elements copied to the @a rectangles array.</desc>
12389	</param>
12390	</method>
12391
12392	<method name="setVisibleRegion">
12393	<desc>
12394	Suggests a new visible region to this frame buffer. This region
12395	represents the area of the VM display which is a union of regions of
12396	all top-level windows of the guest operating system running inside the
12397	VM (if the Guest Additions for this system support this
12398	functionality). This information may be used by the frontends to
12399	implement the seamless desktop integration feature.
12400
12401	<note>
12402	The address of the provided array must be in the process space of
12403	this IFramebuffer object.
12404	</note>
12405	<note>
12406	The IFramebuffer implementation must make a copy of the provided
12407	array of rectangles.
12408	</note>
12409	<note>
12410	Method not yet implemented.
12411	</note>
12412	</desc>
12413	<param name="rectangles" type="octet" mod="ptr" dir="in">
12414	<desc>Pointer to the @c RTRECT array.</desc>
12415	</param>
12416	<param name="count" type="unsigned long" dir="in">
12417	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12418	</param>
12419	</method>
12420
12421	<method name="processVHWACommand">
12422	<desc>
12423	Posts a Video HW Acceleration Command to the frame buffer for processing.
12424	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12425	are posted from quest to the host to be processed by the host hardware.
12426
12427	<note>
12428	The address of the provided command must be in the process space of
12429	this IFramebuffer object.
12430	</note>
12431	</desc>
12432
12433	<param name="command" type="octet" mod="ptr" dir="in">
12434	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12435	</param>
12436	</method>
12437
12438	</interface>
12439
12440	<interface
12441	name="IFramebufferOverlay" extends="IFramebuffer"
12442	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12443	wsmap="suppress"
12444	>
12445	<desc>
12446	The IFramebufferOverlay interface represents an alpha blended overlay
12447	for displaying status icons above an IFramebuffer. It is always created
12448	not visible, so that it must be explicitly shown. It only covers a
12449	portion of the IFramebuffer, determined by its width, height and
12450	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12451	that order) format, and may be written to directly. Do re-read the
12452	width though, after setting it, as it may be adjusted (increased) to
12453	make it more suitable for the front end.
12454	</desc>
12455	<attribute name="x" type="unsigned long" readonly="yes">
12456	<desc>X position of the overlay, relative to the frame buffer.</desc>
12457	</attribute>
12458
12459	<attribute name="y" type="unsigned long" readonly="yes">
12460	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12461	</attribute>
12462
12463	<attribute name="visible" type="boolean" readonly="no">
12464	<desc>
12465	Whether the overlay is currently visible.
12466	</desc>
12467	</attribute>
12468
12469	<attribute name="alpha" type="unsigned long" readonly="no">
12470	<desc>
12471	The global alpha value for the overlay. This may or may not be
12472	supported by a given front end.
12473	</desc>
12474	</attribute>
12475
12476	<method name="move">
12477	<desc>
12478	Changes the overlay's position relative to the IFramebuffer.
12479	</desc>
12480	<param name="x" type="unsigned long" dir="in"/>
12481	<param name="y" type="unsigned long" dir="in"/>
12482	</method>
12483
12484	</interface>
12485
12486	<interface
12487	name="IDisplay" extends="$unknown"
12488	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12489	wsmap="managed"
12490	>
12491	<desc>
12492	The IDisplay interface represents the virtual machine's display.
12493
12494	The object implementing this interface is contained in each
12495	<link to="IConsole::display"/> attribute and represents the visual
12496	output of the virtual machine.
12497
12498	The virtual display supports pluggable output targets represented by the
12499	IFramebuffer interface. Examples of the output target are a window on
12500	the host computer or an RDP session's display on a remote computer.
12501	</desc>
12502	<method name="getScreenResolution">
12503	<desc>Queries display width, height and color depth for given screen.</desc>
12504	<param name="screenId" type="unsigned long" dir="in"/>
12505	<param name="width" type="unsigned long" dir="out"/>
12506	<param name="height" type="unsigned long" dir="out"/>
12507	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12508	</method>
12509
12510	<method name="setFramebuffer">
12511	<desc>
12512	Sets the framebuffer for given screen.
12513	</desc>
12514	<param name="screenId" type="unsigned long" dir="in"/>
12515	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12516	</method>
12517
12518	<method name="getFramebuffer">
12519	<desc>
12520	Queries the framebuffer for given screen.
12521	</desc>
12522	<param name="screenId" type="unsigned long" dir="in"/>
12523	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12524	<param name="xOrigin" type="long" dir="out"/>
12525	<param name="yOrigin" type="long" dir="out"/>
12526	</method>
12527
12528	<method name="setVideoModeHint">
12529	<desc>
12530	Asks VirtualBox to request the given video mode from
12531	the guest. This is just a hint and it cannot be guaranteed
12532	that the requested resolution will be used. Guest Additions
12533	are required for the request to be seen by guests. The caller
12534	should issue the request and wait for a resolution change and
12535	after a timeout retry.
12536
12537	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12538	parameters means that the corresponding values should be taken from the
12539	current video mode (i.e. left unchanged).
12540
12541	If the guest OS supports multi-monitor configuration then the @a display
12542	parameter specifies the number of the guest display to send the hint to:
12543	@c 0 is the primary display, @c 1 is the first secondary and
12544	so on. If the multi-monitor configuration is not supported, @a display
12545	must be @c 0.
12546
12547	<result name="E_INVALIDARG">
12548	The @a display is not associated with any monitor.
12549	</result>
12550
12551	</desc>
12552	<param name="width" type="unsigned long" dir="in"/>
12553	<param name="height" type="unsigned long" dir="in"/>
12554	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12555	<param name="display" type="unsigned long" dir="in"/>
12556	</method>
12557
12558	<method name="setSeamlessMode">
12559	<desc>
12560	Enables or disables seamless guest display rendering (seamless desktop
12561	integration) mode.
12562	<note>
12563	Calling this method has no effect if <link
12564	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12565	does not return @c Active.
12566	</note>
12567	</desc>
12568	<param name="enabled" type="boolean" dir="in"/>
12569	</method>
12570
12571	<method name="takeScreenShot">
12572	<desc>
12573	Takes a screen shot of the requested size and copies it to the
12574	32-bpp buffer allocated by the caller and pointed to by @a address.
12575	A pixel consists of 4 bytes in order: B, G, R, 0.
12576
12577	<note>This API can be used only locally by a VM process through the
12578	COM/XPCOM C++ API as it requires pointer support. It is not
12579	available for scripting langages, Java or any webservice clients.
12580	Unless you are writing a new VM frontend use
12581	<link to="#takeScreenShotToArray" />.
12582	</note>
12583
12584	<result name="E_NOTIMPL">
12585	Feature not implemented.
12586	</result>
12587	<result name="VBOX_E_IPRT_ERROR">
12588	Could not take a screenshot.
12589	</result>
12590
12591	</desc>
12592	<param name="screenId" type="unsigned long" dir="in"/>
12593	<param name="address" type="octet" mod="ptr" dir="in"/>
12594	<param name="width" type="unsigned long" dir="in"/>
12595	<param name="height" type="unsigned long" dir="in"/>
12596	</method>
12597
12598	<method name="takeScreenShotToArray">
12599	<desc>
12600	Takes a guest screen shot of the requested size and returns it as
12601	an array of bytes in uncompressed 32-bit RGBA format.
12602	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12603
12604	This API is slow, but could be the only option to get guest screenshot
12605	for scriptable languages not allowed to manipulate with addresses
12606	directly.
12607
12608	<result name="E_NOTIMPL">
12609	Feature not implemented.
12610	</result>
12611	<result name="VBOX_E_IPRT_ERROR">
12612	Could not take a screenshot.
12613	</result>
12614	</desc>
12615	<param name="screenId" type="unsigned long" dir="in">
12616	<desc>
12617	Monitor to take screenshot from.
12618	</desc>
12619	</param>
12620	<param name="width" type="unsigned long" dir="in">
12621	<desc>
12622	Desired image width.
12623	</desc>
12624	</param>
12625	<param name="height" type="unsigned long" dir="in">
12626	<desc>
12627	Desired image height.
12628	</desc>
12629	</param>
12630	<param name="screenData" type="octet" dir="return" safearray="yes">
12631	<desc>
12632	Array with resulting screen data.
12633	</desc>
12634	</param>
12635	</method>
12636
12637	<method name="takeScreenShotPNGToArray">
12638	<desc>
12639	Takes a guest screen shot of the requested size and returns it as
12640	PNG image in array.
12641
12642	<result name="E_NOTIMPL">
12643	Feature not implemented.
12644	</result>
12645	<result name="VBOX_E_IPRT_ERROR">
12646	Could not take a screenshot.
12647	</result>
12648	</desc>
12649	<param name="screenId" type="unsigned long" dir="in">
12650	<desc>
12651	Monitor to take the screenshot from.
12652	</desc>
12653	</param>
12654	<param name="width" type="unsigned long" dir="in">
12655	<desc>
12656	Desired image width.
12657	</desc>
12658	</param>
12659	<param name="height" type="unsigned long" dir="in">
12660	<desc>
12661	Desired image height.
12662	</desc>
12663	</param>
12664	<param name="screenData" type="octet" dir="return" safearray="yes">
12665	<desc>
12666	Array with resulting screen data.
12667	</desc>
12668	</param>
12669	</method>
12670
12671	<method name="drawToScreen">
12672	<desc>
12673	Draws a 32-bpp image of the specified size from the given buffer
12674	to the given point on the VM display.
12675
12676	<result name="E_NOTIMPL">
12677	Feature not implemented.
12678	</result>
12679	<result name="VBOX_E_IPRT_ERROR">
12680	Could not draw to screen.
12681	</result>
12682
12683	</desc>
12684	<param name="screenId" type="unsigned long" dir="in">
12685	<desc>
12686	Monitor to take the screenshot from.
12687	</desc>
12688	</param>
12689	<param name="address" type="octet" mod="ptr" dir="in">
12690	<desc>
12691	Address to store the screenshot to
12692	</desc>
12693	</param>
12694	<param name="x" type="unsigned long" dir="in">
12695	<desc>
12696	Relative to the screen top left corner.
12697	</desc>
12698	</param>
12699	<param name="y" type="unsigned long" dir="in">
12700	<desc>
12701	Relative to the screen top left corner.
12702	</desc>
12703	</param>
12704	<param name="width" type="unsigned long" dir="in">
12705	<desc>
12706	Desired image width.
12707	</desc>
12708	</param>
12709	<param name="height" type="unsigned long" dir="in">
12710	<desc>
12711	Desired image height.
12712	</desc>
12713	</param>
12714	</method>
12715
12716	<method name="invalidateAndUpdate">
12717	<desc>
12718	Does a full invalidation of the VM display and instructs the VM
12719	to update it.
12720
12721	<result name="VBOX_E_IPRT_ERROR">
12722	Could not invalidate and update screen.
12723	</result>
12724
12725	</desc>
12726	</method>
12727
12728	<method name="resizeCompleted">
12729	<desc>
12730	Signals that a framebuffer has completed the resize operation.
12731
12732	<result name="VBOX_E_NOT_SUPPORTED">
12733	Operation only valid for external frame buffers.
12734	</result>
12735
12736	</desc>
12737	<param name="screenId" type="unsigned long" dir="in"/>
12738	</method>
12739
12740	<method name="completeVHWACommand">
12741	<desc>
12742	Signals that the Video HW Acceleration command has completed.
12743	</desc>
12744
12745	<param name="command" type="octet" mod="ptr" dir="in">
12746	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12747	</param>
12748	</method>
12749
12750	</interface>
12751
12752	<!--
12753	// INetworkAdapter
12754	/////////////////////////////////////////////////////////////////////////
12755	-->
12756
12757	<enum
12758	name="NetworkAttachmentType"
12759	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12760	>
12761	<desc>
12762	Network attachment type.
12763	</desc>
12764
12765	<const name="Null" value="0">
12766	<desc>Null value, also means "not attached".</desc>
12767	</const>
12768	<const name="NAT" value="1"/>
12769	<const name="Bridged" value="2"/>
12770	<const name="Internal" value="3"/>
12771	<const name="HostOnly" value="4"/>
12772	<const name="Generic" value="5"/>
12773	</enum>
12774
12775	<enum
12776	name="NetworkAdapterType"
12777	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12778	>
12779	<desc>
12780	Network adapter type.
12781	</desc>
12782
12783	<const name="Null" value="0">
12784	<desc>Null value (never used by the API).</desc>
12785	</const>
12786	<const name="Am79C970A" value="1">
12787	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12788	</const>
12789	<const name="Am79C973" value="2">
12790	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12791	</const>
12792	<const name="I82540EM" value="3">
12793	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12794	</const>
12795	<const name="I82543GC" value="4">
12796	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12797	</const>
12798	<const name="I82545EM" value="5">
12799	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12800	</const>
12801	<const name="Virtio" value="6">
12802	<desc>Virtio network device.</desc>
12803	</const>
12804	</enum>
12805
12806	<enum
12807	name="NetworkAdapterPromiscModePolicy"
12808	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12809	>
12810	<desc>
12811	The promiscuous mode policy of an interface.
12812	</desc>
12813
12814	<const name="Deny" value="1">
12815	<desc>Deny promiscuous mode requests.</desc>
12816	</const>
12817	<const name="AllowNetwork" value="2">
12818	<desc>
12819	Allow promicuous mode, but restrict the scope it to the internal
12820	network so that it only applies to other VMs.
12821	</desc>
12822	</const>
12823	<const name="AllowAll" value="3">
12824	<desc>
12825	Allow promicuous mode, include unrelated traffic going over the wire
12826	and internally on the host.
12827	</desc>
12828	</const>
12829	</enum>
12830
12831	<interface
12832	name="INetworkAdapter" extends="$unknown"
12833	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12834	wsmap="managed"
12835	>
12836	<desc>
12837	Represents a virtual network adapter that is attached to a virtual machine.
12838	Each virtual machine has a fixed number of network adapter slots with one
12839	instance of this attached to each of them. Call
12840	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12841	is attached to a given slot in a given machine.
12842
12843	Each network adapter can be in one of five attachment modes, which are
12844	represented by the <link to="NetworkAttachmentType" /> enumeration;
12845	see the <link to="#attachmentType" /> attribute.
12846	</desc>
12847
12848	<attribute name="adapterType" type="NetworkAdapterType">
12849	<desc>
12850	Type of the virtual network adapter. Depending on this value,
12851	VirtualBox will provide a different virtual network hardware
12852	to the guest.
12853	</desc>
12854	</attribute>
12855
12856	<attribute name="slot" type="unsigned long" readonly="yes">
12857	<desc>
12858	Slot number this adapter is plugged into. Corresponds to
12859	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12860	to obtain this instance.
12861	</desc>
12862	</attribute>
12863
12864	<attribute name="enabled" type="boolean">
12865	<desc>
12866	Flag whether the network adapter is present in the
12867	guest system. If disabled, the virtual guest hardware will
12868	not contain this network adapter. Can only be changed when
12869	the VM is not running.
12870	</desc>
12871	</attribute>
12872
12873	<attribute name="MACAddress" type="wstring">
12874	<desc>
12875	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12876	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12877	</desc>
12878	</attribute>
12879
12880	<attribute name="attachmentType" type="NetworkAttachmentType">
12881	<desc>
12882	Sets/Gets network attachment type of this network adapter.
12883	</desc>
12884	</attribute>
12885
12886	<attribute name="bridgedInterface" type="wstring">
12887	<desc>
12888	Name of the network interface the VM should be bridged to.
12889	</desc>
12890	</attribute>
12891
12892	<attribute name="hostOnlyInterface" type="wstring">
12893	<desc>
12894	Name of the host only network interface the VM is attached to.
12895	</desc>
12896	</attribute>
12897
12898	<attribute name="internalNetwork" type="wstring">
12899	<desc>
12900	Name of the internal network the VM is attached to.
12901	</desc>
12902	</attribute>
12903
12904	<attribute name="NATNetwork" type="wstring">
12905	<desc>
12906	Name of the NAT network the VM is attached to.
12907	</desc>
12908	</attribute>
12909
12910	<attribute name="genericDriver" type="wstring">
12911	<desc>
12912	Name of the driver to use for the "Generic" network attachment type.
12913	</desc>
12914	</attribute>
12915
12916	<attribute name="cableConnected" type="boolean">
12917	<desc>
12918	Flag whether the adapter reports the cable as connected or not.
12919	It can be used to report offline situations to a VM.
12920	</desc>
12921	</attribute>
12922
12923	<attribute name="lineSpeed" type="unsigned long">
12924	<desc>
12925	Line speed reported by custom drivers, in units of 1 kbps.
12926	</desc>
12927	</attribute>
12928
12929	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
12930	<desc>
12931	The promiscuous mode policy of the network adapter when attached to an
12932	internal network, host only network or a bridge.
12933	</desc>
12934	</attribute>
12935
12936	<attribute name="traceEnabled" type="boolean">
12937	<desc>
12938	Flag whether network traffic from/to the network card should be traced.
12939	Can only be toggled when the VM is turned off.
12940	</desc>
12941	</attribute>
12942
12943	<attribute name="traceFile" type="wstring">
12944	<desc>
12945	Filename where a network trace will be stored. If not set, VBox-pid.pcap
12946	will be used.
12947	</desc>
12948	</attribute>
12949
12950	<attribute name="natDriver" type="INATEngine" readonly="yes">
12951	<desc>
12952	Points to the NAT engine which handles the network address translation
12953	for this interface. This is active only when the interface actually uses
12954	NAT.
12955	</desc>
12956	</attribute>
12957
12958	<attribute name="bootPriority" type="unsigned long">
12959	<desc>
12960	Network boot priority of the adapter. Priority 1 is highest. If not set,
12961	the priority is considered to be at the lowest possible setting.
12962	</desc>
12963	</attribute>
12964
12965	<attribute name="bandwidthGroup" type="IBandwidthGroup">
12966	<desc>The bandwidth group this network adapter is assigned to.</desc>
12967	</attribute>
12968
12969	<!-- property methods -->
12970
12971	<method name="getProperty" const="yes">
12972	<desc>
12973	Returns the value of the network attachment property with the given name.
12974
12975	If the requested data @a key does not exist, this function will
12976	succeed and return an empty string in the @a value argument.
12977
12978	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12979	</desc>
12980	<param name="key" type="wstring" dir="in">
12981	<desc>Name of the property to get.</desc>
12982	</param>
12983	<param name="value" type="wstring" dir="return">
12984	<desc>Current property value.</desc>
12985	</param>
12986	</method>
12987
12988	<method name="setProperty">
12989	<desc>
12990	Sets the value of the network attachment property with the given name.
12991
12992	Setting the property value to @c null or an empty string is equivalent
12993	to deleting the existing value.
12994
12995	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
12996	</desc>
12997	<param name="key" type="wstring" dir="in">
12998	<desc>Name of the property to set.</desc>
12999	</param>
13000	<param name="value" type="wstring" dir="in">
13001	<desc>Property value to set.</desc>
13002	</param>
13003	</method>
13004
13005	<method name="getProperties" const="yes">
13006	<desc>
13007	Returns values for a group of properties in one call.
13008
13009	The names of the properties to get are specified using the @a names
13010	argument which is a list of comma-separated property names or
13011	an empty string if all properties are to be returned.
13012	<note>Currently the value of this argument is ignored and the method
13013	always returns all existing properties.</note>
13014
13015	The method returns two arrays, the array of property names corresponding
13016	to the @a names argument and the current values of these properties.
13017	Both arrays have the same number of elements with each element at the
13018	given index in the first array corresponds to an element at the same
13019	index in the second array.
13020	</desc>
13021	<param name="names" type="wstring" dir="in">
13022	<desc>
13023	Names of properties to get.
13024	</desc>
13025	</param>
13026	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13027	<desc>Names of returned properties.</desc>
13028	</param>
13029	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13030	<desc>Values of returned properties.</desc>
13031	</param>
13032	</method>
13033
13034	</interface>
13035
13036
13037	<!--
13038	// ISerialPort
13039	/////////////////////////////////////////////////////////////////////////
13040	-->
13041
13042	<enum
13043	name="PortMode"
13044	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13045	>
13046	<desc>
13047	The PortMode enumeration represents possible communication modes for
13048	the virtual serial port device.
13049	</desc>
13050
13051	<const name="Disconnected" value="0">
13052	<desc>Virtual device is not attached to any real host device.</desc>
13053	</const>
13054	<const name="HostPipe" value="1">
13055	<desc>Virtual device is attached to a host pipe.</desc>
13056	</const>
13057	<const name="HostDevice" value="2">
13058	<desc>Virtual device is attached to a host device.</desc>
13059	</const>
13060	<const name="RawFile" value="3">
13061	<desc>Virtual device is attached to a raw file.</desc>
13062	</const>
13063	</enum>
13064
13065	<interface
13066	name="ISerialPort" extends="$unknown"
13067	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13068	wsmap="managed"
13069	>
13070
13071	<desc>
13072	The ISerialPort interface represents the virtual serial port device.
13073
13074	The virtual serial port device acts like an ordinary serial port
13075	inside the virtual machine. This device communicates to the real
13076	serial port hardware in one of two modes: host pipe or host device.
13077
13078	In host pipe mode, the #path attribute specifies the path to the pipe on
13079	the host computer that represents a serial port. The #server attribute
13080	determines if this pipe is created by the virtual machine process at
13081	machine startup or it must already exist before starting machine
13082	execution.
13083
13084	In host device mode, the #path attribute specifies the name of the
13085	serial port device on the host computer.
13086
13087	There is also a third communication mode: the disconnected mode. In this
13088	mode, the guest OS running inside the virtual machine will be able to
13089	detect the serial port, but all port write operations will be discarded
13090	and all port read operations will return no data.
13091
13092	<see><link to="IMachine::getSerialPort"/></see>
13093	</desc>
13094
13095	<attribute name="slot" type="unsigned long" readonly="yes">
13096	<desc>
13097	Slot number this serial port is plugged into. Corresponds to
13098	the value you pass to <link to="IMachine::getSerialPort"/>
13099	to obtain this instance.
13100	</desc>
13101	</attribute>
13102
13103	<attribute name="enabled" type="boolean">
13104	<desc>
13105	Flag whether the serial port is enabled. If disabled,
13106	the serial port will not be reported to the guest OS.
13107	</desc>
13108	</attribute>
13109
13110	<attribute name="IOBase" type="unsigned long">
13111	<desc>Base I/O address of the serial port.</desc>
13112	</attribute>
13113
13114	<attribute name="IRQ" type="unsigned long">
13115	<desc>IRQ number of the serial port.</desc>
13116	</attribute>
13117
13118	<attribute name="hostMode" type="PortMode">
13119	<desc>
13120	How is this port connected to the host.
13121	<note>
13122	Changing this attribute may fail if the conditions for
13123	<link to="#path"/> are not met.
13124	</note>
13125	</desc>
13126	</attribute>
13127
13128	<attribute name="server" type="boolean">
13129	<desc>
13130	Flag whether this serial port acts as a server (creates a new pipe on
13131	the host) or as a client (uses the existing pipe). This attribute is
13132	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13133	</desc>
13134	</attribute>
13135
13136	<attribute name="path" type="wstring">
13137	<desc>
13138	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13139	PortMode_HostPipe, or the host serial device name when
13140	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13141	cases, setting a @c null or empty string as the attribute's value
13142	is an error. Otherwise, the value of this property is ignored.
13143	</desc>
13144	</attribute>
13145
13146	</interface>
13147
13148	<!--
13149	// IParallelPort
13150	/////////////////////////////////////////////////////////////////////////
13151	-->
13152
13153	<interface
13154	name="IParallelPort" extends="$unknown"
13155	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13156	wsmap="managed"
13157	>
13158
13159	<desc>
13160	The IParallelPort interface represents the virtual parallel port device.
13161
13162	The virtual parallel port device acts like an ordinary parallel port
13163	inside the virtual machine. This device communicates to the real
13164	parallel port hardware using the name of the parallel device on the host
13165	computer specified in the #path attribute.
13166
13167	Each virtual parallel port device is assigned a base I/O address and an
13168	IRQ number that will be reported to the guest operating system and used
13169	to operate the given parallel port from within the virtual machine.
13170
13171	<see><link to="IMachine::getParallelPort"/></see>
13172	</desc>
13173
13174	<attribute name="slot" type="unsigned long" readonly="yes">
13175	<desc>
13176	Slot number this parallel port is plugged into. Corresponds to
13177	the value you pass to <link to="IMachine::getParallelPort"/>
13178	to obtain this instance.
13179	</desc>
13180	</attribute>
13181
13182	<attribute name="enabled" type="boolean">
13183	<desc>
13184	Flag whether the parallel port is enabled. If disabled,
13185	the parallel port will not be reported to the guest OS.
13186	</desc>
13187	</attribute>
13188
13189	<attribute name="IOBase" type="unsigned long">
13190	<desc>Base I/O address of the parallel port.</desc>
13191	</attribute>
13192
13193	<attribute name="IRQ" type="unsigned long">
13194	<desc>IRQ number of the parallel port.</desc>
13195	</attribute>
13196
13197	<attribute name="path" type="wstring">
13198	<desc>
13199	Host parallel device name. If this parallel port is enabled, setting a
13200	@c null or an empty string as this attribute's value will result in
13201	an error.
13202	</desc>
13203	</attribute>
13204
13205	</interface>
13206
13207
13208	<!--
13209	// IMachineDebugger
13210	/////////////////////////////////////////////////////////////////////////
13211	-->
13212
13213	<interface
13214	name="IMachineDebugger" extends="$unknown"
13215	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13216	wsmap="suppress"
13217	>
13218	<method name="dumpGuestCore">
13219	<desc>
13220	Takes a core dump of the guest.
13221
13222	See include/VBox/dbgfcorefmt.h for details on the file format.
13223	</desc>
13224	<param name="filename" type="wstring" dir="in">
13225	<desc>
13226	The name of the output file. The file must not exist.
13227	</desc>
13228	</param>
13229	<param name="compression" type="wstring" dir="in">
13230	<desc>
13231	Reserved for future compression method indicator.
13232	</desc>
13233	</param>
13234	</method>
13235
13236	<method name="dumpHostProcessCore">
13237	<desc>
13238	Takes a core dump of the VM process on the host.
13239
13240	This feature is not implemented in the 4.0.0 release but it may show up
13241	in a dot release.
13242	</desc>
13243	<param name="filename" type="wstring" dir="in">
13244	<desc>
13245	The name of the output file. The file must not exist.
13246	</desc>
13247	</param>
13248	<param name="compression" type="wstring" dir="in">
13249	<desc>
13250	Reserved for future compression method indicator.
13251	</desc>
13252	</param>
13253	</method>
13254
13255	<method name="info">
13256	<desc>
13257	Interfaces with the info dumpers (DBGFInfo).
13258
13259	This feature is not implemented in the 4.0.0 release but it may show up
13260	in a dot release.
13261	</desc>
13262	<param name="name" type="wstring" dir="in">
13263	<desc>
13264	The name of the info item.
13265	</desc>
13266	</param>
13267	<param name="args" type="wstring" dir="in">
13268	<desc>
13269	Arguments to the info dumper.
13270	</desc>
13271	</param>
13272	<param name="info" type="wstring" dir="return">
13273	<desc>
13274	The into string.
13275	</desc>
13276	</param>
13277	</method>
13278
13279	<method name="injectNMI">
13280	<desc>
13281	Inject an NMI into a running VT-x/AMD-V VM.
13282	</desc>
13283	</method>
13284
13285	<method name="modifyLogGroups">
13286	<desc>
13287	Modifies the group settings of the debug or release logger.
13288	</desc>
13289	<param name="settings" type="wstring" dir="in">
13290	<desc>
13291	The group settings string. See iprt/log.h for details. To target the
13292	release logger, prefix the string with "release:".
13293	</desc>
13294	</param>
13295	</method>
13296
13297	<method name="modifyLogFlags">
13298	<desc>
13299	Modifies the debug or release logger flags.
13300	</desc>
13301	<param name="settings" type="wstring" dir="in">
13302	<desc>
13303	The flags settings string. See iprt/log.h for details. To target the
13304	release logger, prefix the string with "release:".
13305	</desc>
13306	</param>
13307	</method>
13308
13309	<method name="modifyLogDestinations">
13310	<desc>
13311	Modifies the debug or release logger destinations.
13312	</desc>
13313	<param name="settings" type="wstring" dir="in">
13314	<desc>
13315	The destination settings string. See iprt/log.h for details. To target the
13316	release logger, prefix the string with "release:".
13317	</desc>
13318	</param>
13319	</method>
13320
13321	<method name="readPhysicalMemory">
13322	<desc>
13323	Reads guest physical memory, no side effects (MMIO++).
13324
13325	This feature is not implemented in the 4.0.0 release but may show up
13326	in a dot release.
13327	</desc>
13328	<param name="address" type="long long" dir="in">
13329	<desc>The guest physical address.</desc>
13330	</param>
13331	<param name="size" type="unsigned long" dir="in">
13332	<desc>The number of bytes to read.</desc>
13333	</param>
13334	<param name="bytes" type="octet" safearray="yes" dir="return">
13335	<desc>The bytes read.</desc>
13336	</param>
13337	</method>
13338
13339	<method name="writePhysicalMemory">
13340	<desc>
13341	Writes guest physical memory, access handles (MMIO++) are ignored.
13342
13343	This feature is not implemented in the 4.0.0 release but may show up
13344	in a dot release.
13345	</desc>
13346	<param name="address" type="long long" dir="in">
13347	<desc>The guest physical address.</desc>
13348	</param>
13349	<param name="size" type="unsigned long" dir="in">
13350	<desc>The number of bytes to read.</desc>
13351	</param>
13352	<param name="bytes" type="octet" safearray="yes" dir="in">
13353	<desc>The bytes to write.</desc>
13354	</param>
13355	</method>
13356
13357	<method name="readVirtualMemory">
13358	<desc>
13359	Reads guest virtual memory, no side effects (MMIO++).
13360
13361	This feature is not implemented in the 4.0.0 release but may show up
13362	in a dot release.
13363	</desc>
13364	<param name="cpuId" type="unsigned long" dir="in">
13365	<desc>The identifier of the Virtual CPU.</desc>
13366	</param>
13367	<param name="address" type="long long" dir="in">
13368	<desc>The guest virtual address.</desc>
13369	</param>
13370	<param name="size" type="unsigned long" dir="in">
13371	<desc>The number of bytes to read.</desc>
13372	</param>
13373	<param name="bytes" type="octet" safearray="yes" dir="return">
13374	<desc>The bytes read.</desc>
13375	</param>
13376	</method>
13377
13378	<method name="writeVirtualMemory">
13379	<desc>
13380	Writes guest virtual memory, access handles (MMIO++) are ignored.
13381
13382	This feature is not implemented in the 4.0.0 release but may show up
13383	in a dot release.
13384	</desc>
13385	<param name="cpuId" type="unsigned long" dir="in">
13386	<desc>The identifier of the Virtual CPU.</desc>
13387	</param>
13388	<param name="address" type="long long" dir="in">
13389	<desc>The guest virtual address.</desc>
13390	</param>
13391	<param name="size" type="unsigned long" dir="in">
13392	<desc>The number of bytes to read.</desc>
13393	</param>
13394	<param name="bytes" type="octet" safearray="yes" dir="in">
13395	<desc>The bytes to write.</desc>
13396	</param>
13397	</method>
13398
13399	<method name="detectOS">
13400	<desc>
13401	Tries to (re-)detect the guest OS kernel.
13402
13403	This feature is not implemented in the 4.0.0 release but may show up
13404	in a dot release.
13405	</desc>
13406	<param name="os" type="wstring" dir="return">
13407	<desc>
13408	The detected OS kernel on success.
13409	</desc>
13410	</param>
13411	</method>
13412
13413	<method name="getRegister">
13414	<desc>
13415	Gets one register.
13416
13417	This feature is not implemented in the 4.0.0 release but may show up
13418	in a dot release.
13419	</desc>
13420	<param name="cpuId" type="unsigned long" dir="in">
13421	<desc>The identifier of the Virtual CPU.</desc>
13422	</param>
13423	<param name="name" type="wstring" dir="in">
13424	<desc>The register name, case is ignored.</desc>
13425	</param>
13426	<param name="value" type="wstring" dir="return">
13427	<desc>
13428	The register value. This is usually a hex value (always 0x prefixed)
13429	but other format may be used for floating point registers (TBD).
13430	</desc>
13431	</param>
13432	</method>
13433
13434	<method name="getRegisters">
13435	<desc>
13436	Gets all the registers for the given CPU.
13437
13438	This feature is not implemented in the 4.0.0 release but may show up
13439	in a dot release.
13440	</desc>
13441	<param name="cpuId" type="unsigned long" dir="in">
13442	<desc>The identifier of the Virtual CPU.</desc>
13443	</param>
13444	<param name="names" type="wstring" dir="out" safearray="yes">
13445	<desc>Array containing the lowercase register names.</desc>
13446	</param>
13447	<param name="values" type="wstring" dir="out" safearray="yes">
13448	<desc>
13449	Array paralell to the names holding the register values as if the
13450	register was returned by <link to="IMachineDebugger::getRegister"/>.
13451	</desc>
13452	</param>
13453	</method>
13454
13455	<method name="setRegister">
13456	<desc>
13457	Gets one register.
13458
13459	This feature is not implemented in the 4.0.0 release but may show up
13460	in a dot release.
13461	</desc>
13462	<param name="cpuId" type="unsigned long" dir="in">
13463	<desc>The identifier of the Virtual CPU.</desc>
13464	</param>
13465	<param name="name" type="wstring" dir="in">
13466	<desc>The register name, case is ignored.</desc>
13467	</param>
13468	<param name="value" type="wstring" dir="in">
13469	<desc>
13470	The new register value. Hexadecimal, decimal and octal formattings
13471	are supported in addition to any special formattings returned by
13472	the getters.
13473	</desc>
13474	</param>
13475	</method>
13476
13477	<method name="setRegisters">
13478	<desc>
13479	Sets zero or more registers atomically.
13480
13481	This feature is not implemented in the 4.0.0 release but may show up
13482	in a dot release.
13483	</desc>
13484	<param name="cpuId" type="unsigned long" dir="in">
13485	<desc>The identifier of the Virtual CPU.</desc>
13486	</param>
13487	<param name="names" type="wstring" dir="in" safearray="yes">
13488	<desc>Array containing the register names, case ignored.</desc>
13489	</param>
13490	<param name="values" type="wstring" dir="in" safearray="yes">
13491	<desc>
13492	Array paralell to the names holding the register values. See
13493	<link to="IMachineDebugger::setRegister"/> for formatting
13494	guidelines.
13495	</desc>
13496	</param>
13497	</method>
13498
13499	<method name="dumpGuestStack">
13500	<desc>
13501	Produce a simple stack dump using the current guest state.
13502
13503	This feature is not implemented in the 4.0.0 release but may show up
13504	in a dot release.
13505	</desc>
13506	<param name="cpuId" type="unsigned long" dir="in">
13507	<desc>The identifier of the Virtual CPU.</desc>
13508	</param>
13509	<param name="stack" type="wstring" dir="return">
13510	<desc>String containing the formatted stack dump.</desc>
13511	</param>
13512	</method>
13513
13514	<method name="resetStats">
13515	<desc>
13516	Reset VM statistics.
13517	</desc>
13518	<param name="pattern" type="wstring" dir="in">
13519	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13520	</param>
13521	</method>
13522
13523	<method name="dumpStats">
13524	<desc>
13525	Dumps VM statistics.
13526	</desc>
13527	<param name="pattern" type="wstring" dir="in">
13528	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13529	</param>
13530	</method>
13531
13532	<method name="getStats">
13533	<desc>
13534	Get the VM statistics in a XMLish format.
13535	</desc>
13536	<param name="pattern" type="wstring" dir="in">
13537	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13538	</param>
13539	<param name="withDescriptions" type="boolean" dir="in">
13540	<desc>Whether to include the descriptions.</desc>
13541	</param>
13542	<param name="stats" type="wstring" dir="out">
13543	<desc>The XML document containing the statistics.</desc>
13544	</param>
13545	</method>
13546
13547	<attribute name="singleStep" type="boolean">
13548	<desc>Switch for enabling single-stepping.</desc>
13549	</attribute>
13550
13551	<attribute name="recompileUser" type="boolean">
13552	<desc>Switch for forcing code recompilation for user mode code.</desc>
13553	</attribute>
13554
13555	<attribute name="recompileSupervisor" type="boolean">
13556	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13557	</attribute>
13558
13559	<attribute name="PATMEnabled" type="boolean">
13560	<desc>Switch for enabling and disabling the PATM component.</desc>
13561	</attribute>
13562
13563	<attribute name="CSAMEnabled" type="boolean">
13564	<desc>Switch for enabling and disabling the CSAM component.</desc>
13565	</attribute>
13566
13567	<attribute name="logEnabled" type="boolean">
13568	<desc>Switch for enabling and disabling the debug logger.</desc>
13569	</attribute>
13570
13571	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13572	<desc>The debug logger flags.</desc>
13573	</attribute>
13574
13575	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13576	<desc>The debug logger's group settings.</desc>
13577	</attribute>
13578
13579	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13580	<desc>The debug logger's destination settings.</desc>
13581	</attribute>
13582
13583	<attribute name="logRelFlags" type="wstring" readonly="yes">
13584	<desc>The release logger flags.</desc>
13585	</attribute>
13586
13587	<attribute name="logRelGroups" type="wstring" readonly="yes">
13588	<desc>The release logger's group settings.</desc>
13589	</attribute>
13590
13591	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13592	<desc>The relase logger's destination settings.</desc>
13593	</attribute>
13594
13595	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13596	<desc>
13597	Flag indicating whether the VM is currently making use of CPU hardware
13598	virtualization extensions.
13599	</desc>
13600	</attribute>
13601
13602	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13603	<desc>
13604	Flag indicating whether the VM is currently making use of the nested paging
13605	CPU hardware virtualization extension.
13606	</desc>
13607	</attribute>
13608
13609	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13610	<desc>
13611	Flag indicating whether the VM is currently making use of the VPID
13612	VT-x extension.
13613	</desc>
13614	</attribute>
13615
13616	<attribute name="OSName" type="wstring" readonly="yes">
13617	<desc>
13618	Query the guest OS kernel name as detected by the DBGF.
13619
13620	This feature is not implemented in the 4.0.0 release but may show up
13621	in a dot release.
13622	</desc>
13623	</attribute>
13624
13625	<attribute name="OSVersion" type="wstring" readonly="yes">
13626	<desc>
13627	Query the guest OS kernel version string as detected by the DBGF.
13628
13629	This feature is not implemented in the 4.0.0 release but may show up
13630	in a dot release.
13631	</desc>
13632	</attribute>
13633
13634	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13635	<desc>
13636	Flag indicating whether the VM is currently making use of the Physical
13637	Address Extension CPU feature.
13638	</desc>
13639	</attribute>
13640
13641	<attribute name="virtualTimeRate" type="unsigned long">
13642	<desc>
13643	The rate at which the virtual time runs expressed as a percentage.
13644	The accepted range is 2% to 20000%.
13645	</desc>
13646	</attribute>
13647
13648	<attribute name="VM" type="long long" readonly="yes">
13649	<desc>
13650	Gets the VM handle. This is only for internal use while
13651	we carve the details of this interface.
13652	</desc>
13653	</attribute>
13654
13655	</interface>
13656
13657	<!--
13658	// IUSBController
13659	/////////////////////////////////////////////////////////////////////////
13660	-->
13661
13662	<interface
13663	name="IUSBController" extends="$unknown"
13664	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13665	wsmap="managed"
13666	>
13667	<attribute name="enabled" type="boolean">
13668	<desc>
13669	Flag whether the USB controller is present in the
13670	guest system. If disabled, the virtual guest hardware will
13671	not contain any USB controller. Can only be changed when
13672	the VM is powered off.
13673	</desc>
13674	</attribute>
13675
13676	<attribute name="enabledEhci" type="boolean">
13677	<desc>
13678	Flag whether the USB EHCI controller is present in the
13679	guest system. If disabled, the virtual guest hardware will
13680	not contain a USB EHCI controller. Can only be changed when
13681	the VM is powered off.
13682	</desc>
13683	</attribute>
13684
13685	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13686	<desc>
13687	Flag whether there is an USB proxy available.
13688	</desc>
13689	</attribute>
13690
13691	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13692	<desc>
13693	USB standard version which the controller implements.
13694	This is a BCD which means that the major version is in the
13695	high byte and minor version is in the low byte.
13696	</desc>
13697	</attribute>
13698
13699	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13700	<desc>
13701	List of USB device filters associated with the machine.
13702
13703	If the machine is currently running, these filters are activated
13704	every time a new (supported) USB device is attached to the host
13705	computer that was not ignored by global filters
13706	(<link to="IHost::USBDeviceFilters"/>).
13707
13708	These filters are also activated when the machine is powered up.
13709	They are run against a list of all currently available USB
13710	devices (in states
13711	<link to="USBDeviceState_Available"/>,
13712	<link to="USBDeviceState_Busy"/>,
13713	<link to="USBDeviceState_Held"/>) that were not previously
13714	ignored by global filters.
13715
13716	If at least one filter matches the USB device in question, this
13717	device is automatically captured (attached to) the virtual USB
13718	controller of this machine.
13719
13720	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13721	</desc>
13722	</attribute>
13723
13724	<method name="createDeviceFilter">
13725	<desc>
13726	Creates a new USB device filter. All attributes except
13727	the filter name are set to empty (any match),
13728	<i>active</i> is @c false (the filter is not active).
13729
13730	The created filter can then be added to the list of filters using
13731	<link to="#insertDeviceFilter"/>.
13732
13733	<result name="VBOX_E_INVALID_VM_STATE">
13734	The virtual machine is not mutable.
13735	</result>
13736
13737	<see><link to="#deviceFilters"/></see>
13738	</desc>
13739	<param name="name" type="wstring" dir="in">
13740	<desc>
13741	Filter name. See <link to="IUSBDeviceFilter::name"/>
13742	for more info.
13743	</desc>
13744	</param>
13745	<param name="filter" type="IUSBDeviceFilter" dir="return">
13746	<desc>Created filter object.</desc>
13747	</param>
13748	</method>
13749
13750	<method name="insertDeviceFilter">
13751	<desc>
13752	Inserts the given USB device to the specified position
13753	in the list of filters.
13754
13755	Positions are numbered starting from <tt>0</tt>. If the specified
13756	position is equal to or greater than the number of elements in
13757	the list, the filter is added to the end of the collection.
13758
13759	<note>
13760	Duplicates are not allowed, so an attempt to insert a
13761	filter that is already in the collection, will return an
13762	error.
13763	</note>
13764
13765	<result name="VBOX_E_INVALID_VM_STATE">
13766	Virtual machine is not mutable.
13767	</result>
13768	<result name="E_INVALIDARG">
13769	USB device filter not created within this VirtualBox instance.
13770	</result>
13771	<result name="VBOX_E_INVALID_OBJECT_STATE">
13772	USB device filter already in list.
13773	</result>
13774
13775	<see><link to="#deviceFilters"/></see>
13776	</desc>
13777	<param name="position" type="unsigned long" dir="in">
13778	<desc>Position to insert the filter to.</desc>
13779	</param>
13780	<param name="filter" type="IUSBDeviceFilter" dir="in">
13781	<desc>USB device filter to insert.</desc>
13782	</param>
13783	</method>
13784
13785	<method name="removeDeviceFilter">
13786	<desc>
13787	Removes a USB device filter from the specified position in the
13788	list of filters.
13789
13790	Positions are numbered starting from <tt>0</tt>. Specifying a
13791	position equal to or greater than the number of elements in
13792	the list will produce an error.
13793
13794	<see><link to="#deviceFilters"/></see>
13795
13796	<result name="VBOX_E_INVALID_VM_STATE">
13797	Virtual machine is not mutable.
13798	</result>
13799	<result name="E_INVALIDARG">
13800	USB device filter list empty or invalid @a position.
13801	</result>
13802
13803	</desc>
13804	<param name="position" type="unsigned long" dir="in">
13805	<desc>Position to remove the filter from.</desc>
13806	</param>
13807	<param name="filter" type="IUSBDeviceFilter" dir="return">
13808	<desc>Removed USB device filter.</desc>
13809	</param>
13810	</method>
13811
13812	</interface>
13813
13814
13815	<!--
13816	// IUSBDevice
13817	/////////////////////////////////////////////////////////////////////////
13818	-->
13819
13820	<interface
13821	name="IUSBDevice" extends="$unknown"
13822	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13823	wsmap="managed"
13824	>
13825	<desc>
13826	The IUSBDevice interface represents a virtual USB device attached to the
13827	virtual machine.
13828
13829	A collection of objects implementing this interface is stored in the
13830	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13831	attached to a running virtual machine's USB controller.
13832	</desc>
13833
13834	<attribute name="id" type="uuid" mod="string" readonly="yes">
13835	<desc>
13836	Unique USB device ID. This ID is built from #vendorId,
13837	#productId, #revision and #serialNumber.
13838	</desc>
13839	</attribute>
13840
13841	<attribute name="vendorId" type="unsigned short" readonly="yes">
13842	<desc>Vendor ID.</desc>
13843	</attribute>
13844
13845	<attribute name="productId" type="unsigned short" readonly="yes">
13846	<desc>Product ID.</desc>
13847	</attribute>
13848
13849	<attribute name="revision" type="unsigned short" readonly="yes">
13850	<desc>
13851	Product revision number. This is a packed BCD represented as
13852	unsigned short. The high byte is the integer part and the low
13853	byte is the decimal.
13854	</desc>
13855	</attribute>
13856
13857	<attribute name="manufacturer" type="wstring" readonly="yes">
13858	<desc>Manufacturer string.</desc>
13859	</attribute>
13860
13861	<attribute name="product" type="wstring" readonly="yes">
13862	<desc>Product string.</desc>
13863	</attribute>
13864
13865	<attribute name="serialNumber" type="wstring" readonly="yes">
13866	<desc>Serial number string.</desc>
13867	</attribute>
13868
13869	<attribute name="address" type="wstring" readonly="yes">
13870	<desc>Host specific address of the device.</desc>
13871	</attribute>
13872
13873	<attribute name="port" type="unsigned short" readonly="yes">
13874	<desc>
13875	Host USB port number the device is physically
13876	connected to.
13877	</desc>
13878	</attribute>
13879
13880	<attribute name="version" type="unsigned short" readonly="yes">
13881	<desc>
13882	The major USB version of the device - 1 or 2.
13883	</desc>
13884	</attribute>
13885
13886	<attribute name="portVersion" type="unsigned short" readonly="yes">
13887	<desc>
13888	The major USB version of the host USB port the device is
13889	physically connected to - 1 or 2. For devices not connected to
13890	anything this will have the same value as the version attribute.
13891	</desc>
13892	</attribute>
13893
13894	<attribute name="remote" type="boolean" readonly="yes">
13895	<desc>
13896	Whether the device is physically connected to a remote VRDE
13897	client or to a local host machine.
13898	</desc>
13899	</attribute>
13900
13901	</interface>
13902
13903
13904	<!--
13905	// IUSBDeviceFilter
13906	/////////////////////////////////////////////////////////////////////////
13907	-->
13908
13909	<interface
13910	name="IUSBDeviceFilter" extends="$unknown"
13911	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
13912	wsmap="managed"
13913	>
13914	<desc>
13915	The IUSBDeviceFilter interface represents an USB device filter used
13916	to perform actions on a group of USB devices.
13917
13918	This type of filters is used by running virtual machines to
13919	automatically capture selected USB devices once they are physically
13920	attached to the host computer.
13921
13922	A USB device is matched to the given device filter if and only if all
13923	attributes of the device match the corresponding attributes of the
13924	filter (that is, attributes are joined together using the logical AND
13925	operation). On the other hand, all together, filters in the list of
13926	filters carry the semantics of the logical OR operation. So if it is
13927	desirable to create a match like "this vendor id OR this product id",
13928	one needs to create two filters and specify "any match" (see below)
13929	for unused attributes.
13930
13931	All filter attributes used for matching are strings. Each string
13932	is an expression representing a set of values of the corresponding
13933	device attribute, that will match the given filter. Currently, the
13934	following filtering expressions are supported:
13935
13936	<ul>
13937	<li><i>Interval filters</i>. Used to specify valid intervals for
13938	integer device attributes (Vendor ID, Product ID and Revision).
13939	The format of the string is:
13940
13941	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
13942
13943	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
13944	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
13945	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
13946	is omitted before a dash (<tt>-</tt>), the minimum possible integer
13947	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
13948	possible integer is assumed.
13949	</li>
13950	<li><i>Boolean filters</i>. Used to specify acceptable values for
13951	boolean device attributes. The format of the string is:
13952
13953	<tt>true\|false\|yes\|no\|0\|1</tt>
13954
13955	</li>
13956	<li><i>Exact match</i>. Used to specify a single value for the given
13957	device attribute. Any string that doesn't start with <tt>int:</tt>
13958	represents the exact match. String device attributes are compared to
13959	this string including case of symbols. Integer attributes are first
13960	converted to a string (see individual filter attributes) and then
13961	compared ignoring case.
13962
13963	</li>
13964	<li><i>Any match</i>. Any value of the corresponding device attribute
13965	will match the given filter. An empty or @c null string is
13966	used to construct this type of filtering expressions.
13967
13968	</li>
13969	</ul>
13970
13971	<note>
13972	On the Windows host platform, interval filters are not currently
13973	available. Also all string filter attributes
13974	(<link to="#manufacturer"/>, <link to="#product"/>,
13975	<link to="#serialNumber"/>) are ignored, so they behave as
13976	<i>any match</i> no matter what string expression is specified.
13977	</note>
13978
13979	<see><link to="IUSBController::deviceFilters"/>,
13980	<link to="IHostUSBDeviceFilter"/></see>
13981	</desc>
13982
13983	<attribute name="name" type="wstring">
13984	<desc>
13985	Visible name for this filter.
13986	This name is used to visually distinguish one filter from another,
13987	so it can neither be @c null nor an empty string.
13988	</desc>
13989	</attribute>
13990
13991	<attribute name="active" type="boolean">
13992	<desc>Whether this filter active or has been temporarily disabled.</desc>
13993	</attribute>
13994
13995	<attribute name="vendorId" type="wstring">
13996	<desc>
13997	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
13998	The string representation for the <i>exact matching</i>
13999	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14000	(including leading zeroes).
14001	</desc>
14002	</attribute>
14003
14004	<attribute name="productId" type="wstring">
14005	<desc>
14006	<link to="IUSBDevice::productId">Product ID</link> filter.
14007	The string representation for the <i>exact matching</i>
14008	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14009	(including leading zeroes).
14010	</desc>
14011	</attribute>
14012
14013	<attribute name="revision" type="wstring">
14014	<desc>
14015	<link to="IUSBDevice::productId">Product revision number</link>
14016	filter. The string representation for the <i>exact matching</i>
14017	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14018	of the integer part of the revision, and <tt>F</tt> is the
14019	decimal digit of its fractional part (including leading and
14020	trailing zeros).
14021	Note that for interval filters, it's best to use the hexadecimal
14022	form, because the revision is stored as a 16 bit packed BCD value;
14023	so the expression <tt>int:0x0100-0x0199</tt> will match any
14024	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14025	</desc>
14026	</attribute>
14027
14028	<attribute name="manufacturer" type="wstring">
14029	<desc>
14030	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14031	</desc>
14032	</attribute>
14033
14034	<attribute name="product" type="wstring">
14035	<desc>
14036	<link to="IUSBDevice::product">Product</link> filter.
14037	</desc>
14038	</attribute>
14039
14040	<attribute name="serialNumber" type="wstring">
14041	<desc>
14042	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14043	</desc>
14044	</attribute>
14045
14046	<attribute name="port" type="wstring">
14047	<desc>
14048	<link to="IUSBDevice::port">Host USB port</link> filter.
14049	</desc>
14050	</attribute>
14051
14052	<attribute name="remote" type="wstring">
14053	<desc>
14054	<link to="IUSBDevice::remote">Remote state</link> filter.
14055	<note>
14056	This filter makes sense only for machine USB filters,
14057	i.e. it is ignored by IHostUSBDeviceFilter objects.
14058	</note>
14059	</desc>
14060	</attribute>
14061
14062	<attribute name="maskedInterfaces" type="unsigned long">
14063	<desc>
14064	This is an advanced option for hiding one or more USB interfaces
14065	from the guest. The value is a bit mask where the bits that are set
14066	means the corresponding USB interface should be hidden, masked off
14067	if you like.
14068	This feature only works on Linux hosts.
14069	</desc>
14070	</attribute>
14071
14072	</interface>
14073
14074
14075	<!--
14076	// IHostUSBDevice
14077	/////////////////////////////////////////////////////////////////////////
14078	-->
14079
14080	<enum
14081	name="USBDeviceState"
14082	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14083	>
14084	<desc>
14085	USB device state. This enumeration represents all possible states
14086	of the USB device physically attached to the host computer regarding
14087	its state on the host computer and availability to guest computers
14088	(all currently running virtual machines).
14089
14090	Once a supported USB device is attached to the host, global USB
14091	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14092	either ignore the device, or put it to USBDeviceState_Held state, or do
14093	nothing. Unless the device is ignored by global filters, filters of all
14094	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14095	activated that can put it to USBDeviceState_Captured state.
14096
14097	If the device was ignored by global filters, or didn't match
14098	any filters at all (including guest ones), it is handled by the host
14099	in a normal way. In this case, the device state is determined by
14100	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14101	or USBDeviceState_Available, depending on the current device usage.
14102
14103	Besides auto-capturing based on filters, the device can be manually
14104	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14105	state is USBDeviceState_Busy, USBDeviceState_Available or
14106	USBDeviceState_Held.
14107
14108	<note>
14109	Due to differences in USB stack implementations in Linux and Win32,
14110	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14111	only to the Linux version of the product. This also means that (<link
14112	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14113	device state is USBDeviceState_Held.
14114	</note>
14115
14116	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14117	</desc>
14118
14119	<const name="NotSupported" value="0">
14120	<desc>
14121	Not supported by the VirtualBox server, not available to guests.
14122	</desc>
14123	</const>
14124	<const name="Unavailable" value="1">
14125	<desc>
14126	Being used by the host computer exclusively,
14127	not available to guests.
14128	</desc>
14129	</const>
14130	<const name="Busy" value="2">
14131	<desc>
14132	Being used by the host computer, potentially available to guests.
14133	</desc>
14134	</const>
14135	<const name="Available" value="3">
14136	<desc>
14137	Not used by the host computer, available to guests (the host computer
14138	can also start using the device at any time).
14139	</desc>
14140	</const>
14141	<const name="Held" value="4">
14142	<desc>
14143	Held by the VirtualBox server (ignored by the host computer),
14144	available to guests.
14145	</desc>
14146	</const>
14147	<const name="Captured" value="5">
14148	<desc>
14149	Captured by one of the guest computers, not available
14150	to anybody else.
14151	</desc>
14152	</const>
14153	</enum>
14154
14155	<interface
14156	name="IHostUSBDevice" extends="IUSBDevice"
14157	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14158	wsmap="managed"
14159	>
14160	<desc>
14161	The IHostUSBDevice interface represents a physical USB device attached
14162	to the host computer.
14163
14164	Besides properties inherited from IUSBDevice, this interface adds the
14165	<link to="#state"/> property that holds the current state of the USB
14166	device.
14167
14168	<see><link to="IHost::USBDevices"/>,
14169	<link to="IHost::USBDeviceFilters"/></see>
14170	</desc>
14171
14172	<attribute name="state" type="USBDeviceState" readonly="yes">
14173	<desc>
14174	Current state of the device.
14175	</desc>
14176	</attribute>
14177
14178	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14179
14180	</interface>
14181
14182
14183	<!--
14184	// IHostUSBDeviceFilter
14185	/////////////////////////////////////////////////////////////////////////
14186	-->
14187
14188	<enum
14189	name="USBDeviceFilterAction"
14190	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14191	>
14192	<desc>
14193	Actions for host USB device filters.
14194	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14195	</desc>
14196
14197	<const name="Null" value="0">
14198	<desc>Null value (never used by the API).</desc>
14199	</const>
14200	<const name="Ignore" value="1">
14201	<desc>Ignore the matched USB device.</desc>
14202	</const>
14203	<const name="Hold" value="2">
14204	<desc>Hold the matched USB device.</desc>
14205	</const>
14206	</enum>
14207
14208	<interface
14209	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14210	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14211	wsmap="managed"
14212	>
14213	<desc>
14214	The IHostUSBDeviceFilter interface represents a global filter for a
14215	physical USB device used by the host computer. Used indirectly in
14216	<link to="IHost::USBDeviceFilters"/>.
14217
14218	Using filters of this type, the host computer determines the initial
14219	state of the USB device after it is physically attached to the
14220	host's USB controller.
14221
14222	<note>
14223	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14224	filters, because it makes sense only for
14225	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14226	</note>
14227
14228	<see><link to="IHost::USBDeviceFilters"/></see>
14229	</desc>
14230
14231	<attribute name="action" type="USBDeviceFilterAction">
14232	<desc>
14233	Action performed by the host when an attached USB device
14234	matches this filter.
14235	</desc>
14236	</attribute>
14237
14238	</interface>
14239
14240	<!--
14241	// IAudioAdapter
14242	/////////////////////////////////////////////////////////////////////////
14243	-->
14244
14245	<enum
14246	name="AudioDriverType"
14247	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14248	>
14249	<desc>
14250	Host audio driver type.
14251	</desc>
14252
14253	<const name="Null" value="0">
14254	<desc>Null value, also means "dummy audio driver".</desc>
14255	</const>
14256	<const name="WinMM" value="1">
14257	<desc>Windows multimedia (Windows hosts only).</desc>
14258	</const>
14259	<const name="OSS" value="2">
14260	<desc>Open Sound System (Linux hosts only).</desc>
14261	</const>
14262	<const name="ALSA" value="3">
14263	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14264	</const>
14265	<const name="DirectSound" value="4">
14266	<desc>DirectSound (Windows hosts only).</desc>
14267	</const>
14268	<const name="CoreAudio" value="5">
14269	<desc>CoreAudio (Mac hosts only).</desc>
14270	</const>
14271	<const name="MMPM" value="6">
14272	<desc>Reserved for historical reasons.</desc>
14273	</const>
14274	<const name="Pulse" value="7">
14275	<desc>PulseAudio (Linux hosts only).</desc>
14276	</const>
14277	<const name="SolAudio" value="8">
14278	<desc>Solaris audio (Solaris hosts only).</desc>
14279	</const>
14280	</enum>
14281
14282	<enum
14283	name="AudioControllerType"
14284	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14285	>
14286	<desc>
14287	Virtual audio controller type.
14288	</desc>
14289
14290	<const name="AC97" value="0"/>
14291	<const name="SB16" value="1"/>
14292	<const name="HDA" value="2"/>
14293	</enum>
14294
14295	<interface
14296	name="IAudioAdapter" extends="$unknown"
14297	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14298	wsmap="managed"
14299	>
14300	<desc>
14301	The IAudioAdapter interface represents the virtual audio adapter of
14302	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14303	</desc>
14304	<attribute name="enabled" type="boolean">
14305	<desc>
14306	Flag whether the audio adapter is present in the
14307	guest system. If disabled, the virtual guest hardware will
14308	not contain any audio adapter. Can only be changed when
14309	the VM is not running.
14310	</desc>
14311	</attribute>
14312	<attribute name="audioController" type="AudioControllerType">
14313	<desc>
14314	The audio hardware we emulate.
14315	</desc>
14316	</attribute>
14317	<attribute name="audioDriver" type="AudioDriverType">
14318	<desc>
14319	Audio driver the adapter is connected to. This setting
14320	can only be changed when the VM is not running.
14321	</desc>
14322	</attribute>
14323	</interface>
14324
14325	<enum
14326	name="AuthType"
14327	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14328	>
14329	<desc>
14330	VirtualBox authentication type.
14331	</desc>
14332
14333	<const name="Null" value="0">
14334	<desc>Null value, also means "no authentication".</desc>
14335	</const>
14336	<const name="External" value="1"/>
14337	<const name="Guest" value="2"/>
14338	</enum>
14339
14340	<!--
14341	// IVRDEServer
14342	/////////////////////////////////////////////////////////////////////////
14343	-->
14344
14345	<interface
14346	name="IVRDEServer" extends="$unknown"
14347	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14348	wsmap="managed"
14349	>
14350	<attribute name="enabled" type="boolean">
14351	<desc>VRDE server status.</desc>
14352	</attribute>
14353
14354	<attribute name="authType" type="AuthType">
14355	<desc>VRDE authentication method.</desc>
14356	</attribute>
14357
14358	<attribute name="authTimeout" type="unsigned long">
14359	<desc>Timeout for guest authentication. Milliseconds.</desc>
14360	</attribute>
14361
14362	<attribute name="allowMultiConnection" type="boolean">
14363	<desc>
14364	Flag whether multiple simultaneous connections to the VM are permitted.
14365	Note that this will be replaced by a more powerful mechanism in the future.
14366	</desc>
14367	</attribute>
14368
14369	<attribute name="reuseSingleConnection" type="boolean">
14370	<desc>
14371	Flag whether the existing connection must be dropped and a new connection
14372	must be established by the VRDE server, when a new client connects in single
14373	connection mode.
14374	</desc>
14375	</attribute>
14376
14377	<attribute name="VRDEExtPack" type="wstring">
14378	<desc>
14379	The name of Extension Pack providing VRDE for this VM. Overrides
14380	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14381	</desc>
14382	</attribute>
14383
14384	<attribute name="authLibrary" type="wstring">
14385	<desc>
14386	Library used for authentication of RDP clients by this VM. Overrides
14387	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14388	</desc>
14389	</attribute>
14390
14391	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14392	<desc>
14393	Array of names of properties, which are supported by this VRDE server.
14394	</desc>
14395	</attribute>
14396
14397	<method name="setVRDEProperty">
14398	<desc>
14399	Sets a VRDE specific property string.
14400
14401	If you pass @c null or empty string as a key @a value, the given @a key
14402	will be deleted.
14403
14404	</desc>
14405	<param name="key" type="wstring" dir="in">
14406	<desc>Name of the key to set.</desc>
14407	</param>
14408	<param name="value" type="wstring" dir="in">
14409	<desc>Value to assign to the key.</desc>
14410	</param>
14411	</method>
14412
14413	<method name="getVRDEProperty" const="yes">
14414	<desc>
14415	Returns a VRDE specific property string.
14416
14417	If the requested data @a key does not exist, this function will
14418	succeed and return an empty string in the @a value argument.
14419
14420	</desc>
14421	<param name="key" type="wstring" dir="in">
14422	<desc>Name of the key to get.</desc>
14423	</param>
14424	<param name="value" type="wstring" dir="return">
14425	<desc>Value of the requested key.</desc>
14426	</param>
14427	</method>
14428
14429	</interface>
14430
14431
14432	<!--
14433	// ISharedFolder
14434	/////////////////////////////////////////////////////////////////////////
14435	-->
14436
14437	<interface
14438	name="ISharedFolder" extends="$unknown"
14439	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14440	wsmap="struct"
14441	>
14442	<desc>
14443	The ISharedFolder interface represents a folder in the host computer's
14444	file system accessible from the guest OS running inside a virtual
14445	machine using an associated logical name.
14446
14447	There are three types of shared folders:
14448	<ul>
14449	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14450	folders available to all virtual machines.</li>
14451	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14452	VM-specific shared folders available to the given virtual machine at
14453	startup.</li>
14454	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14455	VM-specific shared folders created in the session context (for
14456	example, when the virtual machine is running) and automatically
14457	discarded when the session is closed (the VM is powered off).</li>
14458	</ul>
14459
14460	Logical names of shared folders must be unique within the given scope
14461	(global, permanent or transient). However, they do not need to be unique
14462	across scopes. In this case, the definition of the shared folder in a
14463	more specific scope takes precedence over definitions in all other
14464	scopes. The order of precedence is (more specific to more general):
14465	<ol>
14466	<li>Transient definitions</li>
14467	<li>Permanent definitions</li>
14468	<li>Global definitions</li>
14469	</ol>
14470
14471	For example, if MyMachine has a shared folder named
14472	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14473	transient shared folder named <tt>C_DRIVE</tt> (that points
14474	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14475	of <tt>C_DRIVE</tt> in the guest OS so
14476	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14477	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14478	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14479	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14480	to <tt>C:\\</tt> if it still exists.
14481
14482	Note that permanent and transient shared folders of different machines
14483	are in different name spaces, so they don't overlap and don't need to
14484	have unique logical names.
14485
14486	<note>
14487	Global shared folders are not implemented in the current version of the
14488	product.
14489	</note>
14490	</desc>
14491
14492	<attribute name="name" type="wstring" readonly="yes">
14493	<desc>Logical name of the shared folder.</desc>
14494	</attribute>
14495
14496	<attribute name="hostPath" type="wstring" readonly="yes">
14497	<desc>Full path to the shared folder in the host file system.</desc>
14498	</attribute>
14499
14500	<attribute name="accessible" type="boolean" readonly="yes">
14501	<desc>
14502	Whether the folder defined by the host path is currently
14503	accessible or not.
14504	For example, the folder can be inaccessible if it is placed
14505	on the network share that is not available by the time
14506	this property is read.
14507	</desc>
14508	</attribute>
14509
14510	<attribute name="writable" type="boolean" readonly="yes">
14511	<desc>
14512	Whether the folder defined by the host path is writable or
14513	not.
14514	</desc>
14515	</attribute>
14516
14517	<attribute name="autoMount" type="boolean" readonly="yes">
14518	<desc>
14519	Whether the folder gets automatically mounted by the guest or not.
14520	</desc>
14521	</attribute>
14522
14523	<attribute name="lastAccessError" type="wstring" readonly="yes">
14524	<desc>
14525	Text message that represents the result of the last accessibility
14526	check.
14527
14528	Accessibility checks are performed each time the <link to="#accessible"/>
14529	attribute is read. An empty string is returned if the last
14530	accessibility check was successful. A non-empty string indicates a
14531	failure and should normally describe a reason of the failure (for
14532	example, a file read error).
14533	</desc>
14534	</attribute>
14535
14536	</interface>
14537
14538	<!--
14539	// ISession
14540	/////////////////////////////////////////////////////////////////////////
14541	-->
14542
14543	<interface
14544	name="IInternalSessionControl" extends="$unknown"
14545	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
14546	internal="yes"
14547	wsmap="suppress"
14548	>
14549	<method name="getPID">
14550	<desc>PID of the process that has created this Session object.
14551	</desc>
14552	<param name="pid" type="unsigned long" dir="return"/>
14553	</method>
14554
14555	<method name="getRemoteConsole">
14556	<desc>
14557	Returns the console object suitable for remote control.
14558
14559	<result name="VBOX_E_INVALID_VM_STATE">
14560	Session state prevents operation.
14561	</result>
14562	<result name="VBOX_E_INVALID_OBJECT_STATE">
14563	Session type prevents operation.
14564	</result>
14565
14566	</desc>
14567	<param name="console" type="IConsole" dir="return"/>
14568	</method>
14569
14570	<method name="assignMachine">
14571	<desc>
14572	Assigns the machine object associated with this direct-type
14573	session or informs the session that it will be a remote one
14574	(if @a machine == @c null).
14575
14576	<result name="VBOX_E_INVALID_VM_STATE">
14577	Session state prevents operation.
14578	</result>
14579	<result name="VBOX_E_INVALID_OBJECT_STATE">
14580	Session type prevents operation.
14581	</result>
14582
14583	</desc>
14584	<param name="machine" type="IMachine" dir="in"/>
14585	</method>
14586
14587	<method name="assignRemoteMachine">
14588	<desc>
14589	Assigns the machine and the (remote) console object associated with
14590	this remote-type session.
14591
14592	<result name="VBOX_E_INVALID_VM_STATE">
14593	Session state prevents operation.
14594	</result>
14595
14596	</desc>
14597	<param name="machine" type="IMachine" dir="in"/>
14598	<param name="console" type="IConsole" dir="in"/>
14599	</method>
14600
14601	<method name="updateMachineState">
14602	<desc>
14603	Updates the machine state in the VM process.
14604	Must be called only in certain cases
14605	(see the method implementation).
14606
14607	<result name="VBOX_E_INVALID_VM_STATE">
14608	Session state prevents operation.
14609	</result>
14610	<result name="VBOX_E_INVALID_OBJECT_STATE">
14611	Session type prevents operation.
14612	</result>
14613
14614	</desc>
14615	<param name="aMachineState" type="MachineState" dir="in"/>
14616	</method>
14617
14618	<method name="uninitialize">
14619	<desc>
14620	Uninitializes (closes) this session. Used by VirtualBox to close
14621	the corresponding remote session when the direct session dies
14622	or gets closed.
14623
14624	<result name="VBOX_E_INVALID_VM_STATE">
14625	Session state prevents operation.
14626	</result>
14627
14628	</desc>
14629	</method>
14630
14631	<method name="onNetworkAdapterChange">
14632	<desc>
14633	Triggered when settings of a network adapter of the
14634	associated virtual machine have changed.
14635
14636	<result name="VBOX_E_INVALID_VM_STATE">
14637	Session state prevents operation.
14638	</result>
14639	<result name="VBOX_E_INVALID_OBJECT_STATE">
14640	Session type prevents operation.
14641	</result>
14642
14643	</desc>
14644	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14645	<param name="changeAdapter" type="boolean" dir="in"/>
14646	</method>
14647
14648	<method name="onSerialPortChange">
14649	<desc>
14650	Triggered when settings of a serial port of the
14651	associated virtual machine have changed.
14652
14653	<result name="VBOX_E_INVALID_VM_STATE">
14654	Session state prevents operation.
14655	</result>
14656	<result name="VBOX_E_INVALID_OBJECT_STATE">
14657	Session type prevents operation.
14658	</result>
14659
14660	</desc>
14661	<param name="serialPort" type="ISerialPort" dir="in"/>
14662	</method>
14663
14664	<method name="onParallelPortChange">
14665	<desc>
14666	Triggered when settings of a parallel port of the
14667	associated virtual machine have changed.
14668
14669	<result name="VBOX_E_INVALID_VM_STATE">
14670	Session state prevents operation.
14671	</result>
14672	<result name="VBOX_E_INVALID_OBJECT_STATE">
14673	Session type prevents operation.
14674	</result>
14675
14676	</desc>
14677	<param name="parallelPort" type="IParallelPort" dir="in"/>
14678	</method>
14679
14680	<method name="onStorageControllerChange">
14681	<desc>
14682	Triggered when settings of a storage controller of the
14683	associated virtual machine have changed.
14684
14685	<result name="VBOX_E_INVALID_VM_STATE">
14686	Session state prevents operation.
14687	</result>
14688	<result name="VBOX_E_INVALID_OBJECT_STATE">
14689	Session type prevents operation.
14690	</result>
14691
14692	</desc>
14693	</method>
14694
14695	<method name="onMediumChange">
14696	<desc>
14697	Triggered when attached media of the
14698	associated virtual machine have changed.
14699
14700	<result name="VBOX_E_INVALID_VM_STATE">
14701	Session state prevents operation.
14702	</result>
14703	<result name="VBOX_E_INVALID_OBJECT_STATE">
14704	Session type prevents operation.
14705	</result>
14706
14707	</desc>
14708
14709	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14710	<desc>The medium attachment which changed.</desc>
14711	</param>
14712	<param name="force" type="boolean" dir="in">
14713	<desc>If the medium change was forced.</desc>
14714	</param>
14715	</method>
14716
14717	<method name="onStorageDeviceChange">
14718	<desc>
14719	Triggered when attached storage devices of the
14720	associated virtual machine have changed.
14721
14722	<result name="VBOX_E_INVALID_VM_STATE">
14723	Session state prevents operation.
14724	</result>
14725	<result name="VBOX_E_INVALID_OBJECT_STATE">
14726	Session type prevents operation.
14727	</result>
14728
14729	</desc>
14730
14731	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14732	<desc>The medium attachment which changed.</desc>
14733	</param>
14734	<param name="remove" type="boolean" dir="in">
14735	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14736	</param>
14737	</method>
14738
14739	<method name="onCPUChange">
14740	<desc>
14741	Notification when a CPU changes.
14742	</desc>
14743	<param name="cpu" type="unsigned long" dir="in">
14744	<desc>The CPU which changed</desc>
14745	</param>
14746	<param name="add" type="boolean" dir="in">
14747	<desc>Flag whether the CPU was added or removed</desc>
14748	</param>
14749	</method>
14750
14751	<method name="onCPUExecutionCapChange">
14752	<desc>
14753	Notification when the CPU execution cap changes.
14754	</desc>
14755	<param name="executionCap" type="unsigned long" dir="in">
14756	<desc>The new CPU execution cap value. (1-100)</desc>
14757	</param>
14758	</method>
14759
14760	<method name="onVRDEServerChange">
14761	<desc>
14762	Triggered when settings of the VRDE server object of the
14763	associated virtual machine have changed.
14764
14765	<result name="VBOX_E_INVALID_VM_STATE">
14766	Session state prevents operation.
14767	</result>
14768	<result name="VBOX_E_INVALID_OBJECT_STATE">
14769	Session type prevents operation.
14770	</result>
14771
14772	</desc>
14773	<param name="restart" type="boolean" dir="in">
14774	<desc>Flag whether the server must be restarted</desc>
14775	</param>
14776	</method>
14777
14778	<method name="onUSBControllerChange">
14779	<desc>
14780	Triggered when settings of the USB controller object of the
14781	associated virtual machine have changed.
14782
14783	<result name="VBOX_E_INVALID_VM_STATE">
14784	Session state prevents operation.
14785	</result>
14786	<result name="VBOX_E_INVALID_OBJECT_STATE">
14787	Session type prevents operation.
14788	</result>
14789
14790	</desc>
14791	</method>
14792
14793	<method name="onSharedFolderChange">
14794	<desc>
14795	Triggered when a permanent (global or machine) shared folder has been
14796	created or removed.
14797	<note>
14798	We don't pass shared folder parameters in this notification because
14799	the order in which parallel notifications are delivered is not defined,
14800	therefore it could happen that these parameters were outdated by the
14801	time of processing this notification.
14802	</note>
14803
14804	<result name="VBOX_E_INVALID_VM_STATE">
14805	Session state prevents operation.
14806	</result>
14807	<result name="VBOX_E_INVALID_OBJECT_STATE">
14808	Session type prevents operation.
14809	</result>
14810
14811	</desc>
14812	<param name="global" type="boolean" dir="in"/>
14813	</method>
14814
14815	<method name="onUSBDeviceAttach">
14816	<desc>
14817	Triggered when a request to capture a USB device (as a result
14818	of matched USB filters or direct call to
14819	<link to="IConsole::attachUSBDevice"/>) has completed.
14820	A @c null @a error object means success, otherwise it
14821	describes a failure.
14822
14823	<result name="VBOX_E_INVALID_VM_STATE">
14824	Session state prevents operation.
14825	</result>
14826	<result name="VBOX_E_INVALID_OBJECT_STATE">
14827	Session type prevents operation.
14828	</result>
14829
14830	</desc>
14831	<param name="device" type="IUSBDevice" dir="in"/>
14832	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14833	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14834	</method>
14835
14836	<method name="onUSBDeviceDetach">
14837	<desc>
14838	Triggered when a request to release the USB device (as a result
14839	of machine termination or direct call to
14840	<link to="IConsole::detachUSBDevice"/>) has completed.
14841	A @c null @a error object means success, otherwise it
14842	describes a failure.
14843
14844	<result name="VBOX_E_INVALID_VM_STATE">
14845	Session state prevents operation.
14846	</result>
14847	<result name="VBOX_E_INVALID_OBJECT_STATE">
14848	Session type prevents operation.
14849	</result>
14850
14851	</desc>
14852	<param name="id" type="uuid" mod="string" dir="in"/>
14853	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14854	</method>
14855
14856	<method name="onShowWindow">
14857	<desc>
14858	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14859	<link to="IMachine::showConsoleWindow"/> in order to notify
14860	console listeners
14861	<link to="ICanShowWindowEvent"/>
14862	and <link to="IShowWindowEvent"/>.
14863
14864	<result name="VBOX_E_INVALID_OBJECT_STATE">
14865	Session type prevents operation.
14866	</result>
14867
14868	</desc>
14869	<param name="check" type="boolean" dir="in"/>
14870	<param name="canShow" type="boolean" dir="out"/>
14871	<param name="winId" type="long long" dir="out"/>
14872	</method>
14873
14874	<method name="onBandwidthGroupChange">
14875	<desc>
14876	Notification when one of the bandwidth groups change.
14877	</desc>
14878	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14879	<desc>The bandwidth group which changed.</desc>
14880	</param>
14881	</method>
14882
14883	<method name="accessGuestProperty">
14884	<desc>
14885	Called by <link to="IMachine::getGuestProperty"/> and by
14886	<link to="IMachine::setGuestProperty"/> in order to read and
14887	modify guest properties.
14888
14889	<result name="VBOX_E_INVALID_VM_STATE">
14890	Machine session is not open.
14891	</result>
14892	<result name="VBOX_E_INVALID_OBJECT_STATE">
14893	Session type is not direct.
14894	</result>
14895
14896	</desc>
14897	<param name="name" type="wstring" dir="in"/>
14898	<param name="value" type="wstring" dir="in"/>
14899	<param name="flags" type="wstring" dir="in"/>
14900	<param name="isSetter" type="boolean" dir="in"/>
14901	<param name="retValue" type="wstring" dir="out"/>
14902	<param name="retTimestamp" type="long long" dir="out"/>
14903	<param name="retFlags" type="wstring" dir="out"/>
14904	</method>
14905
14906	<method name="enumerateGuestProperties" const="yes">
14907	<desc>
14908	Return a list of the guest properties matching a set of patterns along
14909	with their values, time stamps and flags.
14910
14911	<result name="VBOX_E_INVALID_VM_STATE">
14912	Machine session is not open.
14913	</result>
14914	<result name="VBOX_E_INVALID_OBJECT_STATE">
14915	Session type is not direct.
14916	</result>
14917
14918	</desc>
14919	<param name="patterns" type="wstring" dir="in">
14920	<desc>
14921	The patterns to match the properties against as a comma-separated
14922	string. If this is empty, all properties currently set will be
14923	returned.
14924	</desc>
14925	</param>
14926	<param name="key" type="wstring" dir="out" safearray="yes">
14927	<desc>
14928	The key names of the properties returned.
14929	</desc>
14930	</param>
14931	<param name="value" type="wstring" dir="out" safearray="yes">
14932	<desc>
14933	The values of the properties returned. The array entries match the
14934	corresponding entries in the @a key array.
14935	</desc>
14936	</param>
14937	<param name="timestamp" type="long long" dir="out" safearray="yes">
14938	<desc>
14939	The time stamps of the properties returned. The array entries match
14940	the corresponding entries in the @a key array.
14941	</desc>
14942	</param>
14943	<param name="flags" type="wstring" dir="out" safearray="yes">
14944	<desc>
14945	The flags of the properties returned. The array entries match the
14946	corresponding entries in the @a key array.
14947	</desc>
14948	</param>
14949	</method>
14950
14951	<method name="onlineMergeMedium">
14952	<desc>
14953	Triggers online merging of a hard disk. Used internally when deleting
14954	a snapshot while a VM referring to the same hard disk chain is running.
14955
14956	<result name="VBOX_E_INVALID_VM_STATE">
14957	Machine session is not open.
14958	</result>
14959	<result name="VBOX_E_INVALID_OBJECT_STATE">
14960	Session type is not direct.
14961	</result>
14962
14963	</desc>
14964	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14965	<desc>The medium attachment to identify the medium chain.</desc>
14966	</param>
14967	<param name="sourceIdx" type="unsigned long" dir="in">
14968	<desc>The index of the source image in the chain.
14969	Redundant, but drastically reduces IPC.</desc>
14970	</param>
14971	<param name="targetIdx" type="unsigned long" dir="in">
14972	<desc>The index of the target image in the chain.
14973	Redundant, but drastically reduces IPC.</desc>
14974	</param>
14975	<param name="source" type="IMedium" dir="in">
14976	<desc>Merge source medium.</desc>
14977	</param>
14978	<param name="target" type="IMedium" dir="in">
14979	<desc>Merge target medium.</desc>
14980	</param>
14981	<param name="mergeForward" type="boolean" dir="in">
14982	<desc>Merge direction.</desc>
14983	</param>
14984	<param name="parentForTarget" type="IMedium" dir="in">
14985	<desc>For forward merges: new parent for target medium.</desc>
14986	</param>
14987	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
14988	<desc>For backward merges: list of media which need their parent UUID
14989	updated.</desc>
14990	</param>
14991	<param name="progress" type="IProgress" dir="in">
14992	<desc>
14993	Progress object for this operation.
14994	</desc>
14995	</param>
14996	</method>
14997
14998	</interface>
14999
15000	<interface
15001	name="ISession" extends="$unknown"
15002	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15003	wsmap="managed"
15004	>
15005	<desc>
15006	The ISession interface represents a client process and allows for locking
15007	virtual machines (represented by IMachine objects) to prevent conflicting
15008	changes to the machine.
15009
15010	Any caller wishing to manipulate a virtual machine needs to create a session
15011	object first, which lives in its own process space. Such session objects are
15012	then associated with <link to="IMachine" /> objects living in the VirtualBox
15013	server process to coordinate such changes.
15014
15015	There are two typical scenarios in which sessions are used:
15016
15017	<ul>
15018	<li>To alter machine settings or control a running virtual machine, one
15019	needs to lock a machine for a given session (client process) by calling
15020	<link to="IMachine::lockMachine"/>.
15021
15022	Whereas multiple sessions may control a running virtual machine, only
15023	one process can obtain a write lock on the machine to prevent conflicting
15024	changes. A write lock is also needed if a process wants to actually run a
15025	virtual machine in its own context, such as the VirtualBox GUI or
15026	VBoxHeadless front-ends. They must also lock a machine for their own
15027	sessions before they are allowed to power up the virtual machine.
15028
15029	As a result, no machine settings can be altered while another process is
15030	already using it, either because that process is modifying machine settings
15031	or because the machine is running.
15032	</li>
15033	<li>
15034	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15035	VirtualBox GUI or VBoxHeadless), one would use
15036	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15037	as its first parameter. This session then identifies the caller and lets the
15038	caller control the started machine (for example, pause machine execution or
15039	power it down) as well as be notified about machine execution state changes.
15040	</li>
15041	</ul>
15042
15043	How sessions objects are created in a client process depends on whether you use
15044	the Main API via COM or via the webservice:
15045
15046	<ul>
15047	<li>When using the COM API directly, an object of the Session class from the
15048	VirtualBox type library needs to be created. In regular COM C++ client code,
15049	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15050	This object will then act as a local session object in further calls to open
15051	a session.
15052	</li>
15053
15054	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15055	a session object automatically whenever <link to="IWebsessionManager::logon" />
15056	is called. A managed object reference to that session object can be retrieved by
15057	calling <link to="IWebsessionManager::getSessionObject" />.
15058	</li>
15059	</ul>
15060	</desc>
15061
15062	<attribute name="state" type="SessionState" readonly="yes">
15063	<desc>Current state of this session.</desc>
15064	</attribute>
15065
15066	<attribute name="type" type="SessionType" readonly="yes">
15067	<desc>
15068	Type of this session. The value of this attribute is valid only
15069	if the session currently has a machine locked (i.e. its
15070	<link to="#state" /> is Locked), otherwise an error will be returned.
15071	</desc>
15072	</attribute>
15073
15074	<attribute name="machine" type="IMachine" readonly="yes">
15075	<desc>Machine object associated with this session.</desc>
15076	</attribute>
15077
15078	<attribute name="console" type="IConsole" readonly="yes">
15079	<desc>Console object associated with this session.</desc>
15080	</attribute>
15081
15082	<method name="unlockMachine">
15083	<desc>
15084	Unlocks a machine that was previously locked for the current session.
15085
15086	Calling this method is required every time a machine has been locked
15087	for a particular session using the <link to="IMachine::launchVMProcess" />
15088	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15089	the machine will be set to <link to="MachineState_Aborted" /> on the
15090	server, and changes made to the machine settings will be lost.
15091
15092	Generally, it is recommended to unlock all machines explicitly
15093	before terminating the application (regardless of the reason for
15094	the termination).
15095
15096	<note>
15097	Do not expect the session state (<link to="ISession::state" />
15098	to return to "Unlocked" immediately after you invoke this method,
15099	particularly if you have started a new VM process. The session
15100	state will automatically return to "Unlocked" once the VM is no
15101	longer executing, which can of course take a very long time.
15102	</note>
15103
15104	<result name="E_UNEXPECTED">
15105	Session is not locked.
15106	</result>
15107
15108	</desc>
15109	</method>
15110
15111	</interface>
15112
15113	<!--
15114	// IStorageController
15115	/////////////////////////////////////////////////////////////////////////
15116	-->
15117
15118	<enum
15119	name="StorageBus"
15120	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15121	>
15122	<desc>
15123	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15124	see <link to="IStorageController::bus" />.
15125	</desc>
15126	<const name="Null" value="0">
15127	<desc>@c null value. Never used by the API.</desc>
15128	</const>
15129	<const name="IDE" value="1"/>
15130	<const name="SATA" value="2"/>
15131	<const name="SCSI" value="3"/>
15132	<const name="Floppy" value="4"/>
15133	<const name="SAS" value="5"/>
15134	</enum>
15135
15136	<enum
15137	name="StorageControllerType"
15138	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15139	>
15140	<desc>
15141	The exact variant of storage controller hardware presented
15142	to the guest; see <link to="IStorageController::controllerType" />.
15143	</desc>
15144
15145	<const name="Null" value="0">
15146	<desc>@c null value. Never used by the API.</desc>
15147	</const>
15148	<const name="LsiLogic" value="1">
15149	<desc>A SCSI controller of the LsiLogic variant.</desc>
15150	</const>
15151	<const name="BusLogic" value="2">
15152	<desc>A SCSI controller of the BusLogic variant.</desc>
15153	</const>
15154	<const name="IntelAhci" value="3">
15155	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15156	</const>
15157	<const name="PIIX3" value="4">
15158	<desc>An IDE controller of the PIIX3 variant.</desc>
15159	</const>
15160	<const name="PIIX4" value="5">
15161	<desc>An IDE controller of the PIIX4 variant.</desc>
15162	</const>
15163	<const name="ICH6" value="6">
15164	<desc>An IDE controller of the ICH6 variant.</desc>
15165	</const>
15166	<const name="I82078" value="7">
15167	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15168	</const>
15169	<const name="LsiLogicSas" value="8">
15170	<desc>A variant of the LsiLogic controller using SAS.</desc>
15171	</const>
15172	</enum>
15173
15174	<enum
15175	name="ChipsetType"
15176	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15177	>
15178	<desc>
15179	Type of emulated chipset (mostly southbridge).
15180	</desc>
15181
15182	<const name="Null" value="0">
15183	<desc>@c null value. Never used by the API.</desc>
15184	</const>
15185	<const name="PIIX3" value="1">
15186	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15187	</const>
15188	<const name="ICH9" value="2">
15189	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15190	</const>
15191	</enum>
15192
15193	<interface
15194	name="IStorageController" extends="$unknown"
15195	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15196	wsmap="managed"
15197	>
15198	<desc>
15199	Represents a storage controller that is attached to a virtual machine
15200	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15201	attached to storage controllers in a real computer, virtual drives
15202	(represented by <link to="IMediumAttachment" />) are attached to virtual
15203	storage controllers, represented by this interface.
15204
15205	As opposed to physical hardware, VirtualBox has a very generic concept
15206	of a storage controller, and for purposes of the Main API, all virtual
15207	storage is attached to virtual machines via instances of this interface.
15208	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15209	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15210	is used, certain sub-types may be available and can be selected in
15211	<link to="#controllerType" />.
15212
15213	Depending on these settings, the guest operating system might see
15214	significantly different virtual hardware.
15215	</desc>
15216
15217	<attribute name="name" type="wstring" readonly="yes">
15218	<desc>
15219	Name of the storage controller, as originally specified with
15220	<link to="IMachine::addStorageController" />. This then uniquely
15221	identifies this controller with other method calls such as
15222	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15223	</desc>
15224	</attribute>
15225
15226	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15227	<desc>
15228	Maximum number of devices which can be attached to one port.
15229	</desc>
15230	</attribute>
15231
15232	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15233	<desc>
15234	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15235	</desc>
15236	</attribute>
15237
15238	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15239	<desc>
15240	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15241	</desc>
15242	</attribute>
15243
15244	<attribute name="instance" type="unsigned long">
15245	<desc>
15246	The instance number of the device in the running VM.
15247	</desc>
15248	</attribute>
15249
15250	<attribute name="portCount" type="unsigned long">
15251	<desc>
15252	The number of currently usable ports on the controller.
15253	The minimum and maximum number of ports for one controller are
15254	stored in <link to="IStorageController::minPortCount"/>
15255	and <link to="IStorageController::maxPortCount"/>.
15256	</desc>
15257	</attribute>
15258
15259	<attribute name="bus" type="StorageBus" readonly="yes">
15260	<desc>
15261	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15262	</desc>
15263	</attribute>
15264
15265	<attribute name="controllerType" type="StorageControllerType">
15266	<desc>
15267	The exact variant of storage controller hardware presented
15268	to the guest.
15269	Depending on this value, VirtualBox will provide a different
15270	virtual storage controller hardware to the guest.
15271	For SATA, SAS and floppy controllers, only one variant is
15272	available, but for IDE and SCSI, there are several.
15273
15274	For SCSI controllers, the default type is LsiLogic.
15275	</desc>
15276	</attribute>
15277
15278	<attribute name="useHostIOCache" type="boolean">
15279	<desc>
15280	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15281	caches and use synchronous file APIs on the host. This was the only option in the API before
15282	VirtualBox 3.2 and is still the default for IDE controllers.
15283
15284	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15285	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15286	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15287	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15288	virtual machines are running at the same time to prevent I/O cache related hangs.
15289	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15290	</desc>
15291	</attribute>
15292
15293	<attribute name="bootable" type="boolean" readonly="yes">
15294	<desc>
15295	Returns whether it is possible to boot from disks attached to this controller.
15296	</desc>
15297	</attribute>
15298
15299	<method name="getIDEEmulationPort">
15300	<desc>
15301	Gets the corresponding port number which is emulated as an IDE device.
15302	Works only with SATA controllers.
15303
15304	<result name="E_INVALIDARG">
15305	The @a devicePosition is not in the range 0 to 3.
15306	</result>
15307	<result name="E_NOTIMPL">
15308	The storage controller type is not SATAIntelAhci.
15309	</result>
15310
15311	</desc>
15312	<param name="devicePosition" type="long" dir="in"/>
15313	<param name="portNumber" type="long" dir="return"/>
15314	</method>
15315
15316	<method name="setIDEEmulationPort">
15317	<desc>
15318	Sets the port number which is emulated as an IDE device.
15319	Works only with SATA controllers.
15320
15321	<result name="E_INVALIDARG">
15322	The @a devicePosition is not in the range 0 to 3 or the
15323	@a portNumber is not in the range 0 to 29.
15324	</result>
15325	<result name="E_NOTIMPL">
15326	The storage controller type is not SATAIntelAhci.
15327	</result>
15328
15329	</desc>
15330	<param name="devicePosition" type="long" dir="in"/>
15331	<param name="portNumber" type="long" dir="in"/>
15332	</method>
15333
15334	</interface>
15335
15336	<if target="wsdl">
15337
15338	<!--
15339	// IManagedObjectRef
15340	/////////////////////////////////////////////////////////////////////////
15341	-->
15342
15343	<interface
15344	name="IManagedObjectRef" extends="$unknown"
15345	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15346	internal="yes"
15347	wsmap="managed"
15348	wscpp="hardcoded"
15349	>
15350	<desc>
15351	Managed object reference.
15352
15353	Only within the webservice, a managed object reference (which is really
15354	an opaque number) allows a webservice client to address an object
15355	that lives in the address space of the webservice server.
15356
15357	Behind each managed object reference, there is a COM object that lives
15358	in the webservice server's address space. The COM object is not freed
15359	until the managed object reference is released, either by an explicit
15360	call to <link to="IManagedObjectRef::release" /> or by logging off from
15361	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15362	all objects created during the webservice session.
15363
15364	Whenever a method call of the VirtualBox API returns a COM object, the
15365	webservice representation of that method will instead return a
15366	managed object reference, which can then be used to invoke methods
15367	on that object.
15368	</desc>
15369
15370	<method name="getInterfaceName">
15371	<desc>
15372	Returns the name of the interface that this managed object represents,
15373	for example, "IMachine", as a string.
15374	</desc>
15375	<param name="return" type="wstring" dir="return"/>
15376	</method>
15377
15378	<method name="release">
15379	<desc>
15380	Releases this managed object reference and frees the resources that
15381	were allocated for it in the webservice server process. After calling
15382	this method, the identifier of the reference can no longer be used.
15383	</desc>
15384	</method>
15385
15386	</interface>
15387
15388	<!--
15389	// IWebsessionManager
15390	/////////////////////////////////////////////////////////////////////////
15391	-->
15392
15393	<interface
15394	name="IWebsessionManager" extends="$unknown"
15395	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15396	internal="yes"
15397	wsmap="global"
15398	wscpp="hardcoded"
15399	>
15400	<desc>
15401	Websession manager. This provides essential services
15402	to webservice clients.
15403	</desc>
15404	<method name="logon">
15405	<desc>
15406	Logs a new client onto the webservice and returns a managed object reference to
15407	the IVirtualBox instance, which the client can then use as a basis to further
15408	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15409	interface, in one way or the other.
15410	</desc>
15411	<param name="username" type="wstring" dir="in"/>
15412	<param name="password" type="wstring" dir="in"/>
15413	<param name="return" type="IVirtualBox" dir="return"/>
15414	</method>
15415
15416	<method name="getSessionObject">
15417	<desc>
15418	Returns a managed object reference to the internal ISession object that was created
15419	for this web service session when the client logged on.
15420
15421	<see><link to="ISession"/></see>
15422	</desc>
15423	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15424	<param name="return" type="ISession" dir="return"/>
15425	</method>
15426
15427	<method name="logoff">
15428	<desc>
15429	Logs off the client who has previously logged on with <link to="IWebsessionManager::logoff" />
15430	and destroys all resources associated with the session (most importantly, all
15431	managed objects created in the server while the session was active).
15432	</desc>
15433	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15434	</method>
15435
15436	</interface>
15437
15438	</if>
15439
15440	<!--
15441	// IPerformanceCollector & friends
15442	/////////////////////////////////////////////////////////////////////////
15443	-->
15444
15445	<interface
15446	name="IPerformanceMetric" extends="$unknown"
15447	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15448	>
15449	<desc>
15450	The IPerformanceMetric interface represents parameters of the given
15451	performance metric.
15452	</desc>
15453
15454	<attribute name="metricName" type="wstring" readonly="yes">
15455	<desc>
15456	Name of the metric.
15457	</desc>
15458	</attribute>
15459
15460	<attribute name="object" type="$unknown" readonly="yes">
15461	<desc>
15462	Object this metric belongs to.
15463	</desc>
15464	</attribute>
15465
15466	<attribute name="description" type="wstring" readonly="yes">
15467	<desc>
15468	Textual description of the metric.
15469	</desc>
15470	</attribute>
15471
15472	<attribute name="period" type="unsigned long" readonly="yes">
15473	<desc>
15474	Time interval between samples, measured in seconds.
15475	</desc>
15476	</attribute>
15477
15478	<attribute name="count" type="unsigned long" readonly="yes">
15479	<desc>
15480	Number of recent samples retained by the performance collector for this
15481	metric.
15482
15483	When the collected sample count exceeds this number, older samples
15484	are discarded.
15485	</desc>
15486	</attribute>
15487
15488	<attribute name="unit" type="wstring" readonly="yes">
15489	<desc>
15490	Unit of measurement.
15491	</desc>
15492	</attribute>
15493
15494	<attribute name="minimumValue" type="long" readonly="yes">
15495	<desc>
15496	Minimum possible value of this metric.
15497	</desc>
15498	</attribute>
15499
15500	<attribute name="maximumValue" type="long" readonly="yes">
15501	<desc>
15502	Maximum possible value of this metric.
15503	</desc>
15504	</attribute>
15505	</interface>
15506
15507	<interface
15508	name="IPerformanceCollector" extends="$unknown"
15509	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15510	wsmap="managed"
15511	>
15512	<desc>
15513	The IPerformanceCollector interface represents a service that collects
15514	and stores performance metrics data.
15515
15516	Performance metrics are associated with objects of interfaces like IHost
15517	and IMachine. Each object has a distinct set of performance metrics. The
15518	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15519
15520	Metric data is collected at the specified intervals and is retained
15521	internally. The interval and the number of retained samples can be set
15522	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15523	and collection settings are not persistent, they are discarded as soon as
15524	VBoxSVC process terminates. Moreover, metric settings and data associated
15525	with a particular VM only exist while VM is running. They disappear as
15526	soon as VM shuts down. It is not possible to set up metrics for machines
15527	that are powered off. One needs to start VM first, then set up metric
15528	collection parameters.
15529
15530	Metrics are organized hierarchically, with each level separated by a
15531	slash (/) character. Generally, the scheme for metric names is like this:
15532
15533	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15534
15535	"Category/Metric" together form the base metric name. A base metric is
15536	the smallest unit for which a sampling interval and the number of
15537	retained samples can be set. Only base metrics can be enabled and
15538	disabled. All sub-metrics are collected when their base metric is
15539	collected. Collected values for any set of sub-metrics can be queried
15540	with <link to="IPerformanceCollector::queryMetricsData" />.
15541
15542	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15543	category, "Load" metric, "User" submetric, "average" aggregate. An
15544	aggregate function is computed over all retained data. Valid aggregate
15545	functions are:
15546
15547	<ul>
15548	<li>avg -- average</li>
15549	<li>min -- minimum</li>
15550	<li>max -- maximum</li>
15551	</ul>
15552
15553	When setting up metric parameters, querying metric data, enabling or
15554	disabling metrics wildcards can be used in metric names to specify a
15555	subset of metrics. For example, to select all CPU-related metrics
15556	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15557	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15558
15559	The valid names for base metrics are:
15560
15561	<ul>
15562	<li>CPU/Load</li>
15563	<li>CPU/MHz</li>
15564	<li>RAM/Usage</li>
15565	<li>RAM/VMM</li>
15566	</ul>
15567
15568	The general sequence for collecting and retrieving the metrics is:
15569	<ul>
15570	<li>
15571	Obtain an instance of IPerformanceCollector with
15572	<link to="IVirtualBox::performanceCollector" />
15573	</li>
15574	<li>
15575	Allocate and populate an array with references to objects the metrics
15576	will be collected for. Use references to IHost and IMachine objects.
15577	</li>
15578	<li>
15579	Allocate and populate an array with base metric names the data will
15580	be collected for.
15581	</li>
15582	<li>
15583	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15584	the metric data will be collected and stored.
15585	</li>
15586	<li>
15587	Wait for the data to get collected.
15588	</li>
15589	<li>
15590	Allocate and populate an array with references to objects the metric
15591	values will be queried for. You can re-use the object array used for
15592	setting base metrics.
15593	</li>
15594	<li>
15595	Allocate and populate an array with metric names the data will be
15596	collected for. Note that metric names differ from base metric names.
15597	</li>
15598	<li>
15599	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15600	that have been collected so far are returned. Note that the values
15601	are still retained internally and data collection continues.
15602	</li>
15603	</ul>
15604
15605	For an example of usage refer to the following files in VirtualBox SDK:
15606	<ul>
15607	<li>
15608	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15609	</li>
15610	<li>
15611	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15612	</li>
15613	</ul>
15614	</desc>
15615
15616	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15617	<desc>
15618	Array of unique names of metrics.
15619
15620	This array represents all metrics supported by the performance
15621	collector. Individual objects do not necessarily support all of them.
15622	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15623	list of supported metrics for a particular object.
15624	</desc>
15625	</attribute>
15626
15627	<method name="getMetrics">
15628	<desc>
15629	Returns parameters of specified metrics for a set of objects.
15630	<note>
15631	@c Null metrics array means all metrics. @c Null object array means
15632	all existing objects.
15633	</note>
15634	</desc>
15635	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15636	<desc>
15637	Metric name filter. Currently, only a comma-separated list of metrics
15638	is supported.
15639	</desc>
15640	</param>
15641	<param name="objects" type="$unknown" dir="in" safearray="yes">
15642	<desc>
15643	Set of objects to return metric parameters for.
15644	</desc>
15645	</param>
15646	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15647	<desc>
15648	Array of returned metric parameters.
15649	</desc>
15650	</param>
15651	</method>
15652
15653	<method name="setupMetrics">
15654	<desc>
15655	Sets parameters of specified base metrics for a set of objects. Returns
15656	an array of <link to="IPerformanceMetric" /> describing the metrics
15657	have been affected.
15658	<note>
15659	@c Null or empty metric name array means all metrics. @c Null or
15660	empty object array means all existing objects. If metric name array
15661	contains a single element and object array contains many, the single
15662	metric name array element is applied to each object array element to
15663	form metric/object pairs.
15664	</note>
15665	</desc>
15666	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15667	<desc>
15668	Metric name filter. Comma-separated list of metrics with wildcard
15669	support.
15670	</desc>
15671	</param>
15672	<param name="objects" type="$unknown" dir="in" safearray="yes">
15673	<desc>
15674	Set of objects to setup metric parameters for.
15675	</desc>
15676	</param>
15677	<param name="period" type="unsigned long" dir="in">
15678	<desc>
15679	Time interval in seconds between two consecutive samples of
15680	performance data.
15681	</desc>
15682	</param>
15683	<param name="count" type="unsigned long" dir="in">
15684	<desc>
15685	Number of samples to retain in performance data history. Older
15686	samples get discarded.
15687	</desc>
15688	</param>
15689	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15690	<desc>
15691	Array of metrics that have been modified by the call to this method.
15692	</desc>
15693	</param>
15694	</method>
15695
15696	<method name="enableMetrics">
15697	<desc>
15698	Turns on collecting specified base metrics. Returns an array of
15699	<link to="IPerformanceMetric" /> describing the metrics have been
15700	affected.
15701	<note>
15702	@c Null or empty metric name array means all metrics. @c Null or
15703	empty object array means all existing objects. If metric name array
15704	contains a single element and object array contains many, the single
15705	metric name array element is applied to each object array element to
15706	form metric/object pairs.
15707	</note>
15708	</desc>
15709	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15710	<desc>
15711	Metric name filter. Comma-separated list of metrics with wildcard
15712	support.
15713	</desc>
15714	</param>
15715	<param name="objects" type="$unknown" dir="in" safearray="yes">
15716	<desc>
15717	Set of objects to enable metrics for.
15718	</desc>
15719	</param>
15720	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15721	<desc>
15722	Array of metrics that have been modified by the call to this method.
15723	</desc>
15724	</param>
15725	</method>
15726
15727	<method name="disableMetrics">
15728	<desc>
15729	Turns off collecting specified base metrics. Returns an array of
15730	<link to="IPerformanceMetric" /> describing the metrics have been
15731	affected.
15732	<note>
15733	@c Null or empty metric name array means all metrics. @c Null or
15734	empty object array means all existing objects. If metric name array
15735	contains a single element and object array contains many, the single
15736	metric name array element is applied to each object array element to
15737	form metric/object pairs.
15738	</note>
15739	</desc>
15740	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15741	<desc>
15742	Metric name filter. Comma-separated list of metrics with wildcard
15743	support.
15744	</desc>
15745	</param>
15746	<param name="objects" type="$unknown" dir="in" safearray="yes">
15747	<desc>
15748	Set of objects to disable metrics for.
15749	</desc>
15750	</param>
15751	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15752	<desc>
15753	Array of metrics that have been modified by the call to this method.
15754	</desc>
15755	</param>
15756	</method>
15757
15758	<method name="queryMetricsData">
15759	<desc>
15760	Queries collected metrics data for a set of objects.
15761
15762	The data itself and related metric information are returned in seven
15763	parallel and one flattened array of arrays. Elements of
15764	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15765	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15766	the same index describe one set of values corresponding to a single
15767	metric.
15768
15769	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15770	start and length of a sub-array is indicated by
15771	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15772	value for metric <tt>metricNames[i]</tt> is at
15773	<tt>returnData[returnIndices[i]]</tt>.
15774
15775	<note>
15776	@c Null or empty metric name array means all metrics. @c Null or
15777	empty object array means all existing objects. If metric name array
15778	contains a single element and object array contains many, the single
15779	metric name array element is applied to each object array element to
15780	form metric/object pairs.
15781	</note>
15782	<note>
15783	Data collection continues behind the scenes after call to @c
15784	queryMetricsData. The return data can be seen as the snapshot of the
15785	current state at the time of @c queryMetricsData call. The internally
15786	kept metric values are not cleared by the call. This makes possible
15787	querying different subsets of metrics or aggregates with subsequent
15788	calls. If periodic querying is needed it is highly suggested to query
15789	the values with @c interval*count period to avoid confusion. This way
15790	a completely new set of data values will be provided by each query.
15791	</note>
15792	</desc>
15793	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15794	<desc>
15795	Metric name filter. Comma-separated list of metrics with wildcard
15796	support.
15797	</desc>
15798	</param>
15799	<param name="objects" type="$unknown" dir="in" safearray="yes">
15800	<desc>
15801	Set of objects to query metrics for.
15802	</desc>
15803	</param>
15804	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15805	<desc>
15806	Names of metrics returned in @c returnData.
15807	</desc>
15808	</param>
15809	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15810	<desc>
15811	Objects associated with metrics returned in @c returnData.
15812	</desc>
15813	</param>
15814	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15815	<desc>
15816	Units of measurement for each returned metric.
15817	</desc>
15818	</param>
15819	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15820	<desc>
15821	Divisor that should be applied to return values in order to get
15822	floating point values. For example:
15823	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15824	will retrieve the floating point value of i-th sample of the first
15825	metric.
15826	</desc>
15827	</param>
15828	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15829	<desc>
15830	Sequence numbers of the first elements of value sequences of
15831	particular metrics returned in @c returnData. For aggregate metrics
15832	it is the sequence number of the sample the aggregate started
15833	calculation from.
15834	</desc>
15835	</param>
15836	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15837	<desc>
15838	Indices of the first elements of value sequences of particular
15839	metrics returned in @c returnData.
15840	</desc>
15841	</param>
15842	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15843	<desc>
15844	Lengths of value sequences of particular metrics.
15845	</desc>
15846	</param>
15847	<param name="returnData" type="long" dir="return" safearray="yes">
15848	<desc>
15849	Flattened array of all metric data containing sequences of values for
15850	each metric.
15851	</desc>
15852	</param>
15853	</method>
15854
15855	</interface>
15856
15857	<enum
15858	name="NATAliasMode"
15859	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15860	>
15861	<desc></desc>
15862	<const name="AliasLog" value="0x1">
15863	<desc></desc>
15864	</const>
15865	<const name="AliasProxyOnly" value="0x02">
15866	<desc></desc>
15867	</const>
15868	<const name="AliasUseSamePorts" value="0x04">
15869	<desc></desc>
15870	</const>
15871	</enum>
15872
15873	<enum
15874	name="NATProtocol"
15875	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15876	>
15877	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15878	<const name="UDP" value="0">
15879	<desc>Port-forwarding uses UDP protocol.</desc>
15880	</const>
15881	<const name="TCP" value="1">
15882	<desc>Port-forwarding uses TCP protocol.</desc>
15883	</const>
15884	</enum>
15885
15886	<interface
15887	name="INATEngine" extends="$unknown"
15888	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
15889	wsmap="managed"
15890	>
15891	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
15892	allows for changing NAT behavior such as port-forwarding rules. This interface is
15893	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
15894	<attribute name="network" type="wstring">
15895	<desc>The network attribute of the NAT engine (the same value is used with built-in
15896	DHCP server to fill corresponding fields of DHCP leases).</desc>
15897	</attribute>
15898	<attribute name="hostIP" type="wstring">
15899	<desc>IP of host interface to bind all opened sockets to.
15900	<note>Changing this does not change binding of port forwarding.</note>
15901	</desc>
15902	</attribute>
15903	<attribute name="tftpPrefix" type="wstring">
15904	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
15905	the corresponding fields of DHCP leases.</desc>
15906	</attribute>
15907	<attribute name="tftpBootFile" type="wstring">
15908	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
15909	the corresponding fields of DHCP leases.</desc>
15910	</attribute>
15911	<attribute name="tftpNextServer" type="wstring">
15912	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
15913	the corresponding fields of DHCP leases.
15914	<note>The preferred form is IPv4 addresses.</note>
15915	</desc>
15916	</attribute>
15917	<attribute name="aliasMode" type="unsigned long">
15918	<desc></desc>
15919	</attribute>
15920	<attribute name="dnsPassDomain" type="boolean">
15921	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
15922	</attribute>
15923	<attribute name="dnsProxy" type="boolean">
15924	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15925	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
15926	</attribute>
15927	<attribute name="dnsUseHostResolver" type="boolean">
15928	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
15929	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
15930	</attribute>
15931	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
15932	<desc>Array of NAT port-forwarding rules in string representation, in the following
15933	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
15934	</attribute>
15935	<method name="setNetworkSettings">
15936	<desc>Sets network configuration of the NAT engine.</desc>
15937	<param name="mtu" type="unsigned long" dir="in">
15938	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
15939	</param>
15940	<param name="sockSnd" type="unsigned long" dir="in">
15941	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
15942	</param>
15943	<param name="sockRcv" type="unsigned long" dir="in">
15944	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
15945	</param>
15946	<param name="TcpWndSnd" type="unsigned long" dir="in">
15947	<desc>Initial size of the NAT engine's sending TCP window in bytes when
15948	establishing a new TCP connection.</desc>
15949	</param>
15950	<param name="TcpWndRcv" type="unsigned long" dir="in">
15951	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
15952	establishing a new TCP connection.</desc>
15953	</param>
15954	</method>
15955	<method name="getNetworkSettings">
15956	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
15957	for parameter descriptions.</desc>
15958	<param name="mtu" type="unsigned long" dir="out" />
15959	<param name="sockSnd" type="unsigned long" dir="out" />
15960	<param name="sockRcv" type="unsigned long" dir="out" />
15961	<param name="TcpWndSnd" type="unsigned long" dir="out" />
15962	<param name="TcpWndRcv" type="unsigned long" dir="out" />
15963	</method>
15964	<method name="addRedirect">
15965	<desc>Adds a new NAT port-forwarding rule.</desc>
15966	<param name="name" type="wstring" dir="in">
15967	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
15968	auto-generates one using the other parameters.</desc>
15969	</param>
15970	<param name="proto" type="NATProtocol" dir="in">
15971	<desc>Protocol handled with the rule.</desc>
15972	</param>
15973	<param name="hostIp" type="wstring" dir="in">
15974	<desc>IP of the host interface to which the rule should apply. An empty ip address is
15975	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
15976	</param>
15977	<param name="hostPort" type="unsigned short" dir="in">
15978	<desc>The port number to listen on.</desc>
15979	</param>
15980	<param name="guestIp" type="wstring" dir="in">
15981	<desc>The IP address of the guest which the NAT engine will forward matching packets
15982	to. An empty IP address is acceptable, in which case the NAT engine will forward
15983	packets to the first DHCP lease (x.x.x.15).</desc>
15984	</param>
15985	<param name="guestPort" type="unsigned short" dir="in">
15986	<desc>The port number to forward.</desc>
15987	</param>
15988	</method>
15989	<method name="removeRedirect">
15990	<desc>Removes a port-forwarding rule that was previously registered.</desc>
15991	<param name="name" type="wstring" dir="in">
15992	<desc>The name of the rule to delete.</desc>
15993	</param>
15994	</method>
15995	</interface>
15996
15997	<!--
15998	// IExtPackManager
15999	/////////////////////////////////////////////////////////////////////////
16000	-->
16001
16002	<interface
16003	name="IExtPackPlugIn" extends="$unknown"
16004	uuid="58000040-e718-4746-bbce-4b86d96da461"
16005	wsmap="suppress"
16006	>
16007	<desc>
16008	Interface for keeping information about a plug-in that ships with an
16009	extension pack.
16010	</desc>
16011	<attribute name="name" type="wstring" readonly="yes">
16012	<desc>The plug-in name.</desc>
16013	</attribute>
16014	<attribute name="description" type="wstring" readonly="yes">
16015	<desc>The plug-in description.</desc>
16016	</attribute>
16017	<attribute name="frontend" type="wstring" readonly="yes">
16018	<desc>
16019	The name of the frontend or component name this plug-in plugs into.
16020	</desc>
16021	</attribute>
16022	<attribute name="modulePath" type="wstring" readonly="yes">
16023	<desc> The module path. </desc>
16024	</attribute>
16025	</interface>
16026
16027	<interface
16028	name="IExtPackBase" extends="$unknown"
16029	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16030	wsmap="suppress"
16031	>
16032	<desc>
16033	Interface for querying information about an extension pack as well as
16034	accessing COM objects within it.
16035	</desc>
16036	<attribute name="name" type="wstring" readonly="yes">
16037	<desc>The extension pack name. This is unique.</desc>
16038	</attribute>
16039	<attribute name="description" type="wstring" readonly="yes">
16040	<desc>The extension pack description.</desc>
16041	</attribute>
16042	<attribute name="version" type="wstring" readonly="yes">
16043	<desc>
16044	The extension pack version string. This is restricted to the dotted
16045	version number and optionally a build indicator. No tree revision or
16046	tag will be included in the string as those things are available as
16047	separate properties. An optional publisher tag may be present like for
16048	<link to="IVirtualBox::version"/>.
16049
16050	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16051	</desc>
16052	</attribute>
16053	<attribute name="revision" type="unsigned long" readonly="yes">
16054	<desc>The extension pack internal revision number.</desc>
16055	</attribute>
16056	<attribute name="edition" type="wstring" readonly="yes">
16057	<desc>
16058	Edition indicator. This is usually empty.
16059
16060	Can for instance be used to help distinguishing between two editions
16061	of the same extension pack where only the license, service contract or
16062	something differs.
16063	</desc>
16064	</attribute>
16065	<attribute name="VRDEModule" type="wstring" readonly="yes">
16066	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16067	</attribute>
16068	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16069	<desc>Plug-ins provided by this extension pack.</desc>
16070	</attribute>
16071	<attribute name="usable" type="boolean" readonly="yes">
16072	<desc>
16073	Indicates whether the extension pack is usable or not.
16074
16075	There are a number of reasons why an extension pack might be unusable,
16076	typical examples would be broken installation/file or that it is
16077	incompatible with the current VirtualBox version.
16078	</desc>
16079	</attribute>
16080	<attribute name="whyUnusable" type="wstring" readonly="yes">
16081	<desc>
16082	String indicating why the extension pack is not usable. This is an
16083	empty string if usable and always a non-empty string if not usable.
16084	</desc>
16085	</attribute>
16086	<attribute name="showLicense" type="boolean" readonly="yes">
16087	<desc>Whether to show the license before installation</desc>
16088	</attribute>
16089	<attribute name="license" type="wstring" readonly="yes">
16090	<desc>
16091	The default HTML license text for the extension pack. Same as
16092	calling <link to="#queryLicense">queryLicense</link> with
16093	preferredLocale and preferredLanguage as empty strings and format set
16094	to html.
16095	</desc>
16096	</attribute>
16097
16098	<method name="queryLicense">
16099	<desc>
16100	Full feature version of the license attribute.
16101	</desc>
16102	<param name="preferredLocale" type="wstring" dir="in">
16103	<desc>
16104	The preferred license locale. Pass an empty string to get the default
16105	license.
16106	</desc>
16107	</param>
16108	<param name="preferredLanguage" type="wstring" dir="in">
16109	<desc>
16110	The preferred license language. Pass an empty string to get the
16111	default language for the locale.
16112	</desc>
16113	</param>
16114	<param name="format" type="wstring" dir="in">
16115	<desc>
16116	The license format: html, rtf or txt. If a license is present there
16117	will always be an HTML of it, the rich text format (RTF) and plain
16118	text (txt) versions are optional. If
16119	</desc>
16120	</param>
16121	<param name="licenseText" type="wstring" dir="return">
16122	<desc>The license text.</desc>
16123	</param>
16124	</method>
16125
16126	</interface>
16127
16128	<interface
16129	name="IExtPack" extends="IExtPackBase"
16130	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16131	wsmap="suppress"
16132	>
16133	<desc>
16134	Interface for querying information about an extension pack as well as
16135	accessing COM objects within it.
16136	</desc>
16137	<method name="queryObject">
16138	<desc>
16139	Queries the IUnknown interface to an object in the extension pack
16140	main module. This allows plug-ins and others to talk directly to an
16141	extension pack.
16142	</desc>
16143	<param name="objUuid" type="wstring" dir="in">
16144	<desc>The object ID. What exactly this is </desc>
16145	</param>
16146	<param name="returnInterface" type="$unknown" dir="return">
16147	<desc>The queried interface.</desc>
16148	</param>
16149	</method>
16150	</interface>
16151
16152	<interface
16153	name="IExtPackFile" extends="IExtPackBase"
16154	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16155	wsmap="suppress"
16156	>
16157	<desc>
16158	Extension pack file (aka tarball, .vbox-extpack) representation returned
16159	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16160	extension pack information with the addition of the file name.
16161	</desc>
16162	<attribute name="filePath" type="wstring" readonly="yes">
16163	<desc>
16164	The path to the extension pack file.
16165	</desc>
16166	</attribute>
16167
16168	<method name="install">
16169	<desc>
16170	Install the extension pack.
16171	</desc>
16172	<param name="replace" type="boolean" dir="in">
16173	<desc>
16174	Set this to automatically uninstall any existing extension pack with
16175	the same name as the one being installed.
16176	</desc>
16177	</param>
16178	<param name="displayInfo" type="wstring" dir="in">
16179	<desc>
16180	Platform specific display information. Reserved for future hacks.
16181	</desc>
16182	</param>
16183	<param name="progess" type="IProgress" dir="return">
16184	<desc>
16185	Progress object for the operation.
16186	</desc>
16187	</param>
16188	</method>
16189	</interface>
16190
16191	<interface
16192	name="IExtPackManager" extends="$unknown"
16193	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16194	wsmap="suppress"
16195	>
16196	<desc>
16197	Interface for managing VirtualBox Extension Packs.
16198
16199	TODO: Describe extension packs, how they are managed and how to create
16200	one.
16201	</desc>
16202
16203	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16204	<desc>
16205	List of the installed extension packs.
16206	</desc>
16207	</attribute>
16208
16209	<method name="find">
16210	<desc>
16211	Returns the extension pack with the specified name if found.
16212
16213	<result name="VBOX_E_OBJECT_NOT_FOUND">
16214	No extension pack matching @a name was found.
16215	</result>
16216	</desc>
16217	<param name="name" type="wstring" dir="in">
16218	<desc>The name of the extension pack to locate.</desc>
16219	</param>
16220	<param name="returnData" type="IExtPack" dir="return">
16221	<desc>The extension pack if found.</desc>
16222	</param>
16223	</method>
16224
16225	<method name="openExtPackFile">
16226	<desc>
16227	Attempts to open an extension pack file in preparation for
16228	installation.
16229	</desc>
16230	<param name="path" type="wstring" dir="in">
16231	<desc>The path of the extension pack tarball. This can optionally be
16232	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16233	</param>
16234	<param name="file" type="IExtPackFile" dir="return">
16235	<desc>The interface of the extension pack file object.</desc>
16236	</param>
16237	</method>
16238
16239	<method name="uninstall">
16240	<desc>Uninstalls an extension pack, removing all related files.</desc>
16241	<param name="name" type="wstring" dir="in">
16242	<desc>The name of the extension pack to uninstall.</desc>
16243	</param>
16244	<param name="forcedRemoval" type="boolean" dir="in">
16245	<desc>
16246	Forced removal of the extension pack. This means that the uninstall
16247	hook will not be called.
16248	</desc>
16249	</param>
16250	<param name="displayInfo" type="wstring" dir="in">
16251	<desc>
16252	Platform specific display information. Reserved for future hacks.
16253	</desc>
16254	</param>
16255	<param name="progess" type="IProgress" dir="return">
16256	<desc>
16257	Progress object for the operation.
16258	</desc>
16259	</param>
16260	</method>
16261
16262	<method name="cleanup">
16263	<desc>Cleans up failed installs and uninstalls</desc>
16264	</method>
16265
16266	<method name="queryAllPlugInsForFrontend">
16267	<desc>
16268	Gets the path to all the plug-in modules for a given frontend.
16269
16270	This is a convenience method that is intended to simplify the plug-in
16271	loading process for a frontend.
16272	</desc>
16273	<param name="frontendName" type="wstring" dir="in">
16274	<desc>The name of the frontend or component.</desc>
16275	</param>
16276	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16277	<desc>Array containing the plug-in modules (full paths).</desc>
16278	</param>
16279	</method>
16280
16281	<method name="isExtPackUsable">
16282	<desc>Check if the given extension pack is loaded and usable.</desc>
16283	<param name="name" type="wstring" dir="in">
16284	<desc>The name of the extension pack to check for.</desc>
16285	</param>
16286	<param name="usable" type="boolean" dir="return">
16287	<desc>Is the given extension pack loaded and usable.</desc>
16288	</param>
16289	</method>
16290
16291	</interface>
16292
16293	<!--
16294	// BandwidthGroupType
16295	/////////////////////////////////////////////////////////////////////////
16296	-->
16297	<enum
16298	name="BandwidthGroupType"
16299	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16300
16301	<desc>
16302	Type of a bandwidth control group.
16303	</desc>
16304
16305	<const name="Null" value="0">
16306	<desc>
16307	Null type, must be first.
16308	</desc>
16309	</const>
16310
16311	<const name="Disk" value="1">
16312	<desc>
16313	The bandwidth group controls disk I/O.
16314	</desc>
16315	</const>
16316
16317	<const name="Network" value="2">
16318	<desc>
16319	The bandwidth group controls network I/O.
16320	</desc>
16321	</const>
16322
16323	</enum>
16324
16325	<!--
16326	// IBandwidthGroup
16327	/////////////////////////////////////////////////////////////////////////
16328	-->
16329	<interface
16330	name="IBandwidthGroup" extends="$unknown"
16331	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16332	wsmap="managed"
16333	>
16334	<desc>Represents one bandwidth group.</desc>
16335
16336	<attribute name="name" type="wstring" readonly="yes">
16337	<desc>Name of the group.</desc>
16338	</attribute>
16339
16340	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16341	<desc>Type of the group.</desc>
16342	</attribute>
16343
16344	<attribute name="reference" type="unsigned long" readonly="yes">
16345	<desc>How many devices/medium attachements use this group.</desc>
16346	</attribute>
16347
16348	<attribute name="maxMbPerSec" type="unsigned long">
16349	<desc>The maximum number of MBytes which can be transfered by all
16350	entities attached to this group during one second.</desc>
16351	</attribute>
16352
16353	</interface>
16354
16355	<!--
16356	// IBandwidthControl
16357	/////////////////////////////////////////////////////////////////////////
16358	-->
16359	<interface
16360	name="IBandwidthControl" extends="$unknown"
16361	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16362	wsmap="managed"
16363	>
16364	<desc>
16365	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16366	This includes network and disk I/O.
16367	</desc>
16368
16369	<attribute name="numGroups" type="unsigned long" readonly="yes">
16370	<desc>
16371	The current number of existing bandwidth groups managed.
16372	</desc>
16373	</attribute>
16374
16375	<method name="createBandwidthGroup">
16376	<desc>
16377	Creates a new bandwidth group.
16378	</desc>
16379
16380	<param name="name" type="wstring" dir="in">
16381	<desc>Name of the bandwidth group.</desc>
16382	</param>
16383	<param name="type" type="BandwidthGroupType" dir="in">
16384	<desc>The type of the bandwidth group (network or disk).</desc>
16385	</param>
16386	<param name="maxMbPerSec" type="unsigned long" dir="in">
16387	<desc>The maximum number of MBytes which can be transfered by all
16388	entities attached to this group during one second.</desc>
16389	</param>
16390	</method>
16391
16392	<method name="deleteBandwidthGroup">
16393	<desc>
16394	Deletes a new bandwidth group.
16395	</desc>
16396
16397	<param name="name" type="wstring" dir="in">
16398	<desc>Name of the bandwidth group to delete.</desc>
16399	</param>
16400	</method>
16401
16402	<method name="getBandwidthGroup" const="yes">
16403	<desc>
16404	Get a bandwidth group by name.
16405	</desc>
16406
16407	<param name="name" type="wstring" dir="in">
16408	<desc>Name of the bandwidth group to get.</desc>
16409	</param>
16410	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16411	<desc>Where to store the bandwidth group on success.</desc>
16412	</param>
16413	</method>
16414
16415	<method name="getAllBandwidthGroups" const="yes">
16416	<desc>
16417	Get all managed bandwidth groups.
16418	</desc>
16419
16420	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16421	<desc>The array of managed bandwidth groups.</desc>
16422	</param>
16423	</method>
16424	</interface>
16425
16426	<!--
16427	// IVirtualBoxClient
16428	/////////////////////////////////////////////////////////////////////////
16429	-->
16430
16431	<interface
16432	name="IVirtualBoxClient" extends="$unknown"
16433	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16434	wsmap="suppress"
16435	>
16436	<desc>
16437	Convenience interface for client applications. Treat this as a
16438	singleton, i.e. never create more than one instance of this interface.
16439
16440	At the moment only available for clients of the local API (not usable
16441	via the webservice). Once the session logic is redesigned this might
16442	change.
16443	</desc>
16444
16445	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16446	<desc>
16447	Reference to the server-side API root object.
16448	</desc>
16449	</attribute>
16450
16451	<attribute name="session" type="ISession" readonly="yes">
16452	<desc>
16453	Create a new session object and return the reference to it.
16454	</desc>
16455	</attribute>
16456
16457	<attribute name="eventSource" type="IEventSource" readonly="yes">
16458	<desc>
16459	Event source for VirtualBoxClient events.
16460	</desc>
16461	</attribute>
16462
16463	</interface>
16464
16465	<!--
16466	// Events
16467	/////////////////////////////////////////////////////////////////////////
16468	-->
16469	<enum
16470	name="VBoxEventType"
16471	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16472	>
16473
16474	<desc>
16475	Type of an event.
16476	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16477	</desc>
16478
16479	<const name="Invalid" value="0">
16480	<desc>
16481	Invalid event, must be first.
16482	</desc>
16483	</const>
16484
16485	<const name="Any" value="1">
16486	<desc>
16487	Wildcard for all events.
16488	Events of this type are never delivered, and only used in
16489	<link to="IEventSource::registerListener"/> call to simplify registration.
16490	</desc>
16491	</const>
16492
16493	<const name="Vetoable" value="2">
16494	<desc>
16495	Wildcard for all vetoable events. Events of this type are never delivered, and only
16496	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16497	</desc>
16498	</const>
16499
16500	<const name="MachineEvent" value="3">
16501	<desc>
16502	Wildcard for all machine events. Events of this type are never delivered, and only used in
16503	<link to="IEventSource::registerListener"/> call to simplify registration.
16504	</desc>
16505	</const>
16506
16507	<const name="SnapshotEvent" value="4">
16508	<desc>
16509	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16510	<link to="IEventSource::registerListener"/> call to simplify registration.
16511	</desc>
16512	</const>
16513
16514	<const name="InputEvent" value="5">
16515	<desc>
16516	Wildcard for all input device (keyboard, mouse) events.
16517	Events of this type are never delivered, and only used in
16518	<link to="IEventSource::registerListener"/> call to simplify registration.
16519	</desc>
16520	</const>
16521
16522	<const name="LastWildcard" value="31">
16523	<desc>
16524	Last wildcard.
16525	</desc>
16526	</const>
16527
16528	<const name="OnMachineStateChanged" value="32">
16529	<desc>
16530	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16531	</desc>
16532	</const>
16533	<const name="OnMachineDataChanged" value="33">
16534	<desc>
16535	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16536	</desc>
16537	</const>
16538	<const name="OnExtraDataChanged" value="34">
16539	<desc>
16540	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16541	</desc>
16542	</const>
16543	<const name="OnExtraDataCanChange" value="35">
16544	<desc>
16545	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16546	</desc>
16547	</const>
16548	<const name="OnMediumRegistered" value="36">
16549	<desc>
16550	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16551	</desc>
16552	</const>
16553	<const name="OnMachineRegistered" value="37">
16554	<desc>
16555	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16556	</desc>
16557	</const>
16558	<const name="OnSessionStateChanged" value="38">
16559	<desc>
16560	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16561	</desc>
16562	</const>
16563	<const name="OnSnapshotTaken" value="39">
16564	<desc>
16565	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16566	</desc>
16567	</const>
16568	<const name="OnSnapshotDeleted" value="40">
16569	<desc>
16570	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16571	</desc>
16572	</const>
16573	<const name="OnSnapshotChanged" value="41">
16574	<desc>
16575	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16576	</desc>
16577	</const>
16578	<const name="OnGuestPropertyChanged" value="42">
16579	<desc>
16580	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16581	</desc>
16582	</const>
16583	<!-- Console events -->
16584	<const name="OnMousePointerShapeChanged" value="43">
16585	<desc>
16586	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16587	</desc>
16588	</const>
16589	<const name="OnMouseCapabilityChanged" value="44">
16590	<desc>
16591	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16592	</desc>
16593	</const>
16594	<const name="OnKeyboardLedsChanged" value="45">
16595	<desc>
16596	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16597	</desc>
16598	</const>
16599	<const name="OnStateChanged" value="46">
16600	<desc>
16601	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16602	</desc>
16603	</const>
16604	<const name="OnAdditionsStateChanged" value="47">
16605	<desc>
16606	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16607	</desc>
16608	</const>
16609	<const name="OnNetworkAdapterChanged" value="48">
16610	<desc>
16611	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16612	</desc>
16613	</const>
16614	<const name="OnSerialPortChanged" value="49">
16615	<desc>
16616	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16617	</desc>
16618	</const>
16619	<const name="OnParallelPortChanged" value="50">
16620	<desc>
16621	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16622	</desc>
16623	</const>
16624	<const name="OnStorageControllerChanged" value="51">
16625	<desc>
16626	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16627	</desc>
16628	</const>
16629	<const name="OnMediumChanged" value="52">
16630	<desc>
16631	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16632	</desc>
16633	</const>
16634	<const name="OnVRDEServerChanged" value="53">
16635	<desc>
16636	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16637	</desc>
16638	</const>
16639	<const name="OnUSBControllerChanged" value="54">
16640	<desc>
16641	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16642	</desc>
16643	</const>
16644	<const name="OnUSBDeviceStateChanged" value="55">
16645	<desc>
16646	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16647	</desc>
16648	</const>
16649	<const name="OnSharedFolderChanged" value="56">
16650	<desc>
16651	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16652	</desc>
16653	</const>
16654	<const name="OnRuntimeError" value="57">
16655	<desc>
16656	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16657	</desc>
16658	</const>
16659	<const name="OnCanShowWindow" value="58">
16660	<desc>
16661	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16662	</desc>
16663	</const>
16664	<const name="OnShowWindow" value="59">
16665	<desc>
16666	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16667	</desc>
16668	</const>
16669	<const name="OnCPUChanged" value="60">
16670	<desc>
16671	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16672	</desc>
16673	</const>
16674	<const name="OnVRDEServerInfoChanged" value="61">
16675	<desc>
16676	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16677	</desc>
16678	</const>
16679	<const name="OnEventSourceChanged" value="62">
16680	<desc>
16681	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16682	</desc>
16683	</const>
16684	<const name="OnCPUExecutionCapChanged" value="63">
16685	<desc>
16686	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16687	</desc>
16688	</const>
16689	<const name="OnGuestKeyboard" value="64">
16690	<desc>
16691	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16692	</desc>
16693	</const>
16694	<const name="OnGuestMouse" value="65">
16695	<desc>
16696	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16697	</desc>
16698	</const>
16699	<const name="OnNATRedirect" value="66">
16700	<desc>
16701	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16702	</desc>
16703	</const>
16704	<const name="OnHostPciDevicePlug" value="67">
16705	<desc>
16706	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16707	</desc>
16708	</const>
16709	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16710	<desc>
16711	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16712	</desc>
16713	</const>
16714	<const name="OnBandwidthGroupChanged" value="69">
16715	<desc>
16716	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16717	</desc>
16718	</const>
16719	<const name="OnGuestMonitorChanged" value="70">
16720	<desc>
16721	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16722	</desc>
16723	</const>
16724	<const name="OnStorageDeviceChanged" value="71">
16725	<desc>
16726	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16727	</desc>
16728	</const>
16729
16730	<!-- Last event marker -->
16731	<const name="Last" value="72">
16732	<desc>
16733	Must be last event, used for iterations and structures relying on numerical event values.
16734	</desc>
16735	</const>
16736
16737	</enum>
16738
16739	<interface
16740	name="IEventSource" extends="$unknown"
16741	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16742	wsmap="managed"
16743	>
16744	<desc>
16745	Event source. Generally, any object which could generate events can be an event source,
16746	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16747	an event source can work with listeners in either active or passive mode. In active mode it is up to
16748	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16749	event source keeps track of pending events for each listener and returns available events on demand.
16750
16751	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16752	</desc>
16753
16754	<method name="createListener">
16755	<desc>
16756	Creates a new listener object, useful for passive mode.
16757	</desc>
16758	<param name="listener" type="IEventListener" dir="return"/>
16759	</method>
16760
16761	<method name="createAggregator">
16762	<desc>
16763	Creates an aggregator event source, collecting events from multiple sources.
16764	This way a single listener can listen for events coming from multiple sources,
16765	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16766	</desc>
16767	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16768	<desc>
16769	Subordinate event source this one aggregatres.
16770	</desc>
16771	</param>
16772	<param name="result" type="IEventSource" dir="return">
16773	<desc>
16774	Event source aggregating passed sources.
16775	</desc>
16776	</param>
16777	</method>
16778
16779	<method name="registerListener">
16780	<desc>
16781	Register an event listener.
16782
16783	<note>
16784	To avoid system overload, the VirtualBox server process checks if passive event
16785	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16786	current implementation, if more than 500 pending events are detected for a passive
16787	event listener, it is forcefully unregistered by the system, and further
16788	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16789	</note>
16790	</desc>
16791	<param name="listener" type="IEventListener" dir="in">
16792	<desc>Listener to register.</desc>
16793	</param>
16794	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16795	<desc>
16796	Event types listener is interested in. One can use wildcards like -
16797	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16798	than one event.
16799	</desc>
16800	</param>
16801	<param name="active" type="boolean" dir="in">
16802	<desc>
16803	Which mode this listener is operating in.
16804	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16805	In passive mode, an internal event queue is created for this this IEventListener.
16806	For each event coming in, it is added to queues for all interested registered passive
16807	listeners. It is then up to the external code to call the listener's
16808	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16809	external code must call <link to="#eventProcessed" />.
16810	</desc>
16811	</param>
16812	</method>
16813
16814	<method name="unregisterListener">
16815	<desc>
16816	Unregister an event listener. If listener is passive, and some waitable events are still
16817	in queue they are marked as processed automatically.
16818	</desc>
16819	<param name="listener" type="IEventListener" dir="in">
16820	<desc>Listener to unregister.</desc>
16821	</param>
16822	</method>
16823
16824	<method name="fireEvent">
16825	<desc>
16826	Fire an event for this source.
16827	</desc>
16828	<param name="event" type="IEvent" dir="in">
16829	<desc>Event to deliver.</desc>
16830	</param>
16831	<param name="timeout" type="long" dir="in">
16832	<desc>
16833	Maximum time to wait for event processing (if event is waitable), in ms;
16834	0 = no wait, -1 = indefinite wait.
16835	</desc>
16836	</param>
16837	<param name="result" type="boolean" dir="return">
16838	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16839	</param>
16840	</method>
16841
16842	<method name="getEvent">
16843	<desc>
16844	Get events from this peer's event queue (for passive mode). Calling this method
16845	regularly is required for passive event listeners to avoid system overload;
16846	see <link to="IEventSource::registerListener" /> for details.
16847
16848	<result name="VBOX_E_OBJECT_NOT_FOUND">
16849	Listener is not registered, or autounregistered.
16850	</result>
16851	</desc>
16852	<param name="listener" type="IEventListener" dir="in">
16853	<desc>Which listener to get data for.</desc>
16854	</param>
16855	<param name="timeout" type="long" dir="in">
16856	<desc>
16857	Maximum time to wait for events, in ms;
16858	0 = no wait, -1 = indefinite wait.
16859	</desc>
16860	</param>
16861	<param name="event" type="IEvent" dir="return">
16862	<desc>Event retrieved, or null if none available.</desc>
16863	</param>
16864	</method>
16865
16866	<method name="eventProcessed">
16867	<desc>
16868	Must be called for waitable events after a particular listener finished its
16869	event processing. When all listeners of a particular event have called this
16870	method, the system will then call <link to="IEvent::setProcessed" />.
16871	</desc>
16872	<param name="listener" type="IEventListener" dir="in">
16873	<desc>Which listener processed event.</desc>
16874	</param>
16875	<param name="event" type="IEvent" dir="in">
16876	<desc>Which event.</desc>
16877	</param>
16878	</method>
16879
16880	</interface>
16881
16882	<interface
16883	name="IEventListener" extends="$unknown"
16884	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
16885	wsmap="managed"
16886	>
16887	<desc>
16888	Event listener. An event listener can work in either active or passive mode, depending on the way
16889	it was registered.
16890	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16891	</desc>
16892
16893	<method name="handleEvent">
16894	<desc>
16895	Handle event callback for active listeners. It is not called for
16896	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
16897	and having received acknowledgement from all passive listeners via
16898	<link to="IEventSource::eventProcessed"/>, the event is marked as
16899	processed and <link to="IEvent::waitProcessed"/> will return
16900	immediately.
16901	</desc>
16902	<param name="event" type="IEvent" dir="in">
16903	<desc>Event available.</desc>
16904	</param>
16905	</method>
16906
16907	</interface>
16908
16909	<interface
16910	name="IEvent" extends="$unknown"
16911	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
16912	wsmap="managed"
16913	>
16914	<desc>
16915	Abstract parent interface for VirtualBox events. Actual events will typically implement
16916	a more specific interface which derives from this (see below).
16917
16918	<b>Introduction to VirtualBox events</b>
16919
16920	Generally speaking, an event (represented by this interface) signals that something
16921	happened, while an event listener (see <link to="IEventListener" />) represents an
16922	entity that is interested in certain events. In order for this to work with
16923	unidirectional protocols (i.e. web services), the concepts of passive and active
16924	listener are used.
16925
16926	Event consumers can register themselves as listeners, providing an array of
16927	events they are interested in (see <link to="IEventSource::registerListener" />).
16928	When an event triggers, the listener is notified about the event. The exact
16929	mechanism of the notification depends on whether the listener was registered as
16930	an active or passive listener:
16931
16932	<ul>
16933	<li>An active listener is very similar to a callback: it is a function invoked
16934	by the API. As opposed to the callbacks that were used in the API before
16935	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
16936	</li>
16937
16938	<li>Passive listeners are somewhat trickier to implement, but do not require
16939	a client function to be callable, which is not an option with scripting
16940	languages or web service clients. Internally the <link to="IEventSource" />
16941	implementation maintains an event queue for each passive listener, and
16942	newly arrived events are put in this queue. When the listener calls
16943	<link to="IEventSource::getEvent"/>, first element from its internal event
16944	queue is returned. When the client completes processing of an event,
16945	the <link to="IEventSource::eventProcessed" /> function must be called,
16946	acknowledging that the event was processed. It supports implementing
16947	waitable events. On passive listener unregistration, all events from its
16948	queue are auto-acknowledged.
16949	</li>
16950	</ul>
16951
16952	Waitable events are useful in situations where the event generator wants to track
16953	delivery or a party wants to wait until all listeners have completed the event. A
16954	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
16955	listeners might veto a certain action, and thus the event producer has to make
16956	sure that all listeners have processed the event and not vetoed before taking
16957	the action.
16958
16959	A given event may have both passive and active listeners at the same time.
16960
16961	<b>Using events</b>
16962
16963	Any VirtualBox object capable of producing externally visible events provides an
16964	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
16965	This event source object is notified by VirtualBox once something has happened, so
16966	consumers may register event listeners with this event source. To register a listener,
16967	an object implementing the <link to="IEventListener" /> interface must be provided.
16968	For active listeners, such an object is typically created by the consumer, while for
16969	passive listeners <link to="IEventSource::createListener" /> should be used. Please
16970	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
16971
16972	Once created, the listener must be registered to listen for the desired events
16973	(see <link to="IEventSource::registerListener" />), providing an array of
16974	<link to="VBoxEventType" /> enums. Those elements can either be the individual
16975	event IDs or wildcards matching multiple event IDs.
16976
16977	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
16978	called automatically when the event is triggered, while passive listeners have to call
16979	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
16980	an event processing loop.
16981
16982	The IEvent interface is an abstract parent interface for all such VirtualBox events
16983	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
16984	or the event processing loop is to check the <link to="#type" /> attribute of the event and
16985	then cast to the appropriate specific interface using @c QueryInterface().
16986	</desc>
16987
16988	<attribute name="type" readonly="yes" type="VBoxEventType">
16989	<desc>
16990	Event type.
16991	</desc>
16992	</attribute>
16993
16994	<attribute name="source" readonly="yes" type="IEventSource">
16995	<desc>
16996	Source of this event.
16997	</desc>
16998	</attribute>
16999
17000	<attribute name="waitable" readonly="yes" type="boolean">
17001	<desc>
17002	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17003	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17004	as no additional overhead associated with waitability imposed.
17005	Waitable events are needed when one need to be able to wait for particular event processed,
17006	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17007	until all consumers confirmed events.
17008	</desc>
17009	</attribute>
17010
17011	<method name="setProcessed">
17012	<desc>
17013	Internal method called by the system when all listeners of a particular event have called
17014	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17015	</desc>
17016	</method>
17017
17018	<method name="waitProcessed">
17019	<desc>
17020	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17021	described semantics, for non-waitable returns true immediately.
17022	</desc>
17023	<param name="timeout" type="long" dir="in">
17024	<desc>
17025	Maximum time to wait for event processeing, in ms;
17026	0 = no wait, -1 = indefinite wait.
17027	</desc>
17028	</param>
17029	<param name="result" type="boolean" dir="return">
17030	<desc>If this event was processed before timeout.</desc>
17031	</param>
17032	</method>
17033	</interface>
17034
17035
17036	<interface
17037	name="IReusableEvent" extends="IEvent"
17038	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17039	wsmap="managed"
17040	>
17041	<desc>Base abstract interface for all reusable events.</desc>
17042
17043	<attribute name="generation" readonly="yes" type="unsigned long">
17044	<desc>Current generation of event, incremented on reuse.</desc>
17045	</attribute>
17046
17047	<method name="reuse">
17048	<desc>
17049	Marks an event as reused, increments 'generation', fields shall no
17050	longer be considered valid.
17051	</desc>
17052	</method>
17053	</interface>
17054
17055	<interface
17056	name="IMachineEvent" extends="IEvent"
17057	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17058	wsmap="managed" id="MachineEvent"
17059	>
17060	<desc>Base abstract interface for all machine events.</desc>
17061
17062	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17063	<desc>ID of the machine this event relates to.</desc>
17064	</attribute>
17065
17066	</interface>
17067
17068	<interface
17069	name="IMachineStateChangedEvent" extends="IMachineEvent"
17070	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17071	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17072	>
17073	<desc>Machine state change event.</desc>
17074
17075	<attribute name="state" readonly="yes" type="MachineState">
17076	<desc>New execution state.</desc>
17077	</attribute>
17078	</interface>
17079
17080	<interface
17081	name="IMachineDataChangedEvent" extends="IMachineEvent"
17082	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17083	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17084	>
17085	<desc>
17086	Any of the settings of the given machine has changed.
17087	</desc>
17088
17089	<attribute name="temporary" readonly="yes" type="boolean">
17090	<desc>@c true if the settings change is temporary. All permanent
17091	settings changes will trigger an event, and only temporary settings
17092	changes for running VMs will trigger an event. Note: sending events
17093	for temporary changes is NOT IMPLEMENTED.</desc>
17094	</attribute>
17095	</interface>
17096
17097	<interface
17098	name="IMediumRegisteredEvent" extends="IEvent"
17099	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17100	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17101	>
17102	<desc>
17103	The given medium was registered or unregistered
17104	within this VirtualBox installation.
17105	</desc>
17106
17107	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17108	<desc>ID of the medium this event relates to.</desc>
17109	</attribute>
17110
17111	<attribute name="mediumType" readonly="yes" type="DeviceType">
17112	<desc>Type of the medium this event relates to.</desc>
17113	</attribute>
17114
17115	<attribute name="registered" type="boolean" readonly="yes">
17116	<desc>
17117	If @c true, the medium was registered, otherwise it was
17118	unregistered.
17119	</desc>
17120	</attribute>
17121	</interface>
17122
17123	<interface
17124	name="IMachineRegisteredEvent" extends="IMachineEvent"
17125	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17126	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17127	>
17128	<desc>
17129	The given machine was registered or unregistered
17130	within this VirtualBox installation.
17131	</desc>
17132
17133	<attribute name="registered" type="boolean" readonly="yes">
17134	<desc>
17135	If @c true, the machine was registered, otherwise it was
17136	unregistered.
17137	</desc>
17138	</attribute>
17139	</interface>
17140
17141	<interface
17142	name="ISessionStateChangedEvent" extends="IMachineEvent"
17143	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17144	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17145	>
17146	<desc>
17147	The state of the session for the given machine was changed.
17148	<see><link to="IMachine::sessionState"/></see>
17149	</desc>
17150
17151	<attribute name="state" type="SessionState" readonly="yes">
17152	<desc>
17153	New session state.
17154	</desc>
17155	</attribute>
17156	</interface>
17157
17158	<interface
17159	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17160	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17161	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17162	>
17163	<desc>
17164	Notification when a guest property has changed.
17165	</desc>
17166
17167	<attribute name="name" readonly="yes" type="wstring">
17168	<desc>
17169	The name of the property that has changed.
17170	</desc>
17171	</attribute>
17172
17173	<attribute name="value" readonly="yes" type="wstring">
17174	<desc>
17175	The new property value.
17176	</desc>
17177	</attribute>
17178
17179	<attribute name="flags" readonly="yes" type="wstring">
17180	<desc>
17181	The new property flags.
17182	</desc>
17183	</attribute>
17184
17185	</interface>
17186
17187	<interface
17188	name="ISnapshotEvent" extends="IMachineEvent"
17189	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17190	wsmap="managed" id="SnapshotEvent"
17191	>
17192	<desc>Base interface for all snapshot events.</desc>
17193
17194	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17195	<desc>ID of the snapshot this event relates to.</desc>
17196	</attribute>
17197
17198	</interface>
17199
17200	<interface
17201	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17202	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17203	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17204	>
17205	<desc>
17206	A new snapshot of the machine has been taken.
17207	<see><link to="ISnapshot"/></see>
17208	</desc>
17209	</interface>
17210
17211	<interface
17212	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17213	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17214	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17215	>
17216	<desc>
17217	Snapshot of the given machine has been deleted.
17218
17219	<note>
17220	This notification is delivered <b>after</b> the snapshot
17221	object has been uninitialized on the server (so that any
17222	attempt to call its methods will return an error).
17223	</note>
17224
17225	<see><link to="ISnapshot"/></see>
17226	</desc>
17227	</interface>
17228
17229	<interface
17230	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17231	uuid="07541941-8079-447a-a33e-47a69c7980db"
17232	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17233	>
17234	<desc>
17235	Snapshot properties (name and/or description) have been changed.
17236	<see><link to="ISnapshot"/></see>
17237	</desc>
17238	</interface>
17239
17240	<interface
17241	name="IMousePointerShapeChangedEvent" extends="IEvent"
17242	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17243	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17244	>
17245	<desc>
17246	Notification when the guest mouse pointer shape has
17247	changed. The new shape data is given.
17248	</desc>
17249
17250	<attribute name="visible" type="boolean" readonly="yes">
17251	<desc>
17252	Flag whether the pointer is visible.
17253	</desc>
17254	</attribute>
17255	<attribute name="alpha" type="boolean" readonly="yes">
17256	<desc>
17257	Flag whether the pointer has an alpha channel.
17258	</desc>
17259	</attribute>
17260	<attribute name="xhot" type="unsigned long" readonly="yes">
17261	<desc>
17262	The pointer hot spot X coordinate.
17263	</desc>
17264	</attribute>
17265	<attribute name="yhot" type="unsigned long" readonly="yes">
17266	<desc>
17267	The pointer hot spot Y coordinate.
17268	</desc>
17269	</attribute>
17270	<attribute name="width" type="unsigned long" readonly="yes">
17271	<desc>
17272	Width of the pointer shape in pixels.
17273	</desc>
17274	</attribute>
17275	<attribute name="height" type="unsigned long" readonly="yes">
17276	<desc>
17277	Height of the pointer shape in pixels.
17278	</desc>
17279	</attribute>
17280	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17281	<desc>
17282	Shape buffer arrays.
17283
17284	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17285	followed by a 32-bpp XOR (color) mask.
17286
17287	For pointers without alpha channel the XOR mask pixels are 32
17288	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17289	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17290
17291	An AND mask is used for pointers with alpha channel, so if the
17292	callback does not support alpha, the pointer could be
17293	displayed as a normal color pointer.
17294
17295	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17296	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17297	height</tt>. The padding bits at the end of each scanline are
17298	undefined.
17299
17300	The XOR mask follows the AND mask on the next 4-byte aligned
17301	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17302	Bytes in the gap between the AND and the XOR mask are undefined.
17303	The XOR mask scanlines have no gap between them and the size of
17304	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17305
17306	<note>
17307	If @a shape is 0, only the pointer visibility is changed.
17308	</note>
17309	</desc>
17310	</attribute>
17311	</interface>
17312
17313	<interface
17314	name="IMouseCapabilityChangedEvent" extends="IEvent"
17315	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17316	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17317	>
17318	<desc>
17319	Notification when the mouse capabilities reported by the
17320	guest have changed. The new capabilities are passed.
17321	</desc>
17322	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17323	<desc>
17324	Supports absolute coordinates.
17325	</desc>
17326	</attribute>
17327	<attribute name="supportsRelative" type="boolean" readonly="yes">
17328	<desc>
17329	Supports relative coordinates.
17330	</desc>
17331	</attribute>
17332	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17333	<desc>
17334	If host cursor is needed.
17335	</desc>
17336	</attribute>
17337	</interface>
17338
17339	<interface
17340	name="IKeyboardLedsChangedEvent" extends="IEvent"
17341	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17342	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17343	>
17344	<desc>
17345	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17346	to alter the state of the keyboard LEDs.
17347	</desc>
17348	<attribute name="numLock" type="boolean" readonly="yes">
17349	<desc>
17350	NumLock status.
17351	</desc>
17352	</attribute>
17353	<attribute name="capsLock" type="boolean" readonly="yes">
17354	<desc>
17355	CapsLock status.
17356	</desc>
17357	</attribute>
17358	<attribute name="scrollLock" type="boolean" readonly="yes">
17359	<desc>
17360	ScrollLock status.
17361	</desc>
17362	</attribute>
17363	</interface>
17364
17365	<interface
17366	name="IStateChangedEvent" extends="IEvent"
17367	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17368	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17369	>
17370	<desc>
17371	Notification when the execution state of the machine has changed.
17372	The new state is given.
17373	</desc>
17374	<attribute name="state" type="MachineState" readonly="yes">
17375	<desc>
17376	New machine state.
17377	</desc>
17378	</attribute>
17379	</interface>
17380
17381	<interface
17382	name="IAdditionsStateChangedEvent" extends="IEvent"
17383	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17384	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17385	>
17386	<desc>
17387	Notification when a Guest Additions property changes.
17388	Interested callees should query IGuest attributes to
17389	find out what has changed.
17390	</desc>
17391	</interface>
17392
17393	<interface
17394	name="INetworkAdapterChangedEvent" extends="IEvent"
17395	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17396	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17397	>
17398	<desc>
17399	Notification when a property of one of the
17400	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17401	changes. Interested callees should use INetworkAdapter methods and
17402	attributes to find out what has changed.
17403	</desc>
17404	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17405	<desc>
17406	Network adapter that is subject to change.
17407	</desc>
17408	</attribute>
17409	</interface>
17410
17411	<interface
17412	name="ISerialPortChangedEvent" extends="IEvent"
17413	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17414	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17415	>
17416	<desc>
17417	Notification when a property of one of the
17418	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17419	Interested callees should use ISerialPort methods and attributes
17420	to find out what has changed.
17421	</desc>
17422	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17423	<desc>
17424	Serial port that is subject to change.
17425	</desc>
17426	</attribute>
17427	</interface>
17428
17429	<interface
17430	name="IParallelPortChangedEvent" extends="IEvent"
17431	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17432	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17433	>
17434	<desc>
17435	Notification when a property of one of the
17436	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17437	changes. Interested callees should use ISerialPort methods and
17438	attributes to find out what has changed.
17439	</desc>
17440	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17441	<desc>
17442	Parallel port that is subject to change.
17443	</desc>
17444	</attribute>
17445	</interface>
17446
17447	<interface
17448	name="IStorageControllerChangedEvent" extends="IEvent"
17449	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17450	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17451	>
17452	<desc>
17453	Notification when a
17454	<link to="IMachine::mediumAttachments">medium attachment</link>
17455	changes.
17456	</desc>
17457	</interface>
17458
17459	<interface
17460	name="IMediumChangedEvent" extends="IEvent"
17461	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17462	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17463	>
17464	<desc>
17465	Notification when a
17466	<link to="IMachine::mediumAttachments">medium attachment</link>
17467	changes.
17468	</desc>
17469	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17470	<desc>
17471	Medium attachment that is subject to change.
17472	</desc>
17473	</attribute>
17474	</interface>
17475
17476	<interface
17477	name="ICPUChangedEvent" extends="IEvent"
17478	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17479	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17480	>
17481	<desc>
17482	Notification when a CPU changes.
17483	</desc>
17484	<attribute name="cpu" type="unsigned long" readonly="yes">
17485	<desc>
17486	The CPU which changed.
17487	</desc>
17488	</attribute>
17489	<attribute name="add" type="boolean" readonly="yes">
17490	<desc>
17491	Flag whether the CPU was added or removed.
17492	</desc>
17493	</attribute>
17494	</interface>
17495
17496	<interface
17497	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17498	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17499	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17500	>
17501	<desc>
17502	Notification when the CPU execution cap changes.
17503	</desc>
17504	<attribute name="executionCap" type="unsigned long" readonly="yes">
17505	<desc>
17506	The new CPU execution cap value. (1-100)
17507	</desc>
17508	</attribute>
17509	</interface>
17510
17511	<interface
17512	name="IGuestKeyboardEvent" extends="IEvent"
17513	uuid="88394258-7006-40d4-b339-472ee3801844"
17514	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17515	>
17516	<desc>
17517	Notification when guest keyboard event happens.
17518	</desc>
17519	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17520	<desc>
17521	Array of scancodes.
17522	</desc>
17523	</attribute>
17524	</interface>
17525
17526	<interface
17527	name="IGuestMouseEvent" extends="IReusableEvent"
17528	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17529	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17530	>
17531	<desc>
17532	Notification when guest mouse event happens.
17533	</desc>
17534
17535	<attribute name="absolute" type="boolean" readonly="yes">
17536	<desc>
17537	If this event is relative or absolute.
17538	</desc>
17539	</attribute>
17540
17541	<attribute name="x" type="long" readonly="yes">
17542	<desc>
17543	New X position, or X delta.
17544	</desc>
17545	</attribute>
17546
17547	<attribute name="y" type="long" readonly="yes">
17548	<desc>
17549	New Y position, or Y delta.
17550	</desc>
17551	</attribute>
17552
17553	<attribute name="z" type="long" readonly="yes">
17554	<desc>
17555	Z delta.
17556	</desc>
17557	</attribute>
17558
17559	<attribute name="w" type="long" readonly="yes">
17560	<desc>
17561	W delta.
17562	</desc>
17563	</attribute>
17564
17565	<attribute name="buttons" type="long" readonly="yes">
17566	<desc>
17567	Button state bitmask.
17568	</desc>
17569	</attribute>
17570
17571	</interface>
17572
17573
17574	<interface
17575	name="IVRDEServerChangedEvent" extends="IEvent"
17576	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17577	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17578	>
17579	<desc>
17580	Notification when a property of the
17581	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17582	Interested callees should use IVRDEServer methods and attributes to
17583	find out what has changed.
17584	</desc>
17585	</interface>
17586
17587	<interface
17588	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17589	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17590	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17591	>
17592	<desc>
17593	Notification when the status of the VRDE server changes. Interested callees
17594	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17595	attributes to find out what is the current status.
17596	</desc>
17597	</interface>
17598
17599	<interface
17600	name="IUSBControllerChangedEvent" extends="IEvent"
17601	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17602	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17603	>
17604	<desc>
17605	Notification when a property of the virtual
17606	<link to="IMachine::USBController">USB controller</link> changes.
17607	Interested callees should use IUSBController methods and attributes to
17608	find out what has changed.
17609	</desc>
17610	</interface>
17611
17612	<interface
17613	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17614	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17615	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17616	>
17617	<desc>
17618	Notification when a USB device is attached to or detached from
17619	the virtual USB controller.
17620
17621	This notification is sent as a result of the indirect
17622	request to attach the device because it matches one of the
17623	machine USB filters, or as a result of the direct request
17624	issued by <link to="IConsole::attachUSBDevice"/> or
17625	<link to="IConsole::detachUSBDevice"/>.
17626
17627	This notification is sent in case of both a succeeded and a
17628	failed request completion. When the request succeeds, the
17629	@a error parameter is @c null, and the given device has been
17630	already added to (when @a attached is @c true) or removed from
17631	(when @a attached is @c false) the collection represented by
17632	<link to="IConsole::USBDevices"/>. On failure, the collection
17633	doesn't change and the @a error parameter represents the error
17634	message describing the failure.
17635	</desc>
17636	<attribute name="device" type="IUSBDevice" readonly="yes">
17637	<desc>
17638	Device that is subject to state change.
17639	</desc>
17640	</attribute>
17641	<attribute name="attached" type="boolean" readonly="yes">
17642	<desc>
17643	@c true if the device was attached and @c false otherwise.
17644	</desc>
17645	</attribute>
17646	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17647	<desc>
17648	@c null on success or an error message object on failure.
17649	</desc>
17650	</attribute>
17651	</interface>
17652
17653	<interface
17654	name="ISharedFolderChangedEvent" extends="IEvent"
17655	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17656	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17657	>
17658	<desc>
17659	Notification when a shared folder is added or removed.
17660	The @a scope argument defines one of three scopes:
17661	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17662	(<link to="Scope_Global">Global</link>),
17663	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17664	the machine (<link to="Scope_Machine">Machine</link>) or <link
17665	to="IConsole::sharedFolders">transient shared folders</link> of the
17666	machine (<link to="Scope_Session">Session</link>). Interested callees
17667	should use query the corresponding collections to find out what has
17668	changed.
17669	</desc>
17670	<attribute name="scope" type="Scope" readonly="yes">
17671	<desc>
17672	Scope of the notification.
17673	</desc>
17674	</attribute>
17675	</interface>
17676
17677	<interface
17678	name="IRuntimeErrorEvent" extends="IEvent"
17679	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17680	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17681	>
17682	<desc>
17683	Notification when an error happens during the virtual
17684	machine execution.
17685
17686	There are three kinds of runtime errors:
17687	<ul>
17688	<li><i>fatal</i></li>
17689	<li><i>non-fatal with retry</i></li>
17690	<li><i>non-fatal warnings</i></li>
17691	</ul>
17692
17693	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17694	to @c true. In case of fatal errors, the virtual machine
17695	execution is always paused before calling this notification, and
17696	the notification handler is supposed either to immediately save
17697	the virtual machine state using <link to="IConsole::saveState"/>
17698	or power it off using <link to="IConsole::powerDown"/>.
17699	Resuming the execution can lead to unpredictable results.
17700
17701	<b>Non-fatal</b> errors and warnings are indicated by the
17702	@a fatal parameter set to @c false. If the virtual machine
17703	is in the Paused state by the time the error notification is
17704	received, it means that the user can <i>try to resume</i> the machine
17705	execution after attempting to solve the problem that caused the
17706	error. In this case, the notification handler is supposed
17707	to show an appropriate message to the user (depending on the
17708	value of the @a id parameter) that offers several actions such
17709	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17710	wants to retry, the notification handler should continue
17711	the machine execution using the <link to="IConsole::resume"/>
17712	call. If the machine execution is not Paused during this
17713	notification, then it means this notification is a <i>warning</i>
17714	(for example, about a fatal condition that can happen very soon);
17715	no immediate action is required from the user, the machine
17716	continues its normal execution.
17717
17718	Note that in either case the notification handler
17719	<b>must not</b> perform any action directly on a thread
17720	where this notification is called. Everything it is allowed to
17721	do is to post a message to another thread that will then talk
17722	to the user and take the corresponding action.
17723
17724	Currently, the following error identifiers are known:
17725	<ul>
17726	<li><tt>"HostMemoryLow"</tt></li>
17727	<li><tt>"HostAudioNotResponding"</tt></li>
17728	<li><tt>"VDIStorageFull"</tt></li>
17729	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17730	</ul>
17731	</desc>
17732	<attribute name="fatal" type="boolean" readonly="yes">
17733	<desc>
17734	Whether the error is fatal or not.
17735	</desc>
17736	</attribute>
17737	<attribute name="id" type="wstring" readonly="yes">
17738	<desc>
17739	Error identifier.
17740	</desc>
17741	</attribute>
17742	<attribute name="message" type="wstring" readonly="yes">
17743	<desc>
17744	Optional error message.
17745	</desc>
17746	</attribute>
17747	</interface>
17748
17749
17750	<interface
17751	name="IEventSourceChangedEvent" extends="IEvent"
17752	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17753	waitable="yes"
17754	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17755	>
17756	<desc>
17757	Notification when an event source state changes (listener added or removed).
17758	</desc>
17759
17760	<attribute name="listener" type="IEventListener" readonly="yes">
17761	<desc>
17762	Event listener which has changed.
17763	</desc>
17764	</attribute>
17765
17766	<attribute name="add" type="boolean" readonly="yes">
17767	<desc>
17768	Flag whether listener was added or removed.
17769	</desc>
17770	</attribute>
17771	</interface>
17772
17773	<interface
17774	name="IExtraDataChangedEvent" extends="IEvent"
17775	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17776	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17777	>
17778	<desc>
17779	Notification when machine specific or global extra data
17780	has changed.
17781	</desc>
17782	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17783	<desc>
17784	ID of the machine this event relates to.
17785	Null for global extra data changes.
17786	</desc>
17787	</attribute>
17788	<attribute name="key" type="wstring" readonly="yes">
17789	<desc>
17790	Extra data key that has changed.
17791	</desc>
17792	</attribute>
17793	<attribute name="value" type="wstring" readonly="yes">
17794	<desc>
17795	Extra data value for the given key.
17796	</desc>
17797	</attribute>
17798	</interface>
17799
17800	<interface
17801	name="IVetoEvent" extends="IEvent"
17802	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17803	wsmap="managed"
17804	>
17805	<desc>Base abstract interface for veto events.</desc>
17806
17807	<method name="addVeto">
17808	<desc>
17809	Adds a veto on this event.
17810	</desc>
17811	<param name="reason" type="wstring" dir="in">
17812	<desc>
17813	Reason for veto, could be null or empty string.
17814	</desc>
17815	</param>
17816	</method>
17817
17818	<method name="isVetoed">
17819	<desc>
17820	If this event was vetoed.
17821	</desc>
17822	<param name="result" type="boolean" dir="return">
17823	<desc>
17824	Reason for veto.
17825	</desc>
17826	</param>
17827	</method>
17828
17829	<method name="getVetos">
17830	<desc>
17831	Current veto reason list, if size is 0 - no veto.
17832	</desc>
17833	<param name="result" type="wstring" dir="return" safearray="yes">
17834	<desc>
17835	Array of reasons for veto provided by different event handlers.
17836	</desc>
17837	</param>
17838	</method>
17839
17840	</interface>
17841
17842	<interface
17843	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17844	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17845	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17846	waitable="true"
17847	>
17848	<desc>
17849	Notification when someone tries to change extra data for
17850	either the given machine or (if @c null) global extra data.
17851	This gives the chance to veto against changes.
17852	</desc>
17853	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17854	<desc>
17855	ID of the machine this event relates to.
17856	Null for global extra data changes.
17857	</desc>
17858	</attribute>
17859	<attribute name="key" type="wstring" readonly="yes">
17860	<desc>
17861	Extra data key that has changed.
17862	</desc>
17863	</attribute>
17864	<attribute name="value" type="wstring" readonly="yes">
17865	<desc>
17866	Extra data value for the given key.
17867	</desc>
17868	</attribute>
17869	</interface>
17870
17871	<interface
17872	name="ICanShowWindowEvent" extends="IVetoEvent"
17873	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17874	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17875	waitable="true"
17876	>
17877	<desc>
17878	Notification when a call to
17879	<link to="IMachine::canShowConsoleWindow"/> is made by a
17880	front-end to check if a subsequent call to
17881	<link to="IMachine::showConsoleWindow"/> can succeed.
17882
17883	The callee should give an answer appropriate to the current
17884	machine state using event veto. This answer must
17885	remain valid at least until the next
17886	<link to="IConsole::state">machine state</link> change.
17887	</desc>
17888	</interface>
17889
17890	<interface
17891	name="IShowWindowEvent" extends="IEvent"
17892	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
17893	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
17894	waitable="true"
17895	>
17896	<desc>
17897	Notification when a call to
17898	<link to="IMachine::showConsoleWindow"/>
17899	requests the console window to be activated and brought to
17900	foreground on the desktop of the host PC.
17901
17902	This notification should cause the VM console process to
17903	perform the requested action as described above. If it is
17904	impossible to do it at a time of this notification, this
17905	method should return a failure.
17906
17907	Note that many modern window managers on many platforms
17908	implement some sort of focus stealing prevention logic, so
17909	that it may be impossible to activate a window without the
17910	help of the currently active application (which is supposedly
17911	an initiator of this notification). In this case, this method
17912	must return a non-zero identifier that represents the
17913	top-level window of the VM console process. The caller, if it
17914	represents a currently active process, is responsible to use
17915	this identifier (in a platform-dependent manner) to perform
17916	actual window activation.
17917
17918	This method must set @a winId to zero if it has performed all
17919	actions necessary to complete the request and the console
17920	window is now active and in foreground, to indicate that no
17921	further action is required on the caller's side.
17922	</desc>
17923	<attribute name="winId" type="long long">
17924	<desc>
17925	Platform-dependent identifier of the top-level VM console
17926	window, or zero if this method has performed all actions
17927	necessary to implement the <i>show window</i> semantics for
17928	the given platform and/or this VirtualBox front-end.
17929	</desc>
17930	</attribute>
17931	</interface>
17932
17933	<interface
17934	name="INATRedirectEvent" extends="IMachineEvent"
17935	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
17936	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
17937	>
17938	<desc>
17939	Notification when NAT redirect rule added or removed.
17940	</desc>
17941	<attribute name="slot" type="unsigned long" readonly="yes">
17942	<desc>
17943	Adapter which NAT attached to.
17944	</desc>
17945	</attribute>
17946	<attribute name="remove" type="boolean" readonly="yes">
17947	<desc>
17948	Whether rule remove or add.
17949	</desc>
17950	</attribute>
17951	<attribute name="name" type="wstring" readonly="yes">
17952	<desc>
17953	Name of the rule.
17954	</desc>
17955	</attribute>
17956	<attribute name="proto" type="NATProtocol" readonly="yes">
17957	<desc>
17958	Protocol (TCP or UDP) of the redirect rule.
17959	</desc>
17960	</attribute>
17961	<attribute name="hostIp" type="wstring" readonly="yes">
17962	<desc>
17963	Host ip address to bind socket on.
17964	</desc>
17965	</attribute>
17966	<attribute name="hostPort" type="long" readonly="yes">
17967	<desc>
17968	Host port to bind socket on.
17969	</desc>
17970	</attribute>
17971	<attribute name="guestIp" type="wstring" readonly="yes">
17972	<desc>
17973	Guest ip address to redirect to.
17974	</desc>
17975	</attribute>
17976	<attribute name="guestPort" type="long" readonly="yes">
17977	<desc>
17978	Guest port to redirect to.
17979	</desc>
17980	</attribute>
17981	</interface>
17982
17983	<interface
17984	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
17985	waitable="yes"
17986	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
17987	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
17988	>
17989	<desc>
17990	Notification when host PCI device is plugged/unplugged. Plugging
17991	usually takes place on VM startup, unplug - when
17992	<link to="IMachine::detachHostPciDevice"/> is called.
17993
17994	<see><link to="IMachine::detachHostPciDevice"/></see>
17995
17996	</desc>
17997
17998	<attribute name="plugged" type="boolean" readonly="yes">
17999	<desc>
18000	If device successfully plugged or unplugged.
18001	</desc>
18002	</attribute>
18003
18004	<attribute name="success" type="boolean" readonly="yes">
18005	<desc>
18006	If operation was successful, if false - 'message' attribute
18007	may be of interest.
18008	</desc>
18009	</attribute>
18010
18011	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18012	<desc>
18013	Attachment info for this device.
18014	</desc>
18015	</attribute>
18016
18017	<attribute name="message" type="wstring" readonly="yes">
18018	<desc>
18019	Optional error message.
18020	</desc>
18021	</attribute>
18022
18023	</interface>
18024
18025	<interface
18026	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18027	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18028	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18029	>
18030	<desc>
18031	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18032	unexpected circumstances) or available again.
18033	</desc>
18034
18035	<attribute name="available" type="boolean" readonly="yes">
18036	<desc>
18037	Whether VBoxSVC is available now.
18038	</desc>
18039	</attribute>
18040	</interface>
18041
18042	<interface
18043	name="IBandwidthGroupChangedEvent" extends="IEvent"
18044	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18045	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18046	>
18047	<desc>
18048	Notification when one of the bandwidth groups changed
18049	</desc>
18050	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18051	<desc>
18052	The changed bandwidth group.
18053	</desc>
18054	</attribute>
18055	</interface>
18056
18057	<enum
18058	name="GuestMonitorChangedEventType"
18059	uuid="ef172985-7e36-4297-95be-e46396968d66"
18060	>
18061
18062	<desc>
18063	How the guest monitor has been changed.
18064	</desc>
18065
18066	<const name="Enabled" value="0">
18067	<desc>
18068	The guest monitor has been enabled by the guest.
18069	</desc>
18070	</const>
18071
18072	<const name="Disabled" value="1">
18073	<desc>
18074	The guest monitor has been disabled by the guest.
18075	</desc>
18076	</const>
18077
18078	<const name="NewOrigin" value="2">
18079	<desc>
18080	The guest monitor origin has changed in the guest.
18081	</desc>
18082	</const>
18083	</enum>
18084
18085	<interface
18086	name="IGuestMonitorChangedEvent" extends="IEvent"
18087	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18088	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18089	>
18090	<desc>
18091	Notification when the guest enables one of its monitors.
18092	</desc>
18093
18094	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18095	<desc>
18096	What was changed for this guest monitor.
18097	</desc>
18098	</attribute>
18099
18100	<attribute name="screenId" type="unsigned long" readonly="yes">
18101	<desc>
18102	The monitor which was changed.
18103	</desc>
18104	</attribute>
18105
18106	<attribute name="originX" type="unsigned long" readonly="yes">
18107	<desc>
18108	Physical X origin relative to the primary screen.
18109	Valid for Enabled and NewOrigin.
18110	</desc>
18111	</attribute>
18112
18113	<attribute name="originY" type="unsigned long" readonly="yes">
18114	<desc>
18115	Physical Y origin relative to the primary screen.
18116	Valid for Enabled and NewOrigin.
18117	</desc>
18118	</attribute>
18119
18120	<attribute name="width" type="unsigned long" readonly="yes">
18121	<desc>
18122	Width of the screen.
18123	Valid for Enabled.
18124	</desc>
18125	</attribute>
18126
18127	<attribute name="height" type="unsigned long" readonly="yes">
18128	<desc>
18129	Height of the screen.
18130	Valid for Enabled.
18131	</desc>
18132	</attribute>
18133
18134	</interface>
18135
18136	<interface
18137	name="IStorageDeviceChangedEvent" extends="IEvent"
18138	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18139	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18140	>
18141	<desc>
18142	Notification when a
18143	<link to="IMachine::mediumAttachments">storage device</link>
18144	is attached or removed.
18145	</desc>
18146	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18147	<desc>
18148	Storage device that is subject to change.
18149	</desc>
18150	</attribute>
18151	<attribute name="removed" type="boolean" readonly="yes">
18152	<desc>
18153	Flag whether the device was removed or added to the VM.
18154	</desc>
18155	</attribute>
18156	</interface>
18157
18158	<module name="VBoxSVC" context="LocalServer">
18159	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18160	namespace="virtualbox.org">
18161	<interface name="IVirtualBox" default="yes"/>
18162	</class>
18163	</module>
18164
18165	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18166	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18167	namespace="virtualbox.org">
18168	<interface name="IVirtualBoxClient" default="yes"/>
18169	</class>
18170
18171	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18172	namespace="virtualbox.org">
18173	<interface name="ISession" default="yes"/>
18174	</class>
18175	</module>
18176
18177	</library>
18178
18179	</idl>
18180
18181	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format