VirtualBox.xidl@ 41049

Last change on this file since 41049 was 41049, checked in by vboxsync, 13 years ago
Main: query the guest screen info from saved state (xTracker 5820)
Property svn:eol-style set to `native`
File size: 664.6 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2012 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	<const name="v1_13" value="15">
491	<desc>Settings version "1.13", written by VirtualBox 4.2.x.</desc>
492	<!--
493	Machine changes: tracing config;
494	-->
495	</const>
496
497	<const name="Future" value="99999">
498	<desc>Settings version greater than "1.13", written by a future VirtualBox version.</desc>
499	</const>
500	</enum>
501
502	<enum
503	name="AccessMode"
504	uuid="1da0007c-ddf7-4be8-bcac-d84a1558785f"
505	>
506	<desc>
507	Access mode for opening files.
508	</desc>
509
510	<const name="ReadOnly" value="1"/>
511	<const name="ReadWrite" value="2"/>
512	</enum>
513
514	<enum
515	name="MachineState"
516	uuid="ec6c6a9e-113d-4ff4-b44f-0b69f21c97fe"
517	>
518	<desc>
519	Virtual machine execution state.
520
521	This enumeration represents possible values of the <link
522	to="IMachine::state"/> attribute.
523
524	Below is the basic virtual machine state diagram. It shows how the state
525	changes during virtual machine execution. The text in square braces shows
526	a method of the IConsole interface that performs the given state
527	transition.
528
529	<pre>
530	+---------[powerDown()] <- Stuck <--[failure]-+
531	V \|
532	+-> PoweredOff --+-->[powerUp()]--> Starting --+ \| +-----[resume()]-----+
533	\| \| \| \| V \|
534	\| Aborted -----+ +--> Running --[pause()]--> Paused
535	\| \| ^ \| ^ \|
536	\| Saved -----------[powerUp()]--> Restoring -+ \| \| \| \|
537	\| ^ \| \| \| \|
538	\| \| +-----------------------------------------+-\|-------------------+ +
539	\| \| \| \| \|
540	\| \| +-- Saving <--------[takeSnapshot()]<-------+---------------------+
541	\| \| \| \|
542	\| +-------- Saving <--------[saveState()]<----------+---------------------+
543	\| \| \|
544	+-------------- Stopping -------[powerDown()]<----------+---------------------+
545	</pre>
546
547	Note that states to the right from PoweredOff, Aborted and Saved in the
548	above diagram are called <i>online VM states</i>. These states
549	represent the virtual machine which is being executed in a dedicated
550	process (usually with a GUI window attached to it where you can see the
551	activity of the virtual machine and interact with it). There are two
552	special pseudo-states, FirstOnline and LastOnline, that can be used in
553	relational expressions to detect if the given machine state is online or
554	not:
555
556	<pre>
557	if (machine.GetState() >= MachineState_FirstOnline &&
558	machine.GetState() <= MachineState_LastOnline)
559	{
560	...the machine is being executed...
561	}
562	</pre>
563
564	When the virtual machine is in one of the online VM states (that is, being
565	executed), only a few machine settings can be modified. Methods working
566	with such settings contain an explicit note about that. An attempt to
567	change any other setting or perform a modifying operation during this time
568	will result in the @c VBOX_E_INVALID_VM_STATE error.
569
570	All online states except Running, Paused and Stuck are transitional: they
571	represent temporary conditions of the virtual machine that will last as
572	long as the operation that initiated such a condition.
573
574	The Stuck state is a special case. It means that execution of the machine
575	has reached the "Guru Meditation" condition. This condition indicates an
576	internal VMM (virtual machine manager) failure which may happen as a
577	result of either an unhandled low-level virtual hardware exception or one
578	of the recompiler exceptions (such as the <i>too-many-traps</i>
579	condition).
580
581	Note also that any online VM state may transit to the Aborted state. This
582	happens if the process that is executing the virtual machine terminates
583	unexpectedly (for example, crashes). Other than that, the Aborted state is
584	equivalent to PoweredOff.
585
586	There are also a few additional state diagrams that do not deal with
587	virtual machine execution and therefore are shown separately. The states
588	shown on these diagrams are called <i>offline VM states</i> (this includes
589	PoweredOff, Aborted and Saved too).
590
591	The first diagram shows what happens when a lengthy setup operation is
592	being executed (such as <link to="IMachine::attachDevice"/>).
593
594	<pre>
595	+----------------------------------(same state as before the call)------+
596	\| \|
597	+-> PoweredOff --+ \|
598	\| \| \|
599	\|-> Aborted -----+-->[lengthy VM configuration call] --> SettingUp -----+
600	\| \|
601	+-> Saved -------+
602	</pre>
603
604	The next two diagrams demonstrate the process of taking a snapshot of a
605	powered off virtual machine, restoring the state to that as of a snapshot
606	or deleting a snapshot, respectively.
607
608	<pre>
609	+----------------------------------(same state as before the call)------+
610	\| \|
611	+-> PoweredOff --+ \|
612	\| +-->[takeSnapshot()] -------------------> Saving ------+
613	+-> Aborted -----+
614
615	+-> PoweredOff --+
616	\| \|
617	\| Aborted -----+-->[restoreSnapshot() ]-------> RestoringSnapshot -+
618	\| \| [deleteSnapshot() ]-------> DeletingSnapshot --+
619	+-> Saved -------+ \|
620	\| \|
621	+---(Saved if restored from an online snapshot, PoweredOff otherwise)---+
622	</pre>
623
624	Note that the Saving state is present in both the offline state group and
625	online state group. Currently, the only way to determine what group is
626	assumed in a particular case is to remember the previous machine state: if
627	it was Running or Paused, then Saving is an online state, otherwise it is
628	an offline state. This inconsistency may be removed in one of the future
629	versions of VirtualBox by adding a new state.
630
631	<note internal="yes">
632	For whoever decides to touch this enum: In order to keep the
633	comparisons involving FirstOnline and LastOnline pseudo-states valid,
634	the numeric values of these states must be correspondingly updated if
635	needed: for any online VM state, the condition
636	<tt>FirstOnline <= state <= LastOnline</tt> must be
637	@c true. The same relates to transient states for which
638	the condition <tt>FirstOnline <= state <= LastOnline</tt> must be
639	@c true.
640	</note>
641	</desc>
642
643	<const name="Null" value="0">
644	<desc>Null value (never used by the API).</desc>
645	</const>
646	<const name="PoweredOff" value="1">
647	<desc>
648	The machine is not running and has no saved execution state; it has
649	either never been started or been shut down successfully.
650	</desc>
651	</const>
652	<const name="Saved" value="2">
653	<desc>
654	The machine is not currently running, but the execution state of the machine
655	has been saved to an external file when it was running, from where
656	it can be resumed.
657	</desc>
658	</const>
659	<const name="Teleported" value="3">
660	<desc>
661	The machine was teleported to a different host (or process) and then
662	powered off. Take care when powering it on again may corrupt resources
663	it shares with the teleportation target (e.g. disk and network).
664	</desc>
665	</const>
666	<const name="Aborted" value="4">
667	<desc>
668	The process running the machine has terminated abnormally. This may
669	indicate a crash of the VM process in host execution context, or
670	the VM process has been terminated externally.
671	</desc>
672	</const>
673	<const name="Running" value="5">
674	<desc>
675	The machine is currently being executed.
676	<note internal="yes">
677	For whoever decides to touch this enum: In order to keep the
678	comparisons in the old source code valid, this state must immediately
679	precede the Paused state.
680	TODO: Lift this spectacularly wonderful restriction.
681	</note>
682	</desc>
683	</const>
684	<const name="Paused" value="6">
685	<desc>
686	Execution of the machine has been paused.
687	<note internal="yes">
688	For whoever decides to touch this enum: In order to keep the
689	comparisons in the old source code valid, this state must immediately
690	follow the Running state.
691	TODO: Lift this spectacularly wonderful restriction.
692	</note>
693	</desc>
694	</const>
695	<const name="Stuck" value="7">
696	<desc>
697	Execution of the machine has reached the "Guru Meditation"
698	condition. This indicates a severe error in the hypervisor itself.
699	<note internal="yes">
700	bird: Why this uncool name? Could we rename it to "GuruMeditation" or
701	"Guru", perhaps? Or are there some other VMM states that are
702	intended to be lumped in here as well?
703	</note>
704	</desc>
705	</const>
706	<const name="Teleporting" value="8">
707	<desc>
708	The machine is about to be teleported to a different host or process.
709	It is possible to pause a machine in this state, but it will go to the
710	@c TeleportingPausedVM state and it will not be
711	possible to resume it again unless the teleportation fails.
712	</desc>
713	</const>
714	<const name="LiveSnapshotting" value="9">
715	<desc>
716	A live snapshot is being taken. The machine is running normally, but
717	some of the runtime configuration options are inaccessible. Also, if
718	paused while in this state it will transition to
719	@c Saving and it will not be resume the
720	execution until the snapshot operation has completed.
721	</desc>
722	</const>
723	<const name="Starting" value="10">
724	<desc>
725	Machine is being started after powering it on from a
726	zero execution state.
727	</desc>
728	</const>
729	<const name="Stopping" value="11">
730	<desc>
731	Machine is being normally stopped powering it off, or after the guest OS
732	has initiated a shutdown sequence.
733	</desc>
734	</const>
735	<const name="Saving" value="12">
736	<desc>
737	Machine is saving its execution state to a file, or an online
738	snapshot of the machine is being taken.
739	</desc>
740	</const>
741	<const name="Restoring" value="13">
742	<desc>
743	Execution state of the machine is being restored from a file
744	after powering it on from the saved execution state.
745	</desc>
746	</const>
747	<const name="TeleportingPausedVM" value="14">
748	<desc>
749	The machine is being teleported to another host or process, but it is
750	not running. This is the paused variant of the
751	@c state.
752	</desc>
753	</const>
754	<const name="TeleportingIn" value="15">
755	<desc>
756	Teleporting the machine state in from another host or process.
757	</desc>
758	</const>
759	<const name="FaultTolerantSyncing" value="16">
760	<desc>
761	The machine is being synced with a fault tolerant VM running elsewhere.
762	</desc>
763	</const>
764	<const name="DeletingSnapshotOnline" value="17">
765	<desc>
766	Like @c DeletingSnapshot, but the merging of media is ongoing in
767	the background while the machine is running.
768	</desc>
769	</const>
770	<const name="DeletingSnapshotPaused" value="18">
771	<desc>
772	Like @c DeletingSnapshotOnline, but the machine was paused when the
773	merging of differencing media was started.
774	</desc>
775	</const>
776	<const name="RestoringSnapshot" value="19">
777	<desc>
778	A machine snapshot is being restored; this typically does not take long.
779	</desc>
780	</const>
781	<const name="DeletingSnapshot" value="20">
782	<desc>
783	A machine snapshot is being deleted; this can take a long time since this
784	may require merging differencing media. This value indicates that the
785	machine is not running while the snapshot is being deleted.
786	</desc>
787	</const>
788	<const name="SettingUp" value="21">
789	<desc>
790	Lengthy setup operation is in progress.
791	</desc>
792	</const>
793
794	<const name="FirstOnline" value="5" wsmap="suppress"> <!-- Running -->
795	<desc>
796	Pseudo-state: first online state (for use in relational expressions).
797	</desc>
798	</const>
799	<const name="LastOnline" value="18" wsmap="suppress"> <!-- DeletingSnapshotPaused -->
800	<desc>
801	Pseudo-state: last online state (for use in relational expressions).
802	</desc>
803	</const>
804
805	<const name="FirstTransient" value="8" wsmap="suppress"> <!-- Teleporting -->
806	<desc>
807	Pseudo-state: first transient state (for use in relational expressions).
808	</desc>
809	</const>
810	<const name="LastTransient" value="21" wsmap="suppress"> <!-- SettingUp -->
811	<desc>
812	Pseudo-state: last transient state (for use in relational expressions).
813	</desc>
814	</const>
815
816	</enum>
817
818	<enum
819	name="SessionState"
820	uuid="cf2700c0-ea4b-47ae-9725-7810114b94d8"
821	>
822	<desc>
823	Session state. This enumeration represents possible values of
824	<link to="IMachine::sessionState"/> and <link to="ISession::state"/>
825	attributes.
826	</desc>
827
828	<const name="Null" value="0">
829	<desc>Null value (never used by the API).</desc>
830	</const>
831	<const name="Unlocked" value="1">
832	<desc>
833	In <link to="IMachine::sessionState"/>, this means that the machine
834	is not locked for any sessions.
835
836	In <link to="ISession::state"/>, this means that no machine is
837	currently locked for this session.
838	</desc>
839	</const>
840	<const name="Locked" value="2">
841	<desc>
842	In <link to="IMachine::sessionState"/>, this means that the machine
843	is currently locked for a session, whose process identifier can
844	then be found in the <link to="IMachine::sessionPid" /> attribute.
845
846	In <link to="ISession::state"/>, this means that a machine is
847	currently locked for this session, and the mutable machine object
848	can be found in the <link to="ISession::machine"/> attribute
849	(see <link to="IMachine::lockMachine" /> for details).
850	</desc>
851	</const>
852	<const name="Spawning" value="3">
853	<desc>
854	A new process is being spawned for the machine as a result of
855	<link to="IMachine::launchVMProcess"/> call. This state also occurs
856	as a short transient state during an <link to="IMachine::lockMachine"/>
857	call.
858	</desc>
859	</const>
860	<const name="Unlocking" value="4">
861	<desc>
862	The session is being unlocked.
863	</desc>
864	</const>
865	</enum>
866
867	<enum
868	name="CPUPropertyType"
869	uuid="24d356a6-2f45-4abd-b977-1cbe9c4701f5"
870	>
871	<desc>
872	Virtual CPU property type. This enumeration represents possible values of the
873	IMachine get- and setCPUProperty methods.
874	</desc>
875	<const name="Null" value="0">
876	<desc>Null value (never used by the API).</desc>
877	</const>
878	<const name="PAE" value="1">
879	<desc>
880	This setting determines whether VirtualBox will expose the Physical Address
881	Extension (PAE) feature of the host CPU to the guest. Note that in case PAE
882	is not available, it will not be reported.
883	</desc>
884	</const>
885	<const name="Synthetic" value="2">
886	<desc>
887	This setting determines whether VirtualBox will expose a synthetic CPU to the guest to allow
888	teleporting between host systems that differ significantly.
889	</desc>
890	</const>
891	</enum>
892
893
894	<enum
895	name="HWVirtExPropertyType"
896	uuid="ce81dfdd-d2b8-4a90-bbea-40ee8b7ffcee"
897	>
898	<desc>
899	Hardware virtualization property type. This enumeration represents possible values
900	for the <link to="IMachine::getHWVirtExProperty"/> and
901	<link to="IMachine::setHWVirtExProperty"/> methods.
902	</desc>
903	<const name="Null" value="0">
904	<desc>Null value (never used by the API).</desc>
905	</const>
906	<const name="Enabled" value="1">
907	<desc>
908	Whether hardware virtualization (VT-x/AMD-V) is enabled at all. If
909	such extensions are not available, they will not be used.
910	</desc>
911	</const>
912	<const name="Exclusive" value="2">
913	<desc>
914	Whether hardware virtualization is used exclusively by VirtualBox. When enabled,
915	VirtualBox assumes it can acquire full and exclusive access to the VT-x or AMD-V
916	feature of the host. To share these with other hypervisors, you must disable this property.
917	</desc>
918	</const>
919	<const name="VPID" value="3">
920	<desc>
921	Whether VT-x VPID is enabled. If this extension is not available, it will not be used.
922	</desc>
923	</const>
924	<const name="NestedPaging" value="4">
925	<desc>
926	Whether Nested Paging is enabled. If this extension is not available, it will not be used.
927	</desc>
928	</const>
929	<const name="LargePages" value="5">
930	<desc>
931	Whether large page allocation is enabled; requires nested paging and a 64 bits host.
932	</desc>
933	</const>
934	<const name="Force" value="6">
935	<desc>
936	Whether the VM should fail to start if hardware virtualization (VT-x/AMD-V) cannot be used. If
937	not set, there will be an automatic fallback to software virtualization.
938	</desc>
939	</const>
940	</enum>
941
942	<enum
943	name="FaultToleranceState"
944	uuid="5124f7ec-6b67-493c-9dee-ee45a44114e1"
945	>
946	<desc>
947	Used with <link to="IMachine::faultToleranceState" />.
948	</desc>
949	<const name="Inactive" value="1">
950	<desc>No fault tolerance enabled.</desc>
951	</const>
952	<const name="Master" value="2">
953	<desc>Fault tolerant master VM.</desc>
954	</const>
955	<const name="Standby" value="3">
956	<desc>Fault tolerant standby VM.</desc>
957	</const>
958	</enum>
959
960	<enum
961	name="LockType"
962	uuid="138b53f8-db4b-47c5-b32b-4ef52f769413"
963	>
964	<desc>
965	Used with <link to="IMachine::lockMachine" />.
966	</desc>
967	<const name="Write" value="2">
968	<desc>Lock the machine for writing.</desc>
969	</const>
970	<const name="Shared" value="1">
971	<desc>Request only a shared read lock for remote-controlling the machine.</desc>
972	</const>
973	</enum>
974
975	<enum
976	name="SessionType"
977	uuid="A13C02CB-0C2C-421E-8317-AC0E8AAA153A"
978	>
979	<desc>
980	Session type. This enumeration represents possible values of the
981	<link to="ISession::type"/> attribute.
982	</desc>
983
984	<const name="Null" value="0">
985	<desc>Null value (never used by the API).</desc>
986	</const>
987	<const name="WriteLock" value="1">
988	<desc>
989	Session has acquired an exclusive write lock on a machine
990	using <link to="IMachine::lockMachine"/>.
991	</desc>
992	</const>
993	<const name="Remote" value="2">
994	<desc>
995	Session has launched a VM process using
996	<link to="IMachine::launchVMProcess"/>
997	</desc>
998	</const>
999	<const name="Shared" value="3">
1000	<desc>
1001	Session has obtained a link to another session using
1002	<link to="IMachine::lockMachine"/>
1003	</desc>
1004	</const>
1005	</enum>
1006
1007	<enum
1008	name="DeviceType"
1009	uuid="6d9420f7-0b56-4636-99f9-7346f1b01e57"
1010	>
1011	<desc>
1012	Device type.
1013	</desc>
1014	<const name="Null" value="0">
1015	<desc>
1016	Null value, may also mean "no device" (not allowed for
1017	<link to="IConsole::getDeviceActivity"/>).
1018	</desc>
1019	</const>
1020	<const name="Floppy" value="1">
1021	<desc>Floppy device.</desc>
1022	</const>
1023	<const name="DVD" value="2">
1024	<desc>CD/DVD-ROM device.</desc>
1025	</const>
1026	<const name="HardDisk" value="3">
1027	<desc>Hard disk device.</desc>
1028	</const>
1029	<const name="Network" value="4">
1030	<desc>Network device.</desc>
1031	</const>
1032	<const name="USB" value="5">
1033	<desc>USB device.</desc>
1034	</const>
1035	<const name="SharedFolder" value="6">
1036	<desc>Shared folder device.</desc>
1037	</const>
1038	</enum>
1039
1040	<enum
1041	name="DeviceActivity"
1042	uuid="6FC8AEAA-130A-4eb5-8954-3F921422D707"
1043	>
1044	<desc>
1045	Device activity for <link to="IConsole::getDeviceActivity"/>.
1046	</desc>
1047
1048	<const name="Null" value="0"/>
1049	<const name="Idle" value="1"/>
1050	<const name="Reading" value="2"/>
1051	<const name="Writing" value="3"/>
1052	</enum>
1053
1054	<enum
1055	name="ClipboardMode"
1056	uuid="33364716-4008-4701-8f14-be0fa3d62950"
1057	>
1058	<desc>
1059	Host-Guest clipboard interchange mode.
1060	</desc>
1061
1062	<const name="Disabled" value="0"/>
1063	<const name="HostToGuest" value="1"/>
1064	<const name="GuestToHost" value="2"/>
1065	<const name="Bidirectional" value="3"/>
1066	</enum>
1067
1068	<enum
1069	name="Scope"
1070	uuid="7c91096e-499e-4eca-9f9b-9001438d7855"
1071	>
1072	<desc>
1073	Scope of the operation.
1074
1075	A generic enumeration used in various methods to define the action or
1076	argument scope.
1077	</desc>
1078
1079	<const name="Global" value="0"/>
1080	<const name="Machine" value="1"/>
1081	<const name="Session" value="2"/>
1082	</enum>
1083
1084	<enum
1085	name="BIOSBootMenuMode"
1086	uuid="ae4fb9f7-29d2-45b4-b2c7-d579603135d5"
1087	>
1088	<desc>
1089	BIOS boot menu mode.
1090	</desc>
1091
1092	<const name="Disabled" value="0"/>
1093	<const name="MenuOnly" value="1"/>
1094	<const name="MessageAndMenu" value="2"/>
1095	</enum>
1096
1097	<enum
1098	name="ProcessorFeature"
1099	uuid="64c38e6b-8bcf-45ad-ac03-9b406287c5bf"
1100	>
1101	<desc>
1102	CPU features.
1103	</desc>
1104
1105	<const name="HWVirtEx" value="0"/>
1106	<const name="PAE" value="1"/>
1107	<const name="LongMode" value="2"/>
1108	<const name="NestedPaging" value="3"/>
1109	</enum>
1110
1111	<enum
1112	name="FirmwareType"
1113	uuid="b903f264-c230-483e-ac74-2b37ce60d371"
1114	>
1115	<desc>
1116	Firmware type.
1117	</desc>
1118	<const name="BIOS" value="1">
1119	<desc>BIOS Firmware.</desc>
1120	</const>
1121	<const name="EFI" value="2">
1122	<desc>EFI Firmware, bitness detected basing on OS type.</desc>
1123	</const>
1124	<const name="EFI32" value="3">
1125	<desc>Efi firmware, 32-bit.</desc>
1126	</const>
1127	<const name="EFI64" value="4">
1128	<desc>Efi firmware, 64-bit.</desc>
1129	</const>
1130	<const name="EFIDUAL" value="5">
1131	<desc>Efi firmware, combined 32 and 64-bit.</desc>
1132	</const>
1133	</enum>
1134
1135	<enum
1136	name="PointingHidType"
1137	uuid="0d3c17a2-821a-4b2e-ae41-890c6c60aa97"
1138	>
1139	<desc>
1140	Type of pointing device used in a virtual machine.
1141	</desc>
1142	<const name="None" value="1">
1143	<desc>No mouse.</desc>
1144	</const>
1145	<const name="PS2Mouse" value="2">
1146	<desc>PS/2 auxiliary device, a.k.a. mouse.</desc>
1147	</const>
1148	<const name="USBMouse" value="3">
1149	<desc>USB mouse (relative pointer).</desc>
1150	</const>
1151	<const name="USBTablet" value="4">
1152	<desc>USB tablet (absolute pointer).</desc>
1153	</const>
1154	<const name="ComboMouse" value="5">
1155	<desc>Combined device, working as PS/2 or USB mouse, depending on guest behavior.
1156	Using of such device can have negative performance implications. </desc>
1157	</const>
1158	</enum>
1159
1160	<enum
1161	name="KeyboardHidType"
1162	uuid="5a5b0996-3a3e-44bb-9019-56979812cbcc"
1163	>
1164	<desc>
1165	Type of keyboard device used in a virtual machine.
1166	</desc>
1167	<const name="None" value="1">
1168	<desc>No keyboard.</desc>
1169	</const>
1170	<const name="PS2Keyboard" value="2">
1171	<desc>PS/2 keyboard.</desc>
1172	</const>
1173	<const name="USBKeyboard" value="3">
1174	<desc>USB keyboard.</desc>
1175	</const>
1176	<const name="ComboKeyboard" value="4">
1177	<desc>Combined device, working as PS/2 or USB keyboard, depending on guest behavior.
1178	Using of such device can have negative performance implications. </desc>
1179	</const>
1180	</enum>
1181
1182	<!--
1183	// IVirtualBoxErrorInfo
1184	/////////////////////////////////////////////////////////////////////////
1185	-->
1186
1187	<interface
1188	name="IVirtualBoxErrorInfo" extends="$errorinfo"
1189	uuid="e053d3c0-f493-491b-a735-3a9f0b1feed4"
1190	supportsErrorInfo="no"
1191	wsmap="managed"
1192	>
1193	<desc>
1194	The IVirtualBoxErrorInfo interface represents extended error information.
1195
1196	Extended error information can be set by VirtualBox components after
1197	unsuccessful or partially successful method invocation. This information
1198	can be retrieved by the calling party as an IVirtualBoxErrorInfo object
1199	and then shown to the client in addition to the plain 32-bit result code.
1200
1201	In MS COM, this interface extends the IErrorInfo interface,
1202	in XPCOM, it extends the nsIException interface. In both cases,
1203	it provides a set of common attributes to retrieve error
1204	information.
1205
1206	Sometimes invocation of some component's method may involve methods of
1207	other components that may also fail (independently of this method's
1208	failure), or a series of non-fatal errors may precede a fatal error that
1209	causes method failure. In cases like that, it may be desirable to preserve
1210	information about all errors happened during method invocation and deliver
1211	it to the caller. The <link to="#next"/> attribute is intended
1212	specifically for this purpose and allows to represent a chain of errors
1213	through a single IVirtualBoxErrorInfo object set after method invocation.
1214
1215	<note>errors are stored to a chain in the reverse order, i.e. the
1216	initial error object you query right after method invocation is the last
1217	error set by the callee, the object it points to in the @a next attribute
1218	is the previous error and so on, up to the first error (which is the last
1219	in the chain).</note>
1220	</desc>
1221
1222	<attribute name="resultCode" type="long" readonly="yes">
1223	<desc>
1224	Result code of the error.
1225	Usually, it will be the same as the result code returned
1226	by the method that provided this error information, but not
1227	always. For example, on Win32, CoCreateInstance() will most
1228	likely return E_NOINTERFACE upon unsuccessful component
1229	instantiation attempt, but not the value the component factory
1230	returned. Value is typed 'long', not 'result',
1231	to make interface usable from scripting languages.
1232	<note>
1233	In MS COM, there is no equivalent.
1234	In XPCOM, it is the same as nsIException::result.
1235	</note>
1236	</desc>
1237	</attribute>
1238
1239	<attribute name="interfaceID" type="uuid" mod="string" readonly="yes">
1240	<desc>
1241	UUID of the interface that defined the error.
1242	<note>
1243	In MS COM, it is the same as IErrorInfo::GetGUID, except for the
1244	data type.
1245	In XPCOM, there is no equivalent.
1246	</note>
1247	</desc>
1248	</attribute>
1249
1250	<attribute name="component" type="wstring" readonly="yes">
1251	<desc>
1252	Name of the component that generated the error.
1253	<note>
1254	In MS COM, it is the same as IErrorInfo::GetSource.
1255	In XPCOM, there is no equivalent.
1256	</note>
1257	</desc>
1258	</attribute>
1259
1260	<attribute name="text" type="wstring" readonly="yes">
1261	<desc>
1262	Text description of the error.
1263	<note>
1264	In MS COM, it is the same as IErrorInfo::GetDescription.
1265	In XPCOM, it is the same as nsIException::message.
1266	</note>
1267	</desc>
1268	</attribute>
1269
1270	<attribute name="next" type="IVirtualBoxErrorInfo" readonly="yes">
1271	<desc>
1272	Next error object if there is any, or @c null otherwise.
1273	<note>
1274	In MS COM, there is no equivalent.
1275	In XPCOM, it is the same as nsIException::inner.
1276	</note>
1277	</desc>
1278	</attribute>
1279
1280	</interface>
1281
1282	<!--
1283	// IVirtualBox
1284	/////////////////////////////////////////////////////////////////////////
1285	-->
1286
1287	<interface
1288	name="IDHCPServer" extends="$unknown"
1289	uuid="6cfe387c-74fb-4ca7-bff6-973bec8af7a3"
1290	wsmap="managed"
1291	>
1292	<desc>
1293	The IDHCPServer interface represents the vbox dhcp server configuration.
1294
1295	To enumerate all the dhcp servers on the host, use the
1296	<link to="IVirtualBox::DHCPServers"/> attribute.
1297	</desc>
1298
1299	<attribute name="enabled" type="boolean">
1300	<desc>
1301	specifies if the dhcp server is enabled
1302	</desc>
1303	</attribute>
1304
1305	<attribute name="IPAddress" type="wstring" readonly="yes">
1306	<desc>
1307	specifies server IP
1308	</desc>
1309	</attribute>
1310
1311	<attribute name="networkMask" type="wstring" readonly="yes">
1312	<desc>
1313	specifies server network mask
1314	</desc>
1315	</attribute>
1316
1317	<attribute name="networkName" type="wstring" readonly="yes">
1318	<desc>
1319	specifies internal network name the server is used for
1320	</desc>
1321	</attribute>
1322
1323	<attribute name="lowerIP" type="wstring" readonly="yes">
1324	<desc>
1325	specifies from IP address in server address range
1326	</desc>
1327	</attribute>
1328
1329	<attribute name="upperIP" type="wstring" readonly="yes">
1330	<desc>
1331	specifies to IP address in server address range
1332	</desc>
1333	</attribute>
1334
1335	<method name="setConfiguration">
1336	<desc>
1337	configures the server
1338	<result name="E_INVALIDARG">
1339	invalid configuration supplied
1340	</result>
1341	</desc>
1342	<param name="IPAddress" type="wstring" dir="in">
1343	<desc>
1344	server IP address
1345	</desc>
1346	</param>
1347	<param name="networkMask" type="wstring" dir="in">
1348	<desc>
1349	server network mask
1350	</desc>
1351	</param>
1352	<param name="FromIPAddress" type="wstring" dir="in">
1353	<desc>
1354	server From IP address for address range
1355	</desc>
1356	</param>
1357	<param name="ToIPAddress" type="wstring" dir="in">
1358	<desc>
1359	server To IP address for address range
1360	</desc>
1361	</param>
1362	</method>
1363
1364	<method name="start">
1365	<desc>
1366	Starts DHCP server process.
1367	<result name="E_FAIL">
1368	Failed to start the process.
1369	</result>
1370	</desc>
1371	<param name="networkName" type="wstring" dir="in">
1372	<desc>
1373	Name of internal network DHCP server should attach to.
1374	</desc>
1375	</param>
1376	<param name="trunkName" type="wstring" dir="in">
1377	<desc>
1378	Name of internal network trunk.
1379	</desc>
1380	</param>
1381	<param name="trunkType" type="wstring" dir="in">
1382	<desc>
1383	Type of internal network trunk.
1384	</desc>
1385	</param>
1386	</method>
1387
1388	<method name="stop">
1389	<desc>
1390	Stops DHCP server process.
1391	<result name="E_FAIL">
1392	Failed to stop the process.
1393	</result>
1394	</desc>
1395	</method>
1396	</interface>
1397
1398	<interface
1399	name="IVirtualBox" extends="$unknown"
1400	uuid="8bf22775-a3c1-4f81-80d3-138584474fb3"
1401	wsmap="managed"
1402	>
1403	<desc>
1404	The IVirtualBox interface represents the main interface exposed by the
1405	product that provides virtual machine management.
1406
1407	An instance of IVirtualBox is required for the product to do anything
1408	useful. Even though the interface does not expose this, internally,
1409	IVirtualBox is implemented as a singleton and actually lives in the
1410	process of the VirtualBox server (VBoxSVC.exe). This makes sure that
1411	IVirtualBox can track the state of all virtual machines on a particular
1412	host, regardless of which frontend started them.
1413
1414	To enumerate all the virtual machines on the host, use the
1415	<link to="IVirtualBox::machines"/> attribute.
1416	</desc>
1417
1418	<attribute name="version" type="wstring" readonly="yes">
1419	<desc>
1420	A string representing the version number of the product. The
1421	format is 3 integer numbers divided by dots (e.g. 1.0.1). The
1422	last number represents the build number and will frequently change.
1423
1424	This may be followed by a _ALPHA[0-9], _BETA[0-9] or _RC[0-9]* tag
1425	in prerelease builds. Non-Oracle builds may (/shall) also have a
1426	publisher tag, at the end. The publisher tag starts with an underscore
1427	just like the prerelease build type tag.
1428	</desc>
1429	</attribute>
1430
1431	<attribute name="revision" type="unsigned long" readonly="yes">
1432	<desc>
1433	The internal build revision number of the product.
1434	</desc>
1435	</attribute>
1436
1437	<attribute name="packageType" type="wstring" readonly="yes">
1438	<desc>
1439	A string representing the package type of this product. The
1440	format is OS_ARCH_DIST where OS is either WINDOWS, LINUX,
1441	SOLARIS, DARWIN. ARCH is either 32BITS or 64BITS. DIST
1442	is either GENERIC, UBUNTU_606, UBUNTU_710, or something like
1443	this.
1444	</desc>
1445	</attribute>
1446
1447	<attribute name="APIVersion" type="wstring" readonly="yes">
1448	<desc>
1449	A string representing the VirtualBox API version number. The format is
1450	2 integer numbers divided by an underscore (e.g. 1_0). After the
1451	first public release of packages with a particular API version the
1452	API will not be changed in an incompatible way. Note that this
1453	guarantee does not apply to development builds, and also there is no
1454	guarantee that this version is identical to the first two integer
1455	numbers of the package version.
1456	</desc>
1457	</attribute>
1458
1459	<attribute name="homeFolder" type="wstring" readonly="yes">
1460	<desc>
1461	Full path to the directory where the global settings file,
1462	<tt>VirtualBox.xml</tt>, is stored.
1463
1464	In this version of VirtualBox, the value of this property is
1465	always <tt><user_dir>/.VirtualBox</tt> (where
1466	<tt><user_dir></tt> is the path to the user directory,
1467	as determined by the host OS), and cannot be changed.
1468
1469	This path is also used as the base to resolve relative paths in
1470	places where relative paths are allowed (unless otherwise
1471	expressly indicated).
1472	</desc>
1473	</attribute>
1474
1475	<attribute name="settingsFilePath" type="wstring" readonly="yes">
1476	<desc>
1477	Full name of the global settings file.
1478	The value of this property corresponds to the value of
1479	<link to="#homeFolder"/> plus <tt>/VirtualBox.xml</tt>.
1480	</desc>
1481	</attribute>
1482
1483	<attribute name="host" type="IHost" readonly="yes">
1484	<desc>Associated host object.</desc>
1485	</attribute>
1486
1487	<attribute name="systemProperties" type="ISystemProperties" readonly="yes">
1488	<desc>Associated system information object.</desc>
1489	</attribute>
1490
1491	<attribute name="machines" type="IMachine" readonly="yes" safearray="yes">
1492	<desc>
1493	Array of machine objects registered within this VirtualBox instance.
1494	</desc>
1495	</attribute>
1496
1497	<attribute name="hardDisks" type="IMedium" readonly="yes" safearray="yes">
1498	<desc>
1499	Array of medium objects known to this VirtualBox installation.
1500
1501	This array contains only base media. All differencing
1502	media of the given base medium can be enumerated using
1503	<link to="IMedium::children"/>.
1504	</desc>
1505	</attribute>
1506
1507	<attribute name="DVDImages" type="IMedium" readonly="yes" safearray="yes">
1508	<desc>
1509	Array of CD/DVD image objects currently in use by this VirtualBox instance.
1510	</desc>
1511	</attribute>
1512
1513	<attribute name="floppyImages" type="IMedium" readonly="yes" safearray="yes">
1514	<desc>
1515	Array of floppy image objects currently in use by this VirtualBox instance.
1516	</desc>
1517	</attribute>
1518
1519	<attribute name="progressOperations" type="IProgress" readonly="yes" safearray="yes"/>
1520
1521	<attribute name="guestOSTypes" type="IGuestOSType" readonly="yes" safearray="yes"/>
1522
1523	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
1524	<desc>
1525	Collection of global shared folders. Global shared folders are
1526	available to all virtual machines.
1527
1528	New shared folders are added to the collection using
1529	<link to="#createSharedFolder"/>. Existing shared folders can be
1530	removed using <link to="#removeSharedFolder"/>.
1531
1532	<note>
1533	In the current version of the product, global shared folders are not
1534	implemented and therefore this collection is always empty.
1535	</note>
1536	</desc>
1537	</attribute>
1538
1539	<attribute name="performanceCollector" type="IPerformanceCollector" readonly="yes">
1540	<desc>
1541	Associated performance collector object.
1542	</desc>
1543	</attribute>
1544
1545	<attribute name="DHCPServers" type="IDHCPServer" safearray="yes" readonly="yes">
1546	<desc>
1547	DHCP servers.
1548	</desc>
1549	</attribute>
1550
1551	<attribute name="eventSource" type="IEventSource" readonly="yes">
1552	<desc>
1553	Event source for VirtualBox events.
1554	</desc>
1555	</attribute>
1556
1557	<attribute name="extensionPackManager" type="IExtPackManager" readonly="yes">
1558	<desc>
1559	The extension pack manager.
1560	</desc>
1561	</attribute>
1562
1563
1564	<attribute name="internalNetworks" type="wstring" safearray="yes" readonly="yes">
1565	<desc>
1566	Names of all internal networks.
1567	</desc>
1568	</attribute>
1569
1570	<attribute name="genericNetworkDrivers" type="wstring" safearray="yes" readonly="yes">
1571	<desc>
1572	Names of all generic network drivers.
1573	</desc>
1574	</attribute>
1575
1576	<method name="composeMachineFilename">
1577	<desc>
1578	Returns a recommended full path of the settings file name for a new virtual
1579	machine.
1580
1581	This API serves two purposes:
1582
1583	<ul>
1584	<li>It gets called by <link to="#createMachine" /> if NULL is specified
1585	for the @a settingsFile argument there, which means that API should use
1586	a recommended default file name.</li>
1587
1588	<li>It can be called manually by a client software before creating a machine,
1589	e.g. if that client wants to pre-create the machine directory to create
1590	virtual hard disks in that directory together with the new machine
1591	settings file. In that case, the file name should be stripped from the
1592	full settings file path returned by this function to obtain the
1593	machine directory.</li>
1594	</ul>
1595
1596	See <link to="IMachine::name"/> and <link to="#createMachine"/> for more
1597	details about the machine name.
1598
1599	If @a baseFolder is a @c null or empty string (which is recommended), the
1600	default machine settings folder
1601	(see <link to="ISystemProperties::defaultMachineFolder" />) will be used as
1602	a base folder for the created machine, resulting in a file name like
1603	"/home/user/VirtualBox VMs/name/name.vbox". Otherwise the given base folder
1604	will be used.
1605
1606	This method does not access the host disks. In particular, it does not check
1607	for whether a machine of this name already exists.
1608	</desc>
1609	<param name="name" type="wstring" dir="in">
1610	<desc>Suggested machine name.</desc>
1611	</param>
1612	<param name="baseFolder" type="wstring" dir="in">
1613	<desc>Base machine folder (optional).</desc>
1614	</param>
1615	<param name="file" type="wstring" dir="return">
1616	<desc>Fully qualified path where the machine would be created.</desc>
1617	</param>
1618	</method>
1619
1620	<method name="createMachine">
1621	<desc>
1622	Creates a new virtual machine by creating a machine settings file at
1623	the given location.
1624
1625	VirtualBox machine settings files use a custom XML dialect. Starting
1626	with VirtualBox 4.0, a ".vbox" extension is recommended, but not enforced,
1627	and machine files can be created at arbitrary locations.
1628
1629	However, it is is recommended that machines be created in the default
1630	machine folder (e.g. "/home/user/VirtualBox VMs/name/name.vbox"; see
1631	<link to="ISystemProperties::defaultMachineFolder" />). If you specify
1632	NULL for the @a settingsFile argument, <link to="#composeMachineFilename" />
1633	is called automatically to have such a recommended name composed based
1634	on the machine name given in the @a name argument.
1635
1636	If the resulting settings file already exists, this method will fail,
1637	unless @a forceOverwrite is set.
1638
1639	The new machine is created unregistered, with the initial configuration
1640	set according to the specified guest OS type. A typical sequence of
1641	actions to create a new virtual machine is as follows:
1642
1643	<ol>
1644	<li>
1645	Call this method to have a new machine created. The returned machine
1646	object will be "mutable" allowing to change any machine property.
1647	</li>
1648
1649	<li>
1650	Configure the machine using the appropriate attributes and methods.
1651	</li>
1652
1653	<li>
1654	Call <link to="IMachine::saveSettings" /> to write the settings
1655	to the machine's XML settings file. The configuration of the newly
1656	created machine will not be saved to disk until this method is
1657	called.
1658	</li>
1659
1660	<li>
1661	Call <link to="#registerMachine" /> to add the machine to the list
1662	of machines known to VirtualBox.
1663	</li>
1664	</ol>
1665
1666	The specified guest OS type identifier must match an ID of one of known
1667	guest OS types listed in the <link to="IVirtualBox::guestOSTypes"/>
1668	array.
1669
1670	Optionally, you may specify an UUID of to assign to the created machine.
1671	However, this is not recommended and you should normally pass an empty
1672	(@c null) UUID to this method so that a new UUID will be automatically
1673	generated for every created machine. You can use UUID
1674	00000000-0000-0000-0000-000000000000 as @c null value.
1675
1676	<note>
1677	There is no way to change the name of the settings file or
1678	subfolder of the created machine directly.
1679	</note>
1680
1681	<result name="VBOX_E_OBJECT_NOT_FOUND">
1682	@a osTypeId is invalid.
1683	</result>
1684	<result name="VBOX_E_FILE_ERROR">
1685	Resulting settings file name is invalid or the settings file already
1686	exists or could not be created due to an I/O error.
1687	</result>
1688	<result name="E_INVALIDARG">
1689	@a name is empty or @c null.
1690	</result>
1691	</desc>
1692
1693	<param name="settingsFile" type="wstring" dir="in">
1694	<desc>Fully qualified path where the settings file should be created,
1695	or NULL for a default folder and file based on the @a name argument
1696	(see <link to="#composeMachineFilename" />).</desc>
1697	</param>
1698	<param name="name" type="wstring" dir="in">
1699	<desc>Machine name.</desc>
1700	</param>
1701	<param name="osTypeId" type="wstring" dir="in">
1702	<desc>Guest OS Type ID.</desc>
1703	</param>
1704	<param name="id" type="uuid" mod="string" dir="in">
1705	<desc>Machine UUID (optional).</desc>
1706	</param>
1707	<param name="forceOverwrite" type="boolean" dir="in">
1708	<desc>If true, an existing machine settings file will be overwritten.</desc>
1709	</param>
1710	<param name="machine" type="IMachine" dir="return">
1711	<desc>Created machine object.</desc>
1712	</param>
1713	</method>
1714
1715	<method name="openMachine">
1716	<desc>
1717	Opens a virtual machine from the existing settings file.
1718	The opened machine remains unregistered until you call
1719	<link to="#registerMachine"/>.
1720
1721	The specified settings file name must be fully qualified.
1722	The file must exist and be a valid machine XML settings file
1723	whose contents will be used to construct the machine object.
1724
1725	<result name="VBOX_E_FILE_ERROR">
1726	Settings file name invalid, not found or sharing violation.
1727	</result>
1728	</desc>
1729	<param name="settingsFile" type="wstring" dir="in">
1730	<desc>
1731	Name of the machine settings file.
1732	</desc>
1733	</param>
1734	<param name="machine" type="IMachine" dir="return">
1735	<desc>Opened machine object.</desc>
1736	</param>
1737	<note>
1738	<link to="IMachine::settingsModified"/> will return
1739	@c false for the created machine, until any of machine settings
1740	are changed.
1741	</note>
1742	</method>
1743
1744	<method name="registerMachine">
1745	<desc>
1746
1747	Registers the machine previously created using
1748	<link to="#createMachine"/> or opened using
1749	<link to="#openMachine"/> within this VirtualBox installation. After
1750	successful method invocation, the
1751	<link to="IMachineRegisteredEvent"/> event is fired.
1752
1753	<note>
1754	This method implicitly calls <link to="IMachine::saveSettings"/>
1755	to save all current machine settings before registering it.
1756	</note>
1757
1758	<result name="VBOX_E_OBJECT_NOT_FOUND">
1759	No matching virtual machine found.
1760	</result>
1761	<result name="VBOX_E_INVALID_OBJECT_STATE">
1762	Virtual machine was not created within this VirtualBox instance.
1763	</result>
1764
1765	</desc>
1766	<param name="machine" type="IMachine" dir="in"/>
1767	</method>
1768
1769	<method name="findMachine">
1770	<desc>
1771	Attempts to find a virtual machine given its name or UUID.
1772
1773	<note>Inaccessible machines cannot be found by name, only by UUID, because their name
1774	cannot safely be determined.</note>
1775
1776	<result name="VBOX_E_OBJECT_NOT_FOUND">
1777	Could not find registered machine matching @a nameOrId.
1778	</result>
1779
1780	</desc>
1781	<param name="nameOrId" type="wstring" dir="in">
1782	<desc>What to search for. This can either be the UUID or the name of a virtual machine.</desc>
1783	</param>
1784	<param name="machine" type="IMachine" dir="return">
1785	<desc>Machine object, if found.</desc>
1786	</param>
1787	</method>
1788
1789	<method name="getMachineStates">
1790	<desc>
1791	Gets the state of several machines in a single operation.
1792	</desc>
1793	<param name="machines" type="IMachine" dir="in" safearray="yes">
1794	<desc>Array with the machine references.</desc>
1795	</param>
1796	<param name="states" type="MachineState" dir="return" safearray="yes">
1797	<desc>Machine states, corresponding to the machines.</desc>
1798	</param>
1799	</method>
1800
1801	<method name="createAppliance">
1802	<desc>
1803	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1804	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1805	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1806	</desc>
1807	<param name="appliance" type="IAppliance" dir="return">
1808	<desc>New appliance.</desc>
1809	</param>
1810	</method>
1811
1812	<method name="createHardDisk">
1813	<desc>
1814	Creates a new base medium object that will use the given storage
1815	format and location for medium data.
1816
1817	The actual storage unit is not created by this method. In order to
1818	do it, and before you are able to attach the created medium to
1819	virtual machines, you must call one of the following methods to
1820	allocate a format-specific storage unit at the specified location:
1821	<ul>
1822	<li><link to="IMedium::createBaseStorage"/></li>
1823	<li><link to="IMedium::createDiffStorage"/></li>
1824	</ul>
1825
1826	Some medium attributes, such as <link to="IMedium::id"/>, may
1827	remain uninitialized until the medium storage unit is successfully
1828	created by one of the above methods.
1829
1830	After the storage unit is successfully created, it will be
1831	accessible through the <link to="#findMedium"/> method and can
1832	be found in the <link to="#hardDisks"/> array.
1833
1834	The list of all storage formats supported by this VirtualBox
1835	installation can be obtained using
1836	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1837	attribute is empty or @c null then the default storage format
1838	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1839	be used for creating a storage unit of the medium.
1840
1841	Note that the format of the location string is storage format specific.
1842	See <link to="IMedium::location"/> and IMedium for more details.
1843
1844	<result name="VBOX_E_OBJECT_NOT_FOUND">
1845	@a format identifier is invalid. See
1846	<link to="ISystemProperties::mediumFormats"/>.
1847	</result>
1848	<result name="VBOX_E_FILE_ERROR">
1849	@a location is a not valid file name (for file-based formats only).
1850	</result>
1851	</desc>
1852	<param name="format" type="wstring" dir="in">
1853	<desc>
1854	Identifier of the storage format to use for the new medium.
1855	</desc>
1856	</param>
1857	<param name="location" type="wstring" dir="in">
1858	<desc>
1859	Location of the storage unit for the new medium.
1860	</desc>
1861	</param>
1862	<param name="medium" type="IMedium" dir="return">
1863	<desc>Created medium object.</desc>
1864	</param>
1865	</method>
1866
1867	<method name="openMedium">
1868	<desc>
1869	Opens a medium from an existing storage location.
1870
1871	Once a medium has been opened, it can be passed to other VirtualBox
1872	methods, in particular to <link to="IMachine::attachDevice" />.
1873
1874	Depending on the given device type, the file at the storage location
1875	must be in one of the media formats understood by VirtualBox:
1876
1877	<ul>
1878	<li>With a "HardDisk" device type, the file must be a hard disk image
1879	in one of the formats supported by VirtualBox (see
1880	<link to="ISystemProperties::mediumFormats" />).
1881	After this method succeeds, if the medium is a base medium, it
1882	will be added to the <link to="#hardDisks"/> array attribute. </li>
1883	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1884	After this method succeeds, the medium will be added to the
1885	<link to="#DVDImages"/> array attribute.</li>
1886	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1887	After this method succeeds, the medium will be added to the
1888	<link to="#floppyImages"/> array attribute.</li>
1889	</ul>
1890
1891	After having been opened, the medium can be found by the <link to="#findMedium"/>
1892	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1893
1894	The UUID of the newly opened medium will either be retrieved from the
1895	storage location, if the format supports it (e.g. for hard disk images),
1896	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1897	If for some reason you need to change the medium's UUID, use
1898	<link to="IMedium::setIDs" />.
1899
1900	If a differencing hard disk medium is to be opened by this method, the
1901	operation will succeed only if its parent medium and all ancestors,
1902	if any, are already known to this VirtualBox installation (for example,
1903	were opened by this method before).
1904
1905	This method attempts to guess the storage format of the specified medium
1906	by reading medium data at the specified location.
1907
1908	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1909	the image is opened for read/write access and must have according permissions,
1910	as VirtualBox may actually write status information into the disk's metadata
1911	sections.
1912
1913	Note that write access is required for all typical hard disk usage in VirtualBox,
1914	since VirtualBox may need to write metadata such as a UUID into the image.
1915	The only exception is opening a source image temporarily for copying and
1916	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1917	again soon.
1918
1919	The format of the location string is storage format specific. See
1920	<link to="IMedium::location"/> and IMedium for more details.
1921
1922	<result name="VBOX_E_FILE_ERROR">
1923	Invalid medium storage file location or could not find the medium
1924	at the specified location.
1925	</result>
1926	<result name="VBOX_E_IPRT_ERROR">
1927	Could not get medium storage format.
1928	</result>
1929	<result name="E_INVALIDARG">
1930	Invalid medium storage format.
1931	</result>
1932	<result name="VBOX_E_INVALID_OBJECT_STATE">
1933	Medium has already been added to a media registry.
1934	</result>
1935	</desc>
1936	<param name="location" type="wstring" dir="in">
1937	<desc>
1938	Location of the storage unit that contains medium data in one of
1939	the supported storage formats.
1940	</desc>
1941	</param>
1942	<param name="deviceType" type="DeviceType" dir="in">
1943	<desc>
1944	Must be one of "HardDisk", "DVD" or "Floppy".
1945	</desc>
1946	</param>
1947	<param name="accessMode" type="AccessMode" dir="in">
1948	<desc>Whether to open the image in read/write or read-only mode. For
1949	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1950	</param>
1951	<param name="forceNewUuid" type="boolean" dir="in">
1952	<desc>Allows the caller to request a completely new medium UUID for
1953	the image which is to be opened. Useful if one intends to open an exact
1954	copy of a previously opened image, as this would normally fail due to
1955	the duplicate UUID.</desc>
1956	</param>
1957	<param name="medium" type="IMedium" dir="return">
1958	<desc>Opened medium object.</desc>
1959	</param>
1960	</method>
1961
1962	<method name="findMedium">
1963	<desc>
1964	Returns a medium of the given type that uses the given fully qualified
1965	location or UUID to store medium data.
1966
1967	The given medium must be known to this VirtualBox installation, i.e.
1968	it must be previously created by <link to="#createHardDisk"/> or opened
1969	by <link to="#openMedium"/>.
1970
1971	The search is done by comparing the value of the @a location argument to
1972	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1973	attributes of each known medium.
1974
1975	On case sensitive file systems, a case sensitive comparison is performed,
1976	otherwise the case of symbols in the file path is ignored.
1977
1978	<result name="VBOX_E_OBJECT_NOT_FOUND">
1979	No medium object matching @a location found.
1980	</result>
1981	</desc>
1982	<param name="location" type="wstring" dir="in">
1983	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1984	</param>
1985	<param name="type" type="DeviceType" dir="in">
1986	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1987	</param>
1988	<param name="medium" type="IMedium" dir="return">
1989	<desc>Medium object, if found.</desc>
1990	</param>
1991	</method>
1992
1993	<method name="getGuestOSType">
1994	<desc>
1995	Returns an object describing the specified guest OS type.
1996
1997	The requested guest OS type is specified using a string which is a
1998	mnemonic identifier of the guest operating system, such as
1999	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
2000	particular virtual machine can be read or set using the
2001	<link to="IMachine::OSTypeId"/> attribute.
2002
2003	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
2004	available guest OS type objects. Each object has an
2005	<link to="IGuestOSType::id"/> attribute which contains an identifier of
2006	the guest OS this object describes.
2007
2008	<result name="E_INVALIDARG">
2009	@a id is not a valid Guest OS type.
2010	</result>
2011
2012	</desc>
2013	<param name="id" type="uuid" mod="string" dir="in">
2014	<desc>Guest OS type ID string.</desc>
2015	</param>
2016	<param name="type" type="IGuestOSType" dir="return">
2017	<desc>Guest OS type object.</desc>
2018	</param>
2019	</method>
2020
2021	<method name="createSharedFolder">
2022	<desc>
2023	Creates a new global shared folder by associating the given logical
2024	name with the given host path, adds it to the collection of shared
2025	folders and starts sharing it. Refer to the description of
2026	<link to="ISharedFolder"/> to read more about logical names.
2027	<note>
2028	In the current implementation, this operation is not
2029	implemented.
2030	</note>
2031	</desc>
2032	<param name="name" type="wstring" dir="in">
2033	<desc>Unique logical name of the shared folder.</desc>
2034	</param>
2035	<param name="hostPath" type="wstring" dir="in">
2036	<desc>Full path to the shared folder in the host file system.</desc>
2037	</param>
2038	<param name="writable" type="boolean" dir="in">
2039	<desc>Whether the share is writable or readonly</desc>
2040	</param>
2041	<param name="automount" type="boolean" dir="in">
2042	<desc>Whether the share gets automatically mounted by the guest
2043	or not.</desc>
2044	</param>
2045	</method>
2046
2047	<method name="removeSharedFolder">
2048	<desc>
2049	Removes the global shared folder with the given name previously
2050	created by <link to="#createSharedFolder"/> from the collection of
2051	shared folders and stops sharing it.
2052	<note>
2053	In the current implementation, this operation is not
2054	implemented.
2055	</note>
2056	</desc>
2057	<param name="name" type="wstring" dir="in">
2058	<desc>Logical name of the shared folder to remove.</desc>
2059	</param>
2060	</method>
2061
2062	<method name="getExtraDataKeys">
2063	<desc>
2064	Returns an array representing the global extra data keys which currently
2065	have values defined.
2066	</desc>
2067	<param name="value" type="wstring" dir="return" safearray="yes">
2068	<desc>Array of extra data keys.</desc>
2069	</param>
2070	</method>
2071
2072	<method name="getExtraData">
2073	<desc>
2074	Returns associated global extra data.
2075
2076	If the requested data @a key does not exist, this function will
2077	succeed and return an empty string in the @a value argument.
2078
2079	<result name="VBOX_E_FILE_ERROR">
2080	Settings file not accessible.
2081	</result>
2082	<result name="VBOX_E_XML_ERROR">
2083	Could not parse the settings file.
2084	</result>
2085
2086	</desc>
2087	<param name="key" type="wstring" dir="in">
2088	<desc>Name of the data key to get.</desc>
2089	</param>
2090	<param name="value" type="wstring" dir="return">
2091	<desc>Value of the requested data key.</desc>
2092	</param>
2093	</method>
2094
2095	<method name="setExtraData">
2096	<desc>
2097	Sets associated global extra data.
2098
2099	If you pass @c null or empty string as a key @a value, the given @a key
2100	will be deleted.
2101
2102	<note>
2103	Before performing the actual data change, this method will ask all
2104	registered event listener using the
2105	<link to="IExtraDataCanChangeEvent"/>
2106	notification for a permission. If one of the listeners refuses the
2107	new value, the change will not be performed.
2108	</note>
2109	<note>
2110	On success, the
2111	<link to="IExtraDataChangedEvent"/> notification
2112	is called to inform all registered listeners about a successful data
2113	change.
2114	</note>
2115
2116	<result name="VBOX_E_FILE_ERROR">
2117	Settings file not accessible.
2118	</result>
2119	<result name="VBOX_E_XML_ERROR">
2120	Could not parse the settings file.
2121	</result>
2122	<result name="E_ACCESSDENIED">
2123	Modification request refused.
2124	</result>
2125
2126	</desc>
2127	<param name="key" type="wstring" dir="in">
2128	<desc>Name of the data key to set.</desc>
2129	</param>
2130	<param name="value" type="wstring" dir="in">
2131	<desc>Value to assign to the key.</desc>
2132	</param>
2133	</method>
2134
2135	<!--method name="createDHCPServerForInterface">
2136	<desc>
2137	Creates a dhcp server settings to be used for the given interface
2138	<result name="E_INVALIDARG">
2139	Host network interface @a name already exists.
2140	</result>
2141	</desc>
2142	<param name="interface" type="IHostNetworkInterface" dir="in">
2143	<desc>Network Interface</desc>
2144	</param>
2145	<param name="server" type="IDHCPServer" dir="out">
2146	<desc>Dhcp server settings</desc>
2147	</param>
2148	</method-->
2149
2150	<method name="createDHCPServer">
2151	<desc>
2152	Creates a dhcp server settings to be used for the given internal network name
2153	<result name="E_INVALIDARG">
2154	Host network interface @a name already exists.
2155	</result>
2156	</desc>
2157	<param name="name" type="wstring" dir="in">
2158	<desc>server name</desc>
2159	</param>
2160	<param name="server" type="IDHCPServer" dir="return">
2161	<desc>Dhcp server settings</desc>
2162	</param>
2163	</method>
2164
2165	<method name="findDHCPServerByNetworkName">
2166	<desc>
2167	Searches a dhcp server settings to be used for the given internal network name
2168	<result name="E_INVALIDARG">
2169	Host network interface @a name already exists.
2170	</result>
2171
2172	</desc>
2173	<param name="name" type="wstring" dir="in">
2174	<desc>server name</desc>
2175	</param>
2176	<param name="server" type="IDHCPServer" dir="return">
2177	<desc>Dhcp server settings</desc>
2178	</param>
2179	</method>
2180
2181	<!--method name="findDHCPServerForInterface">
2182	<desc>
2183	Searches a dhcp server settings to be used for the given interface
2184	<result name="E_INVALIDARG">
2185	Host network interface @a name already exists.
2186	</result>
2187	</desc>
2188	<param name="interface" type="IHostNetworkInterface" dir="in">
2189	<desc>Network Interface</desc>
2190	</param>
2191	<param name="server" type="IDHCPServer" dir="out">
2192	<desc>Dhcp server settings</desc>
2193	</param>
2194	</method-->
2195
2196	<method name="removeDHCPServer">
2197	<desc>
2198	Removes the dhcp server settings
2199	<result name="E_INVALIDARG">
2200	Host network interface @a name already exists.
2201	</result>
2202	</desc>
2203	<param name="server" type="IDHCPServer" dir="in">
2204	<desc>Dhcp server settings to be removed</desc>
2205	</param>
2206	</method>
2207
2208
2209	<method name="checkFirmwarePresent">
2210	<desc>
2211	Check if this VirtualBox installation has a firmware
2212	of the given type available, either system-wide or per-user.
2213	Optionally, this may return a hint where this firmware can be
2214	downloaded from.
2215	</desc>
2216	<param name="firmwareType" type="FirmwareType" dir="in">
2217	<desc>
2218	Type of firmware to check.
2219	</desc>
2220	</param>
2221	<param name="version" type="wstring" dir="in">
2222	<desc>Expected version number, usually empty string (presently ignored).</desc>
2223	</param>
2224
2225	<param name="url" type="wstring" dir="out">
2226	<desc>
2227	Suggested URL to download this firmware from.
2228	</desc>
2229	</param>
2230
2231	<param name="file" type="wstring" dir="out">
2232	<desc>
2233	Filename of firmware, only valid if result == TRUE.
2234	</desc>
2235	</param>
2236
2237	<param name="result" type="boolean" dir="return">
2238	<desc>If firmware of this type and version is available.</desc>
2239	</param>
2240	</method>
2241
2242	</interface>
2243
2244	<!--
2245	// IVFSExplorer
2246	/////////////////////////////////////////////////////////////////////////
2247	-->
2248
2249	<enum
2250	name="VFSType"
2251	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2252	>
2253	<desc>
2254	Virtual file systems supported by VFSExplorer.
2255	</desc>
2256
2257	<const name="File" value="1" />
2258	<const name="Cloud" value="2" />
2259	<const name="S3" value="3" />
2260	<const name="WebDav" value="4" />
2261	</enum>
2262
2263	<enum
2264	name="VFSFileType"
2265	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2266	>
2267	<desc>
2268	File types known by VFSExplorer.
2269	</desc>
2270
2271	<const name="Unknown" value="1" />
2272	<const name="Fifo" value="2" />
2273	<const name="DevChar" value="3" />
2274	<const name="Directory" value="4" />
2275	<const name="DevBlock" value="5" />
2276	<const name="File" value="6" />
2277	<const name="SymLink" value="7" />
2278	<const name="Socket" value="8" />
2279	<const name="WhiteOut" value="9" />
2280	</enum>
2281
2282	<interface
2283	name="IVFSExplorer" extends="$unknown"
2284	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2285	wsmap="managed"
2286	>
2287	<desc>
2288	The VFSExplorer interface unifies access to different file system
2289	types. This includes local file systems as well remote file systems like
2290	S3. For a list of supported types see <link to="VFSType" />.
2291	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2292	</desc>
2293
2294	<attribute name="path" type="wstring" readonly="yes">
2295	<desc>Returns the current path in the virtual file system.</desc>
2296	</attribute>
2297
2298	<attribute name="type" type="VFSType" readonly="yes">
2299	<desc>Returns the file system type which is currently in use.</desc>
2300	</attribute>
2301
2302	<method name="update">
2303	<desc>Updates the internal list of files/directories from the
2304	current directory level. Use <link to="#entryList" /> to get the full list
2305	after a call to this method.</desc>
2306
2307	<param name="aProgress" type="IProgress" dir="return">
2308	<desc>Progress object to track the operation completion.</desc>
2309	</param>
2310	</method>
2311
2312	<method name="cd">
2313	<desc>Change the current directory level.</desc>
2314
2315	<param name="aDir" type="wstring" dir="in">
2316	<desc>The name of the directory to go in.</desc>
2317	</param>
2318
2319	<param name="aProgress" type="IProgress" dir="return">
2320	<desc>Progress object to track the operation completion.</desc>
2321	</param>
2322	</method>
2323
2324	<method name="cdUp">
2325	<desc>Go one directory upwards from the current directory level.</desc>
2326
2327	<param name="aProgress" type="IProgress" dir="return">
2328	<desc>Progress object to track the operation completion.</desc>
2329	</param>
2330	</method>
2331
2332	<method name="entryList">
2333	<desc>Returns a list of files/directories after a call to <link
2334	to="#update" />. The user is responsible for keeping this internal
2335	list up do date.</desc>
2336
2337	<param name="aNames" type="wstring" safearray="yes" dir="out">
2338	<desc>The list of names for the entries.</desc>
2339	</param>
2340
2341	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2342	<desc>The list of types for the entries.</desc>
2343	</param>
2344
2345	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2346	<desc>The list of sizes (in bytes) for the entries.</desc>
2347	</param>
2348
2349	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2350	<desc>The list of file modes (in octal form) for the entries.</desc>
2351	</param>
2352	</method>
2353
2354	<method name="exists">
2355	<desc>Checks if the given file list exists in the current directory
2356	level.</desc>
2357
2358	<param name="aNames" type="wstring" safearray="yes" dir="in">
2359	<desc>The names to check.</desc>
2360	</param>
2361
2362	<param name="aExists" type="wstring" safearray="yes" dir="return">
2363	<desc>The names which exist.</desc>
2364	</param>
2365	</method>
2366
2367	<method name="remove">
2368	<desc>Deletes the given files in the current directory level.</desc>
2369
2370	<param name="aNames" type="wstring" safearray="yes" dir="in">
2371	<desc>The names to remove.</desc>
2372	</param>
2373
2374	<param name="aProgress" type="IProgress" dir="return">
2375	<desc>Progress object to track the operation completion.</desc>
2376	</param>
2377	</method>
2378
2379	</interface>
2380
2381	<enum
2382	name="ImportOptions" extends="$unknown"
2383	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2384	>
2385
2386	<desc>
2387	Import options, used with <link to="IAppliance::importMachines" />.
2388	</desc>
2389
2390	<const name="KeepAllMACs" value="1">
2391	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2392	</const>
2393	<const name="KeepNATMACs" value="2">
2394	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2395	</const>
2396
2397	</enum>
2398
2399
2400	<!--
2401	// IAppliance
2402	/////////////////////////////////////////////////////////////////////////
2403	-->
2404
2405	<interface
2406	name="IAppliance" extends="$unknown"
2407	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2408	wsmap="managed"
2409	>
2410	<desc>
2411	Represents a platform-independent appliance in OVF format. An instance of this is returned
2412	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2413	virtual machines within an appliance with VirtualBox.
2414
2415	The OVF standard suggests two different physical file formats:
2416
2417	<ol>
2418	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2419	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2420	this descriptor file references other files such as disk images, as OVF appliances typically
2421	do, those additional files must be in the same directory as the descriptor file.</li>
2422
2423	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2424	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2425	files and optionally other files.
2426
2427	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2428	be added with a later version.</li>
2429	</ol>
2430
2431	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2432	<link to="IMachine" /> involves the following sequence of API calls:
2433
2434	<ol>
2435	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2436	</li>
2437
2438	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2439	would like to import. So long as this file is syntactically valid, this will succeed
2440	and fill the appliance object with the parsed data from the OVF file.
2441	</li>
2442
2443	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2444	contents of the IAppliance attributes accordingly. These can be inspected by a
2445	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2446	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2447	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2448	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2449	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2450	The GUI can then give the user the option to confirm and/or change these suggestions.
2451	</li>
2452
2453	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2454	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2455	</li>
2456
2457	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2458	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2459	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2460	can be found in the <link to="#machines" /> array attribute.
2461	</li>
2462	</ol>
2463
2464	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2465
2466	<ol>
2467	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2468	an empty IAppliance object.
2469	</li>
2470
2471	<li>For each machine you would like to export, call <link to="IMachine::export" />
2472	with the IAppliance object you just created. Each such call creates one instance of
2473	<link to="IVirtualSystemDescription" /> inside the appliance.
2474	</li>
2475
2476	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2477	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2478	</li>
2479
2480	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2481	file written.</li>
2482	</ol>
2483
2484	</desc>
2485
2486	<attribute name="path" type="wstring" readonly="yes">
2487	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2488	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2489	<link to="#write" /> (for export).
2490	This attribute is empty until one of these methods has been called.
2491	</desc>
2492	</attribute>
2493
2494	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2495	<desc>
2496	Array of virtual disk definitions. One such description exists for each
2497	disk definition in the OVF; each string array item represents one such piece of
2498	disk information, with the information fields separated by tab (\\t) characters.
2499
2500	The caller should be prepared for additional fields being appended to
2501	this string in future versions of VirtualBox and therefore check for
2502	the number of tabs in the strings returned.
2503
2504	In the current version, the following eight fields are returned per string
2505	in the array:
2506
2507	<ol>
2508	<li>Disk ID (unique string identifier given to disk)</li>
2509
2510	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2511
2512	<li>Populated size (optional unsigned integer indicating the current size of the
2513	disk; can be approximate; -1 if unspecified)</li>
2514
2515	<li>Format (string identifying the disk format, typically
2516	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2517
2518	<li>Reference (where to find the disk image, typically a file name; if empty,
2519	then the disk should be created on import)</li>
2520
2521	<li>Image size (optional unsigned integer indicating the size of the image,
2522	which need not necessarily be the same as the values specified above, since
2523	the image may be compressed or sparse; -1 if not specified)</li>
2524
2525	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2526	presently unsupported and always -1)</li>
2527
2528	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2529	</ol>
2530	</desc>
2531	</attribute>
2532
2533	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2534	<desc> Array of virtual system descriptions. One such description is created
2535	for each virtual system (machine) found in the OVF.
2536	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2537	(for export) has been called.
2538	</desc>
2539	</attribute>
2540
2541	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2542	<desc>
2543	Contains the UUIDs of the machines created from the information in this appliances. This is only
2544	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2545	succeeded.
2546	</desc>
2547	</attribute>
2548
2549	<method name="read">
2550	<desc>
2551	Reads an OVF file into the appliance object.
2552
2553	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2554	mere fact that this method returns successfully does not mean that VirtualBox supports all
2555	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2556	</desc>
2557	<param name="file" type="wstring" dir="in">
2558	<desc>
2559	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2560	on whether the appliance is distributed as a set of files or as a single file, respectively).
2561	</desc>
2562	</param>
2563	<param name="aProgress" type="IProgress" dir="return">
2564	<desc>Progress object to track the operation completion.</desc>
2565	</param>
2566	</method>
2567
2568	<method name="interpret">
2569	<desc>
2570	Interprets the OVF data that was read when the appliance was constructed. After
2571	calling this method, one can inspect the
2572	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2573	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2574	the appliance.
2575
2576	Calling this method is the second step of importing an appliance into VirtualBox;
2577	see <link to="IAppliance" /> for an overview.
2578
2579	After calling this method, one should call <link to="#getWarnings" /> to find out
2580	if problems were encountered during the processing which might later lead to
2581	errors.
2582	</desc>
2583	</method>
2584
2585	<method name="importMachines">
2586	<desc>
2587	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2588	and other interfaces that match the information contained in the appliance as
2589	closely as possible, as represented by the import instructions in the
2590	<link to="#virtualSystemDescriptions" /> array.
2591
2592	Calling this method is the final step of importing an appliance into VirtualBox;
2593	see <link to="IAppliance" /> for an overview.
2594
2595	Since importing the appliance will most probably involve copying and converting
2596	disk images, which can take a long time, this method operates asynchronously and
2597	returns an IProgress object to allow the caller to monitor the progress.
2598
2599	After the import succeeded, the UUIDs of the IMachine instances created can be
2600	retrieved from the <link to="#machines" /> array attribute.
2601	</desc>
2602
2603	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2604	<desc>Options for the importing operation.</desc>
2605	</param>
2606
2607	<param name="aProgress" type="IProgress" dir="return">
2608	<desc>Progress object to track the operation completion.</desc>
2609	</param>
2610	</method>
2611
2612	<method name="createVFSExplorer">
2613	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2614
2615	<param name="aUri" type="wstring" dir="in">
2616	<desc>The URI describing the file system to use.</desc>
2617	</param>
2618
2619	<param name="aExplorer" type="IVFSExplorer" dir="return">
2620	<desc></desc>
2621	</param>
2622	</method>
2623
2624	<method name="write">
2625	<desc>
2626	Writes the contents of the appliance exports into a new OVF file.
2627
2628	Calling this method is the final step of exporting an appliance from VirtualBox;
2629	see <link to="IAppliance" /> for an overview.
2630
2631	Since exporting the appliance will most probably involve copying and converting
2632	disk images, which can take a long time, this method operates asynchronously and
2633	returns an IProgress object to allow the caller to monitor the progress.
2634	</desc>
2635	<param name="format" type="wstring" dir="in">
2636	<desc>
2637	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2638	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2639	</desc>
2640	</param>
2641	<param name="manifest" type="boolean" dir="in">
2642	<desc>
2643	Indicate if the optional manifest file (.mf) should be written. The manifest file
2644	is used for integrity checks prior import.
2645	</desc>
2646	</param>
2647	<param name="path" type="wstring" dir="in">
2648	<desc>
2649	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2650	on whether the appliance is distributed as a set of files or as a single file, respectively).
2651	</desc>
2652	</param>
2653	<param name="progress" type="IProgress" dir="return">
2654	<desc>Progress object to track the operation completion.</desc>
2655	</param>
2656	</method>
2657
2658	<method name="getWarnings">
2659	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2660
2661	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2662	<desc></desc>
2663	</param>
2664	</method>
2665
2666	</interface>
2667
2668	<enum
2669	name="VirtualSystemDescriptionType"
2670	uuid="303c0900-a746-4612-8c67-79003e91f459"
2671	>
2672	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2673	a configuration value.</desc>
2674
2675	<const name="Ignore" value="1" />
2676	<const name="OS" value="2" />
2677	<const name="Name" value="3" />
2678	<const name="Product" value="4" />
2679	<const name="Vendor" value="5" />
2680	<const name="Version" value="6" />
2681	<const name="ProductUrl" value="7" />
2682	<const name="VendorUrl" value="8" />
2683	<const name="Description" value="9" />
2684	<const name="License" value="10" />
2685	<const name="Miscellaneous" value="11" />
2686	<const name="CPU" value="12" />
2687	<const name="Memory" value="13" />
2688	<const name="HardDiskControllerIDE" value="14" />
2689	<const name="HardDiskControllerSATA" value="15" />
2690	<const name="HardDiskControllerSCSI" value="16" />
2691	<const name="HardDiskControllerSAS" value="17" />
2692	<const name="HardDiskImage" value="18" />
2693	<const name="Floppy" value="19" />
2694	<const name="CDROM" value="20" />
2695	<const name="NetworkAdapter" value="21" />
2696	<const name="USBController" value="22" />
2697	<const name="SoundCard" value="23" />
2698	<const name="SettingsFile" value="24">
2699	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2700	</const>
2701	</enum>
2702
2703	<enum
2704	name="VirtualSystemDescriptionValueType"
2705	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2706	>
2707	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2708	type to fetch.</desc>
2709
2710	<const name="Reference" value="1" />
2711	<const name="Original" value="2" />
2712	<const name="Auto" value="3" />
2713	<const name="ExtraConfig" value="4" />
2714
2715	</enum>
2716
2717	<interface
2718	name="IVirtualSystemDescription" extends="$unknown"
2719	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2720	wsmap="managed"
2721	>
2722
2723	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2724	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2725	<link to="IAppliance::interpret" /> has been called, that array contains information
2726	about how the virtual systems described in the OVF should best be imported into
2727	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2728	import an OVF into VirtualBox.
2729	</desc>
2730
2731	<attribute name="count" type="unsigned long" readonly="yes">
2732	<desc>Return the number of virtual system description entries.</desc>
2733	</attribute>
2734
2735	<method name="getDescription">
2736	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2737	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2738
2739	The list below identifies the value sets that are possible depending on the
2740	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2741	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2742	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2743	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2744	the @a aExtraConfigValues[] array item may also be used.
2745
2746	<ul>
2747	<li>
2748	"OS": the guest operating system type. There must be exactly one such array item on import. The
2749	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2750	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2751	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2752	</li>
2753	<li>
2754	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2755	if none is present on import, then an automatic name will be created from the operating system
2756	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2757	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2758	<link to="IMachine" /> name that does not exist yet.
2759	</li>
2760	<li>
2761	"Description": an arbitrary description.
2762	</li>
2763	<li>
2764	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2765	code to display such a license for agreement; the Main API does not enforce any such policy.
2766	</li>
2767	<li>
2768	Miscellaneous: reserved for future use.
2769	</li>
2770	<li>
2771	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2772	</li>
2773	<li>
2774	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2775	is present on import, then VirtualBox will set a meaningful default based on the operating system
2776	type.
2777	</li>
2778	<li>
2779	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2780	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2781	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2782	writes into the OVF.
2783	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2784	type can use to specify which hard disk controller a virtual disk should be connected to.
2785	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2786	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2787	its virtual machines supports four channels (primary master, primary slave, secondary master,
2788	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2789	</li>
2790	<li>
2791	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2792	has no value in @a aOvfValues[] or @a aVBoxValues[].
2793	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2794	</li>
2795	<li>
2796	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2797	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2798	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2799	whereas VirtualBox considers it a class of storage controllers of its own; see
2800	<link to="StorageControllerType" />).
2801	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2802	</li>
2803	<li>
2804	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2805	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2806
2807	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2808	a path since the image file should be in the same location as the OVF file itself), whereas the
2809	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2810	hard disk image. This means that on import the image will be copied and converted from the
2811	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2812
2813	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2814	format: "controller=<index>;channel=<c>"
2815	In this string, <index> must be an integer specifying the hard disk controller to connect
2816	the image to. That number must be the index of an array item with one of the hard disk controller
2817	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2818	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2819	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2820	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2821	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2822	</li>
2823	<li>
2824	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2825	attachment information as with "HardDiskImage" items.
2826	</li>
2827	<li>
2828	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2829	attachment information as with "HardDiskImage" items.
2830	</li>
2831	<li>
2832	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2833	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2834	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2835	</li>
2836	<li>
2837	"USBController": a USB controller. There can be at most one such item. If and only if such an
2838	item ispresent, USB support will be enabled for the new virtual machine.
2839	</li>
2840	<li>
2841	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2842	present, sound support will be enabled for the new virtual machine. Note that the virtual
2843	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2844	may be different from the virtual soundcard expected by the appliance.
2845	</li>
2846	</ul>
2847
2848	</desc>
2849
2850	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2859	<desc></desc>
2860	</param>
2861
2862	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2863	<desc></desc>
2864	</param>
2865
2866	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2867	<desc></desc>
2868	</param>
2869
2870	</method>
2871
2872	<method name="getDescriptionByType">
2873	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2874	should be returned.</desc>
2875
2876	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2877	<desc></desc>
2878	</param>
2879
2880	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2881	<desc></desc>
2882	</param>
2883
2884	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2885	<desc></desc>
2886	</param>
2887
2888	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2889	<desc></desc>
2890	</param>
2891
2892	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2893	<desc></desc>
2894	</param>
2895
2896	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2897	<desc></desc>
2898	</param>
2899
2900	</method>
2901
2902	<method name="getValuesByType">
2903	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2904	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2905	values.</desc>
2906
2907	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2908	<desc></desc>
2909	</param>
2910
2911	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2912	<desc></desc>
2913	</param>
2914
2915	<param name="aValues" type="wstring" dir="return" safearray="yes">
2916	<desc></desc>
2917	</param>
2918
2919	</method>
2920
2921	<method name="setFinalValues">
2922	<desc>
2923	This method allows the appliance's user to change the configuration for the virtual
2924	system descriptions. For each array item returned from <link to="#getDescription" />,
2925	you must pass in one boolean value and one configuration value.
2926
2927	Each item in the boolean array determines whether the particular configuration item
2928	should be enabled.
2929	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2930	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2931	and SoundCard.
2932
2933	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2934	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2935	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2936	for valid configuration values for the individual array item types. If the
2937	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2938	</desc>
2939
2940	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2941	<desc></desc>
2942	</param>
2943
2944	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2945	<desc></desc>
2946	</param>
2947
2948	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2949	<desc></desc>
2950	</param>
2951	</method>
2952
2953	<method name="addDescription">
2954	<desc>
2955	This method adds an additional description entry to the stack of already
2956	available descriptions for this virtual system. This is handy for writing
2957	values which aren't directly supported by VirtualBox. One example would
2958	be the License type of <link to="VirtualSystemDescriptionType" />.
2959	</desc>
2960
2961	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2962	<desc></desc>
2963	</param>
2964
2965	<param name="aVBoxValue" type="wstring" dir="in">
2966	<desc></desc>
2967	</param>
2968
2969	<param name="aExtraConfigValue" type="wstring" dir="in">
2970	<desc></desc>
2971	</param>
2972	</method>
2973	</interface>
2974
2975
2976	<!--
2977	// IMachine
2978	/////////////////////////////////////////////////////////////////////////
2979	-->
2980
2981	<interface
2982	name="IInternalMachineControl" extends="$unknown"
2983	uuid="ec824977-e43f-479c-81c9-ac6cae1423a5"
2984	internal="yes"
2985	wsmap="suppress"
2986	>
2987	<method name="setRemoveSavedStateFile">
2988	<desc>
2989	Updates the flag whether the saved state file is removed on a
2990	machine state change from Saved to PoweredOff.
2991	</desc>
2992	<param name="aRemove" type="boolean" dir="in"/>
2993	</method>
2994
2995	<method name="updateState">
2996	<desc>
2997	Updates the VM state.
2998	<note>
2999	This operation will also update the settings file with the correct
3000	information about the saved state file and delete this file from disk
3001	when appropriate.
3002	</note>
3003	</desc>
3004	<param name="state" type="MachineState" dir="in"/>
3005	</method>
3006
3007	<method name="getIPCId">
3008	<param name="id" type="wstring" dir="return"/>
3009	</method>
3010
3011	<method name="beginPowerUp">
3012	<desc>
3013	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3014	gives it the progress object that should be part of any pending
3015	<link to="IMachine::launchVMProcess"/> operations. The progress
3016	object may be called back to reflect an early cancelation, so some care
3017	have to be taken with respect to any cancelation callbacks. The console
3018	object will call <link to="IInternalMachineControl::endPowerUp"/>
3019	to signal the completion of the progress object.
3020	</desc>
3021	<param name="aProgress" type="IProgress" dir="in" />
3022	</method>
3023
3024	<method name="endPowerUp">
3025	<desc>
3026	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3027	This method may query status information from the progress object it
3028	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3029	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3030	call in order to complete that progress object.
3031	</desc>
3032	<param name="result" type="long" dir="in"/>
3033	</method>
3034
3035	<method name="beginPoweringDown">
3036	<desc>
3037	Called by the VM process to inform the server it wants to
3038	stop the VM execution and power down.
3039	</desc>
3040	<param name="progress" type="IProgress" dir="out">
3041	<desc>
3042	Progress object created by VBoxSVC to wait until
3043	the VM is powered down.
3044	</desc>
3045	</param>
3046	</method>
3047
3048	<method name="endPoweringDown">
3049	<desc>
3050	Called by the VM process to inform the server that powering
3051	down previously requested by #beginPoweringDown is either
3052	successfully finished or there was a failure.
3053
3054	<result name="VBOX_E_FILE_ERROR">
3055	Settings file not accessible.
3056	</result>
3057	<result name="VBOX_E_XML_ERROR">
3058	Could not parse the settings file.
3059	</result>
3060
3061	</desc>
3062
3063	<param name="result" type="long" dir="in">
3064	<desc>@c S_OK to indicate success.
3065	</desc>
3066	</param>
3067	<param name="errMsg" type="wstring" dir="in">
3068	<desc>@c human readable error message in case of failure.
3069	</desc>
3070	</param>
3071	</method>
3072
3073	<method name="runUSBDeviceFilters">
3074	<desc>
3075	Asks the server to run USB devices filters of the associated
3076	machine against the given USB device and tell if there is
3077	a match.
3078	<note>
3079	Intended to be used only for remote USB devices. Local
3080	ones don't require to call this method (this is done
3081	implicitly by the Host and USBProxyService).
3082	</note>
3083	</desc>
3084	<param name="device" type="IUSBDevice" dir="in"/>
3085	<param name="matched" type="boolean" dir="out"/>
3086	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3087	</method>
3088
3089	<method name="captureUSBDevice">
3090	<desc>
3091	Requests a capture of the given host USB device.
3092	When the request is completed, the VM process will
3093	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3094	notification.
3095	</desc>
3096	<param name="id" type="uuid" mod="string" dir="in"/>
3097	</method>
3098
3099	<method name="detachUSBDevice">
3100	<desc>
3101	Notification that a VM is going to detach (@a done = @c false) or has
3102	already detached (@a done = @c true) the given USB device.
3103	When the @a done = @c true request is completed, the VM process will
3104	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3105	notification.
3106	<note>
3107	In the @a done = @c true case, the server must run its own filters
3108	and filters of all VMs but this one on the detached device
3109	as if it were just attached to the host computer.
3110	</note>
3111	</desc>
3112	<param name="id" type="uuid" mod="string" dir="in"/>
3113	<param name="done" type="boolean" dir="in"/>
3114	</method>
3115
3116	<method name="autoCaptureUSBDevices">
3117	<desc>
3118	Requests a capture all matching USB devices attached to the host.
3119	When the request is completed, the VM process will
3120	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3121	notification per every captured device.
3122	</desc>
3123	</method>
3124
3125	<method name="detachAllUSBDevices">
3126	<desc>
3127	Notification that a VM that is being powered down. The done
3128	parameter indicates whether which stage of the power down
3129	we're at. When @a done = @c false the VM is announcing its
3130	intentions, while when @a done = @c true the VM is reporting
3131	what it has done.
3132	<note>
3133	In the @a done = @c true case, the server must run its own filters
3134	and filters of all VMs but this one on all detach devices as
3135	if they were just attached to the host computer.
3136	</note>
3137	</desc>
3138	<param name="done" type="boolean" dir="in"/>
3139	</method>
3140
3141	<method name="onSessionEnd">
3142	<desc>
3143	Triggered by the given session object when the session is about
3144	to close normally.
3145	</desc>
3146	<param name="session" type="ISession" dir="in">
3147	<desc>Session that is being closed</desc>
3148	</param>
3149	<param name="progress" type="IProgress" dir="return">
3150	<desc>
3151	Used to wait until the corresponding machine is actually
3152	dissociated from the given session on the server.
3153	Returned only when this session is a direct one.
3154	</desc>
3155	</param>
3156	</method>
3157
3158	<method name="beginSavingState">
3159	<desc>
3160	Called by the VM process to inform the server it wants to
3161	save the current state and stop the VM execution.
3162	</desc>
3163	<param name="progress" type="IProgress" dir="out">
3164	<desc>
3165	Progress object created by VBoxSVC to wait until
3166	the state is saved.
3167	</desc>
3168	</param>
3169	<param name="stateFilePath" type="wstring" dir="out">
3170	<desc>
3171	File path the VM process must save the execution state to.
3172	</desc>
3173	</param>
3174	</method>
3175
3176	<method name="endSavingState">
3177	<desc>
3178	Called by the VM process to inform the server that saving
3179	the state previously requested by #beginSavingState is either
3180	successfully finished or there was a failure.
3181
3182	<result name="VBOX_E_FILE_ERROR">
3183	Settings file not accessible.
3184	</result>
3185	<result name="VBOX_E_XML_ERROR">
3186	Could not parse the settings file.
3187	</result>
3188
3189	</desc>
3190
3191	<param name="result" type="long" dir="in">
3192	<desc>@c S_OK to indicate success.
3193	</desc>
3194	</param>
3195	<param name="errMsg" type="wstring" dir="in">
3196	<desc>@c human readable error message in case of failure.
3197	</desc>
3198	</param>
3199	</method>
3200
3201	<method name="adoptSavedState">
3202	<desc>
3203	Gets called by <link to="IConsole::adoptSavedState"/>.
3204	<result name="VBOX_E_FILE_ERROR">
3205	Invalid saved state file path.
3206	</result>
3207	</desc>
3208	<param name="savedStateFile" type="wstring" dir="in">
3209	<desc>Path to the saved state file to adopt.</desc>
3210	</param>
3211	</method>
3212
3213	<method name="beginTakingSnapshot">
3214	<desc>
3215	Called from the VM process to request from the server to perform the
3216	server-side actions of creating a snapshot (creating differencing images
3217	and the snapshot object).
3218
3219	<result name="VBOX_E_FILE_ERROR">
3220	Settings file not accessible.
3221	</result>
3222	<result name="VBOX_E_XML_ERROR">
3223	Could not parse the settings file.
3224	</result>
3225	</desc>
3226	<param name="initiator" type="IConsole" dir="in">
3227	<desc>The console object that initiated this call.</desc>
3228	</param>
3229	<param name="name" type="wstring" dir="in">
3230	<desc>Snapshot name.</desc>
3231	</param>
3232	<param name="description" type="wstring" dir="in">
3233	<desc>Snapshot description.</desc>
3234	</param>
3235	<param name="consoleProgress" type="IProgress" dir="in">
3236	<desc>
3237	Progress object created by the VM process tracking the
3238	snapshot's progress. This has the following sub-operations:
3239	<ul>
3240	<li>setting up (weight 1);</li>
3241	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3242	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3243	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3244	<li>finishing up (weight 1)</li>
3245	</ul>
3246	</desc>
3247	</param>
3248	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3249	<desc>
3250	Whether this is an online snapshot (i.e. the machine is running).
3251	</desc>
3252	</param>
3253	<param name="stateFilePath" type="wstring" dir="out">
3254	<desc>
3255	File path the VM process must save the execution state to.
3256	</desc>
3257	</param>
3258	</method>
3259
3260	<method name="endTakingSnapshot">
3261	<desc>
3262	Called by the VM process to inform the server that the snapshot
3263	previously requested by #beginTakingSnapshot is either
3264	successfully taken or there was a failure.
3265	</desc>
3266
3267	<param name="success" type="boolean" dir="in">
3268	<desc>@c true to indicate success and @c false otherwise</desc>
3269	</param>
3270	</method>
3271
3272	<method name="deleteSnapshot">
3273	<desc>
3274	Gets called by <link to="IConsole::deleteSnapshot"/>,
3275	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3276	<link to="IConsole::deleteSnapshotRange"/>.
3277	<result name="VBOX_E_INVALID_OBJECT_STATE">
3278	Snapshot has more than one child snapshot. Only possible if the
3279	delete operation does not delete all children or the range does
3280	not meet the linearity condition.
3281	</result>
3282	</desc>
3283	<param name="initiator" type="IConsole" dir="in">
3284	<desc>The console object that initiated this call.</desc>
3285	</param>
3286	<param name="startId" type="uuid" mod="string" dir="in">
3287	<desc>UUID of the first snapshot to delete.</desc>
3288	</param>
3289	<param name="endId" type="uuid" mod="string" dir="in">
3290	<desc>UUID of the last snapshot to delete.</desc>
3291	</param>
3292	<param name="deleteAllChildren" type="boolean" dir="in">
3293	<desc>Whether all children should be deleted.</desc>
3294	</param>
3295	<param name="machineState" type="MachineState" dir="out">
3296	<desc>New machine state after this operation is started.</desc>
3297	</param>
3298	<param name="progress" type="IProgress" dir="return">
3299	<desc>Progress object to track the operation completion.</desc>
3300	</param>
3301	</method>
3302
3303	<method name="finishOnlineMergeMedium">
3304	<desc>
3305	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3306	</desc>
3307	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3308	<desc>The medium attachment which needs to be cleaned up.</desc>
3309	</param>
3310	<param name="source" type="IMedium" dir="in">
3311	<desc>Merge source medium.</desc>
3312	</param>
3313	<param name="target" type="IMedium" dir="in">
3314	<desc>Merge target medium.</desc>
3315	</param>
3316	<param name="mergeForward" type="boolean" dir="in">
3317	<desc>Merge direction.</desc>
3318	</param>
3319	<param name="parentForTarget" type="IMedium" dir="in">
3320	<desc>For forward merges: new parent for target medium.</desc>
3321	</param>
3322	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3323	<desc>For backward merges: list of media which need their parent UUID
3324	updated.</desc>
3325	</param>
3326	</method>
3327
3328	<method name="restoreSnapshot">
3329	<desc>
3330	Gets called by <link to="IConsole::restoreSnapshot"/>.
3331	</desc>
3332	<param name="initiator" type="IConsole" dir="in">
3333	<desc>The console object that initiated this call.</desc>
3334	</param>
3335	<param name="snapshot" type="ISnapshot" dir="in">
3336	<desc>The snapshot to restore the VM state from.</desc>
3337	</param>
3338	<param name="machineState" type="MachineState" dir="out">
3339	<desc>New machine state after this operation is started.</desc>
3340	</param>
3341	<param name="progress" type="IProgress" dir="return">
3342	<desc>Progress object to track the operation completion.</desc>
3343	</param>
3344	</method>
3345
3346	<method name="pullGuestProperties">
3347	<desc>
3348	Get the list of the guest properties matching a set of patterns along
3349	with their values, time stamps and flags and give responsibility for
3350	managing properties to the console.
3351	</desc>
3352	<param name="name" type="wstring" dir="out" safearray="yes">
3353	<desc>
3354	The names of the properties returned.
3355	</desc>
3356	</param>
3357	<param name="value" type="wstring" dir="out" safearray="yes">
3358	<desc>
3359	The values of the properties returned. The array entries match the
3360	corresponding entries in the @a name array.
3361	</desc>
3362	</param>
3363	<param name="timestamp" type="long long" dir="out" safearray="yes">
3364	<desc>
3365	The time stamps of the properties returned. The array entries match
3366	the corresponding entries in the @a name array.
3367	</desc>
3368	</param>
3369	<param name="flags" type="wstring" dir="out" safearray="yes">
3370	<desc>
3371	The flags of the properties returned. The array entries match the
3372	corresponding entries in the @a name array.
3373	</desc>
3374	</param>
3375	</method>
3376
3377	<method name="pushGuestProperty">
3378	<desc>
3379	Update a single guest property in IMachine.
3380	</desc>
3381	<param name="name" type="wstring" dir="in">
3382	<desc>
3383	The name of the property to be updated.
3384	</desc>
3385	</param>
3386	<param name="value" type="wstring" dir="in">
3387	<desc>
3388	The value of the property.
3389	</desc>
3390	</param>
3391	<param name="timestamp" type="long long" dir="in">
3392	<desc>
3393	The timestamp of the property.
3394	</desc>
3395	</param>
3396	<param name="flags" type="wstring" dir="in">
3397	<desc>
3398	The flags of the property.
3399	</desc>
3400	</param>
3401	</method>
3402
3403	<method name="lockMedia">
3404	<desc>
3405	Locks all media attached to the machine for writing and parents of
3406	attached differencing media (if any) for reading. This operation is
3407	atomic so that if it fails no media is actually locked.
3408
3409	This method is intended to be called when the machine is in Starting or
3410	Restoring state. The locked media will be automatically unlocked when
3411	the machine is powered off or crashed.
3412	</desc>
3413	</method>
3414	<method name="unlockMedia">
3415	<desc>
3416	Unlocks all media previously locked using
3417	<link to="IInternalMachineControl::lockMedia"/>.
3418
3419	This method is intended to be used with teleportation so that it is
3420	possible to teleport between processes on the same machine.
3421	</desc>
3422	</method>
3423
3424	<method name="ejectMedium">
3425	<desc>
3426	Tells VBoxSVC that the guest has ejected the medium associated with
3427	the medium attachment.
3428	</desc>
3429	<param name="attachment" type="IMediumAttachment" dir="in">
3430	<desc>
3431	The medium attachment where the eject happened.
3432	</desc>
3433	</param>
3434	<param name="newAttachment" type="IMediumAttachment" dir="return">
3435	<desc>
3436	A new reference to the medium attachment, as the config change can
3437	result in the creation of a new instance.
3438	</desc>
3439	</param>
3440	</method>
3441
3442	<method name="reportGuestStatistics">
3443	<desc>
3444	Passes collected guest statistics to VBoxSVC.
3445	</desc>
3446	<param name="validStats" type="unsigned long" dir="in">
3447	<desc>
3448	Mask defining which parameters are valid. For example: 0x11 means
3449	that cpuIdle and XXX are valid. Other parameters should be ignored.
3450	</desc>
3451	</param>
3452	<param name="cpuUser" type="unsigned long" dir="in">
3453	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3454	</param>
3455	<param name="cpuKernel" type="unsigned long" dir="in">
3456	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3457	</param>
3458	<param name="cpuIdle" type="unsigned long" dir="in">
3459	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3460	</param>
3461	<param name="memTotal" type="unsigned long" dir="in">
3462	<desc>Total amount of physical guest RAM.</desc>
3463	</param>
3464	<param name="memFree" type="unsigned long" dir="in">
3465	<desc>Free amount of physical guest RAM.</desc>
3466	</param>
3467	<param name="memBalloon" type="unsigned long" dir="in">
3468	<desc>Amount of ballooned physical guest RAM.</desc>
3469	</param>
3470	<param name="memShared" type="unsigned long" dir="in">
3471	<desc>Amount of shared physical guest RAM.</desc>
3472	</param>
3473	<param name="memCache" type="unsigned long" dir="in">
3474	<desc>Total amount of guest (disk) cache memory.</desc>
3475	</param>
3476	<param name="pagedTotal" type="unsigned long" dir="in">
3477	<desc>Total amount of space in the page file.</desc>
3478	</param>
3479	<param name="memAllocTotal" type="unsigned long" dir="in">
3480	<desc>Total amount of memory allocated by the hypervisor.</desc>
3481	</param>
3482	<param name="memFreeTotal" type="unsigned long" dir="in">
3483	<desc>Total amount of free memory available in the hypervisor.</desc>
3484	</param>
3485	<param name="memBalloonTotal" type="unsigned long" dir="in">
3486	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3487	</param>
3488	<param name="memSharedTotal" type="unsigned long" dir="in">
3489	<desc>Total amount of shared memory in the hypervisor.</desc>
3490	</param>
3491	</method>
3492	</interface>
3493
3494	<interface
3495	name="IBIOSSettings" extends="$unknown"
3496	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3497	wsmap="managed"
3498	>
3499	<desc>
3500	The IBIOSSettings interface represents BIOS settings of the virtual
3501	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3502	</desc>
3503	<attribute name="logoFadeIn" type="boolean">
3504	<desc>Fade in flag for BIOS logo animation.</desc>
3505	</attribute>
3506
3507	<attribute name="logoFadeOut" type="boolean">
3508	<desc>Fade out flag for BIOS logo animation.</desc>
3509	</attribute>
3510
3511	<attribute name="logoDisplayTime" type="unsigned long">
3512	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3513	</attribute>
3514
3515	<attribute name="logoImagePath" type="wstring">
3516	<desc>
3517	Local file system path for external BIOS splash image. Empty string
3518	means the default image is shown on boot.
3519	</desc>
3520	</attribute>
3521
3522	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3523	<desc>Mode of the BIOS boot device menu.</desc>
3524	</attribute>
3525
3526	<attribute name="ACPIEnabled" type="boolean">
3527	<desc>ACPI support flag.</desc>
3528	</attribute>
3529
3530	<attribute name="IOAPICEnabled" type="boolean">
3531	<desc>
3532	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3533	and support IRQs above 15.
3534	</desc>
3535	</attribute>
3536
3537	<attribute name="timeOffset" type="long long">
3538	<desc>
3539	Offset in milliseconds from the host system time. This allows for
3540	guests running with a different system date/time than the host.
3541	It is equivalent to setting the system date/time in the BIOS except
3542	it is not an absolute value but a relative one. Guest Additions
3543	time synchronization honors this offset.
3544	</desc>
3545	</attribute>
3546
3547	<attribute name="PXEDebugEnabled" type="boolean">
3548	<desc>
3549	PXE debug logging flag. If set, VirtualBox will write extensive
3550	PXE trace information to the release log.
3551	</desc>
3552	</attribute>
3553	</interface>
3554
3555	<enum
3556	name="CleanupMode"
3557	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3558	>
3559	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3560	</desc>
3561	<const name="UnregisterOnly" value="1">
3562	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3563	</const>
3564	<const name="DetachAllReturnNone" value="2">
3565	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3566	</const>
3567	<const name="DetachAllReturnHardDisksOnly" value="3">
3568	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3569	</const>
3570	<const name="Full" value="4">
3571	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3572	</const>
3573	</enum>
3574
3575	<interface
3576	name="IPciAddress" extends="$unknown"
3577	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3578	wsmap="struct"
3579	>
3580
3581	<desc>
3582	Address on the PCI bus.
3583	</desc>
3584
3585	<attribute name="bus" type="short">
3586	<desc>
3587	Bus number.
3588	</desc>
3589	</attribute>
3590
3591	<attribute name="device" type="short">
3592	<desc>
3593	Device number.
3594	</desc>
3595	</attribute>
3596
3597	<attribute name="devFunction" type="short">
3598	<desc>
3599	Device function number.
3600	</desc>
3601	</attribute>
3602
3603	<method name="asLong">
3604	<desc>
3605	Convert PCI address into long.
3606	</desc>
3607	<param name="result" type="long" dir="return" />
3608	</method>
3609
3610	<method name="fromLong">
3611	<desc>
3612	Make PCI address from long.
3613	</desc>
3614	<param name="number" type="long" dir="in" />
3615	</method>
3616	</interface>
3617
3618	<interface
3619	name="IPciDeviceAttachment" extends="$unknown"
3620	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3621	wsmap="struct"
3622	>
3623
3624	<desc>
3625	Information about PCI attachments.
3626	</desc>
3627
3628	<attribute name="name" type="wstring" readonly="yes">
3629	<desc>
3630	Device name.
3631	</desc>
3632	</attribute>
3633
3634	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3635	<desc>
3636	If this is physical or virtual device.
3637	</desc>
3638	</attribute>
3639
3640	<attribute name="hostAddress" type="long" readonly="yes">
3641	<desc>
3642	Address of device on the host, applicable only to host devices.
3643	</desc>
3644	</attribute>
3645
3646	<attribute name="guestAddress" type="long" readonly="yes">
3647	<desc>
3648	Address of device on the guest.
3649	</desc>
3650	</attribute>
3651
3652	</interface>
3653
3654	<enum
3655	name="CloneMode" extends="$unknown"
3656	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3657	>
3658
3659	<desc>
3660	Clone mode, used with <link to="IMachine::cloneTo" />.
3661	</desc>
3662
3663	<const name="MachineState" value="1">
3664	<desc>Clone the state of the selected machine.</desc>
3665	</const>
3666	<const name="MachineAndChildStates" value="2">
3667	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3668	</const>
3669	<const name="AllStates" value="3">
3670	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3671	</const>
3672
3673	</enum>
3674
3675	<enum
3676	name="CloneOptions" extends="$unknown"
3677	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3678	>
3679
3680	<desc>
3681	Clone options, used with <link to="IMachine::cloneTo" />.
3682	</desc>
3683
3684	<const name="Link" value="1">
3685	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3686	</const>
3687	<const name="KeepAllMACs" value="2">
3688	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3689	</const>
3690	<const name="KeepNATMACs" value="3">
3691	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3692	</const>
3693	<const name="KeepDiskNames" value="4">
3694	<desc>Don't change the disk names.</desc>
3695	</const>
3696
3697	</enum>
3698
3699
3700	<interface
3701	name="IMachine" extends="$unknown"
3702	uuid="e7c78fee-f20d-4b4f-ac28-37af30d79ddf"
3703	wsmap="managed"
3704	>
3705	<desc>
3706	The IMachine interface represents a virtual machine, or guest, created
3707	in VirtualBox.
3708
3709	This interface is used in two contexts. First of all, a collection of
3710	objects implementing this interface is stored in the
3711	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3712	machines that are currently registered with this VirtualBox
3713	installation. Also, once a session has been opened for the given virtual
3714	machine (e.g. the virtual machine is running), the machine object
3715	associated with the open session can be queried from the session object;
3716	see <link to="ISession"/> for details.
3717
3718	The main role of this interface is to expose the settings of the virtual
3719	machine and provide methods to change various aspects of the virtual
3720	machine's configuration. For machine objects stored in the
3721	<link to="IVirtualBox::machines"/> collection, all attributes are
3722	read-only unless explicitly stated otherwise in individual attribute
3723	and method descriptions.
3724
3725	In order to change a machine setting, a session for this machine must be
3726	opened using one of the <link to="IMachine::lockMachine" /> or
3727	<link to="IMachine::launchVMProcess"/> methods. After the
3728	machine has been successfully locked for a session, a mutable machine object
3729	needs to be queried from the session object and then the desired settings
3730	changes can be applied to the returned object using IMachine attributes and
3731	methods. See the <link to="ISession"/> interface description for more
3732	information about sessions.
3733
3734	Note that IMachine does not provide methods to control virtual machine
3735	execution (such as start the machine, or power it down) -- these methods
3736	are grouped in a separate interface called <link to="IConsole" />.
3737
3738	<see><link to="ISession"/>, <link to="IConsole"/></see>
3739	</desc>
3740
3741	<attribute name="parent" type="IVirtualBox" readonly="yes">
3742	<desc>Associated parent object.</desc>
3743	</attribute>
3744
3745	<attribute name="accessible" type="boolean" readonly="yes">
3746	<desc>
3747	Whether this virtual machine is currently accessible or not.
3748
3749	A machine is always deemed accessible unless it is registered <i>and</i>
3750	its settings file cannot be read or parsed (either because the file itself
3751	is unavailable or has invalid XML contents).
3752
3753	Every time this property is read, the accessibility state of
3754	this machine is re-evaluated. If the returned value is @c false,
3755	the <link to="#accessError"/> property may be used to get the
3756	detailed error information describing the reason of
3757	inaccessibility, including XML error messages.
3758
3759	When the machine is inaccessible, only the following properties
3760	can be used on it:
3761	<ul>
3762	<li><link to="#parent"/></li>
3763	<li><link to="#id"/></li>
3764	<li><link to="#settingsFilePath"/></li>
3765	<li><link to="#accessible"/></li>
3766	<li><link to="#accessError"/></li>
3767	</ul>
3768
3769	An attempt to access any other property or method will return
3770	an error.
3771
3772	The only possible action you can perform on an inaccessible
3773	machine is to unregister it using the
3774	<link to="IMachine::unregister"/> call (or, to check
3775	for the accessibility state once more by querying this
3776	property).
3777
3778	<note>
3779	In the current implementation, once this property returns
3780	@c true, the machine will never become inaccessible
3781	later, even if its settings file cannot be successfully
3782	read/written any more (at least, until the VirtualBox
3783	server is restarted). This limitation may be removed in
3784	future releases.
3785	</note>
3786	</desc>
3787	</attribute>
3788
3789	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3790	<desc>
3791	Error information describing the reason of machine
3792	inaccessibility.
3793
3794	Reading this property is only valid after the last call to
3795	<link to="#accessible"/> returned @c false (i.e. the
3796	machine is currently inaccessible). Otherwise, a @c null
3797	IVirtualBoxErrorInfo object will be returned.
3798	</desc>
3799	</attribute>
3800
3801	<attribute name="name" type="wstring">
3802	<desc>
3803	Name of the virtual machine.
3804
3805	Besides being used for human-readable identification purposes
3806	everywhere in VirtualBox, the virtual machine name is also used
3807	as a name of the machine's settings file and as a name of the
3808	subdirectory this settings file resides in. Thus, every time you
3809	change the value of this property, the settings file will be
3810	renamed once you call <link to="#saveSettings"/> to confirm the
3811	change. The containing subdirectory will be also renamed, but
3812	only if it has exactly the same name as the settings file
3813	itself prior to changing this property (for backward compatibility
3814	with previous API releases). The above implies the following
3815	limitations:
3816	<ul>
3817	<li>The machine name cannot be empty.</li>
3818	<li>The machine name can contain only characters that are valid
3819	file name characters according to the rules of the file
3820	system used to store VirtualBox configuration.</li>
3821	<li>You cannot have two or more machines with the same name
3822	if they use the same subdirectory for storing the machine
3823	settings files.</li>
3824	<li>You cannot change the name of the machine if it is running,
3825	or if any file in the directory containing the settings file
3826	is being used by another running machine or by any other
3827	process in the host operating system at a time when
3828	<link to="#saveSettings"/> is called.
3829	</li>
3830	</ul>
3831	If any of the above limitations are hit, <link to="#saveSettings"/>
3832	will return an appropriate error message explaining the exact
3833	reason and the changes you made to this machine will not be saved.
3834
3835	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3836	file is recommended, but not enforced. (Previous versions always
3837	used a generic ".xml" extension.)
3838	</desc>
3839	</attribute>
3840
3841	<attribute name="description" type="wstring">
3842	<desc>
3843	Description of the virtual machine.
3844
3845	The description attribute can contain any text and is
3846	typically used to describe the hardware and software
3847	configuration of the virtual machine in detail (i.e. network
3848	settings, versions of the installed software and so on).
3849	</desc>
3850	</attribute>
3851
3852	<attribute name="id" type="uuid" mod="string" readonly="yes">
3853	<desc>UUID of the virtual machine.</desc>
3854	</attribute>
3855
3856	<attribute name="OSTypeId" type="wstring">
3857	<desc>
3858	User-defined identifier of the Guest OS type.
3859	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3860	an IGuestOSType object representing details about the given
3861	Guest OS type.
3862	<note>
3863	This value may differ from the value returned by
3864	<link to="IGuest::OSTypeId"/> if Guest Additions are
3865	installed to the guest OS.
3866	</note>
3867	</desc>
3868	</attribute>
3869
3870	<attribute name="hardwareVersion" type="wstring">
3871	<desc>Hardware version identifier. Internal use only for now.</desc>
3872	</attribute>
3873
3874	<attribute name="hardwareUUID" type="uuid" mod="string">
3875	<desc>
3876	The UUID presented to the guest via memory tables, hardware and guest
3877	properties. For most VMs this is the same as the @a id, but for VMs
3878	which have been cloned or teleported it may be the same as the source
3879	VM. This latter is because the guest shouldn't notice that it was
3880	cloned or teleported.
3881	</desc>
3882	</attribute>
3883
3884	<attribute name="CPUCount" type="unsigned long">
3885	<desc>Number of virtual CPUs in the VM.</desc>
3886	</attribute>
3887
3888	<attribute name="CPUHotPlugEnabled" type="boolean">
3889	<desc>
3890	This setting determines whether VirtualBox allows CPU
3891	hotplugging for this machine.</desc>
3892	</attribute>
3893
3894	<attribute name="CPUExecutionCap" type="unsigned long">
3895	<desc>
3896	Means to limit the number of CPU cycles a guest can use. The unit
3897	is percentage of host CPU cycles per second. The valid range
3898	is 1 - 100. 100 (the default) implies no limit.
3899	</desc>
3900	</attribute>
3901
3902	<attribute name="memorySize" type="unsigned long">
3903	<desc>System memory size in megabytes.</desc>
3904	</attribute>
3905
3906	<attribute name="memoryBalloonSize" type="unsigned long">
3907	<desc>Memory balloon size in megabytes.</desc>
3908	</attribute>
3909
3910	<attribute name="pageFusionEnabled" type="boolean">
3911	<desc>
3912	This setting determines whether VirtualBox allows page
3913	fusion for this machine (64 bits host only).
3914	</desc>
3915	</attribute>
3916
3917	<attribute name="VRAMSize" type="unsigned long">
3918	<desc>Video memory size in megabytes.</desc>
3919	</attribute>
3920
3921	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3922	<desc>
3923	This setting determines whether VirtualBox allows this machine to make
3924	use of the 3D graphics support available on the host.</desc>
3925	</attribute>
3926
3927	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3928	<desc>
3929	This setting determines whether VirtualBox allows this machine to make
3930	use of the 2D video acceleration support available on the host.</desc>
3931	</attribute>
3932
3933	<attribute name="monitorCount" type="unsigned long">
3934	<desc>
3935	Number of virtual monitors.
3936	<note>
3937	Only effective on Windows XP and later guests with
3938	Guest Additions installed.
3939	</note>
3940	</desc>
3941	</attribute>
3942
3943	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3944	<desc>Object containing all BIOS settings.</desc>
3945	</attribute>
3946
3947	<attribute name="firmwareType" type="FirmwareType">
3948	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3949	bootstrap in this VM.</desc>
3950	</attribute>
3951
3952	<attribute name="pointingHidType" type="PointingHidType">
3953	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3954	The default is typically "PS2Mouse" but can vary depending on the
3955	requirements of the guest operating system.</desc>
3956	</attribute>
3957
3958	<attribute name="keyboardHidType" type="KeyboardHidType">
3959	<desc>Type of keyboard HID used in this VM.
3960	The default is typically "PS2Keyboard" but can vary depending on the
3961	requirements of the guest operating system.</desc>
3962	</attribute>
3963
3964	<attribute name="hpetEnabled" type="boolean">
3965	<desc>This attribute controls if High Precision Event Timer (HPET) is
3966	enabled in this VM. Use this property if you want to provide guests
3967	with additional time source, or if guest requires HPET to function correctly.
3968	Default is false.</desc>
3969	</attribute>
3970
3971	<attribute name="chipsetType" type="ChipsetType">
3972	<desc>Chipset type used in this VM.</desc>
3973	</attribute>
3974
3975	<attribute name="snapshotFolder" type="wstring">
3976	<desc>
3977	Full path to the directory used to store snapshot data
3978	(differencing media and saved state files) of this machine.
3979
3980	The initial value of this property is
3981	<tt><</tt><link to="#settingsFilePath">
3982	path_to_settings_file</link><tt>>/<</tt>
3983	<link to="#id">machine_uuid</link>
3984	<tt>></tt>.
3985
3986	Currently, it is an error to try to change this property on
3987	a machine that has snapshots (because this would require to
3988	move possibly large files to a different location).
3989	A separate method will be available for this purpose later.
3990
3991	<note>
3992	Setting this property to @c null or to an empty string will restore
3993	the initial value.
3994	</note>
3995	<note>
3996	When setting this property, the specified path can be
3997	absolute (full path) or relative to the directory where the
3998	<link to="#settingsFilePath">machine settings file</link>
3999	is located. When reading this property, a full path is
4000	always returned.
4001	</note>
4002	<note>
4003	The specified path may not exist, it will be created
4004	when necessary.
4005	</note>
4006	</desc>
4007	</attribute>
4008
4009	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
4010	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
4011	</attribute>
4012
4013	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4014	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4015
4016	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4017	<desc>Array of media attached to this machine.</desc>
4018	</attribute>
4019
4020	<attribute name="USBController" type="IUSBController" readonly="yes">
4021	<desc>
4022	Associated USB controller object.
4023
4024	<note>
4025	If USB functionality is not available in the given edition of
4026	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4027	</note>
4028	</desc>
4029	</attribute>
4030
4031	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4032	<desc>Associated audio adapter, always present.</desc>
4033	</attribute>
4034
4035	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4036	<desc>Array of storage controllers attached to this machine.</desc>
4037	</attribute>
4038
4039	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4040	<desc>
4041	Full name of the file containing machine settings data.
4042	</desc>
4043	</attribute>
4044
4045	<attribute name="settingsModified" type="boolean" readonly="yes">
4046	<desc>
4047	Whether the settings of this machine have been modified
4048	(but neither yet saved nor discarded).
4049	<note>
4050	Reading this property is only valid on instances returned
4051	by <link to="ISession::machine"/> and on new machines
4052	created by <link to="IVirtualBox::createMachine"/> or opened
4053	by <link to="IVirtualBox::openMachine"/> but not
4054	yet registered, or on unregistered machines after calling
4055	<link to="IMachine::unregister"/>. For all other
4056	cases, the settings can never be modified.
4057	</note>
4058	<note>
4059	For newly created unregistered machines, the value of this
4060	property is always @c true until <link to="#saveSettings"/>
4061	is called (no matter if any machine settings have been
4062	changed after the creation or not). For opened machines
4063	the value is set to @c false (and then follows to normal rules).
4064	</note>
4065	</desc>
4066	</attribute>
4067
4068	<attribute name="sessionState" type="SessionState" readonly="yes">
4069	<desc>Current session state for this machine.</desc>
4070	</attribute>
4071
4072	<attribute name="sessionType" type="wstring" readonly="yes">
4073	<desc>
4074	Type of the session. If <link to="#sessionState"/> is
4075	Spawning or Locked, this attribute contains the
4076	same value as passed to the
4077	<link to="IMachine::launchVMProcess"/> method in the
4078	@a type parameter. If the session was used with
4079	<link to="IMachine::lockMachine" />, or if
4080	<link to="#sessionState"/> is SessionClosed, the value of this
4081	attribute is an empty string.
4082	</desc>
4083	</attribute>
4084
4085	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4086	<desc>
4087	Identifier of the session process. This attribute contains the
4088	platform-dependent identifier of the process whose session was
4089	used with <link to="IMachine::lockMachine" /> call. The returned
4090	value is only valid if <link to="#sessionState"/> is Locked or
4091	Unlocking by the time this property is read.
4092	</desc>
4093	</attribute>
4094
4095	<attribute name="state" type="MachineState" readonly="yes">
4096	<desc>Current execution state of this machine.</desc>
4097	</attribute>
4098
4099	<attribute name="lastStateChange" type="long long" readonly="yes">
4100	<desc>
4101	Time stamp of the last execution state change,
4102	in milliseconds since 1970-01-01 UTC.
4103	</desc>
4104	</attribute>
4105
4106	<attribute name="stateFilePath" type="wstring" readonly="yes">
4107	<desc>
4108	Full path to the file that stores the execution state of
4109	the machine when it is in the <link to="MachineState_Saved"/> state.
4110	<note>
4111	When the machine is not in the Saved state, this attribute is
4112	an empty string.
4113	</note>
4114	</desc>
4115	</attribute>
4116
4117	<attribute name="logFolder" type="wstring" readonly="yes">
4118	<desc>
4119	Full path to the folder that stores a set of rotated log files
4120	recorded during machine execution. The most recent log file is
4121	named <tt>VBox.log</tt>, the previous log file is
4122	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4123	in the current version).
4124	</desc>
4125	</attribute>
4126
4127	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4128	<desc>
4129	Current snapshot of this machine. This is @c null if the machine
4130	currently has no snapshots. If it is not @c null, then it was
4131	set by one of <link to="IConsole::takeSnapshot" />,
4132	<link to="IConsole::deleteSnapshot" />
4133	or <link to="IConsole::restoreSnapshot" />, depending on which
4134	was called last. See <link to="ISnapshot"/> for details.
4135	</desc>
4136	</attribute>
4137
4138	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4139	<desc>
4140	Number of snapshots taken on this machine. Zero means the
4141	machine doesn't have any snapshots.
4142	</desc>
4143	</attribute>
4144
4145	<attribute name="currentStateModified" type="boolean" readonly="yes">
4146	<desc>
4147	Returns @c true if the current state of the machine is not
4148	identical to the state stored in the current snapshot.
4149
4150	The current state is identical to the current snapshot only
4151	directly after one of the following calls are made:
4152
4153	<ul>
4154	<li><link to="IConsole::restoreSnapshot"/>
4155	</li>
4156	<li><link to="IConsole::takeSnapshot"/> (issued on a
4157	"powered off" or "saved" machine, for which
4158	<link to="#settingsModified"/> returns @c false)
4159	</li>
4160	</ul>
4161
4162	The current state remains identical until one of the following
4163	happens:
4164	<ul>
4165	<li>settings of the machine are changed</li>
4166	<li>the saved state is deleted</li>
4167	<li>the current snapshot is deleted</li>
4168	<li>an attempt to execute the machine is made</li>
4169	</ul>
4170
4171	<note>
4172	For machines that don't have snapshots, this property is
4173	always @c false.
4174	</note>
4175	</desc>
4176	</attribute>
4177
4178	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4179	<desc>
4180	Collection of shared folders for this machine (permanent shared
4181	folders). These folders are shared automatically at machine startup
4182	and available only to the guest OS installed within this machine.
4183
4184	New shared folders are added to the collection using
4185	<link to="#createSharedFolder"/>. Existing shared folders can be
4186	removed using <link to="#removeSharedFolder"/>.
4187	</desc>
4188	</attribute>
4189
4190	<attribute name="clipboardMode" type="ClipboardMode">
4191	<desc>
4192	Synchronization mode between the host OS clipboard
4193	and the guest OS clipboard.
4194	</desc>
4195	</attribute>
4196
4197	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4198	<desc>
4199	A comma-separated list of simple glob patterns. Changes to guest
4200	properties whose name matches one of the patterns will generate an
4201	<link to="IGuestPropertyChangedEvent"/> signal.
4202	</desc>
4203	</attribute>
4204
4205	<attribute name="teleporterEnabled" type="boolean">
4206	<desc>
4207	When set to @a true, the virtual machine becomes a target teleporter
4208	the next time it is powered on. This can only set to @a true when the
4209	VM is in the @a PoweredOff or @a Aborted state.
4210
4211	<!-- This property is automatically set to @a false when the VM is powered
4212	on. (bird: This doesn't work yet ) -->
4213	</desc>
4214	</attribute>
4215
4216	<attribute name="teleporterPort" type="unsigned long">
4217	<desc>
4218	The TCP port the target teleporter will listen for incoming
4219	teleportations on.
4220
4221	0 means the port is automatically selected upon power on. The actual
4222	value can be read from this property while the machine is waiting for
4223	incoming teleportations.
4224	</desc>
4225	</attribute>
4226
4227	<attribute name="teleporterAddress" type="wstring">
4228	<desc>
4229	The address the target teleporter will listen on. If set to an empty
4230	string, it will listen on all addresses.
4231	</desc>
4232	</attribute>
4233
4234	<attribute name="teleporterPassword" type="wstring">
4235	<desc>
4236	The password to check for on the target teleporter. This is just a
4237	very basic measure to prevent simple hacks and operators accidentally
4238	beaming a virtual machine to the wrong place.
4239
4240	Note that you SET a plain text password while reading back a HASHED
4241	password. Setting a hashed password is currently not supported.
4242	</desc>
4243	</attribute>
4244
4245	<attribute name="faultToleranceState" type="FaultToleranceState">
4246	<desc>
4247	Fault tolerance state; disabled, source or target.
4248	This property can be changed at any time. If you change it for a running
4249	VM, then the fault tolerance address and port must be set beforehand.
4250	</desc>
4251	</attribute>
4252
4253	<attribute name="faultTolerancePort" type="unsigned long">
4254	<desc>
4255	The TCP port the fault tolerance source or target will use for
4256	communication.
4257	</desc>
4258	</attribute>
4259
4260	<attribute name="faultToleranceAddress" type="wstring">
4261	<desc>
4262	The address the fault tolerance source or target.
4263	</desc>
4264	</attribute>
4265
4266	<attribute name="faultTolerancePassword" type="wstring">
4267	<desc>
4268	The password to check for on the standby VM. This is just a
4269	very basic measure to prevent simple hacks and operators accidentally
4270	choosing the wrong standby VM.
4271	</desc>
4272	</attribute>
4273
4274	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4275	<desc>
4276	The interval in ms used for syncing the state between source and target.
4277	</desc>
4278	</attribute>
4279
4280	<attribute name="RTCUseUTC" type="boolean">
4281	<desc>
4282	When set to @a true, the RTC device of the virtual machine will run
4283	in UTC time, otherwise in local time. Especially Unix guests prefer
4284	the time in UTC.
4285	</desc>
4286	</attribute>
4287
4288	<attribute name="ioCacheEnabled" type="boolean">
4289	<desc>
4290	When set to @a true, the builtin I/O cache of the virtual machine
4291	will be enabled.
4292	</desc>
4293	</attribute>
4294
4295	<attribute name="ioCacheSize" type="unsigned long">
4296	<desc>
4297	Maximum size of the I/O cache in MB.
4298	</desc>
4299	</attribute>
4300
4301	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4302	<desc>Array of PCI devices assigned to this machine, to get list of all
4303	PCI devices attached to the machine use
4304	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4305	is intended to list only devices additional to what described in
4306	virtual hardware config. Usually, this list keeps host's physical
4307	devices assigned to the particular machine.
4308	</desc>
4309	</attribute>
4310
4311	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4312	<desc>
4313	Bandwidth control manager.
4314	</desc>
4315	</attribute>
4316
4317	<attribute name="tracingEnabled" type="boolean">
4318	<desc>
4319	Enables the tracing facility in the VMM (including PDM devices +
4320	drivers). The VMM will consume about 0.5MB of more memory when
4321	enabled and there may be some extra overhead from tracepoints that are
4322	always enabled.
4323	</desc>
4324	</attribute>
4325
4326	<attribute name="tracingConfig" type="wstring">
4327	<desc>
4328	Tracepoint configuration to apply at startup when
4329	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4330	a space separated of tracepoint group names to enable. The special
4331	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4332	more details on available tracepoint groups and such.
4333
4334	Note that on hosts supporting DTrace (or similar), a lot of the
4335	tracepoints may be implemented exclusivly as DTrace probes. So, the
4336	effect of the same config may differ between Solaris and Windows for
4337	example.
4338	</desc>
4339	</attribute>
4340
4341	<attribute name="allowTracingToAccessVM" type="boolean">
4342	<desc>
4343	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4344	structures when firing off trace points. This is especially useful
4345	with DTrace tracepoints, as it allow you to use the VMCPU or VM pointer
4346	to obtail useful information such as guest register state.
4347
4348	This is disabled by default because devices and drivers normally has no
4349	business accessing the VMCPU or VM structures, and are therefore unable
4350	to get any pointers to these.
4351	</desc>
4352	</attribute>
4353
4354	<method name="lockMachine">
4355	<desc>
4356	Locks the machine for the given session to enable the caller
4357	to make changes to the machine or start the VM or control
4358	VM execution.
4359
4360	There are two ways to lock a machine for such uses:
4361
4362	<ul>
4363	<li>If you want to make changes to the machine settings,
4364	you must obtain an exclusive write lock on the machine
4365	by setting @a lockType to @c Write.
4366
4367	This will only succeed if no other process has locked
4368	the machine to prevent conflicting changes. Only after
4369	an exclusive write lock has been obtained using this method, one
4370	can change all VM settings or execute the VM in the process
4371	space of the session object. (Note that the latter is only of
4372	interest if you actually want to write a new front-end for
4373	virtual machines; but this API gets called internally by
4374	the existing front-ends such as VBoxHeadless and the VirtualBox
4375	GUI to acquire a write lock on the machine that they are running.)
4376
4377	On success, write-locking the machine for a session creates
4378	a second copy of the IMachine object. It is this second object
4379	upon which changes can be made; in VirtualBox terminology, the
4380	second copy is "mutable". It is only this second, mutable machine
4381	object upon which you can call methods that change the
4382	machine state. After having called this method, you can
4383	obtain this second, mutable machine object using the
4384	<link to="ISession::machine" /> attribute.
4385	</li>
4386	<li>If you only want to check the machine state or control
4387	machine execution without actually changing machine
4388	settings (e.g. to get access to VM statistics or take
4389	a snapshot or save the machine state), then set the
4390	@a lockType argument to @c Shared.
4391
4392	If no other session has obtained a lock, you will obtain an
4393	exclusive write lock as described above. However, if another
4394	session has already obtained such a lock, then a link to that
4395	existing session will be established which allows you
4396	to control that existing session.
4397
4398	To find out which type of lock was obtained, you can
4399	inspect <link to="ISession::type" />, which will have been
4400	set to either @c WriteLock or @c Shared.
4401	</li>
4402	</ul>
4403
4404	In either case, you can get access to the <link to="IConsole" />
4405	object which controls VM execution.
4406
4407	Also in all of the above cases, one must always call
4408	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4409	the machine's state will eventually be set to "Aborted".
4410
4411	To change settings on a machine, the following sequence is typically
4412	performed:
4413
4414	<ol>
4415	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4416
4417	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4418
4419	<li>Change the settings of the machine by invoking IMachine methods.</li>
4420
4421	<li>Call <link to="IMachine::saveSettings" />.</li>
4422
4423	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4424	</ol>
4425
4426	<result name="E_UNEXPECTED">
4427	Virtual machine not registered.
4428	</result>
4429	<result name="E_ACCESSDENIED">
4430	Process not started by OpenRemoteSession.
4431	</result>
4432	<result name="VBOX_E_INVALID_OBJECT_STATE">
4433	Session already open or being opened.
4434	</result>
4435	<result name="VBOX_E_VM_ERROR">
4436	Failed to assign machine to session.
4437	</result>
4438	</desc>
4439	<param name="session" type="ISession" dir="in">
4440	<desc>
4441	Session object for which the machine will be locked.
4442	</desc>
4443	</param>
4444	<param name="lockType" type="LockType" dir="in">
4445	<desc>
4446	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4447	If set to @c Shared, then either acquire an exclusive write lock or establish
4448	a link to an existing session.
4449	</desc>
4450	</param>
4451	</method>
4452
4453	<method name="launchVMProcess">
4454	<desc>
4455	Spawns a new process that will execute the virtual machine and obtains a shared
4456	lock on the machine for the calling session.
4457
4458	If launching the VM succeeds, the new VM process will create its own session
4459	and write-lock the machine for it, preventing conflicting changes from other
4460	processes. If the machine is already locked (because it is already running or
4461	because another session has a write lock), launching the VM process will therefore
4462	fail. Reversely, future attempts to obtain a write lock will also fail while the
4463	machine is running.
4464
4465	The caller's session object remains separate from the session opened by the new
4466	VM process. It receives its own <link to="IConsole" /> object which can be used
4467	to control machine execution, but it cannot be used to change all VM settings
4468	which would be available after a <link to="#lockMachine" /> call.
4469
4470	The caller must eventually release the session's shared lock by calling
4471	<link to="ISession::unlockMachine" /> on the local session object once this call
4472	has returned. However, the session's state (see <link to="ISession::state" />)
4473	will not return to "Unlocked" until the remote session has also unlocked
4474	the machine (i.e. the machine has stopped running).
4475
4476	Launching a VM process can take some time (a new VM is started in a new process,
4477	for which memory and other resources need to be set up). Because of this,
4478	an <link to="IProgress" /> object is returned to allow the caller to wait
4479	for this asynchronous operation to be completed. Until then, the caller's
4480	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4481	and <link to="ISession::console" /> attributes cannot be accessed.
4482	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4483	similar calls to wait for completion. Completion is signalled when the VM
4484	is powered on. If launching the VM fails, error messages can be queried
4485	via the progress object, if available.
4486
4487	The progress object will have at least 2 sub-operations. The first
4488	operation covers the period up to the new VM process calls powerUp.
4489	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4490	progress object. Because <link to="IConsole::powerUp"/> may require
4491	some extra sub-operations, the <link to="IProgress::operationCount"/>
4492	may change at the completion of operation.
4493
4494	For details on the teleportation progress operation, see
4495	<link to="IConsole::powerUp"/>.
4496
4497	The @a environment argument is a string containing definitions of
4498	environment variables in the following format:
4499	<pre>
4500	NAME[=VALUE]\n
4501	NAME[=VALUE]\n
4502	...
4503	</pre>
4504	where <tt>\\n</tt> is the new line character. These environment
4505	variables will be appended to the environment of the VirtualBox server
4506	process. If an environment variable exists both in the server process
4507	and in this list, the value from this list takes precedence over the
4508	server's variable. If the value of the environment variable is
4509	omitted, this variable will be removed from the resulting environment.
4510	If the environment string is @c null or empty, the server environment
4511	is inherited by the started process as is.
4512
4513	<result name="E_UNEXPECTED">
4514	Virtual machine not registered.
4515	</result>
4516	<result name="E_INVALIDARG">
4517	Invalid session type @a type.
4518	</result>
4519	<result name="VBOX_E_OBJECT_NOT_FOUND">
4520	No machine matching @a machineId found.
4521	</result>
4522	<result name="VBOX_E_INVALID_OBJECT_STATE">
4523	Session already open or being opened.
4524	</result>
4525	<result name="VBOX_E_IPRT_ERROR">
4526	Launching process for machine failed.
4527	</result>
4528	<result name="VBOX_E_VM_ERROR">
4529	Failed to assign machine to session.
4530	</result>
4531	</desc>
4532	<param name="session" type="ISession" dir="in">
4533	<desc>
4534	Client session object to which the VM process will be connected (this
4535	must be in "Unlocked" state).
4536	</desc>
4537	</param>
4538	<param name="type" type="wstring" dir="in">
4539	<desc>
4540	Front-end to use for the new VM process. The following are currently supported:
4541	<ul>
4542	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4543	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4544	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4545	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4546	the currently running VM or session owner. In this case the
4547	@a session parameter may be @c NULL (if it is non-null it isn't
4548	used in any way), and the @a progress return value will be always
4549	NULL. The operation completes immediately.</li>
4550	</ul>
4551	</desc>
4552	</param>
4553	<param name="environment" type="wstring" dir="in">
4554	<desc>
4555	Environment to pass to the VM process.
4556	</desc>
4557	</param>
4558	<param name="progress" type="IProgress" dir="return">
4559	<desc>Progress object to track the operation completion.</desc>
4560	</param>
4561	</method>
4562
4563	<method name="setBootOrder">
4564	<desc>
4565	Puts the given device to the specified position in
4566	the boot order.
4567
4568	To indicate that no device is associated with the given position,
4569	<link to="DeviceType_Null"/> should be used.
4570
4571	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4572
4573	<result name="E_INVALIDARG">
4574	Boot @a position out of range.
4575	</result>
4576	<result name="E_NOTIMPL">
4577	Booting from USB @a device currently not supported.
4578	</result>
4579
4580	</desc>
4581	<param name="position" type="unsigned long" dir="in">
4582	<desc>
4583	Position in the boot order (@c 1 to the total number of
4584	devices the machine can boot from, as returned by
4585	<link to="ISystemProperties::maxBootPosition"/>).
4586	</desc>
4587	</param>
4588	<param name="device" type="DeviceType" dir="in">
4589	<desc>
4590	The type of the device used to boot at the given position.
4591	</desc>
4592	</param>
4593	</method>
4594
4595	<method name="getBootOrder" const="yes">
4596	<desc>
4597	Returns the device type that occupies the specified
4598	position in the boot order.
4599
4600	@todo [remove?]
4601	If the machine can have more than one device of the returned type
4602	(such as hard disks), then a separate method should be used to
4603	retrieve the individual device that occupies the given position.
4604
4605	If here are no devices at the given position, then
4606	<link to="DeviceType_Null"/> is returned.
4607
4608	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4609
4610	<result name="E_INVALIDARG">
4611	Boot @a position out of range.
4612	</result>
4613
4614	</desc>
4615	<param name="position" type="unsigned long" dir="in">
4616	<desc>
4617	Position in the boot order (@c 1 to the total number of
4618	devices the machine can boot from, as returned by
4619	<link to="ISystemProperties::maxBootPosition"/>).
4620	</desc>
4621	</param>
4622	<param name="device" type="DeviceType" dir="return">
4623	<desc>
4624	Device at the given position.
4625	</desc>
4626	</param>
4627	</method>
4628
4629	<method name="attachDevice">
4630	<desc>
4631	Attaches a device and optionally mounts a medium to the given storage
4632	controller (<link to="IStorageController" />, identified by @a name),
4633	at the indicated port and device.
4634
4635	This method is intended for managing storage devices in general while a
4636	machine is powered off. It can be used to attach and detach fixed
4637	and removable media. The following kind of media can be attached
4638	to a machine:
4639
4640	<ul>
4641	<li>For fixed and removable media, you can pass in a medium that was
4642	previously opened using <link to="IVirtualBox::openMedium" />.
4643	</li>
4644
4645	<li>Only for storage devices supporting removable media (such as
4646	DVDs and floppies), you can also specify a null pointer to
4647	indicate an empty drive or one of the medium objects listed
4648	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4649	arrays to indicate a host drive.
4650	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4651	to change the media while the machine is running.
4652	</li>
4653	</ul>
4654
4655	In a VM's default configuration of virtual machines, the secondary
4656	master of the IDE controller is used for a CD/DVD drive.
4657
4658	After calling this returns successfully, a new instance of
4659	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4660	attachments (see <link to="IMachine::mediumAttachments"/>).
4661
4662	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4663	information about attaching media.
4664
4665	The specified device slot must not have a device attached to it,
4666	or this method will fail.
4667
4668	<note>
4669	You cannot attach a device to a newly created machine until
4670	this machine's settings are saved to disk using
4671	<link to="#saveSettings"/>.
4672	</note>
4673	<note>
4674	If the medium is being attached indirectly, a new differencing medium
4675	will implicitly be created for it and attached instead. If the
4676	changes made to the machine settings (including this indirect
4677	attachment) are later cancelled using <link to="#discardSettings"/>,
4678	this implicitly created differencing medium will implicitly
4679	be deleted.
4680	</note>
4681
4682	<result name="E_INVALIDARG">
4683	SATA device, SATA port, IDE port or IDE slot out of range, or
4684	file or UUID not found.
4685	</result>
4686	<result name="VBOX_E_INVALID_OBJECT_STATE">
4687	Machine must be registered before media can be attached.
4688	</result>
4689	<result name="VBOX_E_INVALID_VM_STATE">
4690	Invalid machine state.
4691	</result>
4692	<result name="VBOX_E_OBJECT_IN_USE">
4693	A medium is already attached to this or another virtual machine.
4694	</result>
4695
4696	</desc>
4697	<param name="name" type="wstring" dir="in">
4698	<desc>Name of the storage controller to attach the device to.</desc>
4699	</param>
4700	<param name="controllerPort" type="long" dir="in">
4701	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4702	the primary controller and 1 specifies the secondary controller.
4703	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4704	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4705	</param>
4706	<param name="device" type="long" dir="in">
4707	<desc>Device slot in the given port to attach the device to. This is only
4708	relevant for IDE controllers, for which 0 specifies the master device and
4709	1 specifies the slave device. For all other controller types, this must
4710	be 0.</desc>
4711	</param>
4712	<param name="type" type="DeviceType" dir="in">
4713	<desc>Device type of the attached device. For media opened by
4714	<link to="IVirtualBox::openMedium" />, this must match the device type
4715	specified there.</desc>
4716	</param>
4717	<param name="medium" type="IMedium" dir="in">
4718	<desc>Medium to mount or NULL for an empty drive.</desc>
4719	</param>
4720	</method>
4721
4722	<method name="detachDevice">
4723	<desc>
4724	Detaches the device attached to a device slot of the specified bus.
4725
4726	Detaching the device from the virtual machine is deferred. This means
4727	that the medium remains associated with the machine when this method
4728	returns and gets actually de-associated only after a successful
4729	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4730	for more detailed information about attaching media.
4731
4732	<note>
4733	You cannot detach a device from a running machine.
4734	</note>
4735	<note>
4736	Detaching differencing media implicitly created by <link
4737	to="#attachDevice"/> for the indirect attachment using this
4738	method will <b>not</b> implicitly delete them. The
4739	<link to="IMedium::deleteStorage"/> operation should be
4740	explicitly performed by the caller after the medium is successfully
4741	detached and the settings are saved with
4742	<link to="#saveSettings"/>, if it is the desired action.
4743	</note>
4744
4745	<result name="VBOX_E_INVALID_VM_STATE">
4746	Attempt to detach medium from a running virtual machine.
4747	</result>
4748	<result name="VBOX_E_OBJECT_NOT_FOUND">
4749	No medium attached to given slot/bus.
4750	</result>
4751	<result name="VBOX_E_NOT_SUPPORTED">
4752	Medium format does not support storage deletion.
4753	</result>
4754
4755	</desc>
4756	<param name="name" type="wstring" dir="in">
4757	<desc>Name of the storage controller to detach the medium from.</desc>
4758	</param>
4759	<param name="controllerPort" type="long" dir="in">
4760	<desc>Port number to detach the medium from.</desc>
4761	</param>
4762	<param name="device" type="long" dir="in">
4763	<desc>Device slot number to detach the medium from.</desc>
4764	</param>
4765	</method>
4766
4767	<method name="passthroughDevice">
4768	<desc>
4769	Sets the passthrough mode of an existing DVD device. Changing the
4770	setting while the VM is running is forbidden. The setting is only used
4771	if at VM start the device is configured as a host DVD drive, in all
4772	other cases it is ignored. The device must already exist; see
4773	<link to="IMachine::attachDevice"/> for how to attach a new device.
4774
4775	The @a controllerPort and @a device parameters specify the device slot and
4776	have have the same meaning as with <link to="IMachine::attachDevice" />.
4777
4778	<result name="E_INVALIDARG">
4779	SATA device, SATA port, IDE port or IDE slot out of range.
4780	</result>
4781	<result name="VBOX_E_INVALID_OBJECT_STATE">
4782	Attempt to modify an unregistered virtual machine.
4783	</result>
4784	<result name="VBOX_E_INVALID_VM_STATE">
4785	Invalid machine state.
4786	</result>
4787
4788	</desc>
4789	<param name="name" type="wstring" dir="in">
4790	<desc>Name of the storage controller.</desc>
4791	</param>
4792	<param name="controllerPort" type="long" dir="in">
4793	<desc>Storage controller port.</desc>
4794	</param>
4795	<param name="device" type="long" dir="in">
4796	<desc>Device slot in the given port.</desc>
4797	</param>
4798	<param name="passthrough" type="boolean" dir="in">
4799	<desc>New value for the passthrough setting.</desc>
4800	</param>
4801	</method>
4802
4803	<method name="temporaryEjectDevice">
4804	<desc>
4805	Sets the behavior for guest-triggered medium eject. In some situations
4806	it is desirable that such ejects update the VM configuration, and in
4807	others the eject should keep the VM configuration. The device must
4808	already exist; see <link to="IMachine::attachDevice"/> for how to
4809	attach a new device.
4810
4811	The @a controllerPort and @a device parameters specify the device slot and
4812	have have the same meaning as with <link to="IMachine::attachDevice" />.
4813
4814	<result name="E_INVALIDARG">
4815	SATA device, SATA port, IDE port or IDE slot out of range.
4816	</result>
4817	<result name="VBOX_E_INVALID_OBJECT_STATE">
4818	Attempt to modify an unregistered virtual machine.
4819	</result>
4820	<result name="VBOX_E_INVALID_VM_STATE">
4821	Invalid machine state.
4822	</result>
4823
4824	</desc>
4825	<param name="name" type="wstring" dir="in">
4826	<desc>Name of the storage controller.</desc>
4827	</param>
4828	<param name="controllerPort" type="long" dir="in">
4829	<desc>Storage controller port.</desc>
4830	</param>
4831	<param name="device" type="long" dir="in">
4832	<desc>Device slot in the given port.</desc>
4833	</param>
4834	<param name="temporaryEject" type="boolean" dir="in">
4835	<desc>New value for the eject behavior.</desc>
4836	</param>
4837	</method>
4838
4839	<method name="nonRotationalDevice">
4840	<desc>
4841	Sets a flag in the device information which indicates that the medium
4842	is not based on rotational technology, i.e. that the access times are
4843	more or less independent of the position on the medium. This may or may
4844	not be supported by a particular drive, and is silently ignored in the
4845	latter case. At the moment only hard disks (which is a misnomer in this
4846	context) accept this setting. Changing the setting while the VM is
4847	running is forbidden. The device must already exist; see
4848	<link to="IMachine::attachDevice"/> for how to attach a new device.
4849
4850	The @a controllerPort and @a device parameters specify the device slot and
4851	have have the same meaning as with <link to="IMachine::attachDevice" />.
4852
4853	<result name="E_INVALIDARG">
4854	SATA device, SATA port, IDE port or IDE slot out of range.
4855	</result>
4856	<result name="VBOX_E_INVALID_OBJECT_STATE">
4857	Attempt to modify an unregistered virtual machine.
4858	</result>
4859	<result name="VBOX_E_INVALID_VM_STATE">
4860	Invalid machine state.
4861	</result>
4862
4863	</desc>
4864	<param name="name" type="wstring" dir="in">
4865	<desc>Name of the storage controller.</desc>
4866	</param>
4867	<param name="controllerPort" type="long" dir="in">
4868	<desc>Storage controller port.</desc>
4869	</param>
4870	<param name="device" type="long" dir="in">
4871	<desc>Device slot in the given port.</desc>
4872	</param>
4873	<param name="nonRotational" type="boolean" dir="in">
4874	<desc>New value for the non-rotational device flag.</desc>
4875	</param>
4876	</method>
4877
4878	<method name="setAutoDiscardForDevice">
4879	<desc>
4880	Sets a flag in the device information which indicates that the medium
4881	supports discarding unsused blocks (called trimming for SATA or unmap
4882	for SCSI devices) .This may or may not be supported by a particular drive,
4883	and is silently ignored in the latter case. At the moment only hard disks
4884	(which is a misnomer in this context) accept this setting. Changing the
4885	setting while the VM is running is forbidden. The device must already
4886	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4887	device.
4888
4889	The @a controllerPort and @a device parameters specify the device slot and
4890	have have the same meaning as with <link to="IMachine::attachDevice" />.
4891
4892	<result name="E_INVALIDARG">
4893	SATA device, SATA port, SCSI port out of range.
4894	</result>
4895	<result name="VBOX_E_INVALID_OBJECT_STATE">
4896	Attempt to modify an unregistered virtual machine.
4897	</result>
4898	<result name="VBOX_E_INVALID_VM_STATE">
4899	Invalid machine state.
4900	</result>
4901
4902	</desc>
4903	<param name="name" type="wstring" dir="in">
4904	<desc>Name of the storage controller.</desc>
4905	</param>
4906	<param name="controllerPort" type="long" dir="in">
4907	<desc>Storage controller port.</desc>
4908	</param>
4909	<param name="device" type="long" dir="in">
4910	<desc>Device slot in the given port.</desc>
4911	</param>
4912	<param name="discard" type="boolean" dir="in">
4913	<desc>New value for the discard device flag.</desc>
4914	</param>
4915	</method>
4916
4917	<method name="setBandwidthGroupForDevice">
4918	<desc>
4919	Sets the bandwidth group of an existing storage device.
4920	The device must already exist; see <link to="IMachine::attachDevice"/>
4921	for how to attach a new device.
4922
4923	The @a controllerPort and @a device parameters specify the device slot and
4924	have have the same meaning as with <link to="IMachine::attachDevice" />.
4925
4926	<result name="E_INVALIDARG">
4927	SATA device, SATA port, IDE port or IDE slot out of range.
4928	</result>
4929	<result name="VBOX_E_INVALID_OBJECT_STATE">
4930	Attempt to modify an unregistered virtual machine.
4931	</result>
4932	<result name="VBOX_E_INVALID_VM_STATE">
4933	Invalid machine state.
4934	</result>
4935
4936	</desc>
4937	<param name="name" type="wstring" dir="in">
4938	<desc>Name of the storage controller.</desc>
4939	</param>
4940	<param name="controllerPort" type="long" dir="in">
4941	<desc>Storage controller port.</desc>
4942	</param>
4943	<param name="device" type="long" dir="in">
4944	<desc>Device slot in the given port.</desc>
4945	</param>
4946	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4947	<desc>New value for the bandwidth group or NULL for no group.</desc>
4948	</param>
4949	</method>
4950
4951	<method name="mountMedium">
4952	<desc>
4953	Mounts a medium (<link to="IMedium" />, identified
4954	by the given UUID @a id) to the given storage controller
4955	(<link to="IStorageController" />, identified by @a name),
4956	at the indicated port and device. The device must already exist;
4957	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4958
4959	This method is intended only for managing removable media, where the
4960	device is fixed but media is changeable at runtime (such as DVDs
4961	and floppies). It cannot be used for fixed media such as hard disks.
4962
4963	The @a controllerPort and @a device parameters specify the device slot and
4964	have have the same meaning as with <link to="IMachine::attachDevice" />.
4965
4966	The specified device slot can have a medium mounted, which will be
4967	unmounted first. Specifying a zero UUID (or an empty string) for
4968	@a medium does just an unmount.
4969
4970	See <link to="IMedium"/> for more detailed information about
4971	attaching media.
4972
4973	<result name="E_INVALIDARG">
4974	SATA device, SATA port, IDE port or IDE slot out of range.
4975	</result>
4976	<result name="VBOX_E_INVALID_OBJECT_STATE">
4977	Attempt to attach medium to an unregistered virtual machine.
4978	</result>
4979	<result name="VBOX_E_INVALID_VM_STATE">
4980	Invalid machine state.
4981	</result>
4982	<result name="VBOX_E_OBJECT_IN_USE">
4983	Medium already attached to this or another virtual machine.
4984	</result>
4985
4986	</desc>
4987	<param name="name" type="wstring" dir="in">
4988	<desc>Name of the storage controller to attach the medium to.</desc>
4989	</param>
4990	<param name="controllerPort" type="long" dir="in">
4991	<desc>Port to attach the medium to.</desc>
4992	</param>
4993	<param name="device" type="long" dir="in">
4994	<desc>Device slot in the given port to attach the medium to.</desc>
4995	</param>
4996	<param name="medium" type="IMedium" dir="in">
4997	<desc>Medium to mount or NULL for an empty drive.</desc>
4998	</param>
4999	<param name="force" type="boolean" dir="in">
5000	<desc>Allows to force unmount/mount of a medium which is locked by
5001	the device slot in the given port to attach the medium to.</desc>
5002	</param>
5003	</method>
5004
5005	<method name="getMedium" const="yes">
5006	<desc>
5007	Returns the virtual medium attached to a device slot of the specified
5008	bus.
5009
5010	Note that if the medium was indirectly attached by
5011	<link to="#mountMedium"/> to the given device slot then this
5012	method will return not the same object as passed to the
5013	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5014	more detailed information about mounting a medium.
5015
5016	<result name="VBOX_E_OBJECT_NOT_FOUND">
5017	No medium attached to given slot/bus.
5018	</result>
5019
5020	</desc>
5021	<param name="name" type="wstring" dir="in">
5022	<desc>Name of the storage controller the medium is attached to.</desc>
5023	</param>
5024	<param name="controllerPort" type="long" dir="in">
5025	<desc>Port to query.</desc>
5026	</param>
5027	<param name="device" type="long" dir="in">
5028	<desc>Device slot in the given port to query.</desc>
5029	</param>
5030	<param name="medium" type="IMedium" dir="return">
5031	<desc>Attached medium object.</desc>
5032	</param>
5033	</method>
5034
5035	<method name="getMediumAttachmentsOfController" const="yes">
5036	<desc>
5037	Returns an array of medium attachments which are attached to the
5038	the controller with the given name.
5039
5040	<result name="VBOX_E_OBJECT_NOT_FOUND">
5041	A storage controller with given name doesn't exist.
5042	</result>
5043	</desc>
5044	<param name="name" type="wstring" dir="in"/>
5045	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5046	</method>
5047
5048	<method name="getMediumAttachment" const="yes">
5049	<desc>
5050	Returns a medium attachment which corresponds to the controller with
5051	the given name, on the given port and device slot.
5052
5053	<result name="VBOX_E_OBJECT_NOT_FOUND">
5054	No attachment exists for the given controller/port/device combination.
5055	</result>
5056	</desc>
5057	<param name="name" type="wstring" dir="in"/>
5058	<param name="controllerPort" type="long" dir="in"/>
5059	<param name="device" type="long" dir="in"/>
5060	<param name="attachment" type="IMediumAttachment" dir="return"/>
5061	</method>
5062
5063	<method name="attachHostPciDevice">
5064	<desc>
5065	Attaches host PCI device with the given (host) PCI address to the
5066	PCI bus of the virtual machine. Please note, that this operation
5067	is two phase, as real attachment will happen when VM will start,
5068	and most information will be delivered as IHostPciDevicePlugEvent
5069	on IVirtualBox event source.
5070
5071	<see><link to="IHostPciDevicePlugEvent"/></see>
5072
5073	<result name="VBOX_E_INVALID_VM_STATE">
5074	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5075	</result>
5076	<result name="VBOX_E_PDM_ERROR">
5077	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5078	</result>
5079	<result name="VBOX_E_NOT_SUPPORTED">
5080	Hardware or host OS doesn't allow PCI device passthrought.
5081	</result>
5082	</desc>
5083	<param name="hostAddress" type="long" dir="in">
5084	<desc>Address of the host PCI device.</desc>
5085	</param>
5086	<param name="desiredGuestAddress" type="long" dir="in">
5087	<desc>Desired position of this device on guest PCI bus.</desc>
5088	</param>
5089	<param name="tryToUnbind" type="boolean" dir="in">
5090	<desc>If VMM shall try to unbind existing drivers from the
5091	device before attaching it to the guest.</desc>
5092	</param>
5093	</method>
5094
5095	<method name="detachHostPciDevice">
5096	<desc>
5097	Detach host PCI device from the virtual machine.
5098	Also HostPciDevicePlugEvent on IVirtualBox event source
5099	will be delivered. As currently we don't support hot device
5100	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5101
5102	<see><link to="IHostPciDevicePlugEvent"/></see>
5103
5104	<result name="VBOX_E_INVALID_VM_STATE">
5105	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5106	</result>
5107	<result name="VBOX_E_OBJECT_NOT_FOUND">
5108	This host device is not attached to this machine.
5109	</result>
5110	<result name="VBOX_E_PDM_ERROR">
5111	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5112	</result>
5113	<result name="VBOX_E_NOT_SUPPORTED">
5114	Hardware or host OS doesn't allow PCI device passthrought.
5115	</result>
5116	</desc>
5117	<param name="hostAddress" type="long" dir="in">
5118	<desc>Address of the host PCI device.</desc>
5119	</param>
5120	</method>
5121
5122	<method name="getNetworkAdapter" const="yes">
5123	<desc>
5124	Returns the network adapter associated with the given slot.
5125	Slots are numbered sequentially, starting with zero. The total
5126	number of adapters per machine is defined by the
5127	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5128	so the maximum slot number is one less than that property's value.
5129
5130	<result name="E_INVALIDARG">
5131	Invalid @a slot number.
5132	</result>
5133
5134	</desc>
5135	<param name="slot" type="unsigned long" dir="in"/>
5136	<param name="adapter" type="INetworkAdapter" dir="return"/>
5137	</method>
5138
5139	<method name="addStorageController">
5140	<desc>
5141	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5142	machine and returns it as an instance of
5143	<link to="IStorageController" />.
5144
5145	@a name identifies the controller for subsequent calls such as
5146	<link to="#getStorageControllerByName" />,
5147	<link to="#getStorageControllerByInstance" />,
5148	<link to="#removeStorageController" />,
5149	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5150
5151	After the controller has been added, you can set its exact
5152	type by setting the <link to="IStorageController::controllerType" />.
5153
5154	<result name="VBOX_E_OBJECT_IN_USE">
5155	A storage controller with given name exists already.
5156	</result>
5157	<result name="E_INVALIDARG">
5158	Invalid @a controllerType.
5159	</result>
5160	</desc>
5161	<param name="name" type="wstring" dir="in"/>
5162	<param name="connectionType" type="StorageBus" dir="in"/>
5163	<param name="controller" type="IStorageController" dir="return"/>
5164	</method>
5165
5166	<method name="getStorageControllerByName" const="yes">
5167	<desc>
5168	Returns a storage controller with the given name.
5169
5170	<result name="VBOX_E_OBJECT_NOT_FOUND">
5171	A storage controller with given name doesn't exist.
5172	</result>
5173	</desc>
5174	<param name="name" type="wstring" dir="in"/>
5175	<param name="storageController" type="IStorageController" dir="return"/>
5176	</method>
5177
5178	<method name="getStorageControllerByInstance" const="yes">
5179	<desc>
5180	Returns a storage controller with the given instance number.
5181
5182	<result name="VBOX_E_OBJECT_NOT_FOUND">
5183	A storage controller with given instance number doesn't exist.
5184	</result>
5185	</desc>
5186	<param name="instance" type="unsigned long" dir="in"/>
5187	<param name="storageController" type="IStorageController" dir="return"/>
5188	</method>
5189
5190	<method name="removeStorageController">
5191	<desc>
5192	Removes a storage controller from the machine.
5193
5194	<result name="VBOX_E_OBJECT_NOT_FOUND">
5195	A storage controller with given name doesn't exist.
5196	</result>
5197	</desc>
5198	<param name="name" type="wstring" dir="in"/>
5199	</method>
5200
5201	<method name="setStorageControllerBootable">
5202	<desc>
5203	Sets the bootable flag of the storage controller with the given name.
5204
5205	<result name="VBOX_E_OBJECT_NOT_FOUND">
5206	A storage controller with given name doesn't exist.
5207	</result>
5208	<result name="VBOX_E_OBJECT_IN_USE">
5209	Another storage controller is marked as bootable already.
5210	</result>
5211	</desc>
5212	<param name="name" type="wstring" dir="in"/>
5213	<param name="bootable" type="boolean" dir="in"/>
5214	</method>
5215
5216	<method name="getSerialPort" const="yes">
5217	<desc>
5218	Returns the serial port associated with the given slot.
5219	Slots are numbered sequentially, starting with zero. The total
5220	number of serial ports per machine is defined by the
5221	<link to="ISystemProperties::serialPortCount"/> property,
5222	so the maximum slot number is one less than that property's value.
5223
5224	<result name="E_INVALIDARG">
5225	Invalid @a slot number.
5226	</result>
5227
5228	</desc>
5229	<param name="slot" type="unsigned long" dir="in"/>
5230	<param name="port" type="ISerialPort" dir="return"/>
5231	</method>
5232
5233	<method name="getParallelPort" const="yes">
5234	<desc>
5235	Returns the parallel port associated with the given slot.
5236	Slots are numbered sequentially, starting with zero. The total
5237	number of parallel ports per machine is defined by the
5238	<link to="ISystemProperties::parallelPortCount"/> property,
5239	so the maximum slot number is one less than that property's value.
5240
5241	<result name="E_INVALIDARG">
5242	Invalid @a slot number.
5243	</result>
5244
5245	</desc>
5246	<param name="slot" type="unsigned long" dir="in"/>
5247	<param name="port" type="IParallelPort" dir="return"/>
5248	</method>
5249
5250	<method name="getExtraDataKeys">
5251	<desc>
5252	Returns an array representing the machine-specific extra data keys
5253	which currently have values defined.
5254	</desc>
5255	<param name="value" type="wstring" dir="return" safearray="yes">
5256	<desc>Array of extra data keys.</desc>
5257	</param>
5258	</method>
5259
5260	<method name="getExtraData">
5261	<desc>
5262	Returns associated machine-specific extra data.
5263
5264	If the requested data @a key does not exist, this function will
5265	succeed and return an empty string in the @a value argument.
5266
5267	<result name="VBOX_E_FILE_ERROR">
5268	Settings file not accessible.
5269	</result>
5270	<result name="VBOX_E_XML_ERROR">
5271	Could not parse the settings file.
5272	</result>
5273
5274	</desc>
5275	<param name="key" type="wstring" dir="in">
5276	<desc>Name of the data key to get.</desc>
5277	</param>
5278	<param name="value" type="wstring" dir="return">
5279	<desc>Value of the requested data key.</desc>
5280	</param>
5281	</method>
5282
5283	<method name="setExtraData">
5284	<desc>
5285	Sets associated machine-specific extra data.
5286
5287	If you pass @c null or an empty string as a key @a value, the given
5288	@a key will be deleted.
5289
5290	<note>
5291	Before performing the actual data change, this method will ask all
5292	registered listeners using the
5293	<link to="IExtraDataCanChangeEvent"/>
5294	notification for a permission. If one of the listeners refuses the
5295	new value, the change will not be performed.
5296	</note>
5297	<note>
5298	On success, the
5299	<link to="IExtraDataChangedEvent"/> notification
5300	is called to inform all registered listeners about a successful data
5301	change.
5302	</note>
5303	<note>
5304	This method can be called outside the machine session and therefore
5305	it's a caller's responsibility to handle possible race conditions
5306	when several clients change the same key at the same time.
5307	</note>
5308
5309	<result name="VBOX_E_FILE_ERROR">
5310	Settings file not accessible.
5311	</result>
5312	<result name="VBOX_E_XML_ERROR">
5313	Could not parse the settings file.
5314	</result>
5315
5316	</desc>
5317	<param name="key" type="wstring" dir="in">
5318	<desc>Name of the data key to set.</desc>
5319	</param>
5320	<param name="value" type="wstring" dir="in">
5321	<desc>Value to assign to the key.</desc>
5322	</param>
5323	</method>
5324
5325	<method name="getCPUProperty" const="yes">
5326	<desc>
5327	Returns the virtual CPU boolean value of the specified property.
5328
5329	<result name="E_INVALIDARG">
5330	Invalid property.
5331	</result>
5332
5333	</desc>
5334	<param name="property" type="CPUPropertyType" dir="in">
5335	<desc>
5336	Property type to query.
5337	</desc>
5338	</param>
5339	<param name="value" type="boolean" dir="return">
5340	<desc>
5341	Property value.
5342	</desc>
5343	</param>
5344	</method>
5345
5346	<method name="setCPUProperty">
5347	<desc>
5348	Sets the virtual CPU boolean value of the specified property.
5349
5350	<result name="E_INVALIDARG">
5351	Invalid property.
5352	</result>
5353
5354	</desc>
5355	<param name="property" type="CPUPropertyType" dir="in">
5356	<desc>
5357	Property type to query.
5358	</desc>
5359	</param>
5360	<param name="value" type="boolean" dir="in">
5361	<desc>
5362	Property value.
5363	</desc>
5364	</param>
5365	</method>
5366
5367	<method name="getCPUIDLeaf" const="yes">
5368	<desc>
5369	Returns the virtual CPU cpuid information for the specified leaf.
5370
5371	Currently supported index values for cpuid:
5372	Standard CPUID leafs: 0 - 0xA
5373	Extended CPUID leafs: 0x80000000 - 0x8000000A
5374
5375	See the Intel and AMD programmer's manuals for detailed information
5376	about the cpuid instruction and its leafs.
5377	<result name="E_INVALIDARG">
5378	Invalid id.
5379	</result>
5380
5381	</desc>
5382	<param name="id" type="unsigned long" dir="in">
5383	<desc>
5384	CPUID leaf index.
5385	</desc>
5386	</param>
5387	<param name="valEax" type="unsigned long" dir="out">
5388	<desc>
5389	CPUID leaf value for register eax.
5390	</desc>
5391	</param>
5392	<param name="valEbx" type="unsigned long" dir="out">
5393	<desc>
5394	CPUID leaf value for register ebx.
5395	</desc>
5396	</param>
5397	<param name="valEcx" type="unsigned long" dir="out">
5398	<desc>
5399	CPUID leaf value for register ecx.
5400	</desc>
5401	</param>
5402	<param name="valEdx" type="unsigned long" dir="out">
5403	<desc>
5404	CPUID leaf value for register edx.
5405	</desc>
5406	</param>
5407	</method>
5408
5409	<method name="setCPUIDLeaf">
5410	<desc>
5411	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5412	are not passed unmodified. VirtualBox clears features that it doesn't support.
5413
5414	Currently supported index values for cpuid:
5415	Standard CPUID leafs: 0 - 0xA
5416	Extended CPUID leafs: 0x80000000 - 0x8000000A
5417
5418	See the Intel and AMD programmer's manuals for detailed information
5419	about the cpuid instruction and its leafs.
5420
5421	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5422	random crashes inside VMs.
5423	<result name="E_INVALIDARG">
5424	Invalid id.
5425	</result>
5426
5427	</desc>
5428	<param name="id" type="unsigned long" dir="in">
5429	<desc>
5430	CPUID leaf index.
5431	</desc>
5432	</param>
5433	<param name="valEax" type="unsigned long" dir="in">
5434	<desc>
5435	CPUID leaf value for register eax.
5436	</desc>
5437	</param>
5438	<param name="valEbx" type="unsigned long" dir="in">
5439	<desc>
5440	CPUID leaf value for register ebx.
5441	</desc>
5442	</param>
5443	<param name="valEcx" type="unsigned long" dir="in">
5444	<desc>
5445	CPUID leaf value for register ecx.
5446	</desc>
5447	</param>
5448	<param name="valEdx" type="unsigned long" dir="in">
5449	<desc>
5450	CPUID leaf value for register edx.
5451	</desc>
5452	</param>
5453	</method>
5454
5455	<method name="removeCPUIDLeaf">
5456	<desc>
5457	Removes the virtual CPU cpuid leaf for the specified index
5458
5459	<result name="E_INVALIDARG">
5460	Invalid id.
5461	</result>
5462
5463	</desc>
5464	<param name="id" type="unsigned long" dir="in">
5465	<desc>
5466	CPUID leaf index.
5467	</desc>
5468	</param>
5469	</method>
5470
5471	<method name="removeAllCPUIDLeaves">
5472	<desc>
5473	Removes all the virtual CPU cpuid leaves
5474	</desc>
5475	</method>
5476
5477	<method name="getHWVirtExProperty" const="yes">
5478	<desc>
5479	Returns the value of the specified hardware virtualization boolean property.
5480
5481	<result name="E_INVALIDARG">
5482	Invalid property.
5483	</result>
5484
5485	</desc>
5486	<param name="property" type="HWVirtExPropertyType" dir="in">
5487	<desc>
5488	Property type to query.
5489	</desc>
5490	</param>
5491	<param name="value" type="boolean" dir="return">
5492	<desc>
5493	Property value.
5494	</desc>
5495	</param>
5496	</method>
5497
5498	<method name="setHWVirtExProperty">
5499	<desc>
5500	Sets a new value for the specified hardware virtualization boolean property.
5501
5502	<result name="E_INVALIDARG">
5503	Invalid property.
5504	</result>
5505
5506	</desc>
5507	<param name="property" type="HWVirtExPropertyType" dir="in">
5508	<desc>
5509	Property type to set.
5510	</desc>
5511	</param>
5512	<param name="value" type="boolean" dir="in">
5513	<desc>
5514	New property value.
5515	</desc>
5516	</param>
5517	</method>
5518
5519	<method name="saveSettings">
5520	<desc>
5521	Saves any changes to machine settings made since the session
5522	has been opened or a new machine has been created, or since the
5523	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5524	For registered machines, new settings become visible to all
5525	other VirtualBox clients after successful invocation of this
5526	method.
5527	<note>
5528	The method sends <link to="IMachineDataChangedEvent"/>
5529	notification event after the configuration has been successfully
5530	saved (only for registered machines).
5531	</note>
5532	<note>
5533	Calling this method is only valid on instances returned
5534	by <link to="ISession::machine"/> and on new machines
5535	created by <link to="IVirtualBox::createMachine"/> but not
5536	yet registered, or on unregistered machines after calling
5537	<link to="IMachine::unregister"/>.
5538	</note>
5539
5540	<result name="VBOX_E_FILE_ERROR">
5541	Settings file not accessible.
5542	</result>
5543	<result name="VBOX_E_XML_ERROR">
5544	Could not parse the settings file.
5545	</result>
5546	<result name="E_ACCESSDENIED">
5547	Modification request refused.
5548	</result>
5549
5550	</desc>
5551	</method>
5552
5553	<method name="discardSettings">
5554	<desc>
5555	Discards any changes to the machine settings made since the session
5556	has been opened or since the last call to <link to="#saveSettings"/>
5557	or <link to="#discardSettings"/>.
5558	<note>
5559	Calling this method is only valid on instances returned
5560	by <link to="ISession::machine"/> and on new machines
5561	created by <link to="IVirtualBox::createMachine"/> or
5562	opened by <link to="IVirtualBox::openMachine"/> but not
5563	yet registered, or on unregistered machines after calling
5564	<link to="IMachine::unregister"/>.
5565	</note>
5566
5567	<result name="VBOX_E_INVALID_VM_STATE">
5568	Virtual machine is not mutable.
5569	</result>
5570
5571	</desc>
5572	</method>
5573
5574	<method name="unregister">
5575	<desc>
5576	Unregisters a machine previously registered with
5577	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5578	cleanup before the machine is unregistered.
5579
5580	This method does not delete any files. It only changes the machine configuration and
5581	the list of registered machines in the VirtualBox object. To delete the files which
5582	belonged to the machine, including the XML file of the machine itself, call
5583	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5584	from this method.
5585
5586	How thoroughly this method cleans up the machine configuration before unregistering
5587	the machine depends on the @a cleanupMode argument.
5588
5589	<ul>
5590	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5591	cleanup will be performed. The call will fail if the machine is in "Saved" state
5592	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5593	It is the responsibility of the caller to delete all such configuration in this mode.
5594	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5595	which it replaces.</li>
5596	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5597	state or if it has snapshots or media attached. All media attached to the current machine
5598	state or in snapshots will be detached. No medium objects will be returned;
5599	all of the machine's media will remain open.</li>
5600	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5601	except that all the hard disk medium objects which were detached from the machine will
5602	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5603	API for closing and deletion.</li>
5604	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5605	that all media will be returned in the array, including removable media like DVDs and
5606	floppies. This might be useful if the user wants to inspect in detail which media were
5607	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5608	in that case because users will typically want to preserve ISO and RAW image files.</li>
5609	</ul>
5610
5611	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5612	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5613	deleted with all its saved states and hard disk images, but images for removable
5614	drives (such as ISO and RAW files) will remain on disk.
5615
5616	This API does not verify whether the media files returned in the array are still
5617	attached to other machines (i.e. shared between several machines). If such a shared
5618	image is passed to <link to="#delete" /> however, closing the image will fail there
5619	and the image will be silently skipped.
5620
5621	This API may, however, move media from this machine's media registry to other media
5622	registries (see <link to="IMedium" /> for details on media registries). For machines
5623	created with VirtualBox 4.0 or later, if media from this machine's media registry
5624	are also attached to another machine (shared attachments), each such medium will be
5625	moved to another machine's registry. This is because without this machine's media
5626	registry, the other machine cannot find its media any more and would become inaccessible.
5627
5628	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5629	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5630	if media are moved to other machines' media registries.
5631
5632	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5633	is fired.
5634
5635	The call will fail if the machine is currently locked (see <link to="ISession" />).
5636
5637	<note>
5638	If the given machine is inaccessible (see <link to="#accessible"/>), it
5639	will be unregistered and fully uninitialized right afterwards. As a result,
5640	the returned machine object will be unusable and an attempt to call
5641	<b>any</b> method will return the "Object not ready" error.
5642	</note>
5643
5644	<result name="VBOX_E_INVALID_OBJECT_STATE">
5645	Machine is currently locked for a session.
5646	</result>
5647	</desc>
5648
5649	<param name="cleanupMode" type="CleanupMode" dir="in">
5650	<desc>How to clean up after the machine has been unregistered.</desc>
5651	</param>
5652	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5653	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5654	</param>
5655	</method>
5656
5657	<method name="delete">
5658	<desc>
5659	Deletes the files associated with this machine from disk. If medium objects are passed
5660	in with the @a aMedia argument, they are closed and, if closing was successful, their
5661	storage files are deleted as well. For convenience, this array of media files can be
5662	the same as the one returned from a previous <link to="#unregister" /> call.
5663
5664	This method must only be called on machines which are either write-locked (i.e. on instances
5665	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5666	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5667	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5668
5669	The following files will be deleted by this method:
5670	<ul>
5671	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5672	argument other than "UnregisterOnly", this will delete all saved state files that
5673	the machine had in use; possibly one if the machine was in "Saved" state and one
5674	for each online snapshot that the machine had.</li>
5675	<li>On each medium object passed in the @a aMedia array, this will call
5676	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5677	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5678	in use, e.g. because it is still attached to a second machine; in that case the
5679	storage will not be deleted.</li>
5680	<li>Finally, the machine's own XML file will be deleted.</li>
5681	</ul>
5682
5683	Since deleting large disk image files can be a time-consuming I/O operation, this
5684	method operates asynchronously and returns an IProgress object to allow the caller
5685	to monitor the progress. There will be one sub-operation for each file that is
5686	being deleted (saved state or medium storage file).
5687
5688	<note>
5689	<link to="#settingsModified"/> will return @c true after this
5690	method successfully returns.
5691	</note>
5692
5693	<result name="VBOX_E_INVALID_VM_STATE">
5694	Machine is registered but not write-locked.
5695	</result>
5696	<result name="VBOX_E_IPRT_ERROR">
5697	Could not delete the settings file.
5698	</result>
5699	</desc>
5700	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5701	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5702	</param>
5703	<param name="aProgress" type="IProgress" dir="return">
5704	<desc>Progress object to track the operation completion.</desc>
5705	</param>
5706	</method>
5707
5708	<method name="export">
5709	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5710	steps required to export VirtualBox machines to OVF.
5711	</desc>
5712
5713	<param name="aAppliance" type="IAppliance" dir="in">
5714	<desc>Appliance to export this machine to.</desc>
5715	</param>
5716	<param name="location" type="wstring" dir="in">
5717	<desc>The target location.</desc>
5718	</param>
5719	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5720	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5721	</param>
5722	</method >
5723
5724	<method name="findSnapshot">
5725	<desc>
5726	Returns a snapshot of this machine with the given name or UUID.
5727
5728	Returns a snapshot of this machine with the given UUID.
5729	A @c null argument can be used to obtain the first snapshot
5730	taken on this machine. To traverse the whole tree of snapshots
5731	starting from the root, inspect the root snapshot's
5732	<link to="ISnapshot::children" /> attribute and recurse over those children.
5733
5734	<result name="VBOX_E_OBJECT_NOT_FOUND">
5735	Virtual machine has no snapshots or snapshot not found.
5736	</result>
5737
5738	</desc>
5739	<param name="nameOrId" type="wstring" dir="in">
5740	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5741	</param>
5742	<param name="snapshot" type="ISnapshot" dir="return">
5743	<desc>Snapshot object with the given name.</desc>
5744	</param>
5745	</method>
5746
5747	<method name="createSharedFolder">
5748	<desc>
5749	Creates a new permanent shared folder by associating the given logical
5750	name with the given host path, adds it to the collection of shared
5751	folders and starts sharing it. Refer to the description of
5752	<link to="ISharedFolder"/> to read more about logical names.
5753
5754	<result name="VBOX_E_OBJECT_IN_USE">
5755	Shared folder already exists.
5756	</result>
5757	<result name="VBOX_E_FILE_ERROR">
5758	Shared folder @a hostPath not accessible.
5759	</result>
5760
5761	</desc>
5762	<param name="name" type="wstring" dir="in">
5763	<desc>Unique logical name of the shared folder.</desc>
5764	</param>
5765	<param name="hostPath" type="wstring" dir="in">
5766	<desc>Full path to the shared folder in the host file system.</desc>
5767	</param>
5768	<param name="writable" type="boolean" dir="in">
5769	<desc>Whether the share is writable or readonly.</desc>
5770	</param>
5771	<param name="automount" type="boolean" dir="in">
5772	<desc>Whether the share gets automatically mounted by the guest
5773	or not.</desc>
5774	</param>
5775	</method>
5776
5777	<method name="removeSharedFolder">
5778	<desc>
5779	Removes the permanent shared folder with the given name previously
5780	created by <link to="#createSharedFolder"/> from the collection of
5781	shared folders and stops sharing it.
5782
5783	<result name="VBOX_E_INVALID_VM_STATE">
5784	Virtual machine is not mutable.
5785	</result>
5786	<result name="VBOX_E_OBJECT_NOT_FOUND">
5787	Shared folder @a name does not exist.
5788	</result>
5789
5790	</desc>
5791	<param name="name" type="wstring" dir="in">
5792	<desc>Logical name of the shared folder to remove.</desc>
5793	</param>
5794	</method>
5795
5796	<method name="canShowConsoleWindow">
5797	<desc>
5798	Returns @c true if the VM console process can activate the
5799	console window and bring it to foreground on the desktop of
5800	the host PC.
5801	<note>
5802	This method will fail if a session for this machine is not
5803	currently open.
5804	</note>
5805
5806	<result name="VBOX_E_INVALID_VM_STATE">
5807	Machine session is not open.
5808	</result>
5809
5810	</desc>
5811	<param name="canShow" type="boolean" dir="return">
5812	<desc>
5813	@c true if the console window can be shown and @c false otherwise.
5814	</desc>
5815	</param>
5816	</method>
5817
5818	<method name="showConsoleWindow">
5819	<desc>
5820	Activates the console window and brings it to foreground on
5821	the desktop of the host PC. Many modern window managers on
5822	many platforms implement some sort of focus stealing
5823	prevention logic, so that it may be impossible to activate
5824	a window without the help of the currently active
5825	application. In this case, this method will return a non-zero
5826	identifier that represents the top-level window of the VM
5827	console process. The caller, if it represents a currently
5828	active process, is responsible to use this identifier (in a
5829	platform-dependent manner) to perform actual window
5830	activation.
5831	<note>
5832	This method will fail if a session for this machine is not
5833	currently open.
5834	</note>
5835
5836	<result name="VBOX_E_INVALID_VM_STATE">
5837	Machine session is not open.
5838	</result>
5839
5840	</desc>
5841	<param name="winId" type="long long" dir="return">
5842	<desc>
5843	Platform-dependent identifier of the top-level VM console
5844	window, or zero if this method has performed all actions
5845	necessary to implement the <i>show window</i> semantics for
5846	the given platform and/or VirtualBox front-end.
5847	</desc>
5848	</param>
5849	</method>
5850
5851	<method name="getGuestProperty" const="yes">
5852	<desc>
5853	Reads an entry from the machine's guest property store.
5854
5855	<result name="VBOX_E_INVALID_VM_STATE">
5856	Machine session is not open.
5857	</result>
5858
5859	</desc>
5860	<param name="name" type="wstring" dir="in">
5861	<desc>
5862	The name of the property to read.
5863	</desc>
5864	</param>
5865	<param name="value" type="wstring" dir="out">
5866	<desc>
5867	The value of the property. If the property does not exist then this
5868	will be empty.
5869	</desc>
5870	</param>
5871	<param name="timestamp" type="long long" dir="out">
5872	<desc>
5873	The time at which the property was last modified, as seen by the
5874	server process.
5875	</desc>
5876	</param>
5877	<param name="flags" type="wstring" dir="out">
5878	<desc>
5879	Additional property parameters, passed as a comma-separated list of
5880	"name=value" type entries.
5881	</desc>
5882	</param>
5883	</method>
5884
5885	<method name="getGuestPropertyValue" const="yes">
5886	<desc>
5887	Reads a value from the machine's guest property store.
5888
5889	<result name="VBOX_E_INVALID_VM_STATE">
5890	Machine session is not open.
5891	</result>
5892
5893	</desc>
5894	<param name="property" type="wstring" dir="in">
5895	<desc>
5896	The name of the property to read.
5897	</desc>
5898	</param>
5899	<param name="value" type="wstring" dir="return">
5900	<desc>
5901	The value of the property. If the property does not exist then this
5902	will be empty.
5903	</desc>
5904	</param>
5905	</method>
5906
5907	<method name="getGuestPropertyTimestamp" const="yes">
5908	<desc>
5909	Reads a property timestamp from the machine's guest property store.
5910
5911	<result name="VBOX_E_INVALID_VM_STATE">
5912	Machine session is not open.
5913	</result>
5914
5915	</desc>
5916	<param name="property" type="wstring" dir="in">
5917	<desc>
5918	The name of the property to read.
5919	</desc>
5920	</param>
5921	<param name="value" type="long long" dir="return">
5922	<desc>
5923	The timestamp. If the property does not exist then this will be
5924	empty.
5925	</desc>
5926	</param>
5927	</method>
5928
5929	<method name="setGuestProperty">
5930	<desc>
5931	Sets, changes or deletes an entry in the machine's guest property
5932	store.
5933
5934	<result name="E_ACCESSDENIED">
5935	Property cannot be changed.
5936	</result>
5937	<result name="E_INVALIDARG">
5938	Invalid @a flags.
5939	</result>
5940	<result name="VBOX_E_INVALID_VM_STATE">
5941	Virtual machine is not mutable or session not open.
5942	</result>
5943	<result name="VBOX_E_INVALID_OBJECT_STATE">
5944	Cannot set transient property when machine not running.
5945	</result>
5946
5947	</desc>
5948	<param name="property" type="wstring" dir="in">
5949	<desc>
5950	The name of the property to set, change or delete.
5951	</desc>
5952	</param>
5953	<param name="value" type="wstring" dir="in">
5954	<desc>
5955	The new value of the property to set, change or delete. If the
5956	property does not yet exist and value is non-empty, it will be
5957	created. If the value is @c null or empty, the property will be
5958	deleted if it exists.
5959	</desc>
5960	</param>
5961	<param name="flags" type="wstring" dir="in">
5962	<desc>
5963	Additional property parameters, passed as a comma-separated list of
5964	"name=value" type entries.
5965	</desc>
5966	</param>
5967	</method>
5968
5969	<method name="setGuestPropertyValue">
5970	<desc>
5971	Sets, changes or deletes a value in the machine's guest property
5972	store. The flags field will be left unchanged or created empty for a
5973	new property.
5974
5975	<result name="E_ACCESSDENIED">
5976	Property cannot be changed.
5977	</result>
5978	<result name="VBOX_E_INVALID_VM_STATE">
5979	Virtual machine is not mutable or session not open.
5980	</result>
5981	<result name="VBOX_E_INVALID_OBJECT_STATE">
5982	Cannot set transient property when machine not running.
5983	</result>
5984	</desc>
5985
5986	<param name="property" type="wstring" dir="in">
5987	<desc>
5988	The name of the property to set, change or delete.
5989	</desc>
5990	</param>
5991	<param name="value" type="wstring" dir="in">
5992	<desc>
5993	The new value of the property to set, change or delete. If the
5994	property does not yet exist and value is non-empty, it will be
5995	created. If the value is @c null or empty, the property will be
5996	deleted if it exists.
5997	</desc>
5998	</param>
5999	</method>
6000
6001	<method name="deleteGuestProperty" const="yes">
6002	<desc>
6003	Deletes an entry from the machine's guest property store.
6004
6005	<result name="VBOX_E_INVALID_VM_STATE">
6006	Machine session is not open.
6007	</result>
6008
6009	</desc>
6010	<param name="name" type="wstring" dir="in">
6011	<desc>
6012	The name of the property to delete.
6013	</desc>
6014	</param>
6015	</method>
6016
6017	<method name="enumerateGuestProperties" const="yes">
6018	<desc>
6019	Return a list of the guest properties matching a set of patterns along
6020	with their values, time stamps and flags.
6021	</desc>
6022	<param name="patterns" type="wstring" dir="in">
6023	<desc>
6024	The patterns to match the properties against, separated by '\|'
6025	characters. If this is empty or @c null, all properties will match.
6026	</desc>
6027	</param>
6028	<param name="name" type="wstring" dir="out" safearray="yes">
6029	<desc>
6030	The names of the properties returned.
6031	</desc>
6032	</param>
6033	<param name="value" type="wstring" dir="out" safearray="yes">
6034	<desc>
6035	The values of the properties returned. The array entries match the
6036	corresponding entries in the @a name array.
6037	</desc>
6038	</param>
6039	<param name="timestamp" type="long long" dir="out" safearray="yes">
6040	<desc>
6041	The time stamps of the properties returned. The array entries match
6042	the corresponding entries in the @a name array.
6043	</desc>
6044	</param>
6045	<param name="flags" type="wstring" dir="out" safearray="yes">
6046	<desc>
6047	The flags of the properties returned. The array entries match the
6048	corresponding entries in the @a name array.
6049	</desc>
6050	</param>
6051	</method>
6052
6053	<method name="querySavedGuestScreenInfo" const="yes">
6054	<desc>
6055	Returns the guest dimensions from the saved state.
6056	</desc>
6057	<param name="screenId" type="unsigned long" dir="in">
6058	<desc>
6059	Saved guest screen to query info from.
6060	</desc>
6061	</param>
6062	<param name="originX" type="unsigned long" dir="out">
6063	<desc>
6064	The X position of the guest monitor top left corner.
6065	</desc>
6066	</param>
6067	<param name="originY" type="unsigned long" dir="out">
6068	<desc>
6069	The Y position of the guest monitor top left corner.
6070	</desc>
6071	</param>
6072	<param name="width" type="unsigned long" dir="out">
6073	<desc>
6074	Guest width at the time of the saved state was taken.
6075	</desc>
6076	</param>
6077	<param name="height" type="unsigned long" dir="out">
6078	<desc>
6079	Guest height at the time of the saved state was taken.
6080	</desc>
6081	</param>
6082	<param name="enabled" type="boolean" dir="out">
6083	<desc>
6084	Whether the monitor is enabled in the guest.
6085	</desc>
6086	</param>
6087	</method>
6088
6089	<method name="querySavedThumbnailSize">
6090	<desc>
6091	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6092	</desc>
6093	<param name="screenId" type="unsigned long" dir="in">
6094	<desc>
6095	Saved guest screen to query info from.
6096	</desc>
6097	</param>
6098	<param name="size" type="unsigned long" dir="out">
6099	<desc>
6100	Size of buffer required to store the bitmap.
6101	</desc>
6102	</param>
6103	<param name="width" type="unsigned long" dir="out">
6104	<desc>
6105	Bitmap width.
6106	</desc>
6107	</param>
6108	<param name="height" type="unsigned long" dir="out">
6109	<desc>
6110	Bitmap height.
6111	</desc>
6112	</param>
6113	</method>
6114
6115	<method name="readSavedThumbnailToArray">
6116	<desc>
6117	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6118	</desc>
6119	<param name="screenId" type="unsigned long" dir="in">
6120	<desc>
6121	Saved guest screen to read from.
6122	</desc>
6123	</param>
6124	<param name="BGR" type="boolean" dir="in">
6125	<desc>
6126	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6127	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
6128	</desc>
6129	</param>
6130	<param name="width" type="unsigned long" dir="out">
6131	<desc>
6132	Bitmap width.
6133	</desc>
6134	</param>
6135	<param name="height" type="unsigned long" dir="out">
6136	<desc>
6137	Bitmap height.
6138	</desc>
6139	</param>
6140	<param name="data" type="octet" safearray="yes" dir="return">
6141	<desc>
6142	Array with resulting bitmap data.
6143	</desc>
6144	</param>
6145	</method>
6146
6147	<method name="readSavedThumbnailPNGToArray">
6148	<desc>
6149	Thumbnail in PNG format is retrieved to an array of bytes.
6150	</desc>
6151	<param name="screenId" type="unsigned long" dir="in">
6152	<desc>
6153	Saved guest screen to read from.
6154	</desc>
6155	</param>
6156	<param name="width" type="unsigned long" dir="out">
6157	<desc>
6158	Image width.
6159	</desc>
6160	</param>
6161	<param name="height" type="unsigned long" dir="out">
6162	<desc>
6163	Image height.
6164	</desc>
6165	</param>
6166	<param name="data" type="octet" dir="return" safearray="yes">
6167	<desc>
6168	Array with resulting PNG data.
6169	</desc>
6170	</param>
6171	</method>
6172
6173	<method name="querySavedScreenshotPNGSize">
6174	<desc>
6175	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6176	</desc>
6177	<param name="screenId" type="unsigned long" dir="in">
6178	<desc>
6179	Saved guest screen to query info from.
6180	</desc>
6181	</param>
6182	<param name="size" type="unsigned long" dir="out">
6183	<desc>
6184	Size of buffer required to store the PNG binary data.
6185	</desc>
6186	</param>
6187	<param name="width" type="unsigned long" dir="out">
6188	<desc>
6189	Image width.
6190	</desc>
6191	</param>
6192	<param name="height" type="unsigned long" dir="out">
6193	<desc>
6194	Image height.
6195	</desc>
6196	</param>
6197	</method>
6198
6199	<method name="readSavedScreenshotPNGToArray">
6200	<desc>
6201	Screenshot in PNG format is retrieved to an array of bytes.
6202	</desc>
6203	<param name="screenId" type="unsigned long" dir="in">
6204	<desc>
6205	Saved guest screen to read from.
6206	</desc>
6207	</param>
6208	<param name="width" type="unsigned long" dir="out">
6209	<desc>
6210	Image width.
6211	</desc>
6212	</param>
6213	<param name="height" type="unsigned long" dir="out">
6214	<desc>
6215	Image height.
6216	</desc>
6217	</param>
6218	<param name="data" type="octet" dir="return" safearray="yes">
6219	<desc>
6220	Array with resulting PNG data.
6221	</desc>
6222	</param>
6223	</method>
6224
6225	<method name="hotPlugCPU">
6226	<desc>
6227	Plugs a CPU into the machine.
6228	</desc>
6229	<param name="cpu" type="unsigned long" dir="in">
6230	<desc>
6231	The CPU id to insert.
6232	</desc>
6233	</param>
6234	</method>
6235
6236	<method name="hotUnplugCPU">
6237	<desc>
6238	Removes a CPU from the machine.
6239	</desc>
6240	<param name="cpu" type="unsigned long" dir="in">
6241	<desc>
6242	The CPU id to remove.
6243	</desc>
6244	</param>
6245	</method>
6246
6247	<method name="getCPUStatus">
6248	<desc>
6249	Returns the current status of the given CPU.
6250	</desc>
6251	<param name="cpu" type="unsigned long" dir="in">
6252	<desc>
6253	The CPU id to check for.
6254	</desc>
6255	</param>
6256	<param name="attached" type="boolean" dir="return">
6257	<desc>
6258	Status of the CPU.
6259	</desc>
6260	</param>
6261	</method>
6262
6263	<method name="queryLogFilename">
6264	<desc>
6265	Queries for the VM log file name of an given index. Returns an empty
6266	string if a log file with that index doesn't exists.
6267	</desc>
6268	<param name="idx" type="unsigned long" dir="in">
6269	<desc>
6270	Which log file name to query. 0=current log file.
6271	</desc>
6272	</param>
6273	<param name="filename" type="wstring" dir="return">
6274	<desc>
6275	On return the full path to the log file or an empty string on error.
6276	</desc>
6277	</param>
6278	</method>
6279
6280	<method name="readLog">
6281	<desc>
6282	Reads the VM log file. The chunk size is limited, so even if you
6283	ask for a big piece there might be less data returned.
6284	</desc>
6285	<param name="idx" type="unsigned long" dir="in">
6286	<desc>
6287	Which log file to read. 0=current log file.
6288	</desc>
6289	</param>
6290	<param name="offset" type="long long" dir="in">
6291	<desc>
6292	Offset in the log file.
6293	</desc>
6294	</param>
6295	<param name="size" type="long long" dir="in">
6296	<desc>
6297	Chunk size to read in the log file.
6298	</desc>
6299	</param>
6300	<param name="data" type="octet" dir="return" safearray="yes">
6301	<desc>
6302	Data read from the log file. A data size of 0 means end of file
6303	if the requested chunk size was not 0. This is the unprocessed
6304	file data, i.e. the line ending style depends on the platform of
6305	the system the server is running on.
6306	</desc>
6307	</param>
6308	</method>
6309
6310	<method name="cloneTo">
6311	<desc>
6312	Creates a clone of this machine, either as a full clone (which means
6313	creating independent copies of the hard disk media, save states and so
6314	on), or as a linked clone (which uses its own differencing media,
6315	sharing the parent media with the source machine).
6316
6317	The target machine object must have been created previously with <link
6318	to="IVirtualBox::createMachine"/>, and all the settings will be
6319	transferred except the VM name and the hardware UUID. You can set the
6320	VM name and the new hardware UUID when creating the target machine. The
6321	network MAC addresses are newly created for all newtwork adapters. You
6322	can change that behaviour with the options parameter. The operation is
6323	performed asynchronously, so the machine object will be not be usable
6324	until the @a progress object signals completion.
6325
6326	<result name="E_INVALIDARG">
6327	@a target is @c null.
6328	</result>
6329	</desc>
6330
6331	<param name="target" type="IMachine" dir="in">
6332	<desc>Target machine object.</desc>
6333	</param>
6334	<param name="mode" type="CloneMode" dir="in">
6335	<desc>Which states should be cloned.</desc>
6336	</param>
6337	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6338	<desc>Options for the cloning operation.</desc>
6339	</param>
6340	<param name="progress" type="IProgress" dir="return">
6341	<desc>Progress object to track the operation completion.</desc>
6342	</param>
6343	</method>
6344
6345	</interface>
6346
6347	<!--
6348	// IConsole
6349	/////////////////////////////////////////////////////////////////////////
6350	-->
6351
6352	<interface
6353	name="IVRDEServerInfo" extends="$unknown"
6354	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6355	wsmap="struct"
6356	>
6357	<desc>
6358	Contains information about the remote desktop (VRDE) server capabilities and status.
6359	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6360	</desc>
6361
6362	<attribute name="active" type="boolean" readonly="yes">
6363	<desc>
6364	Whether the remote desktop connection is active.
6365	</desc>
6366	</attribute>
6367
6368	<attribute name="port" type="long" readonly="yes">
6369	<desc>
6370	VRDE server port number. If this property is equal to <tt>0</tt>, then
6371	the VRDE server failed to start, usually because there are no free IP
6372	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6373	server has not yet been started.
6374	</desc>
6375	</attribute>
6376
6377	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6378	<desc>
6379	How many times a client connected.
6380	</desc>
6381	</attribute>
6382
6383	<attribute name="beginTime" type="long long" readonly="yes">
6384	<desc>
6385	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6386	</desc>
6387	</attribute>
6388
6389	<attribute name="endTime" type="long long" readonly="yes">
6390	<desc>
6391	When the last connection was terminated or the current time, if
6392	connection is still active, in milliseconds since 1970-01-01 UTC.
6393	</desc>
6394	</attribute>
6395
6396	<attribute name="bytesSent" type="long long" readonly="yes">
6397	<desc>
6398	How many bytes were sent in last or current, if still active, connection.
6399	</desc>
6400	</attribute>
6401
6402	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6403	<desc>
6404	How many bytes were sent in all connections.
6405	</desc>
6406	</attribute>
6407
6408	<attribute name="bytesReceived" type="long long" readonly="yes">
6409	<desc>
6410	How many bytes were received in last or current, if still active, connection.
6411	</desc>
6412	</attribute>
6413
6414	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6415	<desc>
6416	How many bytes were received in all connections.
6417	</desc>
6418	</attribute>
6419
6420	<attribute name="user" type="wstring" readonly="yes">
6421	<desc>
6422	Login user name supplied by the client.
6423	</desc>
6424	</attribute>
6425
6426	<attribute name="domain" type="wstring" readonly="yes">
6427	<desc>
6428	Login domain name supplied by the client.
6429	</desc>
6430	</attribute>
6431
6432	<attribute name="clientName" type="wstring" readonly="yes">
6433	<desc>
6434	The client name supplied by the client.
6435	</desc>
6436	</attribute>
6437
6438	<attribute name="clientIP" type="wstring" readonly="yes">
6439	<desc>
6440	The IP address of the client.
6441	</desc>
6442	</attribute>
6443
6444	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6445	<desc>
6446	The client software version number.
6447	</desc>
6448	</attribute>
6449
6450	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6451	<desc>
6452	Public key exchange method used when connection was established.
6453	Values: 0 - RDP4 public key exchange scheme.
6454	1 - X509 certificates were sent to client.
6455	</desc>
6456	</attribute>
6457
6458	</interface>
6459
6460	<interface
6461	name="IConsole" extends="$unknown"
6462	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6463	wsmap="managed"
6464	>
6465	<desc>
6466	The IConsole interface represents an interface to control virtual
6467	machine execution.
6468
6469	A console object gets created when a machine has been locked for a
6470	particular session (client process) using <link to="IMachine::lockMachine" />
6471	or <link to="IMachine::launchVMProcess"/>. The console object can
6472	then be found in the session's <link to="ISession::console" /> attribute.
6473
6474	Methods of the IConsole interface allow the caller to query the current
6475	virtual machine execution state, pause the machine or power it down, save
6476	the machine state or take a snapshot, attach and detach removable media
6477	and so on.
6478
6479	<see><link to="ISession"/></see>
6480	</desc>
6481
6482	<attribute name="machine" type="IMachine" readonly="yes">
6483	<desc>
6484	Machine object for this console session.
6485	<note>
6486	This is a convenience property, it has the same value as
6487	<link to="ISession::machine"/> of the corresponding session
6488	object.
6489	</note>
6490	</desc>
6491	</attribute>
6492
6493	<attribute name="state" type="MachineState" readonly="yes">
6494	<desc>
6495	Current execution state of the machine.
6496	<note>
6497	This property always returns the same value as the corresponding
6498	property of the IMachine object for this console session.
6499	For the process that owns (executes) the VM, this is the
6500	preferable way of querying the VM state, because no IPC
6501	calls are made.
6502	</note>
6503	</desc>
6504	</attribute>
6505
6506	<attribute name="guest" type="IGuest" readonly="yes">
6507	<desc>Guest object.</desc>
6508	</attribute>
6509
6510	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6511	<desc>
6512	Virtual keyboard object.
6513	<note>
6514	If the machine is not running, any attempt to use
6515	the returned object will result in an error.
6516	</note>
6517	</desc>
6518	</attribute>
6519
6520	<attribute name="mouse" type="IMouse" readonly="yes">
6521	<desc>
6522	Virtual mouse object.
6523	<note>
6524	If the machine is not running, any attempt to use
6525	the returned object will result in an error.
6526	</note>
6527	</desc>
6528	</attribute>
6529
6530	<attribute name="display" type="IDisplay" readonly="yes">
6531	<desc>Virtual display object.
6532	<note>
6533	If the machine is not running, any attempt to use
6534	the returned object will result in an error.
6535	</note>
6536	</desc>
6537	</attribute>
6538
6539	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6540	<desc>Debugging interface.</desc>
6541	</attribute>
6542
6543	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6544	<desc>
6545	Collection of USB devices currently attached to the virtual
6546	USB controller.
6547	<note>
6548	The collection is empty if the machine is not running.
6549	</note>
6550	</desc>
6551	</attribute>
6552
6553	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6554	<desc>
6555	List of USB devices currently attached to the remote VRDE client.
6556	Once a new device is physically attached to the remote host computer,
6557	it appears in this list and remains there until detached.
6558	</desc>
6559	</attribute>
6560
6561	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6562	<desc>
6563	Collection of shared folders for the current session. These folders
6564	are called transient shared folders because they are available to the
6565	guest OS running inside the associated virtual machine only for the
6566	duration of the session (as opposed to
6567	<link to="IMachine::sharedFolders"/> which represent permanent shared
6568	folders). When the session is closed (e.g. the machine is powered down),
6569	these folders are automatically discarded.
6570
6571	New shared folders are added to the collection using
6572	<link to="#createSharedFolder"/>. Existing shared folders can be
6573	removed using <link to="#removeSharedFolder"/>.
6574	</desc>
6575	</attribute>
6576
6577	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6578	<desc>
6579	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6580	</desc>
6581	</attribute>
6582
6583	<attribute name="eventSource" type="IEventSource" readonly="yes">
6584	<desc>
6585	Event source for console events.
6586	</desc>
6587	</attribute>
6588
6589	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6590	<desc>Array of PCI devices attached to this machine.</desc>
6591	</attribute>
6592
6593	<attribute name="useHostClipboard" type="boolean">
6594	<desc>
6595	Whether the guest clipboard should be connected to the host one or
6596	whether it should only be allowed access to the VRDE clipboard. This
6597	setting may not affect existing guest clipboard connections which
6598	are already connected to the host clipboard.
6599	</desc>
6600	</attribute>
6601
6602	<method name="powerUp">
6603	<desc>
6604	Starts the virtual machine execution using the current machine
6605	state (that is, its current execution state, current settings and
6606	current storage devices).
6607
6608	<note>
6609	This method is only useful for front-ends that want to actually
6610	execute virtual machines in their own process (like the VirtualBox
6611	or VBoxSDL front-ends). Unless you are intending to write such a
6612	front-end, do not call this method. If you simply want to
6613	start virtual machine execution using one of the existing front-ends
6614	(for example the VirtualBox GUI or headless server), use
6615	<link to="IMachine::launchVMProcess"/> instead; these
6616	front-ends will power up the machine automatically for you.
6617	</note>
6618
6619	If the machine is powered off or aborted, the execution will
6620	start from the beginning (as if the real hardware were just
6621	powered on).
6622
6623	If the machine is in the <link to="MachineState_Saved"/> state,
6624	it will continue its execution the point where the state has
6625	been saved.
6626
6627	If the machine <link to="IMachine::teleporterEnabled"/> property is
6628	enabled on the machine being powered up, the machine will wait for an
6629	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6630	state. The returned progress object will have at least three
6631	operations where the last three are defined as: (1) powering up and
6632	starting TCP server, (2) waiting for incoming teleportations, and
6633	(3) perform teleportation. These operations will be reflected as the
6634	last three operations of the progress objected returned by
6635	<link to="IMachine::launchVMProcess"/> as well.
6636
6637	<see><link to="#saveState"/></see>
6638
6639	<result name="VBOX_E_INVALID_VM_STATE">
6640	Virtual machine already running.
6641	</result>
6642	<result name="VBOX_E_HOST_ERROR">
6643	Host interface does not exist or name not set.
6644	</result>
6645	<result name="VBOX_E_FILE_ERROR">
6646	Invalid saved state file.
6647	</result>
6648	</desc>
6649	<param name="progress" type="IProgress" dir="return">
6650	<desc>Progress object to track the operation completion.</desc>
6651	</param>
6652	</method>
6653
6654	<method name="powerUpPaused">
6655	<desc>
6656	Identical to powerUp except that the VM will enter the
6657	<link to="MachineState_Paused"/> state, instead of
6658	<link to="MachineState_Running"/>.
6659
6660	<see><link to="#powerUp"/></see>
6661	<result name="VBOX_E_INVALID_VM_STATE">
6662	Virtual machine already running.
6663	</result>
6664	<result name="VBOX_E_HOST_ERROR">
6665	Host interface does not exist or name not set.
6666	</result>
6667	<result name="VBOX_E_FILE_ERROR">
6668	Invalid saved state file.
6669	</result>
6670	</desc>
6671	<param name="progress" type="IProgress" dir="return">
6672	<desc>Progress object to track the operation completion.</desc>
6673	</param>
6674	</method>
6675
6676	<method name="powerDown">
6677	<desc>
6678	Initiates the power down procedure to stop the virtual machine
6679	execution.
6680
6681	The completion of the power down procedure is tracked using the returned
6682	IProgress object. After the operation is complete, the machine will go
6683	to the PoweredOff state.
6684	<result name="VBOX_E_INVALID_VM_STATE">
6685	Virtual machine must be Running, Paused or Stuck to be powered down.
6686	</result>
6687	</desc>
6688	<param name="progress" type="IProgress" dir="return">
6689	<desc>Progress object to track the operation completion.</desc>
6690	</param>
6691	</method>
6692
6693	<method name="reset">
6694	<desc>Resets the virtual machine.
6695	<result name="VBOX_E_INVALID_VM_STATE">
6696	Virtual machine not in Running state.
6697	</result>
6698	<result name="VBOX_E_VM_ERROR">
6699	Virtual machine error in reset operation.
6700	</result>
6701	</desc>
6702	</method>
6703
6704	<method name="pause">
6705	<desc>Pauses the virtual machine execution.
6706	<result name="VBOX_E_INVALID_VM_STATE">
6707	Virtual machine not in Running state.
6708	</result>
6709	<result name="VBOX_E_VM_ERROR">
6710	Virtual machine error in suspend operation.
6711	</result>
6712	</desc>
6713	</method>
6714
6715	<method name="resume">
6716	<desc>Resumes the virtual machine execution.
6717	<result name="VBOX_E_INVALID_VM_STATE">
6718	Virtual machine not in Paused state.
6719	</result>
6720	<result name="VBOX_E_VM_ERROR">
6721	Virtual machine error in resume operation.
6722	</result>
6723	</desc>
6724	</method>
6725
6726	<method name="powerButton">
6727	<desc>Sends the ACPI power button event to the guest.
6728	<result name="VBOX_E_INVALID_VM_STATE">
6729	Virtual machine not in Running state.
6730	</result>
6731	<result name="VBOX_E_PDM_ERROR">
6732	Controlled power off failed.
6733	</result>
6734	</desc>
6735	</method>
6736
6737	<method name="sleepButton">
6738	<desc>Sends the ACPI sleep button event to the guest.
6739	<result name="VBOX_E_INVALID_VM_STATE">
6740	Virtual machine not in Running state.
6741	</result>
6742	<result name="VBOX_E_PDM_ERROR">
6743	Sending sleep button event failed.
6744	</result>
6745	</desc>
6746	</method>
6747
6748	<method name="getPowerButtonHandled">
6749	<desc>Checks if the last power button event was handled by guest.
6750	<result name="VBOX_E_PDM_ERROR">
6751	Checking if the event was handled by the guest OS failed.
6752	</result>
6753	</desc>
6754	<param name="handled" type="boolean" dir="return"/>
6755	</method>
6756
6757	<method name="getGuestEnteredACPIMode">
6758	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6759	G1 (sleeping). If this method returns @c false, the guest will
6760	most likely not respond to external ACPI events.
6761	<result name="VBOX_E_INVALID_VM_STATE">
6762	Virtual machine not in Running state.
6763	</result>
6764	</desc>
6765	<param name="entered" type="boolean" dir="return"/>
6766	</method>
6767
6768	<method name="saveState">
6769	<desc>
6770	Saves the current execution state of a running virtual machine
6771	and stops its execution.
6772
6773	After this operation completes, the machine will go to the
6774	Saved state. Next time it is powered up, this state will
6775	be restored and the machine will continue its execution from
6776	the place where it was saved.
6777
6778	This operation differs from taking a snapshot to the effect
6779	that it doesn't create new differencing media. Also, once
6780	the machine is powered up from the state saved using this method,
6781	the saved state is deleted, so it will be impossible to return
6782	to this state later.
6783
6784	<note>
6785	On success, this method implicitly calls
6786	<link to="IMachine::saveSettings"/> to save all current machine
6787	settings (including runtime changes to the DVD medium, etc.).
6788	Together with the impossibility to change any VM settings when it is
6789	in the Saved state, this guarantees adequate hardware
6790	configuration of the machine when it is restored from the saved
6791	state file.
6792	</note>
6793
6794	<note>
6795	The machine must be in the Running or Paused state, otherwise
6796	the operation will fail.
6797	</note>
6798	<result name="VBOX_E_INVALID_VM_STATE">
6799	Virtual machine state neither Running nor Paused.
6800	</result>
6801	<result name="VBOX_E_FILE_ERROR">
6802	Failed to create directory for saved state file.
6803	</result>
6804
6805	<see><link to="#takeSnapshot"/></see>
6806	</desc>
6807	<param name="progress" type="IProgress" dir="return">
6808	<desc>Progress object to track the operation completion.</desc>
6809	</param>
6810	</method>
6811
6812	<method name="adoptSavedState">
6813	<desc>
6814	Associates the given saved state file to the virtual machine.
6815
6816	On success, the machine will go to the Saved state. Next time it is
6817	powered up, it will be restored from the adopted saved state and
6818	continue execution from the place where the saved state file was
6819	created.
6820
6821	The specified saved state file path may be absolute or relative to the
6822	folder the VM normally saves the state to (usually,
6823	<link to="IMachine::snapshotFolder"/>).
6824
6825	<note>
6826	It's a caller's responsibility to make sure the given saved state
6827	file is compatible with the settings of this virtual machine that
6828	represent its virtual hardware (memory size, storage disk configuration
6829	etc.). If there is a mismatch, the behavior of the virtual machine
6830	is undefined.
6831	</note>
6832	<result name="VBOX_E_INVALID_VM_STATE">
6833	Virtual machine state neither PoweredOff nor Aborted.
6834	</result>
6835	</desc>
6836	<param name="savedStateFile" type="wstring" dir="in">
6837	<desc>Path to the saved state file to adopt.</desc>
6838	</param>
6839	</method>
6840
6841	<method name="discardSavedState">
6842	<desc>
6843	Forcibly resets the machine to "Powered Off" state if it is
6844	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6845	Next time the machine is powered up, a clean boot will occur.
6846	<note>
6847	This operation is equivalent to resetting or powering off
6848	the machine without doing a proper shutdown of the guest
6849	operating system; as with resetting a running phyiscal
6850	computer, it can can lead to data loss.
6851	</note>
6852	If @a fRemoveFile is @c true, the file in the machine directory
6853	into which the machine state was saved is also deleted. If
6854	this is @c false, then the state can be recovered and later
6855	re-inserted into a machine using <link to="#adoptSavedState" />.
6856	The location of the file can be found in the
6857	<link to="IMachine::stateFilePath" /> attribute.
6858	<result name="VBOX_E_INVALID_VM_STATE">
6859	Virtual machine not in state Saved.
6860	</result>
6861	</desc>
6862	<param name="fRemoveFile" type="boolean" dir="in" >
6863	<desc>Whether to also remove the saved state file.</desc>
6864	</param>
6865	</method>
6866
6867	<method name="getDeviceActivity">
6868	<desc>
6869	Gets the current activity type of a given device or device group.
6870	<result name="E_INVALIDARG">
6871	Invalid device type.
6872	</result>
6873	</desc>
6874	<param name="type" type="DeviceType" dir="in"/>
6875	<param name="activity" type="DeviceActivity" dir="return"/>
6876	</method>
6877
6878	<method name="attachUSBDevice">
6879	<desc>
6880	Attaches a host USB device with the given UUID to the
6881	USB controller of the virtual machine.
6882
6883	The device needs to be in one of the following states:
6884	<link to="USBDeviceState_Busy"/>,
6885	<link to="USBDeviceState_Available"/> or
6886	<link to="USBDeviceState_Held"/>,
6887	otherwise an error is immediately returned.
6888
6889	When the device state is
6890	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6891	be returned if the host computer refuses to release it for some reason.
6892
6893	<see><link to="IUSBController::deviceFilters"/>,
6894	<link to="USBDeviceState"/></see>
6895	<result name="VBOX_E_INVALID_VM_STATE">
6896	Virtual machine state neither Running nor Paused.
6897	</result>
6898	<result name="VBOX_E_PDM_ERROR">
6899	Virtual machine does not have a USB controller.
6900	</result>
6901	</desc>
6902	<param name="id" type="uuid" mod="string" dir="in">
6903	<desc>UUID of the host USB device to attach.</desc>
6904	</param>
6905	</method>
6906
6907	<method name="detachUSBDevice">
6908	<desc>
6909	Detaches an USB device with the given UUID from the USB controller
6910	of the virtual machine.
6911
6912	After this method succeeds, the VirtualBox server re-initiates
6913	all USB filters as if the device were just physically attached
6914	to the host, but filters of this machine are ignored to avoid
6915	a possible automatic re-attachment.
6916
6917	<see><link to="IUSBController::deviceFilters"/>,
6918	<link to="USBDeviceState"/></see>
6919
6920	<result name="VBOX_E_PDM_ERROR">
6921	Virtual machine does not have a USB controller.
6922	</result>
6923	<result name="E_INVALIDARG">
6924	USB device not attached to this virtual machine.
6925	</result>
6926	</desc>
6927	<param name="id" type="uuid" mod="string" dir="in">
6928	<desc>UUID of the USB device to detach.</desc>
6929	</param>
6930	<param name="device" type="IUSBDevice" dir="return">
6931	<desc>Detached USB device.</desc>
6932	</param>
6933	</method>
6934
6935	<method name="findUSBDeviceByAddress">
6936	<desc>
6937	Searches for a USB device with the given host address.
6938
6939	<result name="VBOX_E_OBJECT_NOT_FOUND">
6940	Given @c name does not correspond to any USB device.
6941	</result>
6942
6943	<see><link to="IUSBDevice::address"/></see>
6944	</desc>
6945	<param name="name" type="wstring" dir="in">
6946	<desc>
6947	Address of the USB device (as assigned by the host) to
6948	search for.
6949	</desc>
6950	</param>
6951	<param name="device" type="IUSBDevice" dir="return">
6952	<desc>Found USB device object.</desc>
6953	</param>
6954	</method>
6955
6956	<method name="findUSBDeviceById">
6957	<desc>
6958	Searches for a USB device with the given UUID.
6959
6960	<result name="VBOX_E_OBJECT_NOT_FOUND">
6961	Given @c id does not correspond to any USB device.
6962	</result>
6963
6964	<see><link to="IUSBDevice::id"/></see>
6965	</desc>
6966	<param name="id" type="uuid" mod="string" dir="in">
6967	<desc>UUID of the USB device to search for.</desc>
6968	</param>
6969	<param name="device" type="IUSBDevice" dir="return">
6970	<desc>Found USB device object.</desc>
6971	</param>
6972	</method>
6973
6974	<method name="createSharedFolder">
6975	<desc>
6976	Creates a transient new shared folder by associating the given logical
6977	name with the given host path, adds it to the collection of shared
6978	folders and starts sharing it. Refer to the description of
6979	<link to="ISharedFolder"/> to read more about logical names.
6980
6981	<result name="VBOX_E_INVALID_VM_STATE">
6982	Virtual machine in Saved state or currently changing state.
6983	</result>
6984	<result name="VBOX_E_FILE_ERROR">
6985	Shared folder already exists or not accessible.
6986	</result>
6987	</desc>
6988	<param name="name" type="wstring" dir="in">
6989	<desc>Unique logical name of the shared folder.</desc>
6990	</param>
6991	<param name="hostPath" type="wstring" dir="in">
6992	<desc>Full path to the shared folder in the host file system.</desc>
6993	</param>
6994	<param name="writable" type="boolean" dir="in">
6995	<desc>Whether the share is writable or readonly</desc>
6996	</param>
6997	<param name="automount" type="boolean" dir="in">
6998	<desc>Whether the share gets automatically mounted by the guest
6999	or not.</desc>
7000	</param>
7001	</method>
7002
7003	<method name="removeSharedFolder">
7004	<desc>
7005	Removes a transient shared folder with the given name previously
7006	created by <link to="#createSharedFolder"/> from the collection of
7007	shared folders and stops sharing it.
7008	<result name="VBOX_E_INVALID_VM_STATE">
7009	Virtual machine in Saved state or currently changing state.
7010	</result>
7011	<result name="VBOX_E_FILE_ERROR">
7012	Shared folder does not exists.
7013	</result>
7014	</desc>
7015	<param name="name" type="wstring" dir="in">
7016	<desc>Logical name of the shared folder to remove.</desc>
7017	</param>
7018	</method>
7019
7020	<method name="takeSnapshot">
7021	<desc>
7022	Saves the current execution state
7023	and all settings of the machine and creates differencing images
7024	for all normal (non-independent) media.
7025	See <link to="ISnapshot" /> for an introduction to snapshots.
7026
7027	This method can be called for a PoweredOff, Saved (see
7028	<link to="#saveState"/>), Running or
7029	Paused virtual machine. When the machine is PoweredOff, an
7030	offline snapshot is created. When the machine is Running a live
7031	snapshot is created, and an online snapshot is is created when Paused.
7032
7033	The taken snapshot is always based on the
7034	<link to="IMachine::currentSnapshot">current snapshot</link>
7035	of the associated virtual machine and becomes a new current snapshot.
7036
7037	<note>
7038	This method implicitly calls <link to="IMachine::saveSettings"/> to
7039	save all current machine settings before taking an offline snapshot.
7040	</note>
7041
7042	<result name="VBOX_E_INVALID_VM_STATE">
7043	Virtual machine currently changing state.
7044	</result>
7045	</desc>
7046	<param name="name" type="wstring" dir="in">
7047	<desc>Short name for the snapshot.</desc>
7048	</param>
7049	<param name="description" type="wstring" dir="in">
7050	<desc>Optional description of the snapshot.</desc>
7051	</param>
7052	<param name="progress" type="IProgress" dir="return">
7053	<desc>Progress object to track the operation completion.</desc>
7054	</param>
7055	</method>
7056
7057	<method name="deleteSnapshot">
7058	<desc>
7059	Starts deleting the specified snapshot asynchronously.
7060	See <link to="ISnapshot" /> for an introduction to snapshots.
7061
7062	The execution state and settings of the associated machine stored in
7063	the snapshot will be deleted. The contents of all differencing media of
7064	this snapshot will be merged with the contents of their dependent child
7065	media to keep the medium chain valid (in other words, all changes
7066	represented by media being deleted will be propagated to their child
7067	medium). After that, this snapshot's differencing medium will be
7068	deleted. The parent of this snapshot will become a new parent for all
7069	its child snapshots.
7070
7071	If the deleted snapshot is the current one, its parent snapshot will
7072	become a new current snapshot. The current machine state is not directly
7073	affected in this case, except that currently attached differencing
7074	media based on media of the deleted snapshot will be also merged as
7075	described above.
7076
7077	If the deleted snapshot is the first or current snapshot, then the
7078	respective IMachine attributes will be adjusted. Deleting the current
7079	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7080	to make all current machine settings permanent.
7081
7082	Deleting a snapshot has the following preconditions:
7083
7084	<ul>
7085	<li>Child media of all normal media of the deleted snapshot
7086	must be accessible (see <link to="IMedium::state"/>) for this
7087	operation to succeed. If only one running VM refers to all images
7088	which participates in merging the operation can be performed while
7089	the VM is running. Otherwise all virtual machines whose media are
7090	directly or indirectly based on the media of deleted snapshot must
7091	be powered off. In any case, online snapshot deleting usually is
7092	slower than the same operation without any running VM.</li>
7093
7094	<li>You cannot delete the snapshot if a medium attached to it has
7095	more than one child medium (differencing images) because otherwise
7096	merging would be impossible. This might be the case if there is
7097	more than one child snapshot or differencing images were created
7098	for other reason (e.g. implicitly because of multiple machine
7099	attachments).</li>
7100	</ul>
7101
7102	The virtual machine's <link to="IMachine::state">state</link> is
7103	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7104	"DeletingSnapshotPaused" while this operation is in progress.
7105
7106	<note>
7107	Merging medium contents can be very time and disk space
7108	consuming, if these media are big in size and have many
7109	children. However, if the snapshot being deleted is the last
7110	(head) snapshot on the branch, the operation will be rather
7111	quick.
7112	</note>
7113	<result name="VBOX_E_INVALID_VM_STATE">
7114	The running virtual machine prevents deleting this snapshot. This
7115	happens only in very specific situations, usually snapshots can be
7116	deleted without trouble while a VM is running. The error message
7117	text explains the reason for the failure.
7118	</result>
7119	</desc>
7120	<param name="id" type="uuid" mod="string" dir="in">
7121	<desc>UUID of the snapshot to delete.</desc>
7122	</param>
7123	<param name="progress" type="IProgress" dir="return">
7124	<desc>Progress object to track the operation completion.</desc>
7125	</param>
7126	</method>
7127
7128	<method name="deleteSnapshotAndAllChildren">
7129	<desc>
7130	Starts deleting the specified snapshot and all its children
7131	asynchronously. See <link to="ISnapshot" /> for an introduction to
7132	snapshots. The conditions and many details are the same as with
7133	<link to="#deleteSnapshot"/>.
7134
7135	This operation is very fast if the snapshot subtree does not include
7136	the current state. It is still significantly faster than deleting the
7137	snapshots one by one if the current state is in the subtree and there
7138	are more than one snapshots from current state to the snapshot which
7139	marks the subtree, since it eliminates the incremental image merging.
7140
7141	<note>This API method is right now not implemented!</note>
7142
7143	<result name="VBOX_E_INVALID_VM_STATE">
7144	The running virtual machine prevents deleting this snapshot. This
7145	happens only in very specific situations, usually snapshots can be
7146	deleted without trouble while a VM is running. The error message
7147	text explains the reason for the failure.
7148	</result>
7149	<result name="E_NOTIMPL">
7150	The method is not implemented yet.
7151	</result>
7152	</desc>
7153	<param name="id" type="uuid" mod="string" dir="in">
7154	<desc>UUID of the snapshot to delete, including all its children.</desc>
7155	</param>
7156	<param name="progress" type="IProgress" dir="return">
7157	<desc>Progress object to track the operation completion.</desc>
7158	</param>
7159	</method>
7160
7161	<method name="deleteSnapshotRange">
7162	<desc>
7163	Starts deleting the specified snapshot range. This is limited to
7164	linear snapshot lists, which means there may not be any other child
7165	snapshots other than the direct sequence between the start and end
7166	snapshot. If the start and end snapshot point to the same snapshot this
7167	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7168	<link to="ISnapshot" /> for an introduction to snapshots. The
7169	conditions and many details are the same as with
7170	<link to="#deleteSnapshot"/>.
7171
7172	This operation is generally faster than deleting snapshots one by one
7173	and often also needs less extra disk space before freeing up disk space
7174	by deleting the removed disk images corresponding to the snapshot.
7175
7176	<note>This API method is right now not implemented!</note>
7177
7178	<result name="VBOX_E_INVALID_VM_STATE">
7179	The running virtual machine prevents deleting this snapshot. This
7180	happens only in very specific situations, usually snapshots can be
7181	deleted without trouble while a VM is running. The error message
7182	text explains the reason for the failure.
7183	</result>
7184	<result name="E_NOTIMPL">
7185	The method is not implemented yet.
7186	</result>
7187	</desc>
7188	<param name="startId" type="uuid" mod="string" dir="in">
7189	<desc>UUID of the first snapshot to delete.</desc>
7190	</param>
7191	<param name="endId" type="uuid" mod="string" dir="in">
7192	<desc>UUID of the last snapshot to delete.</desc>
7193	</param>
7194	<param name="progress" type="IProgress" dir="return">
7195	<desc>Progress object to track the operation completion.</desc>
7196	</param>
7197	</method>
7198
7199	<method name="restoreSnapshot">
7200	<desc>
7201	Starts resetting the machine's current state to the state contained
7202	in the given snapshot, asynchronously. All current settings of the
7203	machine will be reset and changes stored in differencing media
7204	will be lost.
7205	See <link to="ISnapshot" /> for an introduction to snapshots.
7206
7207	After this operation is successfully completed, new empty differencing
7208	media are created for all normal media of the machine.
7209
7210	If the given snapshot is an online snapshot, the machine will go to
7211	the <link to="MachineState_Saved"> saved state</link>, so that the
7212	next time it is powered on, the execution state will be restored
7213	from the state of the snapshot.
7214
7215	<note>
7216	The machine must not be running, otherwise the operation will fail.
7217	</note>
7218
7219	<note>
7220	If the machine state is <link to="MachineState_Saved">Saved</link>
7221	prior to this operation, the saved state file will be implicitly
7222	deleted (as if <link to="IConsole::discardSavedState"/> were
7223	called).
7224	</note>
7225
7226	<result name="VBOX_E_INVALID_VM_STATE">
7227	Virtual machine is running.
7228	</result>
7229	</desc>
7230	<param name="snapshot" type="ISnapshot" dir="in">
7231	<desc>The snapshot to restore the VM state from.</desc>
7232	</param>
7233	<param name="progress" type="IProgress" dir="return">
7234	<desc>Progress object to track the operation completion.</desc>
7235	</param>
7236	</method>
7237
7238	<method name="teleport">
7239	<desc>
7240	Teleport the VM to a different host machine or process.
7241
7242	TODO explain the details.
7243
7244	<result name="VBOX_E_INVALID_VM_STATE">
7245	Virtual machine not running or paused.
7246	</result>
7247	</desc>
7248	<param name="hostname" type="wstring" dir="in">
7249	<desc>The name or IP of the host to teleport to.</desc>
7250	</param>
7251	<param name="tcpport" type="unsigned long" dir="in">
7252	<desc>The TCP port to connect to (1..65535).</desc>
7253	</param>
7254	<param name="password" type="wstring" dir="in">
7255	<desc>The password.</desc>
7256	</param>
7257	<param name="maxDowntime" type="unsigned long" dir="in">
7258	<desc>
7259	The maximum allowed downtime given as milliseconds. 0 is not a valid
7260	value. Recommended value: 250 ms.
7261
7262	The higher the value is, the greater the chance for a successful
7263	teleportation. A small value may easily result in the teleportation
7264	process taking hours and eventually fail.
7265
7266	<note>
7267	The current implementation treats this a guideline, not as an
7268	absolute rule.
7269	</note>
7270	</desc>
7271	</param>
7272	<param name="progress" type="IProgress" dir="return">
7273	<desc>Progress object to track the operation completion.</desc>
7274	</param>
7275	</method>
7276
7277	</interface>
7278
7279	<!--
7280	// IHost
7281	/////////////////////////////////////////////////////////////////////////
7282	-->
7283
7284	<enum
7285	name="HostNetworkInterfaceMediumType"
7286	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7287	>
7288	<desc>
7289	Type of encapsulation. Ethernet encapsulation includes both wired and
7290	wireless Ethernet connections.
7291	<see><link to="IHostNetworkInterface"/></see>
7292	</desc>
7293
7294	<const name="Unknown" value="0">
7295	<desc>
7296	The type of interface cannot be determined.
7297	</desc>
7298	</const>
7299	<const name="Ethernet" value="1">
7300	<desc>
7301	Ethernet frame encapsulation.
7302	</desc>
7303	</const>
7304	<const name="PPP" value="2">
7305	<desc>
7306	Point-to-point protocol encapsulation.
7307	</desc>
7308	</const>
7309	<const name="SLIP" value="3">
7310	<desc>
7311	Serial line IP encapsulation.
7312	</desc>
7313	</const>
7314	</enum>
7315
7316	<enum
7317	name="HostNetworkInterfaceStatus"
7318	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7319	>
7320	<desc>
7321	Current status of the interface.
7322	<see><link to="IHostNetworkInterface"/></see>
7323	</desc>
7324
7325	<const name="Unknown" value="0">
7326	<desc>
7327	The state of interface cannot be determined.
7328	</desc>
7329	</const>
7330	<const name="Up" value="1">
7331	<desc>
7332	The interface is fully operational.
7333	</desc>
7334	</const>
7335	<const name="Down" value="2">
7336	<desc>
7337	The interface is not functioning.
7338	</desc>
7339	</const>
7340	</enum>
7341
7342	<enum
7343	name="HostNetworkInterfaceType"
7344	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7345	>
7346	<desc>
7347	Network interface type.
7348	</desc>
7349	<const name="Bridged" value="1"/>
7350	<const name="HostOnly" value="2"/>
7351	</enum>
7352
7353	<interface
7354	name="IHostNetworkInterface" extends="$unknown"
7355	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7356	wsmap="managed"
7357	>
7358	<desc>
7359	Represents one of host's network interfaces. IP V6 address and network
7360	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7361	separated by colons.
7362	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7363	</desc>
7364	<attribute name="name" type="wstring" readonly="yes">
7365	<desc>Returns the host network interface name.</desc>
7366	</attribute>
7367
7368	<attribute name="id" type="uuid" mod="string" readonly="yes">
7369	<desc>Returns the interface UUID.</desc>
7370	</attribute>
7371
7372	<attribute name="networkName" type="wstring" readonly="yes">
7373	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7374	</attribute>
7375
7376	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7377	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7378	</attribute>
7379
7380	<attribute name="IPAddress" type="wstring" readonly="yes">
7381	<desc>Returns the IP V4 address of the interface.</desc>
7382	</attribute>
7383
7384	<attribute name="networkMask" type="wstring" readonly="yes">
7385	<desc>Returns the network mask of the interface.</desc>
7386	</attribute>
7387
7388	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7389	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7390	</attribute>
7391
7392	<attribute name="IPV6Address" type="wstring" readonly="yes">
7393	<desc>Returns the IP V6 address of the interface.</desc>
7394	</attribute>
7395
7396	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7397	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7398	</attribute>
7399
7400	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7401	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7402	</attribute>
7403
7404	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7405	<desc>Type of protocol encapsulation used.</desc>
7406	</attribute>
7407
7408	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7409	<desc>Status of the interface.</desc>
7410	</attribute>
7411
7412	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7413	<desc>specifies the host interface type.</desc>
7414	</attribute>
7415
7416	<method name="enableStaticIpConfig">
7417	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7418	<param name="IPAddress" type="wstring" dir="in">
7419	<desc>
7420	IP address.
7421	</desc>
7422	</param>
7423	<param name="networkMask" type="wstring" dir="in">
7424	<desc>
7425	network mask.
7426	</desc>
7427	</param>
7428	</method>
7429
7430	<method name="enableStaticIpConfigV6">
7431	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7432	<param name="IPV6Address" type="wstring" dir="in">
7433	<desc>
7434	IP address.
7435	</desc>
7436	</param>
7437	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7438	<desc>
7439	network mask.
7440	</desc>
7441	</param>
7442	</method>
7443
7444	<method name="enableDynamicIpConfig">
7445	<desc>enables the dynamic IP configuration.</desc>
7446	</method>
7447
7448	<method name="dhcpRediscover">
7449	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7450	</method>
7451
7452	</interface>
7453
7454	<interface
7455	name="IHost" extends="$unknown"
7456	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7457	wsmap="managed"
7458	>
7459	<desc>
7460	The IHost interface represents the physical machine that this VirtualBox
7461	installation runs on.
7462
7463	An object implementing this interface is returned by the
7464	<link to="IVirtualBox::host" /> attribute. This interface contains
7465	read-only information about the host's physical hardware (such as what
7466	processors and disks are available, what the host operating system is,
7467	and so on) and also allows for manipulating some of the host's hardware,
7468	such as global USB device filters and host interface networking.
7469
7470	</desc>
7471	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7472	<desc>List of DVD drives available on the host.</desc>
7473	</attribute>
7474
7475	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7476	<desc>List of floppy drives available on the host.</desc>
7477	</attribute>
7478
7479	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7480	<desc>
7481	List of USB devices currently attached to the host.
7482	Once a new device is physically attached to the host computer,
7483	it appears in this list and remains there until detached.
7484
7485	<note>
7486	If USB functionality is not available in the given edition of
7487	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7488	</note>
7489	</desc>
7490	</attribute>
7491
7492	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7493	<desc>
7494	List of USB device filters in action.
7495	When a new device is physically attached to the host computer,
7496	filters from this list are applied to it (in order they are stored
7497	in the list). The first matched filter will determine the
7498	<link to="IHostUSBDeviceFilter::action">action</link>
7499	performed on the device.
7500
7501	Unless the device is ignored by these filters, filters of all
7502	currently running virtual machines
7503	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7504
7505	<note>
7506	If USB functionality is not available in the given edition of
7507	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7508	</note>
7509
7510	<see><link to="IHostUSBDeviceFilter"/>,
7511	<link to="USBDeviceState"/></see>
7512	</desc>
7513	</attribute>
7514
7515	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7516	<desc>List of host network interfaces currently defined on the host.</desc>
7517	</attribute>
7518
7519	<attribute name="processorCount" type="unsigned long" readonly="yes">
7520	<desc>Number of (logical) CPUs installed in the host system.</desc>
7521	</attribute>
7522
7523	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7524	<desc>Number of (logical) CPUs online in the host system.</desc>
7525	</attribute>
7526
7527	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7528	<desc>Number of physical processor cores installed in the host system.</desc>
7529	</attribute>
7530
7531	<method name="getProcessorSpeed">
7532	<desc>Query the (approximate) maximum speed of a specified host CPU in
7533	Megahertz.
7534	</desc>
7535	<param name="cpuId" type="unsigned long" dir="in">
7536	<desc>
7537	Identifier of the CPU.
7538	</desc>
7539	</param>
7540	<param name="speed" type="unsigned long" dir="return">
7541	<desc>
7542	Speed value. 0 is returned if value is not known or @a cpuId is
7543	invalid.
7544	</desc>
7545	</param>
7546	</method>
7547
7548	<method name="getProcessorFeature">
7549	<desc>Query whether a CPU feature is supported or not.</desc>
7550	<param name="feature" type="ProcessorFeature" dir="in">
7551	<desc>
7552	CPU Feature identifier.
7553	</desc>
7554	</param>
7555	<param name="supported" type="boolean" dir="return">
7556	<desc>
7557	Feature is supported or not.
7558	</desc>
7559	</param>
7560	</method>
7561
7562	<method name="getProcessorDescription">
7563	<desc>Query the model string of a specified host CPU.
7564	</desc>
7565	<param name="cpuId" type="unsigned long" dir="in">
7566	<desc>
7567	Identifier of the CPU.
7568	<note>
7569	The current implementation might not necessarily return the
7570	description for this exact CPU.
7571	</note>
7572	</desc>
7573	</param>
7574	<param name="description" type="wstring" dir="return">
7575	<desc>
7576	Model string. An empty string is returned if value is not known or
7577	@a cpuId is invalid.
7578	</desc>
7579	</param>
7580	</method>
7581
7582	<method name="getProcessorCPUIDLeaf">
7583	<desc>
7584	Returns the CPU cpuid information for the specified leaf.
7585	</desc>
7586	<param name="cpuId" type="unsigned long" dir="in">
7587	<desc>
7588	Identifier of the CPU. The CPU most be online.
7589	<note>
7590	The current implementation might not necessarily return the
7591	description for this exact CPU.
7592	</note>
7593	</desc>
7594	</param>
7595	<param name="leaf" type="unsigned long" dir="in">
7596	<desc>
7597	CPUID leaf index (eax).
7598	</desc>
7599	</param>
7600	<param name="subLeaf" type="unsigned long" dir="in">
7601	<desc>
7602	CPUID leaf sub index (ecx). This currently only applies to cache
7603	information on Intel CPUs. Use 0 if retrieving values for
7604	<link to="IMachine::setCPUIDLeaf"/>.
7605	</desc>
7606	</param>
7607	<param name="valEax" type="unsigned long" dir="out">
7608	<desc>
7609	CPUID leaf value for register eax.
7610	</desc>
7611	</param>
7612	<param name="valEbx" type="unsigned long" dir="out">
7613	<desc>
7614	CPUID leaf value for register ebx.
7615	</desc>
7616	</param>
7617	<param name="valEcx" type="unsigned long" dir="out">
7618	<desc>
7619	CPUID leaf value for register ecx.
7620	</desc>
7621	</param>
7622	<param name="valEdx" type="unsigned long" dir="out">
7623	<desc>
7624	CPUID leaf value for register edx.
7625	</desc>
7626	</param>
7627	</method>
7628
7629	<attribute name="memorySize" type="unsigned long" readonly="yes">
7630	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7631	</attribute>
7632
7633	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7634	<desc>Available system memory in the host system.</desc>
7635	</attribute>
7636
7637	<attribute name="operatingSystem" type="wstring" readonly="yes">
7638	<desc>Name of the host system's operating system.</desc>
7639	</attribute>
7640
7641	<attribute name="OSVersion" type="wstring" readonly="yes">
7642	<desc>Host operating system's version string.</desc>
7643	</attribute>
7644
7645	<attribute name="UTCTime" type="long long" readonly="yes">
7646	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7647	</attribute>
7648
7649	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7650	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7651	</attribute>
7652
7653	<method name="createHostOnlyNetworkInterface">
7654	<desc>
7655	Creates a new adapter for Host Only Networking.
7656	<result name="E_INVALIDARG">
7657	Host network interface @a name already exists.
7658	</result>
7659	</desc>
7660	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7661	<desc>
7662	Created host interface object.
7663	</desc>
7664	</param>
7665	<param name="progress" type="IProgress" dir="return">
7666	<desc>
7667	Progress object to track the operation completion.
7668	</desc>
7669	</param>
7670	</method>
7671
7672	<method name="removeHostOnlyNetworkInterface">
7673	<desc>
7674	Removes the given Host Only Networking interface.
7675	<result name="VBOX_E_OBJECT_NOT_FOUND">
7676	No host network interface matching @a id found.
7677	</result>
7678	</desc>
7679	<param name="id" type="uuid" mod="string" dir="in">
7680	<desc>
7681	Adapter GUID.
7682	</desc>
7683	</param>
7684	<param name="progress" type="IProgress" dir="return">
7685	<desc>
7686	Progress object to track the operation completion.
7687	</desc>
7688	</param>
7689	</method>
7690
7691	<method name="createUSBDeviceFilter">
7692	<desc>
7693	Creates a new USB device filter. All attributes except
7694	the filter name are set to empty (any match),
7695	<i>active</i> is @c false (the filter is not active).
7696
7697	The created filter can be added to the list of filters using
7698	<link to="#insertUSBDeviceFilter"/>.
7699
7700	<see><link to="#USBDeviceFilters"/></see>
7701	</desc>
7702	<param name="name" type="wstring" dir="in">
7703	<desc>
7704	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7705	</desc>
7706	</param>
7707	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7708	<desc>Created filter object.</desc>
7709	</param>
7710	</method>
7711
7712	<method name="insertUSBDeviceFilter">
7713	<desc>
7714	Inserts the given USB device to the specified position
7715	in the list of filters.
7716
7717	Positions are numbered starting from @c 0. If the specified
7718	position is equal to or greater than the number of elements in
7719	the list, the filter is added at the end of the collection.
7720
7721	<note>
7722	Duplicates are not allowed, so an attempt to insert a
7723	filter already in the list is an error.
7724	</note>
7725	<note>
7726	If USB functionality is not available in the given edition of
7727	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7728	</note>
7729
7730	<see><link to="#USBDeviceFilters"/></see>
7731
7732	<result name="VBOX_E_INVALID_OBJECT_STATE">
7733	USB device filter is not created within this VirtualBox instance.
7734	</result>
7735	<result name="E_INVALIDARG">
7736	USB device filter already in list.
7737	</result>
7738
7739	</desc>
7740	<param name="position" type="unsigned long" dir="in">
7741	<desc>Position to insert the filter to.</desc>
7742	</param>
7743	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7744	<desc>USB device filter to insert.</desc>
7745	</param>
7746	</method>
7747
7748	<method name="removeUSBDeviceFilter">
7749	<desc>
7750	Removes a USB device filter from the specified position in the
7751	list of filters.
7752
7753	Positions are numbered starting from @c 0. Specifying a
7754	position equal to or greater than the number of elements in
7755	the list will produce an error.
7756
7757	<note>
7758	If USB functionality is not available in the given edition of
7759	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7760	</note>
7761
7762	<see><link to="#USBDeviceFilters"/></see>
7763
7764	<result name="E_INVALIDARG">
7765	USB device filter list empty or invalid @a position.
7766	</result>
7767
7768	</desc>
7769	<param name="position" type="unsigned long" dir="in">
7770	<desc>Position to remove the filter from.</desc>
7771	</param>
7772	</method>
7773
7774	<method name="findHostDVDDrive">
7775	<desc>
7776	Searches for a host DVD drive with the given @c name.
7777
7778	<result name="VBOX_E_OBJECT_NOT_FOUND">
7779	Given @c name does not correspond to any host drive.
7780	</result>
7781
7782	</desc>
7783	<param name="name" type="wstring" dir="in">
7784	<desc>Name of the host drive to search for</desc>
7785	</param>
7786	<param name="drive" type="IMedium" dir="return">
7787	<desc>Found host drive object</desc>
7788	</param>
7789	</method>
7790
7791	<method name="findHostFloppyDrive">
7792	<desc>
7793	Searches for a host floppy drive with the given @c name.
7794
7795	<result name="VBOX_E_OBJECT_NOT_FOUND">
7796	Given @c name does not correspond to any host floppy drive.
7797	</result>
7798
7799	</desc>
7800	<param name="name" type="wstring" dir="in">
7801	<desc>Name of the host floppy drive to search for</desc>
7802	</param>
7803	<param name="drive" type="IMedium" dir="return">
7804	<desc>Found host floppy drive object</desc>
7805	</param>
7806	</method>
7807
7808	<method name="findHostNetworkInterfaceByName">
7809	<desc>
7810	Searches through all host network interfaces for an interface with
7811	the given @c name.
7812	<note>
7813	The method returns an error if the given @c name does not
7814	correspond to any host network interface.
7815	</note>
7816	</desc>
7817	<param name="name" type="wstring" dir="in">
7818	<desc>Name of the host network interface to search for.</desc>
7819	</param>
7820	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7821	<desc>Found host network interface object.</desc>
7822	</param>
7823	</method>
7824	<method name="findHostNetworkInterfaceById">
7825	<desc>
7826	Searches through all host network interfaces for an interface with
7827	the given GUID.
7828	<note>
7829	The method returns an error if the given GUID does not
7830	correspond to any host network interface.
7831	</note>
7832	</desc>
7833	<param name="id" type="uuid" mod="string" dir="in">
7834	<desc>GUID of the host network interface to search for.</desc>
7835	</param>
7836	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7837	<desc>Found host network interface object.</desc>
7838	</param>
7839	</method>
7840	<method name="findHostNetworkInterfacesOfType">
7841	<desc>
7842	Searches through all host network interfaces and returns a list of interfaces of the specified type
7843	</desc>
7844	<param name="type" type="HostNetworkInterfaceType" dir="in">
7845	<desc>type of the host network interfaces to search for.</desc>
7846	</param>
7847	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7848	<desc>Found host network interface objects.</desc>
7849	</param>
7850	</method>
7851
7852	<method name="findUSBDeviceById">
7853	<desc>
7854	Searches for a USB device with the given UUID.
7855
7856	<result name="VBOX_E_OBJECT_NOT_FOUND">
7857	Given @c id does not correspond to any USB device.
7858	</result>
7859
7860	<see><link to="IUSBDevice::id"/></see>
7861	</desc>
7862	<param name="id" type="uuid" mod="string" dir="in">
7863	<desc>UUID of the USB device to search for.</desc>
7864	</param>
7865	<param name="device" type="IHostUSBDevice" dir="return">
7866	<desc>Found USB device object.</desc>
7867	</param>
7868	</method>
7869
7870	<method name="findUSBDeviceByAddress">
7871	<desc>
7872	Searches for a USB device with the given host address.
7873
7874	<result name="VBOX_E_OBJECT_NOT_FOUND">
7875	Given @c name does not correspond to any USB device.
7876	</result>
7877
7878	<see><link to="IUSBDevice::address"/></see>
7879	</desc>
7880	<param name="name" type="wstring" dir="in">
7881	<desc>
7882	Address of the USB device (as assigned by the host) to
7883	search for.
7884	</desc>
7885	</param>
7886	<param name="device" type="IHostUSBDevice" dir="return">
7887	<desc>Found USB device object.</desc>
7888	</param>
7889	</method>
7890
7891	<method name="generateMACAddress">
7892	<desc>
7893	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7894	</desc>
7895	<param name="address" type="wstring" dir="return">
7896	<desc>New Ethernet MAC address.</desc>
7897	</param>
7898	</method>
7899
7900	</interface>
7901
7902	<!--
7903	// ISystemProperties
7904	/////////////////////////////////////////////////////////////////////////
7905	-->
7906
7907	<interface
7908	name="ISystemProperties"
7909	extends="$unknown"
7910	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7911	wsmap="managed"
7912	>
7913	<desc>
7914	The ISystemProperties interface represents global properties of the given
7915	VirtualBox installation.
7916
7917	These properties define limits and default values for various attributes
7918	and parameters. Most of the properties are read-only, but some can be
7919	changed by a user.
7920	</desc>
7921
7922	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7923	<desc>Minimum guest system memory in Megabytes.</desc>
7924	</attribute>
7925
7926	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7927	<desc>Maximum guest system memory in Megabytes.</desc>
7928	</attribute>
7929
7930	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7931	<desc>Minimum guest video memory in Megabytes.</desc>
7932	</attribute>
7933
7934	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7935	<desc>Maximum guest video memory in Megabytes.</desc>
7936	</attribute>
7937
7938	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7939	<desc>Minimum CPU count.</desc>
7940	</attribute>
7941
7942	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7943	<desc>Maximum CPU count.</desc>
7944	</attribute>
7945
7946	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7947	<desc>Maximum of monitors which could be connected.</desc>
7948	</attribute>
7949
7950	<attribute name="infoVDSize" type="long long" readonly="yes">
7951	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7952	does not reflect the limits of any virtual disk image format.</desc>
7953	</attribute>
7954
7955	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7956	<desc>
7957	Maximum number of serial ports associated with every
7958	<link to="IMachine"/> instance.
7959	</desc>
7960	</attribute>
7961
7962	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7963	<desc>
7964	Maximum number of parallel ports associated with every
7965	<link to="IMachine"/> instance.
7966	</desc>
7967	</attribute>
7968
7969	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7970	<desc>
7971	Maximum device position in the boot order. This value corresponds
7972	to the total number of devices a machine can boot from, to make it
7973	possible to include all possible devices to the boot list.
7974	<see><link to="IMachine::setBootOrder"/></see>
7975	</desc>
7976	</attribute>
7977
7978	<attribute name="defaultMachineFolder" type="wstring">
7979	<desc>
7980	Full path to the default directory used to create new or open
7981	existing machines when a machine settings file name contains no
7982	path.
7983
7984	Starting with VirtualBox 4.0, by default, this attribute contains
7985	the full path of folder named "VirtualBox VMs" in the user's
7986	home directory, which depends on the host platform.
7987
7988	When setting this attribute, a full path must be specified.
7989	Setting this property to @c null or an empty string or the
7990	special value "Machines" (for compatibility reasons) will restore
7991	that default value.
7992
7993	If the folder specified herein does not exist, it will be created
7994	automatically as needed.
7995
7996	<see>
7997	<link to="IVirtualBox::createMachine"/>,
7998	<link to="IVirtualBox::openMachine"/>
7999	</see>
8000	</desc>
8001	</attribute>
8002
8003	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
8004	<desc>
8005	List of all medium storage formats supported by this VirtualBox
8006	installation.
8007
8008	Keep in mind that the medium format identifier
8009	(<link to="IMediumFormat::id"/>) used in other API calls like
8010	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
8011	medium format is a case-insensitive string. This means that, for
8012	example, all of the following strings:
8013	<pre>
8014	"VDI"
8015	"vdi"
8016	"VdI"</pre>
8017	refer to the same medium format.
8018
8019	Note that the virtual medium framework is backend-based, therefore
8020	the list of supported formats depends on what backends are currently
8021	installed.
8022
8023	<see><link to="IMediumFormat"/></see>
8024	</desc>
8025	</attribute>
8026
8027	<attribute name="defaultHardDiskFormat" type="wstring">
8028	<desc>
8029	Identifier of the default medium format used by VirtualBox.
8030
8031	The medium format set by this attribute is used by VirtualBox
8032	when the medium format was not specified explicitly. One example is
8033	<link to="IVirtualBox::createHardDisk"/> with the empty
8034	format argument. A more complex example is implicit creation of
8035	differencing media when taking a snapshot of a virtual machine:
8036	this operation will try to use a format of the parent medium first
8037	and if this format does not support differencing media the default
8038	format specified by this argument will be used.
8039
8040	The list of supported medium formats may be obtained by the
8041	<link to="#mediumFormats"/> call. Note that the default medium
8042	format must have a capability to create differencing media;
8043	otherwise operations that create media implicitly may fail
8044	unexpectedly.
8045
8046	The initial value of this property is <tt>"VDI"</tt> in the current
8047	version of the VirtualBox product, but may change in the future.
8048
8049	<note>
8050	Setting this property to @c null or empty string will restore the
8051	initial value.
8052	</note>
8053
8054	<see>
8055	<link to="#mediumFormats"/>,
8056	<link to="IMediumFormat::id"/>,
8057	<link to="IVirtualBox::createHardDisk"/>
8058	</see>
8059	</desc>
8060	</attribute>
8061
8062	<attribute name="freeDiskSpaceWarning" type="long long">
8063	<desc>Issue a warning if the free disk space is below (or in some disk
8064	intensive operation is expected to go below) the given size in
8065	bytes.</desc>
8066	</attribute>
8067
8068	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8069	<desc>Issue a warning if the free disk space is below (or in some disk
8070	intensive operation is expected to go below) the given percentage.</desc>
8071	</attribute>
8072
8073	<attribute name="freeDiskSpaceError" type="long long">
8074	<desc>Issue an error if the free disk space is below (or in some disk
8075	intensive operation is expected to go below) the given size in
8076	bytes.</desc>
8077	</attribute>
8078
8079	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8080	<desc>Issue an error if the free disk space is below (or in some disk
8081	intensive operation is expected to go below) the given percentage.</desc>
8082	</attribute>
8083
8084	<attribute name="VRDEAuthLibrary" type="wstring">
8085	<desc>
8086	Library that provides authentication for Remote Desktop clients. The library
8087	is used if a virtual machine's authentication type is set to "external"
8088	in the VM RemoteDisplay configuration.
8089
8090	The system library extension (".DLL" or ".so") must be omitted.
8091	A full path can be specified; if not, then the library must reside on the
8092	system's default library path.
8093
8094	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8095	of that name in one of the default VirtualBox library directories.
8096
8097	For details about VirtualBox authentication libraries and how to implement
8098	them, please refer to the VirtualBox manual.
8099
8100	<note>
8101	Setting this property to @c null or empty string will restore the
8102	initial value.
8103	</note>
8104	</desc>
8105	</attribute>
8106
8107	<attribute name="webServiceAuthLibrary" type="wstring">
8108	<desc>
8109	Library that provides authentication for webservice clients. The library
8110	is used if a virtual machine's authentication type is set to "external"
8111	in the VM RemoteDisplay configuration and will be called from
8112	within the <link to="IWebsessionManager::logon" /> implementation.
8113
8114	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8115	there is no per-VM setting for this, as the webservice is a global
8116	resource (if it is running). Only for this setting (for the webservice),
8117	setting this value to a literal <tt>"null"</tt> string disables authentication,
8118	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8119	no matter what user name and password are supplied.
8120
8121	The initial value of this property is <tt>"VBoxAuth"</tt>,
8122	meaning that the webservice will use the same authentication
8123	library that is used by default for VRDE (again, see
8124	<link to="ISystemProperties::VRDEAuthLibrary" />).
8125	The format and calling convention of authentication libraries
8126	is the same for the webservice as it is for VRDE.
8127
8128	<note>
8129	Setting this property to @c null or empty string will restore the
8130	initial value.
8131	</note>
8132	</desc>
8133	</attribute>
8134
8135	<attribute name="defaultVRDEExtPack" type="wstring">
8136	<desc>
8137	The name of the extension pack providing the default VRDE.
8138
8139	This attribute is for choosing between multiple extension packs
8140	providing VRDE. If only one is installed, it will automatically be the
8141	default one. The attribute value can be empty if no VRDE extension
8142	pack is installed.
8143
8144	For details about VirtualBox Remote Desktop Extension and how to
8145	implement one, please refer to the VirtualBox SDK.
8146	</desc>
8147	</attribute>
8148
8149	<attribute name="logHistoryCount" type="unsigned long">
8150	<desc>
8151	This value specifies how many old release log files are kept.
8152	</desc>
8153	</attribute>
8154
8155	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8156	<desc>This value hold the default audio driver for the current
8157	system.</desc>
8158	</attribute>
8159
8160
8161	<method name="getMaxNetworkAdapters">
8162	<desc>
8163	Maximum total number of network adapters associated with every
8164	<link to="IMachine"/> instance.
8165	</desc>
8166
8167	<param name="chipset" type="ChipsetType" dir="in">
8168	<desc>The chipset type to get the value for.</desc>
8169	</param>
8170
8171
8172	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8173	<desc>The maximum total number of network adapters allowed.</desc>
8174	</param>
8175
8176	</method>
8177
8178	<method name="getMaxNetworkAdaptersOfType">
8179	<desc>
8180	Maximum number of network adapters of a given attachment type,
8181	associated with every <link to="IMachine"/> instance.
8182	</desc>
8183
8184	<param name="chipset" type="ChipsetType" dir="in">
8185	<desc>The chipset type to get the value for.</desc>
8186	</param>
8187
8188	<param name="type" type="NetworkAttachmentType" dir="in">
8189	<desc>Type of attachment.</desc>
8190	</param>
8191
8192	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8193	<desc>The maximum number of network adapters allowed for
8194	particular chipset and attachment type.</desc>
8195	</param>
8196
8197	</method>
8198
8199
8200	<method name="getMaxDevicesPerPortForStorageBus">
8201	<desc>Returns the maximum number of devices which can be attached to a port
8202	for the given storage bus.</desc>
8203
8204	<param name="bus" type="StorageBus" dir="in">
8205	<desc>The storage bus type to get the value for.</desc>
8206	</param>
8207
8208	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8209	<desc>The maximum number of devices which can be attached to the port for the given
8210	storage bus.</desc>
8211	</param>
8212	</method>
8213
8214	<method name="getMinPortCountForStorageBus">
8215	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8216
8217	<param name="bus" type="StorageBus" dir="in">
8218	<desc>The storage bus type to get the value for.</desc>
8219	</param>
8220
8221	<param name="minPortCount" type="unsigned long" dir="return">
8222	<desc>The minimum number of ports for the given storage bus.</desc>
8223	</param>
8224	</method>
8225
8226	<method name="getMaxPortCountForStorageBus">
8227	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8228
8229	<param name="bus" type="StorageBus" dir="in">
8230	<desc>The storage bus type to get the value for.</desc>
8231	</param>
8232
8233	<param name="maxPortCount" type="unsigned long" dir="return">
8234	<desc>The maximum number of ports for the given storage bus.</desc>
8235	</param>
8236	</method>
8237
8238	<method name="getMaxInstancesOfStorageBus">
8239	<desc>Returns the maximum number of storage bus instances which
8240	can be configured for each VM. This corresponds to the number of
8241	storage controllers one can have. Value may depend on chipset type
8242	used.</desc>
8243
8244	<param name="chipset" type="ChipsetType" dir="in">
8245	<desc>The chipset type to get the value for.</desc>
8246	</param>
8247
8248	<param name="bus" type="StorageBus" dir="in">
8249	<desc>The storage bus type to get the value for.</desc>
8250	</param>
8251
8252	<param name="maxInstances" type="unsigned long" dir="return">
8253	<desc>The maximum number of instances for the given storage bus.</desc>
8254	</param>
8255	</method>
8256
8257	<method name="getDeviceTypesForStorageBus">
8258	<desc>Returns list of all the supported device types
8259	(<link to="DeviceType"/>) for the given type of storage
8260	bus.</desc>
8261
8262	<param name="bus" type="StorageBus" dir="in">
8263	<desc>The storage bus type to get the value for.</desc>
8264	</param>
8265
8266	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8267	<desc>The list of all supported device types for the given storage bus.</desc>
8268	</param>
8269	</method>
8270
8271	<method name="getDefaultIoCacheSettingForStorageController">
8272	<desc>Returns the default I/O cache setting for the
8273	given storage controller</desc>
8274
8275	<param name="controllerType" type="StorageControllerType" dir="in">
8276	<desc>The storage controller to the setting for.</desc>
8277	</param>
8278
8279	<param name="enabled" type="boolean" dir="return">
8280	<desc>Returned flag indicating the default value</desc>
8281	</param>
8282	</method>
8283	</interface>
8284
8285	<!--
8286	// IGuest
8287	/////////////////////////////////////////////////////////////////////////
8288	-->
8289
8290	<interface
8291	name="IGuestOSType" extends="$unknown"
8292	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8293	wsmap="struct"
8294	>
8295	<desc>
8296	</desc>
8297
8298	<attribute name="familyId" type="wstring" readonly="yes">
8299	<desc>Guest OS family identifier string.</desc>
8300	</attribute>
8301
8302	<attribute name="familyDescription" type="wstring" readonly="yes">
8303	<desc>Human readable description of the guest OS family.</desc>
8304	</attribute>
8305
8306	<attribute name="id" type="wstring" readonly="yes">
8307	<desc>Guest OS identifier string.</desc>
8308	</attribute>
8309
8310	<attribute name="description" type="wstring" readonly="yes">
8311	<desc>Human readable description of the guest OS.</desc>
8312	</attribute>
8313
8314	<attribute name="is64Bit" type="boolean" readonly="yes">
8315	<desc>Returns @c true if the given OS is 64-bit</desc>
8316	</attribute>
8317
8318	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8319	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8320	</attribute>
8321
8322	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8323	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8324	</attribute>
8325
8326	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8327	<desc>Recommended RAM size in Megabytes.</desc>
8328	</attribute>
8329
8330	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8331	<desc>Recommended video RAM size in Megabytes.</desc>
8332	</attribute>
8333
8334	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8335	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8336	</attribute>
8337
8338	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8339	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8340	</attribute>
8341
8342	<attribute name="recommendedHDD" type="long long" readonly="yes">
8343	<desc>Recommended hard disk size in bytes.</desc>
8344	</attribute>
8345
8346	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8347	<desc>Returns recommended network adapter for this OS type.</desc>
8348	</attribute>
8349
8350	<attribute name="recommendedPae" type="boolean" readonly="yes">
8351	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8352	</attribute>
8353
8354	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8355	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8356	</attribute>
8357
8358	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8359	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8360	</attribute>
8361
8362	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8363	<desc>Recommended storage controller type for HD drives.</desc>
8364	</attribute>
8365
8366	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8367	<desc>Recommended storage bus type for HD drives.</desc>
8368	</attribute>
8369
8370	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8371	<desc>Recommended firmware type.</desc>
8372	</attribute>
8373
8374	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8375	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8376	</attribute>
8377
8378	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8379	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8380	</attribute>
8381
8382	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8383	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8384	</attribute>
8385
8386	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8387	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8388	</attribute>
8389
8390	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8391	<desc>Recommended chipset type.</desc>
8392	</attribute>
8393
8394	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8395	<desc>Recommended audio type.</desc>
8396	</attribute>
8397
8398	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8399	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8400	</attribute>
8401
8402	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8403	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8404	</attribute>
8405
8406	</interface>
8407
8408	<enum
8409	name="AdditionsFacilityType"
8410	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8411	>
8412	<desc>
8413	Guest Additions facility IDs.
8414	</desc>
8415
8416	<const name="None" value="0">
8417	<desc>No/invalid facility.</desc>
8418	</const>
8419	<const name="VBoxGuestDriver" value="20">
8420	<desc>VirtualBox base driver (VBoxGuest).</desc>
8421	</const>
8422	<const name="AutoLogon" value="90">
8423	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8424	</const>
8425	<const name="VBoxService" value="100">
8426	<desc>VirtualBox system service (VBoxService).</desc>
8427	</const>
8428	<const name="VBoxTrayClient" value="101">
8429	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8430	</const>
8431	<const name="Seamless" value="1000">
8432	<desc>Seamless guest desktop integration.</desc>
8433	</const>
8434	<const name="Graphics" value="1100">
8435	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8436	are not immediately acted on and guest display resizes are probably not initiated by
8437	the guest additions.
8438	</desc>
8439	</const>
8440	<const name="All" value="2147483646">
8441	<desc>All facilities selected.</desc>
8442	</const>
8443	</enum>
8444
8445	<enum
8446	name="AdditionsFacilityClass"
8447	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8448	>
8449	<desc>
8450	Guest Additions facility classes.
8451	</desc>
8452
8453	<const name="None" value="0">
8454	<desc>No/invalid class.</desc>
8455	</const>
8456	<const name="Driver" value="10">
8457	<desc>Driver.</desc>
8458	</const>
8459	<const name="Service" value="30">
8460	<desc>System service.</desc>
8461	</const>
8462	<const name="Program" value="50">
8463	<desc>Program.</desc>
8464	</const>
8465	<const name="Feature" value="100">
8466	<desc>Feature.</desc>
8467	</const>
8468	<const name="ThirdParty" value="999">
8469	<desc>Third party.</desc>
8470	</const>
8471	<const name="All" value="2147483646">
8472	<desc>All facility classes selected.</desc>
8473	</const>
8474	</enum>
8475
8476	<enum
8477	name="AdditionsFacilityStatus"
8478	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8479	>
8480	<desc>
8481	Guest Additions facility states.
8482	</desc>
8483
8484	<const name="Inactive" value="0">
8485	<desc>Facility is not active.</desc>
8486	</const>
8487	<const name="Paused" value="1">
8488	<desc>Facility has been paused.</desc>
8489	</const>
8490	<const name="PreInit" value="20">
8491	<desc>Facility is preparing to initialize.</desc>
8492	</const>
8493	<const name="Init" value="30">
8494	<desc>Facility is initializing.</desc>
8495	</const>
8496	<const name="Active" value="50">
8497	<desc>Facility is up and running.</desc>
8498	</const>
8499	<const name="Terminating" value="100">
8500	<desc>Facility is shutting down.</desc>
8501	</const>
8502	<const name="Terminated" value="101">
8503	<desc>Facility successfully shut down.</desc>
8504	</const>
8505	<const name="Failed" value="800">
8506	<desc>Facility failed to start.</desc>
8507	</const>
8508	<const name="Unknown" value="999">
8509	<desc>Facility status is unknown.</desc>
8510	</const>
8511	</enum>
8512
8513	<interface
8514	name="IAdditionsFacility" extends="$unknown"
8515	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8516	wsmap="struct"
8517	>
8518	<desc>
8519	Structure representing a Guest Additions facility.
8520	</desc>
8521
8522	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8523	<desc>The class this facility is part of.</desc>
8524	</attribute>
8525
8526	<attribute name="lastUpdated" type="long long" readonly="yes">
8527	<desc>
8528	Time stamp of the last status update,
8529	in milliseconds since 1970-01-01 UTC.
8530	</desc>
8531	</attribute>
8532
8533	<attribute name="name" type="wstring" readonly="yes">
8534	<desc>The facility's friendly name.</desc>
8535	</attribute>
8536
8537	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8538	<desc>The current status.</desc>
8539	</attribute>
8540
8541	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8542	<desc>The facility's type ID.</desc>
8543	</attribute>
8544	</interface>
8545
8546	<enum
8547	name="AdditionsRunLevelType"
8548	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8549	>
8550	<desc>
8551	Guest Additions run level type.
8552	</desc>
8553
8554	<const name="None" value="0">
8555	<desc>Guest Additions are not loaded.</desc>
8556	</const>
8557	<const name="System" value="1">
8558	<desc>Guest drivers are loaded.</desc>
8559	</const>
8560	<const name="Userland" value="2">
8561	<desc>Common components (such as application services) are loaded.</desc>
8562	</const>
8563	<const name="Desktop" value="3">
8564	<desc>Per-user desktop components are loaded.</desc>
8565	</const>
8566	</enum>
8567
8568	<enum
8569	name="AdditionsUpdateFlag"
8570	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8571	>
8572	<desc>
8573	Guest Additions update flags.
8574	</desc>
8575
8576	<const name="None" value="0">
8577	<desc>No flag set.</desc>
8578	</const>
8579	<const name="WaitForUpdateStartOnly" value="1">
8580	<desc>Only wait for the update process being started and do not
8581	wait while peforming the actual update.</desc>
8582	</const>
8583	</enum>
8584
8585	<enum
8586	name="ExecuteProcessFlag"
8587	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8588	>
8589	<desc>
8590	Guest process execution flags.
8591	</desc>
8592
8593	<const name="None" value="0">
8594	<desc>No flag set.</desc>
8595	</const>
8596	<const name="WaitForProcessStartOnly" value="1">
8597	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8598	process itself then uses an infinite timeout.</desc>
8599	</const>
8600	<const name="IgnoreOrphanedProcesses" value="2">
8601	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8602	</const>
8603	<const name="Hidden" value="4">
8604	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8605	</const>
8606	<const name="NoProfile" value="8">
8607	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8608	</const>
8609	<const name="WaitForStdOut" value="16">
8610	<desc>The guest process waits until all data from stdout is read out.</desc>
8611	</const>
8612	<const name="WaitForStdErr" value="32">
8613	<desc>The guest process waits until all data from stderr is read out.</desc>
8614	</const>
8615	</enum>
8616
8617	<enum
8618	name="ExecuteProcessStatus"
8619	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8620	>
8621	<desc>
8622	Guest process execution status.
8623	</desc>
8624	<const name="Undefined" value="0">
8625	<desc>Process is in an undefined state.</desc>
8626	</const>
8627
8628	<const name="Started" value="1">
8629	<desc>Process has been started.</desc>
8630	</const>
8631	<const name="TerminatedNormally" value="2">
8632	<desc>Process terminated normally.</desc>
8633	</const>
8634	<const name="TerminatedSignal" value="3">
8635	<desc>Process terminated via signal.</desc>
8636	</const>
8637	<const name="TerminatedAbnormally" value="4">
8638	<desc>Process terminated abnormally.</desc>
8639	</const>
8640	<const name="TimedOutKilled" value="5">
8641	<desc>Process timed out and was killed.</desc>
8642	</const>
8643	<const name="TimedOutAbnormally" value="6">
8644	<desc>Process timed out and was not killed successfully.</desc>
8645	</const>
8646	<const name="Down" value="7">
8647	<desc>Service/OS is stopping, process was killed.</desc>
8648	</const>
8649	<const name="Error" value="8">
8650	<desc>Something went wrong (error code in flags).</desc>
8651	</const>
8652	</enum>
8653
8654	<enum
8655	name="ProcessInputFlag"
8656	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8657	>
8658	<desc>
8659	Guest process input flags.
8660	</desc>
8661	<const name="None" value="0">
8662	<desc>No flag set.</desc>
8663	</const>
8664	<const name="EndOfFile" value="1">
8665	<desc>End of file (input) reached.</desc>
8666	</const>
8667	</enum>
8668
8669	<enum
8670	name="ProcessOutputFlag"
8671	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8672	>
8673	<desc>
8674	Guest process output flags for specifying which
8675	type of output to retrieve.
8676	</desc>
8677	<const name="None" value="0">
8678	<desc>No flags set. Get output from stdout.</desc>
8679	</const>
8680	<const name="StdErr" value="1">
8681	<desc>Get output from stderr.</desc>
8682	</const>
8683	</enum>
8684
8685	<enum
8686	name="CopyFileFlag"
8687	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8688	>
8689	<desc>
8690	Host/Guest copy flags. At the moment none of these flags
8691	are implemented.
8692	</desc>
8693	<const name="None" value="0">
8694	<desc>No flag set.</desc>
8695	</const>
8696	<const name="Recursive" value="1">
8697	<desc>Copy directories recursively.</desc>
8698	</const>
8699	<const name="Update" value="2">
8700	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8701	</const>
8702	<const name="FollowLinks" value="4">
8703	<desc>Follow symbolic links.</desc>
8704	</const>
8705	</enum>
8706
8707	<enum
8708	name="DirectoryCreateFlag"
8709	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8710	>
8711	<desc>
8712	Directory creation flags.
8713	</desc>
8714	<const name="None" value="0">
8715	<desc>No flag set.</desc>
8716	</const>
8717	<const name="Parents" value="1">
8718	<desc>No error if existing, make parent directories as needed.</desc>
8719	</const>
8720	</enum>
8721
8722	<enum
8723	name="DragAndDropAction"
8724	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8725	>
8726	<desc>
8727	Possible actions within an Drag and Drop operation.
8728	</desc>
8729
8730	<const name="Ignore" value="0">
8731	<desc>Do nothing.</desc>
8732	</const>
8733
8734	<const name="Copy" value="1">
8735	<desc>Copy the item to the target.</desc>
8736	</const>
8737
8738	<const name="Move" value="2">
8739	<desc>Move the item to the target.</desc>
8740	</const>
8741
8742	<const name="Link" value="3">
8743	<desc>Link the item from within the target.</desc>
8744	</const>
8745	</enum>
8746
8747	<enum
8748	name="DirectoryOpenFlag"
8749	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8750	>
8751	<desc>
8752	Directory open flags.
8753	</desc>
8754	<const name="None" value="0">
8755	<desc>No flag set.</desc>
8756	</const>
8757	</enum>
8758
8759	<enum
8760	name="GuestDirEntryType"
8761	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8762	>
8763	<desc>
8764	Guest directory entry type.
8765	</desc>
8766	<const name="Unknown" value="0">
8767	<desc>Unknown.</desc>
8768	</const>
8769	<const name="Directory" value="4">
8770	<desc>Regular file.</desc>
8771	</const>
8772	<const name="File" value="10">
8773	<desc>Regular file.</desc>
8774	</const>
8775	<const name="Symlink" value="12">
8776	<desc>Symbolic link.</desc>
8777	</const>
8778	</enum>
8779
8780	<interface
8781	name="IGuestDirEntry" extends="$unknown"
8782	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8783	wsmap="struct"
8784	>
8785	<desc>
8786	Structure representing a directory entry on the guest OS.
8787	</desc>
8788	<attribute name="nodeId" type="long long" readonly="yes">
8789	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8790	</attribute>
8791	<attribute name="name" type="wstring" readonly="yes">
8792	<desc>The filename.</desc>
8793	</attribute>
8794	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8795	<desc>The entry type.</desc>
8796	</attribute>
8797	</interface>
8798
8799	<interface
8800	name="IGuest" extends="$unknown"
8801	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8802	wsmap="managed"
8803	>
8804	<desc>
8805	The IGuest interface represents information about the operating system
8806	running inside the virtual machine. Used in
8807	<link to="IConsole::guest"/>.
8808
8809	IGuest provides information about the guest operating system, whether
8810	Guest Additions are installed and other OS-specific virtual machine
8811	properties.
8812	</desc>
8813
8814	<attribute name="OSTypeId" type="wstring" readonly="yes">
8815	<desc>
8816	Identifier of the Guest OS type as reported by the Guest
8817	Additions.
8818	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8819	an IGuestOSType object representing details about the given
8820	Guest OS type.
8821	<note>
8822	If Guest Additions are not installed, this value will be
8823	the same as <link to="IMachine::OSTypeId"/>.
8824	</note>
8825	</desc>
8826	</attribute>
8827
8828	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8829	<desc>
8830	Current run level of the Guest Additions.
8831	</desc>
8832	</attribute>
8833
8834	<attribute name="additionsVersion" type="wstring" readonly="yes">
8835	<desc>
8836	Version of the Guest Additions in the same format as
8837	<link to="IVirtualBox::version"/>.
8838	</desc>
8839	</attribute>
8840
8841	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8842	<desc>
8843	The internal build revision number of the additions.
8844
8845	See also <link to="IVirtualBox::revision"/>.
8846	</desc>
8847	</attribute>
8848
8849	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8850	<desc>
8851	Array of current known facilities. Only returns facilities where a status is known,
8852	e.g. facilities with an unknown status will not be returned.
8853	</desc>
8854	</attribute>
8855
8856	<attribute name="memoryBalloonSize" type="unsigned long">
8857	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8858	</attribute>
8859
8860	<attribute name="statisticsUpdateInterval" type="unsigned long">
8861	<desc>Interval to update guest statistics in seconds.</desc>
8862	</attribute>
8863
8864	<method name="internalGetStatistics">
8865	<desc>
8866	Internal method; do not use as it might change at any time.
8867	</desc>
8868	<param name="cpuUser" type="unsigned long" dir="out">
8869	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8870	</param>
8871	<param name="cpuKernel" type="unsigned long" dir="out">
8872	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8873	</param>
8874	<param name="cpuIdle" type="unsigned long" dir="out">
8875	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8876	</param>
8877	<param name="memTotal" type="unsigned long" dir="out">
8878	<desc>Total amount of physical guest RAM.</desc>
8879	</param>
8880	<param name="memFree" type="unsigned long" dir="out">
8881	<desc>Free amount of physical guest RAM.</desc>
8882	</param>
8883	<param name="memBalloon" type="unsigned long" dir="out">
8884	<desc>Amount of ballooned physical guest RAM.</desc>
8885	</param>
8886	<param name="memShared" type="unsigned long" dir="out">
8887	<desc>Amount of shared physical guest RAM.</desc>
8888	</param>
8889	<param name="memCache" type="unsigned long" dir="out">
8890	<desc>Total amount of guest (disk) cache memory.</desc>
8891	</param>
8892	<param name="pagedTotal" type="unsigned long" dir="out">
8893	<desc>Total amount of space in the page file.</desc>
8894	</param>
8895	<param name="memAllocTotal" type="unsigned long" dir="out">
8896	<desc>Total amount of memory allocated by the hypervisor.</desc>
8897	</param>
8898	<param name="memFreeTotal" type="unsigned long" dir="out">
8899	<desc>Total amount of free memory available in the hypervisor.</desc>
8900	</param>
8901	<param name="memBalloonTotal" type="unsigned long" dir="out">
8902	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8903	</param>
8904	<param name="memSharedTotal" type="unsigned long" dir="out">
8905	<desc>Total amount of shared memory in the hypervisor.</desc>
8906	</param>
8907	</method>
8908
8909	<method name="getFacilityStatus">
8910	<desc>
8911	Get the current status of a Guest Additions facility.
8912	</desc>
8913	<param name="facility" type="AdditionsFacilityType" dir="in">
8914	<desc>Facility to check status for.</desc>
8915	</param>
8916	<param name="timestamp" type="long long" dir="out">
8917	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8918	</param>
8919	<param name="status" type="AdditionsFacilityStatus" dir="return">
8920	<desc>The current (latest) facility status.</desc>
8921	</param>
8922	</method>
8923
8924	<method name="getAdditionsStatus">
8925	<desc>
8926	Retrieve the current status of a certain Guest Additions run level.
8927
8928	<result name="VBOX_E_NOT_SUPPORTED">
8929	Wrong status level specified.
8930	</result>
8931
8932	</desc>
8933	<param name="level" type="AdditionsRunLevelType" dir="in">
8934	<desc>Status level to check</desc>
8935	</param>
8936	<param name="active" type="boolean" dir="return">
8937	<desc>Flag whether the status level has been reached or not</desc>
8938	</param>
8939	</method>
8940
8941	<method name="setCredentials">
8942	<desc>
8943	Store login credentials that can be queried by guest operating
8944	systems with Additions installed. The credentials are transient
8945	to the session and the guest may also choose to erase them. Note
8946	that the caller cannot determine whether the guest operating system
8947	has queried or made use of the credentials.
8948
8949	<result name="VBOX_E_VM_ERROR">
8950	VMM device is not available.
8951	</result>
8952
8953	</desc>
8954	<param name="userName" type="wstring" dir="in">
8955	<desc>User name string, can be empty</desc>
8956	</param>
8957	<param name="password" type="wstring" dir="in">
8958	<desc>Password string, can be empty</desc>
8959	</param>
8960	<param name="domain" type="wstring" dir="in">
8961	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8962	</param>
8963	<param name="allowInteractiveLogon" type="boolean" dir="in">
8964	<desc>
8965	Flag whether the guest should alternatively allow the user to
8966	interactively specify different credentials. This flag might
8967	not be supported by all versions of the Additions.
8968	</desc>
8969	</param>
8970	</method>
8971
8972	<method name="dragHGEnter">
8973	<desc>
8974	Informs the guest about a Drag and Drop enter event.
8975
8976	This is used in Host - Guest direction.
8977
8978	<result name="VBOX_E_VM_ERROR">
8979	VMM device is not available.
8980	</result>
8981
8982	</desc>
8983	<param name="screenId" type="unsigned long" dir="in">
8984	<desc>The screen id where the Drag and Drop event occured.</desc>
8985	</param>
8986	<param name="y" type="unsigned long" dir="in">
8987	<desc>y-position of the event.</desc>
8988	</param>
8989	<param name="x" type="unsigned long" dir="in">
8990	<desc>x-position of the event.</desc>
8991	</param>
8992	<param name="defaultAction" type="DragAndDropAction" dir="in">
8993	<desc>The default action to use.</desc>
8994	</param>
8995	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8996	<desc>The actions which are allowed.</desc>
8997	</param>
8998	<param name="formats" type="wstring" dir="in" safearray="yes">
8999	<desc>The supported mime types.</desc>
9000	</param>
9001	<param name="resultAction" type="DragAndDropAction" dir="return">
9002	<desc>The resulting action of this event.</desc>
9003	</param>
9004	</method>
9005
9006	<method name="dragHGMove">
9007	<desc>
9008	Informs the guest about a Drag and Drop move event.
9009
9010	This is used in Host - Guest direction.
9011
9012	<result name="VBOX_E_VM_ERROR">
9013	VMM device is not available.
9014	</result>
9015
9016	</desc>
9017	<param name="screenId" type="unsigned long" dir="in">
9018	<desc>The screen id where the Drag and Drop event occured.</desc>
9019	</param>
9020	<param name="x" type="unsigned long" dir="in">
9021	<desc>x-position of the event.</desc>
9022	</param>
9023	<param name="y" type="unsigned long" dir="in">
9024	<desc>y-position of the event.</desc>
9025	</param>
9026	<param name="defaultAction" type="DragAndDropAction" dir="in">
9027	<desc>The default action to use.</desc>
9028	</param>
9029	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9030	<desc>The actions which are allowed.</desc>
9031	</param>
9032	<param name="formats" type="wstring" dir="in" safearray="yes">
9033	<desc>The supported mime types.</desc>
9034	</param>
9035	<param name="resultAction" type="DragAndDropAction" dir="return">
9036	<desc>The resulting action of this event.</desc>
9037	</param>
9038	</method>
9039
9040	<method name="dragHGLeave">
9041	<desc>
9042	Informs the guest about a Drag and Drop leave event.
9043
9044	This is used in Host - Guest direction.
9045
9046	<result name="VBOX_E_VM_ERROR">
9047	VMM device is not available.
9048	</result>
9049
9050	</desc>
9051	<param name="screenId" type="unsigned long" dir="in">
9052	<desc>The screen id where the Drag and Drop event occured.</desc>
9053	</param>
9054	</method>
9055
9056	<method name="dragHGDrop">
9057	<desc>
9058	Informs the guest about a drop event.
9059
9060	This is used in Host - Guest direction.
9061
9062	<result name="VBOX_E_VM_ERROR">
9063	VMM device is not available.
9064	</result>
9065
9066	</desc>
9067	<param name="screenId" type="unsigned long" dir="in">
9068	<desc>The screen id where the Drag and Drop event occured.</desc>
9069	</param>
9070	<param name="x" type="unsigned long" dir="in">
9071	<desc>x-position of the event.</desc>
9072	</param>
9073	<param name="y" type="unsigned long" dir="in">
9074	<desc>y-position of the event.</desc>
9075	</param>
9076	<param name="defaultAction" type="DragAndDropAction" dir="in">
9077	<desc>The default action to use.</desc>
9078	</param>
9079	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9080	<desc>The actions which are allowed.</desc>
9081	</param>
9082	<param name="formats" type="wstring" dir="in" safearray="yes">
9083	<desc>The supported mime types.</desc>
9084	</param>
9085	<param name="format" type="wstring" dir="out">
9086	<desc>The resulting format of this event.</desc>
9087	</param>
9088	<param name="resultAction" type="DragAndDropAction" dir="return">
9089	<desc>The resulting action of this event.</desc>
9090	</param>
9091	</method>
9092
9093	<method name="dragHGPutData">
9094	<desc>
9095	Informs the guest about a drop data event.
9096
9097	This is used in Host - Guest direction.
9098
9099	<result name="VBOX_E_VM_ERROR">
9100	VMM device is not available.
9101	</result>
9102
9103	</desc>
9104	<param name="screenId" type="unsigned long" dir="in">
9105	<desc>The screen id where the Drag and Drop event occured.</desc>
9106	</param>
9107	<param name="format" type="wstring" dir="in">
9108	<desc>The mime type the data is in.</desc>
9109	</param>
9110	<param name="data" type="octet" dir="in" safearray="yes">
9111	<desc>The actual data.</desc>
9112	</param>
9113	<param name="progress" type="IProgress" dir="return">
9114	<desc>Progress object to track the operation completion.</desc>
9115	</param>
9116	</method>
9117
9118	<method name="dragGHPending">
9119	<desc>
9120	Ask the guest if there is any Drag and Drop operation pending in the guest.
9121
9122	If no Drag and Drop operation is pending currently, Ignore is returned.
9123
9124	This is used in Guest - Host direction.
9125
9126	<result name="VBOX_E_VM_ERROR">
9127	VMM device is not available.
9128	</result>
9129
9130	</desc>
9131	<param name="screenId" type="unsigned long" dir="in">
9132	<desc>The screen id where the Drag and Drop event occured.</desc>
9133	</param>
9134	<param name="format" type="wstring" dir="out" safearray="yes">
9135	<desc>On return the supported mime types.</desc>
9136	</param>
9137	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9138	<desc>On return the actions which are allowed.</desc>
9139	</param>
9140	<param name="defaultAction" type="DragAndDropAction" dir="return">
9141	<desc>On return the default action to use.</desc>
9142	</param>
9143	</method>
9144
9145	<method name="dragGHDropped">
9146	<desc>
9147	Informs the guest that a drop event occured for a pending Drag and Drop event.
9148
9149	This is used in Guest - Host direction.
9150
9151	<result name="VBOX_E_VM_ERROR">
9152	VMM device is not available.
9153	</result>
9154
9155	</desc>
9156
9157	<param name="format" type="wstring" dir="in">
9158	<desc>The mime type the data must be in.</desc>
9159	</param>
9160	<param name="action" type="DragAndDropAction" dir="in">
9161	<desc>The action to use.</desc>
9162	</param>
9163	<param name="progress" type="IProgress" dir="return">
9164	<desc>Progress object to track the operation completion.</desc>
9165	</param>
9166	</method>
9167
9168	<method name="dragGHGetData">
9169	<desc>
9170	Fetch the data of a previously Drag and Drop event from the guest.
9171
9172	This is used in Guest - Host direction.
9173
9174	<result name="VBOX_E_VM_ERROR">
9175	VMM device is not available.
9176	</result>
9177
9178	</desc>
9179
9180	<param name="data" type="octet" safearray="yes" dir="return">
9181	<desc>The actual data.</desc>
9182	</param>
9183	</method>
9184
9185	<method name="executeProcess">
9186	<desc>
9187	Executes an existing program inside the guest VM.
9188
9189	<note>
9190	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9191	to serve up to 25 guest processes at a time. If all 25 guest processes
9192	are still active and running, starting a new guest process will result in an
9193	appropriate error message.
9194
9195	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9196	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9197	set, the guest process will not exit until all data from the specified
9198	stream(s) is/are read out.
9199
9200	To raise or lower the guest process execution limit, either the guest property
9201	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9202	command line by specifying "--control-procs-max-kept" needs to be modified.
9203	A restart of the guest OS is required afterwards. To serve unlimited guest
9204	processes, a value of "0" needs to be set (not recommended).
9205	</note>
9206
9207	<result name="VBOX_E_IPRT_ERROR">
9208	Could not execute process.
9209	</result>
9210
9211	</desc>
9212	<param name="execName" type="wstring" dir="in">
9213	<desc>
9214	Full path name of the command to execute on the guest; the
9215	commands has to exists in the guest VM in order to be executed.
9216	</desc>
9217	</param>
9218	<param name="flags" type="unsigned long" dir="in">
9219	<desc>
9220	<link to="ExecuteProcessFlag"/> flags.
9221	</desc>
9222	</param>
9223	<param name="arguments" type="wstring" safearray="yes" dir="in">
9224	<desc>
9225	Array of arguments passed to the execution command.
9226	</desc>
9227	</param>
9228	<param name="environment" type="wstring" safearray="yes" dir="in">
9229	<desc>
9230	Environment variables that can be set while the command is being
9231	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9232	variable just set its name ("NAME") without a value.
9233	</desc>
9234	</param>
9235	<param name="userName" type="wstring" dir="in">
9236	<desc>
9237	User name under which the command will be executed; has to exist
9238	and have the appropriate rights to execute programs in the VM.
9239	</desc>
9240	</param>
9241	<param name="password" type="wstring" dir="in">
9242	<desc>
9243	Password of the user account specified.
9244	</desc>
9245	</param>
9246	<param name="timeoutMS" type="unsigned long" dir="in">
9247	<desc>
9248	The maximum timeout value (in msec) to wait for finished program
9249	execution. Pass 0 for an infinite timeout.
9250	</desc>
9251	</param>
9252	<param name="pid" type="unsigned long" dir="out">
9253	<desc>
9254	The PID (process ID) of the started command for later reference.
9255	</desc>
9256	</param>
9257	<param name="progress" type="IProgress" dir="return">
9258	<desc>Progress object to track the operation completion.</desc>
9259	</param>
9260	</method>
9261
9262	<method name="getProcessOutput">
9263	<desc>
9264	Retrieves output of a formerly started and running guest process.
9265
9266	<note>
9267	Starting with VirtualBox 4.1.8 this only will return output data
9268	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9269	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9270	<link to="ExecuteProcessFlag"/> is set in the
9271	former <link to="#executeProcess"/> call for this guest process.
9272	</note>
9273
9274	<result name="VBOX_E_IPRT_ERROR">
9275	Could not retrieve output.
9276	</result>
9277
9278	</desc>
9279	<param name="pid" type="unsigned long" dir="in">
9280	<desc>
9281	Process id returned by earlier <link to="#executeProcess"/> call.
9282	</desc>
9283	</param>
9284	<param name="flags" type="unsigned long" dir="in">
9285	<desc>
9286	<link to="ProcessOutputFlag"/> flags.
9287	</desc>
9288	</param>
9289	<param name="timeoutMS" type="unsigned long" dir="in">
9290	<desc>
9291	The maximum timeout value (in msec) to wait for output
9292	data. Pass 0 for an infinite timeout.
9293	</desc>
9294	</param>
9295	<param name="size" type="long long" dir="in">
9296	<desc>
9297	Size in bytes to read in the buffer.
9298	</desc>
9299	</param>
9300	<param name="data" type="octet" safearray="yes" dir="return">
9301	<desc>
9302	Buffer for retrieving the actual output. A data size of 0 means end of file
9303	if the requested size was not 0. This is the unprocessed
9304	output data, i.e. the line ending style depends on the platform of
9305	the system the server is running on.
9306	</desc>
9307	</param>
9308	</method>
9309
9310	<method name="getProcessStatus">
9311	<desc>
9312	Retrieves status, exit code and the exit reason of a formerly started
9313	guest process. If a guest process exited or got terminated this function
9314	returns its final status and removes this process from the list of
9315	known guest processes for further retrieval.
9316
9317	<result name="VBOX_E_IPRT_ERROR">
9318	Process with specified PID was not found.
9319	</result>
9320
9321	</desc>
9322	<param name="pid" type="unsigned long" dir="in">
9323	<desc>
9324	Process id returned by earlier <link to="#executeProcess"/> call.
9325	</desc>
9326	</param>
9327	<param name="exitcode" type="unsigned long" dir="out">
9328	<desc>
9329	The exit code (if available).
9330	</desc>
9331	</param>
9332	<param name="flags" type="unsigned long" dir="out">
9333	<desc>
9334	Additional flags of process status. Not used at the moment and
9335	must be set to 0.
9336	</desc>
9337	</param>
9338	<param name="reason" type="ExecuteProcessStatus" dir="return">
9339	<desc>
9340	The current process status.
9341	</desc>
9342	</param>
9343	</method>
9344
9345	<method name="copyFromGuest">
9346	<desc>
9347	Copies files/directories from guest to the host.
9348
9349	<result name="VBOX_E_IPRT_ERROR">
9350	Error while copying.
9351	</result>
9352
9353	</desc>
9354	<param name="source" type="wstring" dir="in">
9355	<desc>
9356	Source file on the guest to copy.
9357	</desc>
9358	</param>
9359	<param name="dest" type="wstring" dir="in">
9360	<desc>
9361	Destination path on the host.
9362	</desc>
9363	</param>
9364	<param name="userName" type="wstring" dir="in">
9365	<desc>
9366	User name under which the copy command will be executed; the
9367	user has to exist and have the appropriate rights to read from
9368	the source path.
9369	</desc>
9370	</param>
9371	<param name="password" type="wstring" dir="in">
9372	<desc>
9373	Password of the user account specified.
9374	</desc>
9375	</param>
9376	<param name="flags" type="unsigned long" dir="in">
9377	<desc>
9378	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9379	</desc>
9380	</param>
9381	<param name="progress" type="IProgress" dir="return">
9382	<desc>Progress object to track the operation completion.</desc>
9383	</param>
9384	</method>
9385
9386	<method name="copyToGuest">
9387	<desc>
9388	Copies files/directories from host to the guest.
9389
9390	<result name="VBOX_E_IPRT_ERROR">
9391	Error while copying.
9392	</result>
9393
9394	</desc>
9395	<param name="source" type="wstring" dir="in">
9396	<desc>
9397	Source file on the host to copy.
9398	</desc>
9399	</param>
9400	<param name="dest" type="wstring" dir="in">
9401	<desc>
9402	Destination path on the guest.
9403	</desc>
9404	</param>
9405	<param name="userName" type="wstring" dir="in">
9406	<desc>
9407	User name under which the copy command will be executed; the
9408	user has to exist and have the appropriate rights to write to
9409	the destination path.
9410	</desc>
9411	</param>
9412	<param name="password" type="wstring" dir="in">
9413	<desc>
9414	Password of the user account specified.
9415	</desc>
9416	</param>
9417	<param name="flags" type="unsigned long" dir="in">
9418	<desc>
9419	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9420	</desc>
9421	</param>
9422	<param name="progress" type="IProgress" dir="return">
9423	<desc>Progress object to track the operation completion.</desc>
9424	</param>
9425	</method>
9426
9427	<method name="directoryClose">
9428	<desc>
9429	Closes a formerly opened guest directory.
9430
9431	<result name="VBOX_E_IPRT_ERROR">
9432	Error while closing directory.
9433	</result>
9434
9435	</desc>
9436	<param name="handle" type="unsigned long" dir="in">
9437	<desc>
9438	Handle of opened directory to close.
9439	</desc>
9440	</param>
9441	</method>
9442
9443	<method name="directoryCreate">
9444	<desc>
9445	Creates a directory on the guest.
9446
9447	<result name="VBOX_E_IPRT_ERROR">
9448	Error while creating directory.
9449	</result>
9450
9451	</desc>
9452	<param name="directory" type="wstring" dir="in">
9453	<desc>
9454	Directory to create.
9455	</desc>
9456	</param>
9457	<param name="userName" type="wstring" dir="in">
9458	<desc>
9459	User name under which the directory creation will be executed; the
9460	user has to exist and have the appropriate rights to create the
9461	desired directory.
9462	</desc>
9463	</param>
9464	<param name="password" type="wstring" dir="in">
9465	<desc>
9466	Password of the user account specified.
9467	</desc>
9468	</param>
9469	<param name="mode" type="unsigned long" dir="in">
9470	<desc>
9471	File mode.
9472	</desc>
9473	</param>
9474	<param name="flags" type="unsigned long" dir="in">
9475	<desc>
9476	<link to="DirectoryCreateFlag"/> flags.
9477	</desc>
9478	</param>
9479	</method>
9480
9481	<method name="directoryOpen">
9482	<desc>
9483	Opens a directory on the guest.
9484
9485	<result name="VBOX_E_IPRT_ERROR">
9486	Error while opening / reading directory.
9487	</result>
9488
9489	</desc>
9490	<param name="directory" type="wstring" dir="in">
9491	<desc>
9492	Directory to read.
9493	</desc>
9494	</param>
9495	<param name="filter" type="wstring" dir="in">
9496	<desc>
9497	Directory filter (DOS style wildcards). Set to empty
9498	string if no filter required.
9499	</desc>
9500	</param>
9501	<param name="flags" type="unsigned long" dir="in">
9502	<desc>
9503	<link to="DirectoryOpenFlag"/> flags.
9504	</desc>
9505	</param>
9506	<param name="userName" type="wstring" dir="in">
9507	<desc>
9508	User name under which the directory reading will be performed; the
9509	user has to exist and have the appropriate rights to access / read the
9510	desired directory.
9511	</desc>
9512	</param>
9513	<param name="password" type="wstring" dir="in">
9514	<desc>
9515	Password of the user account specified.
9516	</desc>
9517	</param>
9518	<param name="handle" type="unsigned long" dir="return">
9519	<desc>
9520	Handle of opened directory returned by openDirectory.
9521	</desc>
9522	</param>
9523	</method>
9524
9525	<method name="directoryRead">
9526	<desc>
9527	Reads the next directory entry of an opened guest directory.
9528
9529	<result name="E_ABORT">
9530	When the end of the directory has been reached.
9531	</result>
9532
9533	<result name="VBOX_E_IPRT_ERROR">
9534	Error while opening / reading directory.
9535	</result>
9536
9537	</desc>
9538	<param name="handle" type="unsigned long" dir="in">
9539	<desc>
9540	Handle of opened directory returned by openDirectory.
9541	</desc>
9542	</param>
9543	<param name="entry" type="IGuestDirEntry" dir="return">
9544	<desc>
9545	Information about next directory entry on success.
9546	</desc>
9547	</param>
9548	</method>
9549
9550	<method name="fileExists">
9551	<desc>
9552	Checks if the specified file name exists and is a regular file.
9553
9554	If the file name ends with a slash or backslash, the function assumes
9555	it's a directory and will check if the specified directory exists and
9556	is a regular directory.
9557
9558	<result name="VBOX_E_IPRT_ERROR">
9559	Error while looking up information.
9560	</result>
9561
9562	</desc>
9563	<param name="file" type="wstring" dir="in">
9564	<desc>
9565	Full path of file to check.
9566	</desc>
9567	</param>
9568	<param name="userName" type="wstring" dir="in">
9569	<desc>
9570	User name under which the lookup will be performed; the
9571	user has to exist and have the appropriate rights to access / read the
9572	desired directory.
9573	</desc>
9574	</param>
9575	<param name="password" type="wstring" dir="in">
9576	<desc>
9577	Password of the user account specified.
9578	</desc>
9579	</param>
9580	<param name="exists" type="boolean" dir="return">
9581	<desc>
9582	True if it's a regular file, false if it isn't (or doesn't exist).
9583	</desc>
9584	</param>
9585	</method>
9586
9587	<method name="fileQuerySize">
9588	<desc>
9589	Queries the size of a file, given the path to it.
9590
9591	<result name="VBOX_E_IPRT_ERROR">
9592	Error while looking up information.
9593	</result>
9594
9595	</desc>
9596	<param name="file" type="wstring" dir="in">
9597	<desc>
9598	Full path of file to query file size for.
9599	</desc>
9600	</param>
9601	<param name="userName" type="wstring" dir="in">
9602	<desc>
9603	User name under which the lookup will be performed; the
9604	user has to exist and have the appropriate rights to access / read the
9605	desired directory.
9606	</desc>
9607	</param>
9608	<param name="password" type="wstring" dir="in">
9609	<desc>
9610	Password of the user account specified.
9611	</desc>
9612	</param>
9613	<param name="size" type="long long" dir="return">
9614	<desc>
9615	Size (in bytes) of file specified.
9616	</desc>
9617	</param>
9618	</method>
9619
9620	<method name="setProcessInput">
9621	<desc>
9622	Sends input into a formerly started process.
9623
9624	<result name="VBOX_E_IPRT_ERROR">
9625	Could not send input.
9626	</result>
9627
9628	</desc>
9629	<param name="pid" type="unsigned long" dir="in">
9630	<desc>
9631	Process id returned by earlier <link to="#executeProcess"/> call.
9632	</desc>
9633	</param>
9634	<param name="flags" type="unsigned long" dir="in">
9635	<desc>
9636	<link to="ProcessInputFlag"/> flags.
9637	</desc>
9638	</param>
9639	<param name="timeoutMS" type="unsigned long" dir="in">
9640	<desc>
9641	The maximum timeout value (in msec) to wait for getting the
9642	data transfered to the guest. Pass 0 for an infinite timeout.
9643	</desc>
9644	</param>
9645	<param name="data" type="octet" dir="in" safearray="yes">
9646	<desc>
9647	Buffer of input data to send to the started process to.
9648	</desc>
9649	</param>
9650	<param name="written" type="unsigned long" dir="return">
9651	<desc>
9652	Number of bytes written.
9653	</desc>
9654	</param>
9655	</method>
9656
9657	<method name="updateGuestAdditions">
9658	<desc>
9659	Updates already installed Guest Additions in a VM
9660	(Windows guests only).
9661
9662	<result name="VBOX_E_IPRT_ERROR">
9663	Error while updating.
9664	</result>
9665
9666	</desc>
9667	<param name="source" type="wstring" dir="in">
9668	<desc>
9669	Path to the Guest Additions .ISO file to use for the upate.
9670	</desc>
9671	</param>
9672	<param name="flags" type="unsigned long" dir="in">
9673	<desc>
9674	<link to="AdditionsUpdateFlag"/> flags.
9675	</desc>
9676	</param>
9677	<param name="progress" type="IProgress" dir="return">
9678	<desc>Progress object to track the operation completion.</desc>
9679	</param>
9680	</method>
9681
9682	</interface>
9683
9684
9685	<!--
9686	// IProgress
9687	/////////////////////////////////////////////////////////////////////////
9688	-->
9689
9690	<interface
9691	name="IProgress" extends="$unknown"
9692	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9693	wsmap="managed"
9694	>
9695	<desc>
9696	The IProgress interface is used to track and control
9697	asynchronous tasks within VirtualBox.
9698
9699	An instance of this is returned every time VirtualBox starts
9700	an asynchronous task (in other words, a separate thread) which
9701	continues to run after a method call returns. For example,
9702	<link to="IConsole::saveState" />, which saves the state of
9703	a running virtual machine, can take a long time to complete.
9704	To be able to display a progress bar, a user interface such as
9705	the VirtualBox graphical user interface can use the IProgress
9706	object returned by that method.
9707
9708	Note that IProgress is a "read-only" interface in the sense
9709	that only the VirtualBox internals behind the Main API can
9710	create and manipulate progress objects, whereas client code
9711	can only use the IProgress object to monitor a task's
9712	progress and, if <link to="#cancelable" /> is @c true,
9713	cancel the task by calling <link to="#cancel" />.
9714
9715	A task represented by IProgress consists of either one or
9716	several sub-operations that run sequentially, one by one (see
9717	<link to="#operation" /> and <link to="#operationCount" />).
9718	Every operation is identified by a number (starting from 0)
9719	and has a separate description.
9720
9721	You can find the individual percentage of completion of the current
9722	operation in <link to="#operationPercent" /> and the
9723	percentage of completion of the task as a whole
9724	in <link to="#percent" />.
9725
9726	Similarly, you can wait for the completion of a particular
9727	operation via <link to="#waitForOperationCompletion" /> or
9728	for the completion of the whole task via
9729	<link to="#waitForCompletion" />.
9730	</desc>
9731
9732	<attribute name="id" type="uuid" mod="string" readonly="yes">
9733	<desc>ID of the task.</desc>
9734	</attribute>
9735
9736	<attribute name="description" type="wstring" readonly="yes">
9737	<desc>Description of the task.</desc>
9738	</attribute>
9739
9740	<attribute name="initiator" type="$unknown" readonly="yes">
9741	<desc>Initiator of the task.</desc>
9742	</attribute>
9743
9744	<attribute name="cancelable" type="boolean" readonly="yes">
9745	<desc>Whether the task can be interrupted.</desc>
9746	</attribute>
9747
9748	<attribute name="percent" type="unsigned long" readonly="yes">
9749	<desc>
9750	Current progress value of the task as a whole, in percent.
9751	This value depends on how many operations are already complete.
9752	Returns 100 if <link to="#completed" /> is @c true.
9753	</desc>
9754	</attribute>
9755
9756	<attribute name="timeRemaining" type="long" readonly="yes">
9757	<desc>
9758	Estimated remaining time until the task completes, in
9759	seconds. Returns 0 once the task has completed; returns -1
9760	if the remaining time cannot be computed, in particular if
9761	the current progress is 0.
9762
9763	Even if a value is returned, the estimate will be unreliable
9764	for low progress values. It will become more reliable as the
9765	task progresses; it is not recommended to display an ETA
9766	before at least 20% of a task have completed.
9767	</desc>
9768	</attribute>
9769
9770	<attribute name="completed" type="boolean" readonly="yes">
9771	<desc>Whether the task has been completed.</desc>
9772	</attribute>
9773
9774	<attribute name="canceled" type="boolean" readonly="yes">
9775	<desc>Whether the task has been canceled.</desc>
9776	</attribute>
9777
9778	<attribute name="resultCode" type="long" readonly="yes">
9779	<desc>
9780	Result code of the progress task.
9781	Valid only if <link to="#completed"/> is @c true.
9782	</desc>
9783	</attribute>
9784
9785	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9786	<desc>
9787	Extended information about the unsuccessful result of the
9788	progress operation. May be @c null if no extended information
9789	is available.
9790	Valid only if <link to="#completed"/> is @c true and
9791	<link to="#resultCode"/> indicates a failure.
9792	</desc>
9793	</attribute>
9794
9795	<attribute name="operationCount" type="unsigned long" readonly="yes">
9796	<desc>
9797	Number of sub-operations this task is divided into.
9798	Every task consists of at least one suboperation.
9799	</desc>
9800	</attribute>
9801
9802	<attribute name="operation" type="unsigned long" readonly="yes">
9803	<desc>Number of the sub-operation being currently executed.</desc>
9804	</attribute>
9805
9806	<attribute name="operationDescription" type="wstring" readonly="yes">
9807	<desc>
9808	Description of the sub-operation being currently executed.
9809	</desc>
9810	</attribute>
9811
9812	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9813	<desc>Progress value of the current sub-operation only, in percent.</desc>
9814	</attribute>
9815
9816	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9817	<desc>Weight value of the current sub-operation only.</desc>
9818	</attribute>
9819
9820	<attribute name="timeout" type="unsigned long">
9821	<desc>
9822	When non-zero, this specifies the number of milliseconds after which
9823	the operation will automatically be canceled. This can only be set on
9824	cancelable objects.
9825	</desc>
9826	</attribute>
9827
9828	<method name="setCurrentOperationProgress">
9829	<desc>Internal method, not to be called externally.</desc>
9830	<param name="percent" type="unsigned long" dir="in" />
9831	</method>
9832	<method name="setNextOperation">
9833	<desc>Internal method, not to be called externally.</desc>
9834	<param name="nextOperationDescription" type="wstring" dir="in" />
9835	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9836	</method>
9837
9838	<method name="waitForCompletion">
9839	<desc>
9840	Waits until the task is done (including all sub-operations)
9841	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9842
9843	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9844	thread are not processed while waiting. Neglecting event queues may
9845	have dire consequences (degrade performance, resource hogs,
9846	deadlocks, etc.), this is specially so for the main thread on
9847	platforms using XPCOM. Callers are adviced wait for short periods
9848	and service their event queues between calls, or to create a worker
9849	thread to do the waiting.
9850
9851	<result name="VBOX_E_IPRT_ERROR">
9852	Failed to wait for task completion.
9853	</result>
9854	</desc>
9855
9856	<param name="timeout" type="long" dir="in">
9857	<desc>
9858	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9859	</desc>
9860	</param>
9861	</method>
9862
9863	<method name="waitForOperationCompletion">
9864	<desc>
9865	Waits until the given operation is done with a given timeout in
9866	milliseconds; specify -1 for an indefinite wait.
9867
9868	See <link to="#waitForCompletion"> for event queue considerations.</link>
9869
9870	<result name="VBOX_E_IPRT_ERROR">
9871	Failed to wait for operation completion.
9872	</result>
9873
9874	</desc>
9875	<param name="operation" type="unsigned long" dir="in">
9876	<desc>
9877	Number of the operation to wait for.
9878	Must be less than <link to="#operationCount"/>.
9879	</desc>
9880	</param>
9881	<param name="timeout" type="long" dir="in">
9882	<desc>
9883	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9884	</desc>
9885	</param>
9886	</method>
9887
9888	<method name="waitForAsyncProgressCompletion">
9889	<desc>
9890	Waits until the other task is completed (including all
9891	sub-operations) and forward all changes from the other progress to
9892	this progress. This means sub-operation number, description, percent
9893	and so on.
9894
9895	You have to take care on setting up at least the same count on
9896	sub-operations in this progress object like there are in the other
9897	progress object.
9898
9899	If the other progress object supports cancel and this object gets any
9900	cancel request (when here enabled as well), it will be forwarded to
9901	the other progress object.
9902
9903	If there is an error in the other progress, this error isn't
9904	automatically transfered to this progress object. So you have to
9905	check any operation error within the other progress object, after
9906	this method returns.
9907	</desc>
9908
9909	<param name="pProgressAsync" type="IProgress" dir="in">
9910	<desc>
9911	The progress object of the asynchrony process.
9912	</desc>
9913	</param>
9914	</method>
9915
9916	<method name="cancel">
9917	<desc>
9918	Cancels the task.
9919	<note>
9920	If <link to="#cancelable"/> is @c false, then this method will fail.
9921	</note>
9922
9923	<result name="VBOX_E_INVALID_OBJECT_STATE">
9924	Operation cannot be canceled.
9925	</result>
9926
9927	</desc>
9928	</method>
9929
9930	</interface>
9931
9932	<!--
9933	// ISnapshot
9934	/////////////////////////////////////////////////////////////////////////
9935	-->
9936
9937	<interface
9938	name="ISnapshot" extends="$unknown"
9939	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9940	wsmap="managed"
9941	>
9942	<desc>
9943	The ISnapshot interface represents a snapshot of the virtual
9944	machine.
9945
9946	Together with the differencing media that are created
9947	when a snapshot is taken, a machine can be brought back to
9948	the exact state it was in when the snapshot was taken.
9949
9950	The ISnapshot interface has no methods, only attributes; snapshots
9951	are controlled through methods of the <link to="IConsole" /> interface
9952	which also manage the media associated with the snapshot.
9953	The following operations exist:
9954
9955	<ul>
9956	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9957	by creating new, empty differencing images for the machine's
9958	media and saving the VM settings and (if the VM is running)
9959	the current VM state in the snapshot.
9960
9961	The differencing images will then receive all data written to
9962	the machine's media, while their parent (base) images
9963	remain unmodified after the snapshot has been taken (see
9964	<link to="IMedium" /> for details about differencing images).
9965	This simplifies restoring a machine to the state of a snapshot:
9966	only the differencing images need to be deleted.
9967
9968	The current machine state is not changed by taking a snapshot
9969	except that <link to="IMachine::currentSnapshot" /> is set to
9970	the newly created snapshot, which is also added to the machine's
9971	snapshots tree.
9972	</li>
9973
9974	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9975	the state of a previous snapshot by deleting the differencing
9976	image of each of the machine's media and setting the machine's
9977	settings and state to the state that was saved in the snapshot (if any).
9978
9979	This destroys the machine's current state. After calling this,
9980	<link to="IMachine::currentSnapshot" /> points to the snapshot
9981	that was restored.
9982	</li>
9983
9984	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9985	without affecting the current machine state.
9986
9987	This does not change the current machine state, but instead frees the
9988	resources allocated when the snapshot was taken: the settings and machine
9989	state file are deleted (if any), and the snapshot's differencing image for
9990	each of the machine's media gets merged with its parent image.
9991
9992	Neither the current machine state nor other snapshots are affected
9993	by this operation, except that parent media will be modified
9994	to contain the disk data associated with the snapshot being deleted.
9995
9996	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9997	attribute is set to the current snapshot's parent or NULL if it
9998	has no parent. Otherwise the attribute is unchanged.
9999	</li>
10000	</ul>
10001
10002	Each snapshot contains a copy of virtual machine's settings (hardware
10003	configuration etc.). This copy is contained in an immutable (read-only)
10004	instance of <link to="IMachine" /> which is available from the snapshot's
10005	<link to="#machine" /> attribute. When restoring the snapshot, these
10006	settings are copied back to the original machine.
10007
10008	In addition, if the machine was running when the
10009	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
10010	the current VM state is saved in the snapshot (similarly to what happens
10011	when a VM's state is saved). The snapshot is then said to be <i>online</i>
10012	because when restoring it, the VM will be running.
10013
10014	If the machine was in <link to="MachineState_Saved">saved</link> saved,
10015	the snapshot receives a copy of the execution state file
10016	(<link to="IMachine::stateFilePath"/>).
10017
10018	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
10019	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
10020	it then contains a so-called "zero execution state", representing a
10021	machine that is powered off.
10022	</desc>
10023
10024	<attribute name="id" type="uuid" mod="string" readonly="yes">
10025	<desc>UUID of the snapshot.</desc>
10026	</attribute>
10027
10028	<attribute name="name" type="wstring">
10029	<desc>Short name of the snapshot.
10030	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10031	be called implicitly.</note>
10032	</desc>
10033	</attribute>
10034
10035	<attribute name="description" type="wstring">
10036	<desc>Optional description of the snapshot.
10037	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10038	be called implicitly.</note>
10039	</desc>
10040	</attribute>
10041
10042	<attribute name="timeStamp" type="long long" readonly="yes">
10043	<desc>
10044	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
10045	</desc>
10046	</attribute>
10047
10048	<attribute name="online" type="boolean" readonly="yes">
10049	<desc>
10050	@c true if this snapshot is an online snapshot and @c false otherwise.
10051
10052	When this attribute is @c true, the
10053	<link to="IMachine::stateFilePath"/> attribute of the
10054	<link to="#machine"/> object associated with this snapshot
10055	will point to the saved state file. Otherwise, it will be
10056	an empty string.
10057	</desc>
10058	</attribute>
10059
10060	<attribute name="machine" type="IMachine" readonly="yes">
10061	<desc>
10062	Virtual machine this snapshot is taken on. This object
10063	stores all settings the machine had when taking this snapshot.
10064	<note>
10065	The returned machine object is immutable, i.e. no
10066	any settings can be changed.
10067	</note>
10068	</desc>
10069	</attribute>
10070
10071	<attribute name="parent" type="ISnapshot" readonly="yes">
10072	<desc>
10073	Parent snapshot (a snapshot this one is based on), or
10074	@c null if the snapshot has no parent (i.e. is the first snapshot).
10075	</desc>
10076	</attribute>
10077
10078	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
10079	<desc>
10080	Child snapshots (all snapshots having this one as a parent).
10081	By inspecting this attribute starting with a machine's root snapshot
10082	(which can be obtained by calling <link to="IMachine::findSnapshot" />
10083	with a @c null UUID), a machine's snapshots tree can be iterated over.
10084	</desc>
10085	</attribute>
10086
10087	<method name="getChildrenCount" const="yes">
10088	<desc>
10089	Returns the number of direct childrens of this snapshot.
10090	</desc>
10091	<param name="childrenCount" type="unsigned long" dir="return">
10092	<desc>
10093	</desc>
10094	</param>
10095	</method>
10096
10097	</interface>
10098
10099
10100	<!--
10101	// IMedium
10102	/////////////////////////////////////////////////////////////////////////
10103	-->
10104
10105	<enum
10106	name="MediumState"
10107	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
10108	>
10109	<desc>
10110	Virtual medium state.
10111	<see><link to="IMedium"/></see>
10112	</desc>
10113
10114	<const name="NotCreated" value="0">
10115	<desc>
10116	Associated medium storage does not exist (either was not created yet or
10117	was deleted).
10118	</desc>
10119	</const>
10120	<const name="Created" value="1">
10121	<desc>
10122	Associated storage exists and accessible; this gets set if the
10123	accessibility check performed by <link to="IMedium::refreshState" />
10124	was successful.
10125	</desc>
10126	</const>
10127	<const name="LockedRead" value="2">
10128	<desc>
10129	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10130	no data modification is possible.
10131	</desc>
10132	</const>
10133	<const name="LockedWrite" value="3">
10134	<desc>
10135	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10136	no concurrent data reading or modification is possible.
10137	</desc>
10138	</const>
10139	<const name="Inaccessible" value="4">
10140	<desc>
10141	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10142	not yet been performed, or else, associated medium storage is not
10143	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10144	is empty, in the second case, it describes the error that occurred.
10145	</desc>
10146	</const>
10147	<const name="Creating" value="5">
10148	<desc>
10149	Associated medium storage is being created.
10150	</desc>
10151	</const>
10152	<const name="Deleting" value="6">
10153	<desc>
10154	Associated medium storage is being deleted.
10155	</desc>
10156	</const>
10157	</enum>
10158
10159	<enum
10160	name="MediumType"
10161	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10162	>
10163	<desc>
10164	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10165	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10166	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10167	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10168	</desc>
10169
10170	<const name="Normal" value="0">
10171	<desc>
10172	Normal medium (attached directly or indirectly, preserved
10173	when taking snapshots).
10174	</desc>
10175	</const>
10176	<const name="Immutable" value="1">
10177	<desc>
10178	Immutable medium (attached indirectly, changes are wiped out
10179	the next time the virtual machine is started).
10180	</desc>
10181	</const>
10182	<const name="Writethrough" value="2">
10183	<desc>
10184	Write through medium (attached directly, ignored when
10185	taking snapshots).
10186	</desc>
10187	</const>
10188	<const name="Shareable" value="3">
10189	<desc>
10190	Allow using this medium concurrently by several machines.
10191	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10192	</desc>
10193	</const>
10194	<const name="Readonly" value="4">
10195	<desc>
10196	A readonly medium, which can of course be used by several machines.
10197	<note>Present and accepted since VirtualBox 4.0.</note>
10198	</desc>
10199	</const>
10200	<const name="MultiAttach" value="5">
10201	<desc>
10202	A medium which is is indirectly attached, so that one base medium can
10203	be used for several VMs which have their own differencing medium to
10204	store their modifications. In some sense a variant of Immutable
10205	with unset AutoReset flag in each differencing medium.
10206	<note>Present and accepted since VirtualBox 4.0.</note>
10207	</desc>
10208	</const>
10209	</enum>
10210
10211	<enum
10212	name="MediumVariant"
10213	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10214	>
10215	<desc>
10216	Virtual medium image variant. More than one flag may be set.
10217	<see><link to="IMedium"/></see>
10218	</desc>
10219
10220	<const name="Standard" value="0">
10221	<desc>
10222	No particular variant requested, results in using the backend default.
10223	</desc>
10224	</const>
10225	<const name="VmdkSplit2G" value="0x01">
10226	<desc>
10227	VMDK image split in chunks of less than 2GByte.
10228	</desc>
10229	</const>
10230	<const name="VmdkStreamOptimized" value="0x04">
10231	<desc>
10232	VMDK streamOptimized image. Special import/export format which is
10233	read-only/append-only.
10234	</desc>
10235	</const>
10236	<const name="VmdkESX" value="0x08">
10237	<desc>
10238	VMDK format variant used on ESX products.
10239	</desc>
10240	</const>
10241	<const name="Fixed" value="0x10000">
10242	<desc>
10243	Fixed image. Only allowed for base images.
10244	</desc>
10245	</const>
10246	<const name="Diff" value="0x20000">
10247	<desc>
10248	Differencing image. Only allowed for child images.
10249	</desc>
10250	</const>
10251	<const name="NoCreateDir" value="0x40000000">
10252	<desc>
10253	Special flag which suppresses automatic creation of the subdirectory.
10254	Only used when passing the medium variant as an input parameter.
10255	</desc>
10256	</const>
10257	</enum>
10258
10259	<interface
10260	name="IMediumAttachment" extends="$unknown"
10261	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10262	wsmap="struct"
10263	>
10264	<desc>
10265	The IMediumAttachment interface links storage media to virtual machines.
10266	For each medium (<link to="IMedium"/>) which has been attached to a
10267	storage controller (<link to="IStorageController"/>) of a machine
10268	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10269	method, one instance of IMediumAttachment is added to the machine's
10270	<link to="IMachine::mediumAttachments"/> array attribute.
10271
10272	Each medium attachment specifies the storage controller as well as a
10273	port and device number and the IMedium instance representing a virtual
10274	hard disk or floppy or DVD image.
10275
10276	For removable media (DVDs or floppies), there are two additional
10277	options. For one, the IMedium instance can be @c null to represent
10278	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10279	secondly, the medium can be one of the pseudo-media for host drives
10280	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10281
10282	<h3>Attaching Hard Disks</h3>
10283
10284	Hard disks are attached to virtual machines using the
10285	<link to="IMachine::attachDevice"/> method and detached using the
10286	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10287	type (see <link to="IMedium::type" />), hard disks are attached either
10288	<i>directly</i> or <i>indirectly</i>.
10289
10290	When a hard disk is being attached directly, it is associated with the
10291	virtual machine and used for hard disk operations when the machine is
10292	running. When a hard disk is being attached indirectly, a new differencing
10293	hard disk linked to it is implicitly created and this differencing hard
10294	disk is associated with the machine and used for hard disk operations.
10295	This also means that if <link to="IMachine::attachDevice"/> performs
10296	a direct attachment then the same hard disk will be returned in response
10297	to the subsequent <link to="IMachine::getMedium"/> call; however if
10298	an indirect attachment is performed then
10299	<link to="IMachine::getMedium"/> will return the implicitly created
10300	differencing hard disk, not the original one passed to <link
10301	to="IMachine::attachDevice"/>. In detail:
10302
10303	<ul>
10304	<li><b>Normal base</b> hard disks that do not have children (i.e.
10305	differencing hard disks linked to them) and that are not already
10306	attached to virtual machines in snapshots are attached <b>directly</b>.
10307	Otherwise, they are attached <b>indirectly</b> because having
10308	dependent children or being part of the snapshot makes it impossible
10309	to modify hard disk contents without breaking the integrity of the
10310	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10311	quickly determine the kind of the attachment for the given hard
10312	disk. Note that if a normal base hard disk is to be indirectly
10313	attached to a virtual machine with snapshots then a special
10314	procedure called <i>smart attachment</i> is performed (see below).</li>
10315	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10316	they are attached <b>directly</b> if they do not have children and are
10317	not attached to virtual machines in snapshots, and <b>indirectly</b>
10318	otherwise. Note that the smart attachment procedure is never performed
10319	for differencing hard disks.</li>
10320	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10321	they are designed to be non-writable. If an immutable hard disk is
10322	attached to a virtual machine with snapshots then a special
10323	procedure called smart attachment is performed (see below).</li>
10324	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10325	also as designed. This also means that writethrough hard disks cannot
10326	have other hard disks linked to them at all.</li>
10327	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10328	also as designed. This also means that shareable hard disks cannot
10329	have other hard disks linked to them at all. They behave almost
10330	like writethrough hard disks, except that shareable hard disks can
10331	be attached to several virtual machines which are running, allowing
10332	concurrent accesses. You need special cluster software running in
10333	the virtual machines to make use of such disks.</li>
10334	</ul>
10335
10336	Note that the same hard disk, regardless of its type, may be attached to
10337	more than one virtual machine at a time. In this case, the machine that is
10338	started first gains exclusive access to the hard disk and attempts to
10339	start other machines having this hard disk attached will fail until the
10340	first machine is powered down.
10341
10342	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10343	that the given hard disk remains associated with the given machine after a
10344	successful <link to="IMachine::detachDevice"/> call until
10345	<link to="IMachine::saveSettings"/> is called to save all changes to
10346	machine settings to disk. This deferring is necessary to guarantee that
10347	the hard disk configuration may be restored at any time by a call to
10348	<link to="IMachine::discardSettings"/> before the settings
10349	are saved (committed).
10350
10351	Note that if <link to="IMachine::discardSettings"/> is called after
10352	indirectly attaching some hard disks to the machine but before a call to
10353	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10354	all differencing hard disks implicitly created by
10355	<link to="IMachine::attachDevice"/> for these indirect attachments.
10356	Such implicitly created hard disks will also be immediately deleted when
10357	detached explicitly using the <link to="IMachine::detachDevice"/>
10358	call if it is made before <link to="IMachine::saveSettings"/>. This
10359	implicit deletion is safe because newly created differencing hard
10360	disks do not contain any user data.
10361
10362	However, keep in mind that detaching differencing hard disks that were
10363	implicitly created by <link to="IMachine::attachDevice"/>
10364	before the last <link to="IMachine::saveSettings"/> call will
10365	<b>not</b> implicitly delete them as they may already contain some data
10366	(for example, as a result of virtual machine execution). If these hard
10367	disks are no more necessary, the caller can always delete them explicitly
10368	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10369	from this machine by the <link to="IMachine::saveSettings"/> call.
10370
10371	<h3>Smart Attachment</h3>
10372
10373	When normal base or immutable hard disks are indirectly attached to a
10374	virtual machine then some additional steps are performed to make sure the
10375	virtual machine will have the most recent "view" of the hard disk being
10376	attached. These steps include walking through the machine's snapshots
10377	starting from the current one and going through ancestors up to the first
10378	snapshot. Hard disks attached to the virtual machine in all
10379	of the encountered snapshots are checked whether they are descendants of
10380	the given normal base or immutable hard disk. The first found child (which
10381	is the differencing hard disk) will be used instead of the normal base or
10382	immutable hard disk as a parent for creating a new differencing hard disk
10383	that will be actually attached to the machine. And only if no descendants
10384	are found or if the virtual machine does not have any snapshots then the
10385	normal base or immutable hard disk will be used itself as a parent for
10386	this differencing hard disk.
10387
10388	It is easier to explain what smart attachment does using the
10389	following example:
10390	<pre>
10391	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10392
10393	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10394	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10395	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10396	Snapshot 4 (none) Snapshot 4 (none)
10397	CurState (none) CurState (D3->D2.vdi)
10398
10399	NOT
10400	...
10401	CurState (D3->B.vdi)
10402	</pre>
10403	The first column is the virtual machine configuration before the base hard
10404	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10405	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10406	mean that the hard disk that is actually attached to the machine is a
10407	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10408	another hard disk, <tt>B.vdi</tt>.
10409
10410	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10411	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10412	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10413	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10414	it cannot be attached directly and needs an indirect attachment (i.e.
10415	implicit creation of a new differencing hard disk). Due to the smart
10416	attachment procedure, the new differencing hard disk
10417	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10418	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10419	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10420	machine.
10421
10422	Note that if there is more than one descendant hard disk of the given base
10423	hard disk found in a snapshot, and there is an exact device, channel and
10424	bus match, then this exact match will be used. Otherwise, the youngest
10425	descendant will be picked up.
10426
10427	There is one more important aspect of the smart attachment procedure which
10428	is not related to snapshots at all. Before walking through the snapshots
10429	as described above, the backup copy of the current list of hard disk
10430	attachment is searched for descendants. This backup copy is created when
10431	the hard disk configuration is changed for the first time after the last
10432	<link to="IMachine::saveSettings"/> call and used by
10433	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10434	changes. When such a descendant is found in this backup copy, it will be
10435	simply re-attached back, without creating a new differencing hard disk for
10436	it. This optimization is necessary to make it possible to re-attach the
10437	base or immutable hard disk to a different bus, channel or device slot
10438	without losing the contents of the differencing hard disk actually
10439	attached to the machine in place of it.
10440
10441	</desc>
10442
10443	<attribute name="medium" type="IMedium" readonly="yes">
10444	<desc>Medium object associated with this attachment; it
10445	can be @c null for removable devices.</desc>
10446	</attribute>
10447
10448	<attribute name="controller" type="wstring" readonly="yes">
10449	<desc>Name of the storage controller of this attachment; this
10450	refers to one of the controllers in <link to="IMachine::storageControllers" />
10451	by name.</desc>
10452	</attribute>
10453
10454	<attribute name="port" type="long" readonly="yes">
10455	<desc>Port number of this attachment.
10456	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10457	</desc>
10458	</attribute>
10459
10460	<attribute name="device" type="long" readonly="yes">
10461	<desc>Device slot number of this attachment.
10462	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10463	</desc>
10464	</attribute>
10465
10466	<attribute name="type" type="DeviceType" readonly="yes">
10467	<desc>Device type of this attachment.</desc>
10468	</attribute>
10469
10470	<attribute name="passthrough" type="boolean" readonly="yes">
10471	<desc>Pass I/O requests through to a device on the host.</desc>
10472	</attribute>
10473
10474	<attribute name="temporaryEject" type="boolean" readonly="yes">
10475	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10476	</attribute>
10477
10478	<attribute name="isEjected" type="boolean" readonly="yes">
10479	<desc>Signals that the removable medium has been ejected. This is not
10480	necessarily equivalent to having a @c null medium association.</desc>
10481	</attribute>
10482
10483	<attribute name="nonRotational" type="boolean" readonly="yes">
10484	<desc>Whether the associated medium is non-rotational.</desc>
10485	</attribute>
10486
10487	<attribute name="discard" type="boolean" readonly="yes">
10488	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10489	</attribute>
10490
10491	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10492	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10493	</attribute>
10494
10495	</interface>
10496
10497	<interface
10498	name="IMedium" extends="$unknown"
10499	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10500	wsmap="managed"
10501	>
10502	<desc>
10503	The IMedium interface represents virtual storage for a machine's
10504	hard disks, CD/DVD or floppy drives. It will typically represent
10505	a disk image on the host, for example a VDI or VMDK file representing
10506	a virtual hard disk, or an ISO or RAW file representing virtual
10507	removable media, but can also point to a network location (e.g.
10508	for iSCSI targets).
10509
10510	Instances of IMedium are connected to virtual machines by way of medium
10511	attachments, which link the storage medium to a particular device slot
10512	of a storage controller of the virtual machine.
10513	In the VirtualBox API, virtual storage is therefore always represented
10514	by the following chain of object links:
10515
10516	<ul>
10517	<li><link to="IMachine::storageControllers"/> contains an array of
10518	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10519	these are instances of <link to="IStorageController"/>).</li>
10520	<li><link to="IMachine::mediumAttachments"/> contains an array of
10521	medium attachments (instances of <link to="IMediumAttachment"/>
10522	created by <link to="IMachine::attachDevice" />),
10523	each containing a storage controller from the above array, a
10524	port/device specification, and an instance of IMedium representing
10525	the medium storage (image file).
10526
10527	For removable media, the storage medium is optional; a medium
10528	attachment with no medium represents a CD/DVD or floppy drive
10529	with no medium inserted. By contrast, hard disk attachments
10530	will always have an IMedium object attached.</li>
10531	<li>Each IMedium in turn points to a storage unit (such as a file
10532	on the host computer or a network resource) that holds actual
10533	data. This location is represented by the <link to="#location"/>
10534	attribute.</li>
10535	</ul>
10536
10537	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10538	new hard disk media can be created with the VirtualBox API using the
10539	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10540	disks (see below) are usually implicitly created by VirtualBox as
10541	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10542	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10543	should be created with external tools and then opened from within VirtualBox.
10544
10545	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10546	drive. In that case the <link to="#id" /> attribute contains the UUID of
10547	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10548
10549	<h3>Media registries</h3>
10550
10551	When a medium has been opened or created using one of the aforementioned
10552	APIs, it becomes "known" to VirtualBox. Known media can be attached
10553	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10554	They also appear in the global
10555	<link to="IVirtualBox::hardDisks" />,
10556	<link to="IVirtualBox::DVDImages" /> and
10557	<link to="IVirtualBox::floppyImages" /> arrays.
10558
10559	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10560	in the VirtualBox.xml file, which was shared between all machines and made
10561	transporting machines and their media from one host to another difficult.
10562
10563	Starting with VirtualBox 4.0, media are only added to a registry when they are
10564	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10565	backwards compatibility, which registry a medium is added to depends on which
10566	VirtualBox version created a machine:
10567
10568	<ul>
10569	<li>If the medium has first been attached to a machine which was created by
10570	VirtualBox 4.0 or later, it is added to that machine's media registry in
10571	the machine XML settings file. This way all information about a machine's
10572	media attachments is contained in a single file and can be transported
10573	easily.</li>
10574	<li>For older media attachments (i.e. if the medium was first attached to a
10575	machine which was created with a VirtualBox version before 4.0), media
10576	continue to be registered in the global VirtualBox settings file, for
10577	backwards compatibility.</li>
10578	</ul>
10579
10580	See <link to="IVirtualBox::openMedium" /> for more information.
10581
10582	Media are removed from media registries by the <link to="IMedium::close"/>,
10583	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10584
10585	<h3>Accessibility checks</h3>
10586
10587	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10588	method is called explicitly on a medium. This is done to make the VirtualBox object
10589	ready for serving requests as fast as possible and let the end-user
10590	application decide if it needs to check media accessibility right away or not.
10591
10592	As a result, when VirtualBox starts up (e.g. the VirtualBox
10593	object gets created for the first time), all known media are in the
10594	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10595	attribute is an empty string because no actual accessibility check has
10596	been made yet.
10597
10598	After calling <link to="#refreshState" />, a medium is considered
10599	<i>accessible</i> if its storage unit can be read. In that case, the
10600	<link to="#state"/> attribute has a value of "Created". If the storage
10601	unit cannot be read (for example, because it is located on a disconnected
10602	network resource, or was accidentally deleted outside VirtualBox),
10603	the medium is considered <i>inaccessible</i>, which is indicated by the
10604	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10605	obtained by reading the <link to="#lastAccessError"/> attribute.
10606
10607	<h3>Medium types</h3>
10608
10609	There are five types of medium behavior which are stored in the
10610	<link to="#type"/> attribute (see <link to="MediumType" />) and
10611	which define the medium's behavior with attachments and snapshots.
10612
10613	All media can be also divided in two groups: <i>base</i> media and
10614	<i>differencing</i> media. A base medium contains all sectors of the
10615	medium data in its own storage and therefore can be used independently.
10616	In contrast, a differencing medium is a "delta" to some other medium and
10617	contains only those sectors which differ from that other medium, which is
10618	then called a <i>parent</i>. The differencing medium is said to be
10619	<i>linked to</i> that parent. The parent may be itself a differencing
10620	medium, thus forming a chain of linked media. The last element in that
10621	chain must always be a base medium. Note that several differencing
10622	media may be linked to the same parent medium.
10623
10624	Differencing media can be distinguished from base media by querying the
10625	<link to="#parent"/> attribute: base media do not have parents they would
10626	depend on, so the value of this attribute is always @c null for them.
10627	Using this attribute, it is possible to walk up the medium tree (from the
10628	child medium to its parent). It is also possible to walk down the tree
10629	using the <link to="#children"/> attribute.
10630
10631	Note that the type of all differencing media is "normal"; all other
10632	values are meaningless for them. Base media may be of any type.
10633
10634	<h3>Automatic composition of the file name part</h3>
10635
10636	Another extension to the <link to="IMedium::location"/> attribute is that
10637	there is a possibility to cause VirtualBox to compose a unique value for
10638	the file name part of the location using the UUID of the hard disk. This
10639	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10640	e.g. before the storage unit is created, and works as follows. You set the
10641	value of the <link to="IMedium::location"/> attribute to a location
10642	specification which only contains the path specification but not the file
10643	name part and ends with either a forward slash or a backslash character.
10644	In response, VirtualBox will generate a new UUID for the hard disk and
10645	compose the file name using the following pattern:
10646	<pre>
10647	<path>/{<uuid>}.<ext>
10648	</pre>
10649	where <tt><path></tt> is the supplied path specification,
10650	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10651	is the default extension for the storage format of this hard disk. After
10652	that, you may call any of the methods that create a new hard disk storage
10653	unit and they will use the generated UUID and file name.
10654	</desc>
10655
10656	<attribute name="id" type="uuid" mod="string" readonly="yes">
10657	<desc>
10658	UUID of the medium. For a newly created medium, this value is a randomly
10659	generated UUID.
10660
10661	<note>
10662	For media in one of MediumState_NotCreated, MediumState_Creating or
10663	MediumState_Deleting states, the value of this property is undefined
10664	and will most likely be an empty UUID.
10665	</note>
10666	</desc>
10667	</attribute>
10668
10669	<attribute name="description" type="wstring">
10670	<desc>
10671	Optional description of the medium. For a newly created medium the value
10672	of this attribute is an empty string.
10673
10674	Medium types that don't support this attribute will return E_NOTIMPL in
10675	attempt to get or set this attribute's value.
10676
10677	<note>
10678	For some storage types, reading this attribute may return an outdated
10679	(last known) value when <link to="#state"/> is <link
10680	to="MediumState_Inaccessible"/> or <link
10681	to="MediumState_LockedWrite"/> because the value of this attribute is
10682	stored within the storage unit itself. Also note that changing the
10683	attribute value is not possible in such case, as well as when the
10684	medium is the <link to="MediumState_LockedRead"/> state.
10685	</note>
10686	</desc>
10687	</attribute>
10688
10689	<attribute name="state" type="MediumState" readonly="yes">
10690	<desc>
10691	Returns the current medium state, which is the last state set by
10692	the accessibility check performed by <link to="#refreshState"/>.
10693	If that method has not yet been called on the medium, the state
10694	is "Inaccessible"; as opposed to truly inaccessible media, the
10695	value of <link to="#lastAccessError"/> will be an empty string in
10696	that case.
10697
10698	<note>As of version 3.1, this no longer performs an accessibility check
10699	automatically; call <link to="#refreshState"/> for that.
10700	</note>
10701	</desc>
10702	</attribute>
10703
10704	<attribute name="variant" type="unsigned long" readonly="yes">
10705	<desc>
10706	Returns the storage format variant information for this medium
10707	as a combination of the flags described at <link to="MediumVariant" />.
10708	Before <link to="#refreshState"/> is called this method returns
10709	an undefined value.
10710	</desc>
10711	</attribute>
10712
10713	<attribute name="location" type="wstring">
10714	<desc>
10715	Location of the storage unit holding medium data.
10716
10717	The format of the location string is medium type specific. For medium
10718	types using regular files in a host's file system, the location
10719	string is the full file name.
10720
10721	Some medium types may support changing the storage unit location by
10722	simply changing the value of this property. If this operation is not
10723	supported, the implementation will return E_NOTIMPL in attempt to set
10724	this attribute's value.
10725
10726	When setting a value of the location attribute which is a regular file
10727	in the host's file system, the given file name may be either relative to
10728	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10729	absolute. Note that if the given location specification does not contain
10730	the file extension part then a proper default extension will be
10731	automatically appended by the implementation depending on the medium type.
10732	</desc>
10733	</attribute>
10734
10735	<attribute name="name" type="wstring" readonly="yes">
10736	<desc>
10737	Name of the storage unit holding medium data.
10738
10739	The returned string is a short version of the <link to="#location"/>
10740	attribute that is suitable for representing the medium in situations
10741	where the full location specification is too long (such as lists
10742	and comboboxes in GUI frontends). This string is also used by frontends
10743	to sort the media list alphabetically when needed.
10744
10745	For example, for locations that are regular files in the host's file
10746	system, the value of this attribute is just the file name (+ extension),
10747	without the path specification.
10748
10749	Note that as opposed to the <link to="#location"/> attribute, the name
10750	attribute will not necessary be unique for a list of media of the
10751	given type and format.
10752	</desc>
10753	</attribute>
10754
10755	<attribute name="deviceType" type="DeviceType" readonly="yes">
10756	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10757	medium.</desc>
10758	</attribute>
10759
10760	<attribute name="hostDrive" type="boolean" readonly="yes">
10761	<desc>True if this corresponds to a drive on the host.</desc>
10762	</attribute>
10763
10764	<attribute name="size" type="long long" readonly="yes">
10765	<desc>
10766	Physical size of the storage unit used to hold medium data (in bytes).
10767
10768	<note>
10769	For media whose <link to="#state"/> is <link
10770	to="MediumState_Inaccessible"/>, the value of this property is the
10771	last known size. For <link to="MediumState_NotCreated"/> media,
10772	the returned value is zero.
10773	</note>
10774	</desc>
10775	</attribute>
10776
10777	<attribute name="format" type="wstring" readonly="yes">
10778	<desc>
10779	Storage format of this medium.
10780
10781	The value of this attribute is a string that specifies a backend used
10782	to store medium data. The storage format is defined when you create a
10783	new medium or automatically detected when you open an existing medium,
10784	and cannot be changed later.
10785
10786	The list of all storage formats supported by this VirtualBox
10787	installation can be obtained using
10788	<link to="ISystemProperties::mediumFormats"/>.
10789	</desc>
10790	</attribute>
10791
10792	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10793	<desc>
10794	Storage medium format object corresponding to this medium.
10795
10796	The value of this attribute is a reference to the medium format object
10797	that specifies the backend properties used to store medium data. The
10798	storage format is defined when you create a new medium or automatically
10799	detected when you open an existing medium, and cannot be changed later.
10800
10801	<note>@c null is returned if there is no associated medium format
10802	object. This can e.g. happen for medium objects representing host
10803	drives and other special medium objects.</note>
10804	</desc>
10805	</attribute>
10806
10807	<attribute name="type" type="MediumType">
10808	<desc>
10809	Type (role) of this medium.
10810
10811	The following constraints apply when changing the value of this
10812	attribute:
10813	<ul>
10814	<li>If a medium is attached to a virtual machine (either in the
10815	current state or in one of the snapshots), its type cannot be
10816	changed.
10817	</li>
10818	<li>As long as the medium has children, its type cannot be set
10819	to <link to="MediumType_Writethrough"/>.
10820	</li>
10821	<li>The type of all differencing media is
10822	<link to="MediumType_Normal"/> and cannot be changed.
10823	</li>
10824	</ul>
10825
10826	The type of a newly created or opened medium is set to
10827	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10828	which have a type of <link to="MediumType_Writethrough"/>.
10829	</desc>
10830	</attribute>
10831
10832	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10833	<desc>
10834	Returns which medium types can selected for this medium.
10835
10836	<result name="E_NOTIMPL">
10837	This attribute is not implemented at the moment.
10838	</result>
10839	</desc>
10840	</attribute>
10841
10842	<attribute name="parent" type="IMedium" readonly="yes">
10843	<desc>
10844	Parent of this medium (the medium this medium is directly based
10845	on).
10846
10847	Only differencing media have parents. For base (non-differencing)
10848	media, @c null is returned.
10849	</desc>
10850	</attribute>
10851
10852	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10853	<desc>
10854	Children of this medium (all differencing media directly based
10855	on this medium). A @c null array is returned if this medium
10856	does not have any children.
10857	</desc>
10858	</attribute>
10859
10860	<attribute name="base" type="IMedium" readonly="yes">
10861	<desc>
10862	Base medium of this medium.
10863
10864	If this is a differencing medium, its base medium is the medium
10865	the given medium branch starts from. For all other types of media, this
10866	property returns the medium object itself (i.e. the same object this
10867	property is read on).
10868	</desc>
10869	</attribute>
10870
10871	<attribute name="readOnly" type="boolean" readonly="yes">
10872	<desc>
10873	Returns @c true if this medium is read-only and @c false otherwise.
10874
10875	A medium is considered to be read-only when its contents cannot be
10876	modified without breaking the integrity of other parties that depend on
10877	this medium such as its child media or snapshots of virtual machines
10878	where this medium is attached to these machines. If there are no
10879	children and no such snapshots then there is no dependency and the
10880	medium is not read-only.
10881
10882	The value of this attribute can be used to determine the kind of the
10883	attachment that will take place when attaching this medium to a
10884	virtual machine. If the value is @c false then the medium will
10885	be attached directly. If the value is @c true then the medium
10886	will be attached indirectly by creating a new differencing child
10887	medium for that. See the interface description for more information.
10888
10889	Note that all <link to="MediumType_Immutable">Immutable</link> media
10890	are always read-only while all
10891	<link to="MediumType_Writethrough">Writethrough</link> media are
10892	always not.
10893
10894	<note>
10895	The read-only condition represented by this attribute is related to
10896	the medium type and usage, not to the current
10897	<link to="IMedium::state">medium state</link> and not to the read-only
10898	state of the storage unit.
10899	</note>
10900	</desc>
10901	</attribute>
10902
10903	<attribute name="logicalSize" type="long long" readonly="yes">
10904	<desc>
10905	Logical size of this medium (in bytes), as reported to the
10906	guest OS running inside the virtual machine this medium is
10907	attached to. The logical size is defined when the medium is created
10908	and cannot be changed later.
10909
10910	<note>
10911	Reading this property on a differencing medium will return the size
10912	of its <link to="#base"/> medium.
10913	</note>
10914	<note>
10915	For media whose state is <link to="#state"/> is <link
10916	to="MediumState_Inaccessible"/>, the value of this property is the
10917	last known logical size. For <link to="MediumState_NotCreated"/>
10918	media, the returned value is zero.
10919	</note>
10920	</desc>
10921	</attribute>
10922
10923	<attribute name="autoReset" type="boolean">
10924	<desc>
10925	Whether this differencing medium will be automatically reset each
10926	time a virtual machine it is attached to is powered up. This
10927	attribute is automatically set to @c true for the last
10928	differencing image of an "immutable" medium (see
10929	<link to="MediumType" />).
10930
10931	See <link to="#reset"/> for more information about resetting
10932	differencing media.
10933
10934	<note>
10935	Reading this property on a base (non-differencing) medium will
10936	always @c false. Changing the value of this property in this
10937	case is not supported.
10938	</note>
10939
10940	<result name="VBOX_E_NOT_SUPPORTED">
10941	This is not a differencing medium (when changing the attribute
10942	value).
10943	</result>
10944	</desc>
10945	</attribute>
10946
10947	<attribute name="lastAccessError" type="wstring" readonly="yes">
10948	<desc>
10949	Text message that represents the result of the last accessibility
10950	check performed by <link to="#refreshState"/>.
10951
10952	An empty string is returned if the last accessibility check
10953	was successful or has not yet been called. As a result, if
10954	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10955	then <link to="#refreshState"/> has yet to be called; this is the
10956	default value of media after VirtualBox initialization.
10957	A non-empty string indicates a failure and should normally describe
10958	a reason of the failure (for example, a file read error).
10959	</desc>
10960	</attribute>
10961
10962	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10963	<desc>
10964	Array of UUIDs of all machines this medium is attached to.
10965
10966	A @c null array is returned if this medium is not attached to any
10967	machine or to any machine's snapshot.
10968
10969	<note>
10970	The returned array will include a machine even if this medium is not
10971	attached to that machine in the current state but attached to it in
10972	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10973	details.
10974	</note>
10975	</desc>
10976	</attribute>
10977
10978	<method name="setIDs">
10979	<desc>
10980	Changes the UUID and parent UUID for a hard disk medium.
10981	</desc>
10982	<param name="setImageId" type="boolean" dir="in">
10983	<desc>
10984	Select whether a new image UUID is set or not.
10985	</desc>
10986	</param>
10987	<param name="imageId" type="uuid" mod="string" dir="in">
10988	<desc>
10989	New UUID for the image. If an empty string is passed, then a new
10990	UUID is automatically created, provided that @a setImageId is @c true.
10991	Specifying a zero UUID is not allowed.
10992	</desc>
10993	</param>
10994	<param name="setParentId" type="boolean" dir="in">
10995	<desc>
10996	Select whether a new parent UUID is set or not.
10997	</desc>
10998	</param>
10999	<param name="parentId" type="uuid" mod="string" dir="in">
11000	<desc>
11001	New parent UUID for the image. If an empty string is passed, then a
11002	new UUID is automatically created, provided @a setParentId is
11003	@c true. A zero UUID is valid.
11004	</desc>
11005	</param>
11006	<result name="E_INVALIDARG">
11007	Invalid parameter combination.
11008	</result>
11009	<result name="VBOX_E_NOT_SUPPORTED">
11010	Medium is not a hard disk medium.
11011	</result>
11012	</method>
11013
11014	<method name="refreshState">
11015	<desc>
11016	If the current medium state (see <link to="MediumState"/>) is one of
11017	"Created", "Inaccessible" or "LockedRead", then this performs an
11018	accessibility check on the medium and sets the value of the <link to="#state"/>
11019	attribute accordingly; that value is also returned for convenience.
11020
11021	For all other state values, this does not perform a refresh but returns
11022	the state only.
11023
11024	The refresh, if performed, may take a long time (several seconds or even
11025	minutes, depending on the storage unit location and format) because it performs an
11026	accessibility check of the storage unit. This check may cause a significant
11027	delay if the storage unit of the given medium is, for example, a file located
11028	on a network share which is not currently accessible due to connectivity
11029	problems. In that case, the call will not return until a timeout
11030	interval defined by the host OS for this operation expires. For this reason,
11031	it is recommended to never read this attribute on the main UI thread to avoid
11032	making the UI unresponsive.
11033
11034	If the last known state of the medium is "Created" and the accessibility
11035	check fails, then the state would be set to "Inaccessible", and
11036	<link to="#lastAccessError"/> may be used to get more details about the
11037	failure. If the state of the medium is "LockedRead", then it remains the
11038	same, and a non-empty value of <link to="#lastAccessError"/> will
11039	indicate a failed accessibility check in this case.
11040
11041	Note that not all medium states are applicable to all medium types.
11042	</desc>
11043	<param name="state" type="MediumState" dir="return">
11044	<desc>
11045	New medium state.
11046	</desc>
11047	</param>
11048	</method>
11049
11050	<method name="getSnapshotIds">
11051	<desc>
11052	Returns an array of UUIDs of all snapshots of the given machine where
11053	this medium is attached to.
11054
11055	If the medium is attached to the machine in the current state, then the
11056	first element in the array will always be the ID of the queried machine
11057	(i.e. the value equal to the @c machineId argument), followed by
11058	snapshot IDs (if any).
11059
11060	If the medium is not attached to the machine in the current state, then
11061	the array will contain only snapshot IDs.
11062
11063	The returned array may be @c null if this medium is not attached
11064	to the given machine at all, neither in the current state nor in one of
11065	the snapshots.
11066	</desc>
11067	<param name="machineId" type="uuid" mod="string" dir="in">
11068	<desc>
11069	UUID of the machine to query.
11070	</desc>
11071	</param>
11072	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
11073	<desc>
11074	Array of snapshot UUIDs of the given machine using this medium.
11075	</desc>
11076	</param>
11077	</method>
11078
11079	<method name="lockRead">
11080	<desc>
11081	Locks this medium for reading.
11082
11083	A read lock is shared: many clients can simultaneously lock the
11084	same medium for reading unless it is already locked for writing (see
11085	<link to="#lockWrite"/>) in which case an error is returned.
11086
11087	When the medium is locked for reading, it cannot be modified
11088	from within VirtualBox. This means that any method that changes
11089	the properties of this medium or contents of the storage unit
11090	will return an error (unless explicitly stated otherwise). That
11091	includes an attempt to start a virtual machine that wants to
11092	write to the the medium.
11093
11094	When the virtual machine is started up, it locks for reading all
11095	media it uses in read-only mode. If some medium cannot be locked
11096	for reading, the startup procedure will fail.
11097	A medium is typically locked for reading while it is used by a running
11098	virtual machine but has a depending differencing image that receives
11099	the actual write operations. This way one base medium can have
11100	multiple child differencing images which can be written to
11101	simultaneously. Read-only media such as DVD and floppy images are
11102	also locked for reading only (so they can be in use by multiple
11103	machines simultaneously).
11104
11105	A medium is also locked for reading when it is the source of a
11106	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11107
11108	The medium locked for reading must be unlocked using the <link
11109	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
11110	can be nested and must be followed by the same number of paired
11111	<link to="#unlockRead"/> calls.
11112
11113	This method sets the medium state (see <link to="#state"/>) to
11114	"LockedRead" on success. The medium's previous state must be
11115	one of "Created", "Inaccessible" or "LockedRead".
11116
11117	Locking an inaccessible medium is not an error; this method performs
11118	a logical lock that prevents modifications of this medium through
11119	the VirtualBox API, not a physical file-system lock of the underlying
11120	storage unit.
11121
11122	This method returns the current state of the medium
11123	<i>before</i> the operation.
11124
11125	<result name="VBOX_E_INVALID_OBJECT_STATE">
11126	Invalid medium state (e.g. not created, locked, inaccessible,
11127	creating, deleting).
11128	</result>
11129
11130	</desc>
11131	<param name="state" type="MediumState" dir="return">
11132	<desc>
11133	State of the medium after the operation.
11134	</desc>
11135	</param>
11136	</method>
11137
11138	<method name="unlockRead">
11139	<desc>
11140	Cancels the read lock previously set by <link to="#lockRead"/>.
11141
11142	For both success and failure, this method returns the current state
11143	of the medium <i>after</i> the operation.
11144
11145	See <link to="#lockRead"/> for more details.
11146
11147	<result name="VBOX_E_INVALID_OBJECT_STATE">
11148	Medium not locked for reading.
11149	</result>
11150
11151	</desc>
11152	<param name="state" type="MediumState" dir="return">
11153	<desc>
11154	State of the medium after the operation.
11155	</desc>
11156	</param>
11157	</method>
11158
11159	<method name="lockWrite">
11160	<desc>
11161	Locks this medium for writing.
11162
11163	A write lock, as opposed to <link to="#lockRead"/>, is
11164	exclusive: there may be only one client holding a write lock,
11165	and there may be no read locks while the write lock is held.
11166	As a result, read-locking fails if a write lock is held, and
11167	write-locking fails if either a read or another write lock is held.
11168
11169	When a medium is locked for writing, it cannot be modified
11170	from within VirtualBox, and it is not guaranteed that the values
11171	of its properties are up-to-date. Any method that changes the
11172	properties of this medium or contents of the storage unit will
11173	return an error (unless explicitly stated otherwise).
11174
11175	When a virtual machine is started up, it locks for writing all
11176	media it uses to write data to. If any medium could not be locked
11177	for writing, the startup procedure will fail. If a medium has
11178	differencing images, then while the machine is running, only
11179	the last ("leaf") differencing image is locked for writing,
11180	whereas its parents are locked for reading only.
11181
11182	A medium is also locked for writing when it is the target of a
11183	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11184
11185	The medium locked for writing must be unlocked using the <link
11186	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11187
11188	This method sets the medium state (see <link to="#state"/>) to
11189	"LockedWrite" on success. The medium's previous state must be
11190	either "Created" or "Inaccessible".
11191
11192	Locking an inaccessible medium is not an error; this method performs
11193	a logical lock that prevents modifications of this medium through
11194	the VirtualBox API, not a physical file-system lock of the underlying
11195	storage unit.
11196
11197	For both, success and failure, this method returns the current
11198	state of the medium <i>before</i> the operation.
11199
11200	<result name="VBOX_E_INVALID_OBJECT_STATE">
11201	Invalid medium state (e.g. not created, locked, inaccessible,
11202	creating, deleting).
11203	</result>
11204
11205	</desc>
11206	<param name="state" type="MediumState" dir="return">
11207	<desc>
11208	State of the medium after the operation.
11209	</desc>
11210	</param>
11211	</method>
11212
11213	<method name="unlockWrite">
11214	<desc>
11215	Cancels the write lock previously set by <link to="#lockWrite"/>.
11216
11217	For both success and failure, this method returns the current
11218	state of the medium <i>after</i> the operation.
11219
11220	See <link to="#lockWrite"/> for more details.
11221
11222	<result name="VBOX_E_INVALID_OBJECT_STATE">
11223	Medium not locked for writing.
11224	</result>
11225
11226	</desc>
11227	<param name="state" type="MediumState" dir="return">
11228	<desc>
11229	State of the medium after the operation.
11230	</desc>
11231	</param>
11232	</method>
11233
11234	<method name="close">
11235	<desc>
11236	Closes this medium.
11237
11238	The medium must not be attached to any known virtual machine
11239	and must not have any known child media, otherwise the
11240	operation will fail.
11241
11242	When the medium is successfully closed, it is removed from
11243	the list of registered media, but its storage unit is not
11244	deleted. In particular, this means that this medium can
11245	later be opened again using the <link to="IVirtualBox::openMedium"/>
11246	call.
11247
11248	Note that after this method successfully returns, the given medium
11249	object becomes uninitialized. This means that any attempt
11250	to call any of its methods or attributes will fail with the
11251	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11252
11253	<result name="VBOX_E_INVALID_OBJECT_STATE">
11254	Invalid medium state (other than not created, created or
11255	inaccessible).
11256	</result>
11257	<result name="VBOX_E_OBJECT_IN_USE">
11258	Medium attached to virtual machine.
11259	</result>
11260	<result name="VBOX_E_FILE_ERROR">
11261	Settings file not accessible.
11262	</result>
11263	<result name="VBOX_E_XML_ERROR">
11264	Could not parse the settings file.
11265	</result>
11266
11267	</desc>
11268	</method>
11269
11270	<!-- property methods -->
11271
11272	<method name="getProperty" const="yes">
11273	<desc>
11274	Returns the value of the custom medium property with the given name.
11275
11276	The list of all properties supported by the given medium format can
11277	be obtained with <link to="IMediumFormat::describeProperties"/>.
11278
11279	<note>If this method returns an empty string in @a value, the requested
11280	property is supported but currently not assigned any value.</note>
11281
11282	<result name="VBOX_E_OBJECT_NOT_FOUND">
11283	Requested property does not exist (not supported by the format).
11284	</result>
11285	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11286	</desc>
11287	<param name="name" type="wstring" dir="in">
11288	<desc>Name of the property to get.</desc>
11289	</param>
11290	<param name="value" type="wstring" dir="return">
11291	<desc>Current property value.</desc>
11292	</param>
11293	</method>
11294
11295	<method name="setProperty">
11296	<desc>
11297	Sets the value of the custom medium property with the given name.
11298
11299	The list of all properties supported by the given medium format can
11300	be obtained with <link to="IMediumFormat::describeProperties"/>.
11301
11302	<note>Setting the property value to @c null or an empty string is
11303	equivalent to deleting the existing value. A default value (if it is
11304	defined for this property) will be used by the format backend in this
11305	case.</note>
11306
11307	<result name="VBOX_E_OBJECT_NOT_FOUND">
11308	Requested property does not exist (not supported by the format).
11309	</result>
11310	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11311	</desc>
11312	<param name="name" type="wstring" dir="in">
11313	<desc>Name of the property to set.</desc>
11314	</param>
11315	<param name="value" type="wstring" dir="in">
11316	<desc>Property value to set.</desc>
11317	</param>
11318	</method>
11319
11320	<method name="getProperties" const="yes">
11321	<desc>
11322	Returns values for a group of properties in one call.
11323
11324	The names of the properties to get are specified using the @a names
11325	argument which is a list of comma-separated property names or
11326	an empty string if all properties are to be returned.
11327	<note>Currently the value of this argument is ignored and the method
11328	always returns all existing properties.</note>
11329
11330	The list of all properties supported by the given medium format can
11331	be obtained with <link to="IMediumFormat::describeProperties"/>.
11332
11333	The method returns two arrays, the array of property names corresponding
11334	to the @a names argument and the current values of these properties.
11335	Both arrays have the same number of elements with each element at the
11336	given index in the first array corresponds to an element at the same
11337	index in the second array.
11338
11339	For properties that do not have assigned values, an empty string is
11340	returned at the appropriate index in the @a returnValues array.
11341
11342	</desc>
11343	<param name="names" type="wstring" dir="in">
11344	<desc>
11345	Names of properties to get.
11346	</desc>
11347	</param>
11348	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11349	<desc>Names of returned properties.</desc>
11350	</param>
11351	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11352	<desc>Values of returned properties.</desc>
11353	</param>
11354	</method>
11355
11356	<method name="setProperties">
11357	<desc>
11358	Sets values for a group of properties in one call.
11359
11360	The names of the properties to set are passed in the @a names
11361	array along with the new values for them in the @a values array. Both
11362	arrays have the same number of elements with each element at the given
11363	index in the first array corresponding to an element at the same index
11364	in the second array.
11365
11366	If there is at least one property name in @a names that is not valid,
11367	the method will fail before changing the values of any other properties
11368	from the @a names array.
11369
11370	Using this method over <link to="#setProperty"/> is preferred if you
11371	need to set several properties at once since it is more efficient.
11372
11373	The list of all properties supported by the given medium format can
11374	be obtained with <link to="IMediumFormat::describeProperties"/>.
11375
11376	Setting the property value to @c null or an empty string is equivalent
11377	to deleting the existing value. A default value (if it is defined for
11378	this property) will be used by the format backend in this case.
11379	</desc>
11380	<param name="names" type="wstring" safearray="yes" dir="in">
11381	<desc>Names of properties to set.</desc>
11382	</param>
11383	<param name="values" type="wstring" safearray="yes" dir="in">
11384	<desc>Values of properties to set.</desc>
11385	</param>
11386	</method>
11387
11388	<!-- storage methods -->
11389
11390	<method name="createBaseStorage">
11391	<desc>
11392	Starts creating a hard disk storage unit (fixed/dynamic, according
11393	to the variant flags) in in the background. The previous storage unit
11394	created for this object, if any, must first be deleted using
11395	<link to="#deleteStorage"/>, otherwise the operation will fail.
11396
11397	Before the operation starts, the medium is placed in
11398	<link to="MediumState_Creating"/> state. If the create operation
11399	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11400	state.
11401
11402	After the returned progress object reports that the operation has
11403	successfully completed, the medium state will be set to <link
11404	to="MediumState_Created"/>, the medium will be remembered by this
11405	VirtualBox installation and may be attached to virtual machines.
11406
11407	<result name="VBOX_E_NOT_SUPPORTED">
11408	The variant of storage creation operation is not supported. See <link
11409	to="IMediumFormat::capabilities"/>.
11410	</result>
11411	</desc>
11412	<param name="logicalSize" type="long long" dir="in">
11413	<desc>Maximum logical size of the medium in bytes.</desc>
11414	</param>
11415	<param name="variant" type="unsigned long" dir="in">
11416	<desc>Exact image variant which should be created (as a combination of
11417	<link to="MediumVariant" /> flags).</desc>
11418	</param>
11419	<param name="progress" type="IProgress" dir="return">
11420	<desc>Progress object to track the operation completion.</desc>
11421	</param>
11422	</method>
11423
11424	<method name="deleteStorage">
11425	<desc>
11426	Starts deleting the storage unit of this medium.
11427
11428	The medium must not be attached to any known virtual machine and must
11429	not have any known child media, otherwise the operation will fail.
11430	It will also fail if there is no storage unit to delete or if deletion
11431	is already in progress, or if the medium is being in use (locked for
11432	read or for write) or inaccessible. Therefore, the only valid state for
11433	this operation to succeed is <link to="MediumState_Created"/>.
11434
11435	Before the operation starts, the medium is placed in
11436	<link to="MediumState_Deleting"/> state and gets removed from the list
11437	of remembered hard disks (media registry). If the delete operation
11438	fails, the medium will be remembered again and placed back to
11439	<link to="MediumState_Created"/> state.
11440
11441	After the returned progress object reports that the operation is
11442	complete, the medium state will be set to
11443	<link to="MediumState_NotCreated"/> and you will be able to use one of
11444	the storage creation methods to create it again.
11445
11446	<see><link to="#close"/></see>
11447
11448	<result name="VBOX_E_OBJECT_IN_USE">
11449	Medium is attached to a virtual machine.
11450	</result>
11451	<result name="VBOX_E_NOT_SUPPORTED">
11452	Storage deletion is not allowed because neither of storage creation
11453	operations are supported. See
11454	<link to="IMediumFormat::capabilities"/>.
11455	</result>
11456
11457	<note>
11458	If the deletion operation fails, it is not guaranteed that the storage
11459	unit still exists. You may check the <link to="IMedium::state"/> value
11460	to answer this question.
11461	</note>
11462	</desc>
11463	<param name="progress" type="IProgress" dir="return">
11464	<desc>Progress object to track the operation completion.</desc>
11465	</param>
11466	</method>
11467
11468	<!-- diff methods -->
11469
11470	<method name="createDiffStorage">
11471	<desc>
11472	Starts creating an empty differencing storage unit based on this
11473	medium in the format and at the location defined by the @a target
11474	argument.
11475
11476	The target medium must be in <link to="MediumState_NotCreated"/>
11477	state (i.e. must not have an existing storage unit). Upon successful
11478	completion, this operation will set the type of the target medium to
11479	<link to="MediumType_Normal"/> and create a storage unit necessary to
11480	represent the differencing medium data in the given format (according
11481	to the storage format of the target object).
11482
11483	After the returned progress object reports that the operation is
11484	successfully complete, the target medium gets remembered by this
11485	VirtualBox installation and may be attached to virtual machines.
11486
11487	<note>
11488	The medium will be set to <link to="MediumState_LockedRead"/>
11489	state for the duration of this operation.
11490	</note>
11491	<result name="VBOX_E_OBJECT_IN_USE">
11492	Medium not in @c NotCreated state.
11493	</result>
11494	</desc>
11495	<param name="target" type="IMedium" dir="in">
11496	<desc>Target medium.</desc>
11497	</param>
11498	<param name="variant" type="unsigned long" dir="in">
11499	<desc>Exact image variant which should be created (as a combination of
11500	<link to="MediumVariant" /> flags).</desc>
11501	</param>
11502	<param name="progress" type="IProgress" dir="return">
11503	<desc>Progress object to track the operation completion.</desc>
11504	</param>
11505	</method>
11506
11507	<method name="mergeTo">
11508	<desc>
11509	Starts merging the contents of this medium and all intermediate
11510	differencing media in the chain to the given target medium.
11511
11512	The target medium must be either a descendant of this medium or
11513	its ancestor (otherwise this method will immediately return a failure).
11514	It follows that there are two logical directions of the merge operation:
11515	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11516	ancestor (<i>backward merge</i>). Let us consider the following medium
11517	chain:
11518
11519	<pre>Base <- Diff_1 <- Diff_2</pre>
11520
11521	Here, calling this method on the <tt>Base</tt> medium object with
11522	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11523	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11524	merge. Note that in both cases the contents of the resulting medium
11525	will be the same, the only difference is the medium object that takes
11526	the result of the merge operation. In case of the forward merge in the
11527	above example, the result will be written to <tt>Diff_2</tt>; in case of
11528	the backward merge, the result will be written to <tt>Base</tt>. In
11529	other words, the result of the operation is always stored in the target
11530	medium.
11531
11532	Upon successful operation completion, the storage units of all media in
11533	the chain between this (source) medium and the target medium, including
11534	the source medium itself, will be automatically deleted and the
11535	relevant medium objects (including this medium) will become
11536	uninitialized. This means that any attempt to call any of
11537	their methods or attributes will fail with the
11538	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11539	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11540	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11541	Note that <tt>Diff_2</tt> in this case will become a base medium
11542	itself since it will no longer be based on any other medium.
11543
11544	Considering the above, all of the following conditions must be met in
11545	order for the merge operation to succeed:
11546	<ul>
11547	<li>
11548	Neither this (source) medium nor any intermediate
11549	differencing medium in the chain between it and the target
11550	medium is attached to any virtual machine.
11551	</li>
11552	<li>
11553	Neither the source medium nor the target medium is an
11554	<link to="MediumType_Immutable"/> medium.
11555	</li>
11556	<li>
11557	The part of the medium tree from the source medium to the
11558	target medium is a linear chain, i.e. all medium in this
11559	chain have exactly one child which is the next medium in this
11560	chain. The only exception from this rule is the target medium in
11561	the forward merge operation; it is allowed to have any number of
11562	child media because the merge operation will not change its
11563	logical contents (as it is seen by the guest OS or by children).
11564	</li>
11565	<li>
11566	None of the involved media are in
11567	<link to="MediumState_LockedRead"/> or
11568	<link to="MediumState_LockedWrite"/> state.
11569	</li>
11570	</ul>
11571
11572	<note>
11573	This (source) medium and all intermediates will be placed to <link
11574	to="MediumState_Deleting"/> state and the target medium will be
11575	placed to <link to="MediumState_LockedWrite"/> state and for the
11576	duration of this operation.
11577	</note>
11578	</desc>
11579	<param name="target" type="IMedium" dir="in">
11580	<desc>Target medium.</desc>
11581	</param>
11582	<param name="progress" type="IProgress" dir="return">
11583	<desc>Progress object to track the operation completion.</desc>
11584	</param>
11585	</method>
11586
11587	<!-- clone method -->
11588
11589	<method name="cloneTo">
11590	<desc>
11591	Starts creating a clone of this medium in the format and at the
11592	location defined by the @a target argument.
11593
11594	The target medium must be either in <link to="MediumState_NotCreated"/>
11595	state (i.e. must not have an existing storage unit) or in
11596	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11597	big enough to hold the data or else the copy will be partial). Upon
11598	successful completion, the cloned medium will contain exactly the
11599	same sector data as the medium being cloned, except that in the
11600	first case a new UUID for the clone will be randomly generated, and in
11601	the second case the UUID will remain unchanged.
11602
11603	The @a parent argument defines which medium will be the parent
11604	of the clone. Passing a @c null reference indicates that the clone will
11605	be a base image, i.e. completely independent. It is possible to specify
11606	an arbitrary medium for this parameter, including the parent of the
11607	medium which is being cloned. Even cloning to a child of the source
11608	medium is possible. Note that when cloning to an existing image, the
11609	@a parent argument is ignored.
11610
11611	After the returned progress object reports that the operation is
11612	successfully complete, the target medium gets remembered by this
11613	VirtualBox installation and may be attached to virtual machines.
11614
11615	<note>
11616	This medium will be placed to <link to="MediumState_LockedRead"/>
11617	state for the duration of this operation.
11618	</note>
11619	<result name="E_NOTIMPL">
11620	The specified cloning variant is not supported at the moment.
11621	</result>
11622	</desc>
11623	<param name="target" type="IMedium" dir="in">
11624	<desc>Target medium.</desc>
11625	</param>
11626	<param name="variant" type="unsigned long" dir="in">
11627	<desc>Exact image variant which should be created (as a combination of
11628	<link to="MediumVariant" /> flags).</desc>
11629	</param>
11630	<param name="parent" type="IMedium" dir="in">
11631	<desc>Parent of the cloned medium.</desc>
11632	</param>
11633	<param name="progress" type="IProgress" dir="return">
11634	<desc>Progress object to track the operation completion.</desc>
11635	</param>
11636	</method>
11637
11638	<!-- other methods -->
11639
11640	<method name="compact">
11641	<desc>
11642	Starts compacting of this medium. This means that the medium is
11643	transformed into a possibly more compact storage representation.
11644	This potentially creates temporary images, which can require a
11645	substantial amount of additional disk space.
11646
11647	This medium will be placed to <link to="MediumState_LockedWrite"/>
11648	state and all its parent media (if any) will be placed to
11649	<link to="MediumState_LockedRead"/> state for the duration of this
11650	operation.
11651
11652	Please note that the results can be either returned straight away,
11653	or later as the result of the background operation via the object
11654	returned via the @a progress parameter.
11655
11656	<result name="VBOX_E_NOT_SUPPORTED">
11657	Medium format does not support compacting (but potentially
11658	needs it).
11659	</result>
11660	</desc>
11661	<param name="progress" type="IProgress" dir="return">
11662	<desc>Progress object to track the operation completion.</desc>
11663	</param>
11664	</method>
11665
11666	<method name="resize">
11667	<desc>
11668	Starts resizing this medium. This means that the nominal size of the
11669	medium is set to the new value. Both increasing and decreasing the
11670	size is possible, and there are no safety checks, since VirtualBox
11671	does not make any assumptions about the medium contents.
11672
11673	Resizing usually needs additional disk space, and possibly also
11674	some temporary disk space. Note that resize does not create a full
11675	temporary copy of the medium, so the additional disk space requirement
11676	is usually much lower than using the clone operation.
11677
11678	This medium will be placed to <link to="MediumState_LockedWrite"/>
11679	state for the duration of this operation.
11680
11681	Please note that the results can be either returned straight away,
11682	or later as the result of the background operation via the object
11683	returned via the @a progress parameter.
11684
11685	<result name="VBOX_E_NOT_SUPPORTED">
11686	Medium format does not support resizing.
11687	</result>
11688	</desc>
11689	<param name="logicalSize" type="long long" dir="in">
11690	<desc>New nominal capacity of the medium in bytes.</desc>
11691	</param>
11692	<param name="progress" type="IProgress" dir="return">
11693	<desc>Progress object to track the operation completion.</desc>
11694	</param>
11695	</method>
11696
11697	<method name="reset">
11698	<desc>
11699	Starts erasing the contents of this differencing medium.
11700
11701	This operation will reset the differencing medium to its initial
11702	state when it does not contain any sector data and any read operation is
11703	redirected to its parent medium. This automatically gets called
11704	during VM power-up for every medium whose <link to="#autoReset" />
11705	attribute is @c true.
11706
11707	The medium will be write-locked for the duration of this operation (see
11708	<link to="#lockWrite" />).
11709
11710	<result name="VBOX_E_NOT_SUPPORTED">
11711	This is not a differencing medium.
11712	</result>
11713	<result name="VBOX_E_INVALID_OBJECT_STATE">
11714	Medium is not in <link to="MediumState_Created"/> or
11715	<link to="MediumState_Inaccessible"/> state.
11716	</result>
11717	</desc>
11718	<param name="progress" type="IProgress" dir="return">
11719	<desc>Progress object to track the operation completion.</desc>
11720	</param>
11721	</method>
11722
11723	</interface>
11724
11725
11726	<!--
11727	// IMediumFormat
11728	/////////////////////////////////////////////////////////////////////////
11729	-->
11730
11731	<enum
11732	name="DataType"
11733	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11734	>
11735	<const name="Int32" value="0"/>
11736	<const name="Int8" value="1"/>
11737	<const name="String" value="2"/>
11738	</enum>
11739
11740	<enum
11741	name="DataFlags"
11742	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11743	>
11744	<const name="None" value="0x00"/>
11745	<const name="Mandatory" value="0x01"/>
11746	<const name="Expert" value="0x02"/>
11747	<const name="Array" value="0x04"/>
11748	<const name="FlagMask" value="0x07"/>
11749	</enum>
11750
11751	<enum
11752	name="MediumFormatCapabilities"
11753	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11754	>
11755	<desc>
11756	Medium format capability flags.
11757	</desc>
11758
11759	<const name="Uuid" value="0x01">
11760	<desc>
11761	Supports UUIDs as expected by VirtualBox code.
11762	</desc>
11763	</const>
11764
11765	<const name="CreateFixed" value="0x02">
11766	<desc>
11767	Supports creating fixed size images, allocating all space instantly.
11768	</desc>
11769	</const>
11770
11771	<const name="CreateDynamic" value="0x04">
11772	<desc>
11773	Supports creating dynamically growing images, allocating space on
11774	demand.
11775	</desc>
11776	</const>
11777
11778	<const name="CreateSplit2G" value="0x08">
11779	<desc>
11780	Supports creating images split in chunks of a bit less than 2 GBytes.
11781	</desc>
11782	</const>
11783
11784	<const name="Differencing" value="0x10">
11785	<desc>
11786	Supports being used as a format for differencing media (see <link
11787	to="IMedium::createDiffStorage"/>).
11788	</desc>
11789	</const>
11790
11791	<const name="Asynchronous" value="0x20">
11792	<desc>
11793	Supports asynchronous I/O operations for at least some configurations.
11794	</desc>
11795	</const>
11796
11797	<const name="File" value="0x40">
11798	<desc>
11799	The format backend operates on files (the <link to="IMedium::location"/>
11800	attribute of the medium specifies a file used to store medium
11801	data; for a list of supported file extensions see
11802	<link to="IMediumFormat::describeFileExtensions"/>).
11803	</desc>
11804	</const>
11805
11806	<const name="Properties" value="0x80">
11807	<desc>
11808	The format backend uses the property interface to configure the storage
11809	location and properties (the <link to="IMediumFormat::describeProperties"/>
11810	method is used to get access to properties supported by the given medium format).
11811	</desc>
11812	</const>
11813
11814	<const name="TcpNetworking" value="0x100">
11815	<desc>
11816	The format backend uses the TCP networking interface for network access.
11817	</desc>
11818	</const>
11819
11820	<const name="VFS" value="0x200">
11821	<desc>
11822	The format backend supports virtual filesystem functionality.
11823	</desc>
11824	</const>
11825
11826	<const name="CapabilityMask" value="0x3FF"/>
11827	</enum>
11828
11829	<interface
11830	name="IMediumFormat" extends="$unknown"
11831	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11832	wsmap="managed"
11833	>
11834	<desc>
11835	The IMediumFormat interface represents a medium format.
11836
11837	Each medium format has an associated backend which is used to handle
11838	media stored in this format. This interface provides information
11839	about the properties of the associated backend.
11840
11841	Each medium format is identified by a string represented by the
11842	<link to="#id"/> attribute. This string is used in calls like
11843	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11844	format.
11845
11846	The list of all supported medium formats can be obtained using
11847	<link to="ISystemProperties::mediumFormats"/>.
11848
11849	<see><link to="IMedium"/></see>
11850	</desc>
11851
11852	<attribute name="id" type="wstring" readonly="yes">
11853	<desc>
11854	Identifier of this format.
11855
11856	The format identifier is a non-@c null non-empty ASCII string. Note that
11857	this string is case-insensitive. This means that, for example, all of
11858	the following strings:
11859	<pre>
11860	"VDI"
11861	"vdi"
11862	"VdI"</pre>
11863	refer to the same medium format.
11864
11865	This string is used in methods of other interfaces where it is necessary
11866	to specify a medium format, such as
11867	<link to="IVirtualBox::createHardDisk"/>.
11868	</desc>
11869	</attribute>
11870
11871	<attribute name="name" type="wstring" readonly="yes">
11872	<desc>
11873	Human readable description of this format.
11874
11875	Mainly for use in file open dialogs.
11876	</desc>
11877	</attribute>
11878
11879	<attribute name="capabilities" type="unsigned long" readonly="yes">
11880	<desc>
11881	Capabilities of the format as a set of bit flags.
11882
11883	For the meaning of individual capability flags see
11884	<link to="MediumFormatCapabilities"/>.
11885	</desc>
11886	</attribute>
11887
11888	<method name="describeFileExtensions">
11889	<desc>
11890	Returns two arrays describing the supported file extensions.
11891
11892	The first array contains the supported extensions and the seconds one
11893	the type each extension supports. Both have the same size.
11894
11895	Note that some backends do not work on files, so this array may be
11896	empty.
11897
11898	<see><link to="IMediumFormat::capabilities"/></see>
11899	</desc>
11900	<param name="extensions" type="wstring" safearray="yes" dir="out">
11901	<desc>The array of supported extensions.</desc>
11902	</param>
11903	<param name="type" type="DeviceType" safearray="yes" dir="out">
11904	<desc>The array which indicates the device type for every given extension.</desc>
11905	</param>
11906	</method>
11907
11908	<method name="describeProperties" const="yes">
11909	<desc>
11910	Returns several arrays describing the properties supported by this
11911	format.
11912
11913	An element with the given index in each array describes one
11914	property. Thus, the number of elements in each returned array is the
11915	same and corresponds to the number of supported properties.
11916
11917	The returned arrays are filled in only if the
11918	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11919	All arguments must be non-@c null.
11920
11921	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11922	</desc>
11923
11924	<param name="names" type="wstring" safearray="yes" dir="out">
11925	<desc>Array of property names.</desc>
11926	</param>
11927	<param name="description" type="wstring" safearray="yes" dir="out">
11928	<desc>Array of property descriptions.</desc>
11929	</param>
11930	<param name="types" type="DataType" safearray="yes" dir="out">
11931	<desc>Array of property types.</desc>
11932	</param>
11933	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11934	<desc>Array of property flags.</desc>
11935	</param>
11936	<param name="defaults" type="wstring" safearray="yes" dir="out">
11937	<desc>Array of default property values.</desc>
11938	</param>
11939	</method>
11940
11941	</interface>
11942
11943
11944	<!--
11945	// IKeyboard
11946	/////////////////////////////////////////////////////////////////////////
11947	-->
11948
11949	<interface
11950	name="IKeyboard" extends="$unknown"
11951	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11952	wsmap="managed"
11953	>
11954	<desc>
11955	The IKeyboard interface represents the virtual machine's keyboard. Used
11956	in <link to="IConsole::keyboard"/>.
11957
11958	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11959	to the virtual machine.
11960
11961	</desc>
11962	<method name="putScancode">
11963	<desc>Sends a scancode to the keyboard.
11964
11965	<result name="VBOX_E_IPRT_ERROR">
11966	Could not send scan code to virtual keyboard.
11967	</result>
11968
11969	</desc>
11970	<param name="scancode" type="long" dir="in"/>
11971	</method>
11972
11973	<method name="putScancodes">
11974	<desc>Sends an array of scancodes to the keyboard.
11975
11976	<result name="VBOX_E_IPRT_ERROR">
11977	Could not send all scan codes to virtual keyboard.
11978	</result>
11979
11980	</desc>
11981	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11982	<param name="codesStored" type="unsigned long" dir="return"/>
11983	</method>
11984
11985	<method name="putCAD">
11986	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11987	function is nothing special, it is just a convenience function
11988	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11989
11990	<result name="VBOX_E_IPRT_ERROR">
11991	Could not send all scan codes to virtual keyboard.
11992	</result>
11993
11994	</desc>
11995	</method>
11996
11997	<attribute name="eventSource" type="IEventSource" readonly="yes">
11998	<desc>
11999	Event source for keyboard events.
12000	</desc>
12001	</attribute>
12002
12003	</interface>
12004
12005
12006	<!--
12007	// IMouse
12008	/////////////////////////////////////////////////////////////////////////
12009	-->
12010
12011	<enum
12012	name="MouseButtonState"
12013	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
12014	>
12015	<desc>
12016	Mouse button state.
12017	</desc>
12018
12019	<const name="LeftButton" value="0x01"/>
12020	<const name="RightButton" value="0x02"/>
12021	<const name="MiddleButton" value="0x04"/>
12022	<const name="WheelUp" value="0x08"/>
12023	<const name="WheelDown" value="0x10"/>
12024	<const name="XButton1" value="0x20"/>
12025	<const name="XButton2" value="0x40"/>
12026	<const name="MouseStateMask" value="0x7F"/>
12027	</enum>
12028
12029	<interface
12030	name="IMouse" extends="$unknown"
12031	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
12032	wsmap="managed"
12033	>
12034	<desc>
12035	The IMouse interface represents the virtual machine's mouse. Used in
12036	<link to="IConsole::mouse"/>.
12037
12038	Through this interface, the virtual machine's virtual mouse can be
12039	controlled.
12040	</desc>
12041
12042	<attribute name="absoluteSupported" type="boolean" readonly="yes">
12043	<desc>
12044	Whether the guest OS supports absolute mouse pointer positioning
12045	or not.
12046	<note>
12047	You can use the <link to="IMouseCapabilityChangedEvent"/>
12048	event to be instantly informed about changes of this attribute
12049	during virtual machine execution.
12050	</note>
12051	<see><link to="#putMouseEventAbsolute"/></see>
12052	</desc>
12053	</attribute>
12054
12055	<attribute name="relativeSupported" type="boolean" readonly="yes">
12056	<desc>
12057	Whether the guest OS supports relative mouse pointer positioning
12058	or not.
12059	<note>
12060	You can use the <link to="IMouseCapabilityChangedEvent"/>
12061	event to be instantly informed about changes of this attribute
12062	during virtual machine execution.
12063	</note>
12064	<see><link to="#putMouseEvent"/></see>
12065	</desc>
12066	</attribute>
12067
12068	<attribute name="needsHostCursor" type="boolean" readonly="yes">
12069	<desc>
12070	Whether the guest OS can currently switch to drawing it's own mouse
12071	cursor on demand.
12072	<note>
12073	You can use the <link to="IMouseCapabilityChangedEvent"/>
12074	event to be instantly informed about changes of this attribute
12075	during virtual machine execution.
12076	</note>
12077	<see><link to="#putMouseEvent"/></see>
12078	</desc>
12079	</attribute>
12080
12081	<method name="putMouseEvent">
12082	<desc>
12083	Initiates a mouse event using relative pointer movements
12084	along x and y axis.
12085
12086	<result name="E_ACCESSDENIED">
12087	Console not powered up.
12088	</result>
12089	<result name="VBOX_E_IPRT_ERROR">
12090	Could not send mouse event to virtual mouse.
12091	</result>
12092
12093	</desc>
12094
12095	<param name="dx" type="long" dir="in">
12096	<desc>
12097	Amount of pixels the mouse should move to the right.
12098	Negative values move the mouse to the left.
12099	</desc>
12100	</param>
12101	<param name="dy" type="long" dir="in">
12102	<desc>
12103	Amount of pixels the mouse should move downwards.
12104	Negative values move the mouse upwards.
12105	</desc>
12106	</param>
12107	<param name="dz" type="long" dir="in">
12108	<desc>
12109	Amount of mouse wheel moves.
12110	Positive values describe clockwise wheel rotations,
12111	negative values describe counterclockwise rotations.
12112	</desc>
12113	</param>
12114	<param name="dw" type="long" dir="in">
12115	<desc>
12116	Amount of horizontal mouse wheel moves.
12117	Positive values describe a movement to the left,
12118	negative values describe a movement to the right.
12119	</desc>
12120	</param>
12121	<param name="buttonState" type="long" dir="in">
12122	<desc>
12123	The current state of mouse buttons. Every bit represents
12124	a mouse button as follows:
12125	<table>
12126	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12127	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12128	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12129	</table>
12130	A value of <tt>1</tt> means the corresponding button is pressed.
12131	otherwise it is released.
12132	</desc>
12133	</param>
12134	</method>
12135
12136	<method name="putMouseEventAbsolute">
12137	<desc>
12138	Positions the mouse pointer using absolute x and y coordinates.
12139	These coordinates are expressed in pixels and
12140	start from <tt>[1,1]</tt> which corresponds to the top left
12141	corner of the virtual display.
12142
12143	<result name="E_ACCESSDENIED">
12144	Console not powered up.
12145	</result>
12146	<result name="VBOX_E_IPRT_ERROR">
12147	Could not send mouse event to virtual mouse.
12148	</result>
12149
12150	<note>
12151	This method will have effect only if absolute mouse
12152	positioning is supported by the guest OS.
12153	</note>
12154
12155	<see><link to="#absoluteSupported"/></see>
12156	</desc>
12157
12158	<param name="x" type="long" dir="in">
12159	<desc>
12160	X coordinate of the pointer in pixels, starting from @c 1.
12161	</desc>
12162	</param>
12163	<param name="y" type="long" dir="in">
12164	<desc>
12165	Y coordinate of the pointer in pixels, starting from @c 1.
12166	</desc>
12167	</param>
12168	<param name="dz" type="long" dir="in">
12169	<desc>
12170	Amount of mouse wheel moves.
12171	Positive values describe clockwise wheel rotations,
12172	negative values describe counterclockwise rotations.
12173	</desc>
12174	</param>
12175	<param name="dw" type="long" dir="in">
12176	<desc>
12177	Amount of horizontal mouse wheel moves.
12178	Positive values describe a movement to the left,
12179	negative values describe a movement to the right.
12180	</desc>
12181	</param>
12182	<param name="buttonState" type="long" dir="in">
12183	<desc>
12184	The current state of mouse buttons. Every bit represents
12185	a mouse button as follows:
12186	<table>
12187	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12188	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12189	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12190	</table>
12191	A value of @c 1 means the corresponding button is pressed.
12192	otherwise it is released.
12193	</desc>
12194	</param>
12195	</method>
12196
12197	<attribute name="eventSource" type="IEventSource" readonly="yes">
12198	<desc>
12199	Event source for mouse events.
12200	</desc>
12201	</attribute>
12202
12203	</interface>
12204
12205	<!--
12206	// IDisplay
12207	/////////////////////////////////////////////////////////////////////////
12208	-->
12209
12210	<enum
12211	name="FramebufferPixelFormat"
12212	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12213	>
12214	<desc>
12215	Format of the video memory buffer. Constants represented by this enum can
12216	be used to test for particular values of <link
12217	to="IFramebuffer::pixelFormat"/>. See also <link
12218	to="IFramebuffer::requestResize"/>.
12219
12220	See also www.fourcc.org for more information about FOURCC pixel formats.
12221	</desc>
12222
12223	<const name="Opaque" value="0">
12224	<desc>
12225	Unknown buffer format (the user may not assume any particular format of
12226	the buffer).
12227	</desc>
12228	</const>
12229	<const name="FOURCC_RGB" value="0x32424752">
12230	<desc>
12231	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12232	bit layout).
12233	</desc>
12234	</const>
12235	</enum>
12236
12237	<interface
12238	name="IFramebuffer" extends="$unknown"
12239	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12240	wsmap="suppress"
12241	>
12242	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12243	<desc>Address of the start byte of the frame buffer.</desc>
12244	</attribute>
12245
12246	<attribute name="width" type="unsigned long" readonly="yes">
12247	<desc>Frame buffer width, in pixels.</desc>
12248	</attribute>
12249
12250	<attribute name="height" type="unsigned long" readonly="yes">
12251	<desc>Frame buffer height, in pixels.</desc>
12252	</attribute>
12253
12254	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12255	<desc>
12256	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12257	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12258	are: 8, 15, 16, 24 and 32.
12259	</desc>
12260	</attribute>
12261
12262	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12263	<desc>
12264	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12265	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12266	size of the scan line must be aligned to 32 bits.
12267	</desc>
12268	</attribute>
12269
12270	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12271	<desc>
12272	Frame buffer pixel format. It's either one of the values defined by <link
12273	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12274	<note>
12275	This attribute must never return <link
12276	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12277	<link to="#address"/> points to must be always known.
12278	</note>
12279	</desc>
12280	</attribute>
12281
12282	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12283	<desc>
12284	Defines whether this frame buffer uses the virtual video card's memory
12285	buffer (guest VRAM) directly or not. See <link
12286	to="IFramebuffer::requestResize"/> for more information.
12287	</desc>
12288	</attribute>
12289
12290	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12291	<desc>
12292	Hint from the frame buffer about how much of the standard
12293	screen height it wants to use for itself. This information is
12294	exposed to the guest through the VESA BIOS and VMMDev interface
12295	so that it can use it for determining its video mode table. It
12296	is not guaranteed that the guest respects the value.
12297	</desc>
12298	</attribute>
12299
12300	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12301	<desc>
12302	An alpha-blended overlay which is superposed over the frame buffer.
12303	The initial purpose is to allow the display of icons providing
12304	information about the VM state, including disk activity, in front
12305	ends which do not have other means of doing that. The overlay is
12306	designed to controlled exclusively by IDisplay. It has no locking
12307	of its own, and any changes made to it are not guaranteed to be
12308	visible until the affected portion of IFramebuffer is updated. The
12309	overlay can be created lazily the first time it is requested. This
12310	attribute can also return @c null to signal that the overlay is not
12311	implemented.
12312	</desc>
12313	</attribute>
12314
12315	<attribute name="winId" type="long long" readonly="yes">
12316	<desc>
12317	Platform-dependent identifier of the window where context of this
12318	frame buffer is drawn, or zero if there's no such window.
12319	</desc>
12320	</attribute>
12321
12322	<method name="lock">
12323	<desc>
12324	Locks the frame buffer.
12325	Gets called by the IDisplay object where this frame buffer is
12326	bound to.
12327	</desc>
12328	</method>
12329
12330	<method name="unlock">
12331	<desc>
12332	Unlocks the frame buffer.
12333	Gets called by the IDisplay object where this frame buffer is
12334	bound to.
12335	</desc>
12336	</method>
12337
12338	<method name="notifyUpdate">
12339	<desc>
12340	Informs about an update.
12341	Gets called by the display object where this buffer is
12342	registered.
12343	</desc>
12344	<param name="x" type="unsigned long" dir="in"/>
12345	<param name="y" type="unsigned long" dir="in"/>
12346	<param name="width" type="unsigned long" dir="in"/>
12347	<param name="height" type="unsigned long" dir="in"/>
12348	</method>
12349
12350	<method name="requestResize">
12351	<desc>
12352	Requests a size and pixel format change.
12353
12354	There are two modes of working with the video buffer of the virtual
12355	machine. The <i>indirect</i> mode implies that the IFramebuffer
12356	implementation allocates a memory buffer for the requested display mode
12357	and provides it to the virtual machine. In <i>direct</i> mode, the
12358	IFramebuffer implementation uses the memory buffer allocated and owned
12359	by the virtual machine. This buffer represents the video memory of the
12360	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12361	usually faster because the implementation gets a raw pointer to the
12362	guest VRAM buffer which it can directly use for visualizing the contents
12363	of the virtual display, as opposed to the indirect mode where the
12364	contents of guest VRAM are copied to the memory buffer provided by
12365	the implementation every time a display update occurs.
12366
12367	It is important to note that the direct mode is really fast only when
12368	the implementation uses the given guest VRAM buffer directly, for
12369	example, by blitting it to the window representing the virtual machine's
12370	display, which saves at least one copy operation comparing to the
12371	indirect mode. However, using the guest VRAM buffer directly is not
12372	always possible: the format and the color depth of this buffer may be
12373	not supported by the target window, or it may be unknown (opaque) as in
12374	case of text or non-linear multi-plane VGA video modes. In this case,
12375	the indirect mode (that is always available) should be used as a
12376	fallback: when the guest VRAM contents are copied to the
12377	implementation-provided memory buffer, color and format conversion is
12378	done automatically by the underlying code.
12379
12380	The @a pixelFormat parameter defines whether the direct mode is
12381	available or not. If @a pixelFormat is <link
12382	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12383	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12384	@a bytesPerLine parameters must be ignored and the implementation must use
12385	the indirect mode (where it provides its own buffer in one of the
12386	supported formats). In all other cases, @a pixelFormat together with
12387	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12388	buffer pointed to by the @a VRAM parameter and the implementation is
12389	free to choose which mode to use. To indicate that this frame buffer uses
12390	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12391	attribute must return @c true and <link to="#address"/> must
12392	return exactly the same address that is passed in the @a VRAM parameter
12393	of this method; otherwise it is assumed that the indirect strategy is
12394	chosen.
12395
12396	The @a width and @a height parameters represent the size of the
12397	requested display mode in both modes. In case of indirect mode, the
12398	provided memory buffer should be big enough to store data of the given
12399	display mode. In case of direct mode, it is guaranteed that the given
12400	@a VRAM buffer contains enough space to represent the display mode of the
12401	given size. Note that this frame buffer's <link to="#width"/> and <link
12402	to="#height"/> attributes must return exactly the same values as
12403	passed to this method after the resize is completed (see below).
12404
12405	The @a finished output parameter determines if the implementation has
12406	finished resizing the frame buffer or not. If, for some reason, the
12407	resize cannot be finished immediately during this call, @a finished
12408	must be set to @c false, and the implementation must call
12409	<link to="IDisplay::resizeCompleted"/> after it has returned from
12410	this method as soon as possible. If @a finished is @c false, the
12411	machine will not call any frame buffer methods until
12412	<link to="IDisplay::resizeCompleted"/> is called.
12413
12414	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12415	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12416	this frame buffer must return exactly the same values as specified in the
12417	parameters of this method, after the resize is completed. If the
12418	indirect mode is chosen, these attributes must return values describing
12419	the format of the implementation's own memory buffer <link
12420	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12421	value must always correlate with <link to="#pixelFormat"/>. Note that
12422	the <link to="#pixelFormat"/> attribute must never return <link
12423	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12424
12425	<note>
12426	This method is called by the IDisplay object under the
12427	<link to="#lock"/> provided by this IFramebuffer
12428	implementation. If this method returns @c false in @a finished, then
12429	this lock is not released until
12430	<link to="IDisplay::resizeCompleted"/> is called.
12431	</note>
12432	</desc>
12433	<param name="screenId" type="unsigned long" dir="in">
12434	<desc>
12435	Logical screen number. Must be used in the corresponding call to
12436	<link to="IDisplay::resizeCompleted"/> if this call is made.
12437	</desc>
12438	</param>
12439	<param name="pixelFormat" type="unsigned long" dir="in">
12440	<desc>
12441	Pixel format of the memory buffer pointed to by @a VRAM.
12442	See also <link to="FramebufferPixelFormat"/>.
12443	</desc>
12444	</param>
12445	<param name="VRAM" type="octet" mod="ptr" dir="in">
12446	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12447	</param>
12448	<param name="bitsPerPixel" type="unsigned long" dir="in">
12449	<desc>Color depth, bits per pixel.</desc>
12450	</param>
12451	<param name="bytesPerLine" type="unsigned long" dir="in">
12452	<desc>Size of one scan line, in bytes.</desc>
12453	</param>
12454	<param name="width" type="unsigned long" dir="in">
12455	<desc>Width of the guest display, in pixels.</desc>
12456	</param>
12457	<param name="height" type="unsigned long" dir="in">
12458	<desc>Height of the guest display, in pixels.</desc>
12459	</param>
12460	<param name="finished" type="boolean" dir="return">
12461	<desc>
12462	Can the VM start using the new frame buffer immediately
12463	after this method returns or it should wait for
12464	<link to="IDisplay::resizeCompleted"/>.
12465	</desc>
12466	</param>
12467	</method>
12468
12469	<method name="videoModeSupported">
12470	<desc>
12471	Returns whether the frame buffer implementation is willing to
12472	support a given video mode. In case it is not able to render
12473	the video mode (or for some reason not willing), it should
12474	return @c false. Usually this method is called when the guest
12475	asks the VMM device whether a given video mode is supported
12476	so the information returned is directly exposed to the guest.
12477	It is important that this method returns very quickly.
12478	</desc>
12479	<param name="width" type="unsigned long" dir="in"/>
12480	<param name="height" type="unsigned long" dir="in"/>
12481	<param name="bpp" type="unsigned long" dir="in"/>
12482	<param name="supported" type="boolean" dir="return"/>
12483	</method>
12484
12485	<method name="getVisibleRegion">
12486	<desc>
12487	Returns the visible region of this frame buffer.
12488
12489	If the @a rectangles parameter is @c null then the value of the
12490	@a count parameter is ignored and the number of elements necessary to
12491	describe the current visible region is returned in @a countCopied.
12492
12493	If @a rectangles is not @c null but @a count is less
12494	than the required number of elements to store region data, the method
12495	will report a failure. If @a count is equal or greater than the
12496	required number of elements, then the actual number of elements copied
12497	to the provided array will be returned in @a countCopied.
12498
12499	<note>
12500	The address of the provided array must be in the process space of
12501	this IFramebuffer object.
12502	</note>
12503	<note>
12504	Method not yet implemented.
12505	</note>
12506	</desc>
12507	<param name="rectangles" type="octet" mod="ptr" dir="in">
12508	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12509	</param>
12510	<param name="count" type="unsigned long" dir="in">
12511	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12512	</param>
12513	<param name="countCopied" type="unsigned long" dir="return">
12514	<desc>Number of elements copied to the @a rectangles array.</desc>
12515	</param>
12516	</method>
12517
12518	<method name="setVisibleRegion">
12519	<desc>
12520	Suggests a new visible region to this frame buffer. This region
12521	represents the area of the VM display which is a union of regions of
12522	all top-level windows of the guest operating system running inside the
12523	VM (if the Guest Additions for this system support this
12524	functionality). This information may be used by the frontends to
12525	implement the seamless desktop integration feature.
12526
12527	<note>
12528	The address of the provided array must be in the process space of
12529	this IFramebuffer object.
12530	</note>
12531	<note>
12532	The IFramebuffer implementation must make a copy of the provided
12533	array of rectangles.
12534	</note>
12535	<note>
12536	Method not yet implemented.
12537	</note>
12538	</desc>
12539	<param name="rectangles" type="octet" mod="ptr" dir="in">
12540	<desc>Pointer to the @c RTRECT array.</desc>
12541	</param>
12542	<param name="count" type="unsigned long" dir="in">
12543	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12544	</param>
12545	</method>
12546
12547	<method name="processVHWACommand">
12548	<desc>
12549	Posts a Video HW Acceleration Command to the frame buffer for processing.
12550	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12551	are posted from quest to the host to be processed by the host hardware.
12552
12553	<note>
12554	The address of the provided command must be in the process space of
12555	this IFramebuffer object.
12556	</note>
12557	</desc>
12558
12559	<param name="command" type="octet" mod="ptr" dir="in">
12560	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12561	</param>
12562	</method>
12563
12564	</interface>
12565
12566	<interface
12567	name="IFramebufferOverlay" extends="IFramebuffer"
12568	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12569	wsmap="suppress"
12570	>
12571	<desc>
12572	The IFramebufferOverlay interface represents an alpha blended overlay
12573	for displaying status icons above an IFramebuffer. It is always created
12574	not visible, so that it must be explicitly shown. It only covers a
12575	portion of the IFramebuffer, determined by its width, height and
12576	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12577	that order) format, and may be written to directly. Do re-read the
12578	width though, after setting it, as it may be adjusted (increased) to
12579	make it more suitable for the front end.
12580	</desc>
12581	<attribute name="x" type="unsigned long" readonly="yes">
12582	<desc>X position of the overlay, relative to the frame buffer.</desc>
12583	</attribute>
12584
12585	<attribute name="y" type="unsigned long" readonly="yes">
12586	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12587	</attribute>
12588
12589	<attribute name="visible" type="boolean" readonly="no">
12590	<desc>
12591	Whether the overlay is currently visible.
12592	</desc>
12593	</attribute>
12594
12595	<attribute name="alpha" type="unsigned long" readonly="no">
12596	<desc>
12597	The global alpha value for the overlay. This may or may not be
12598	supported by a given front end.
12599	</desc>
12600	</attribute>
12601
12602	<method name="move">
12603	<desc>
12604	Changes the overlay's position relative to the IFramebuffer.
12605	</desc>
12606	<param name="x" type="unsigned long" dir="in"/>
12607	<param name="y" type="unsigned long" dir="in"/>
12608	</method>
12609
12610	</interface>
12611
12612	<interface
12613	name="IDisplay" extends="$unknown"
12614	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12615	wsmap="managed"
12616	>
12617	<desc>
12618	The IDisplay interface represents the virtual machine's display.
12619
12620	The object implementing this interface is contained in each
12621	<link to="IConsole::display"/> attribute and represents the visual
12622	output of the virtual machine.
12623
12624	The virtual display supports pluggable output targets represented by the
12625	IFramebuffer interface. Examples of the output target are a window on
12626	the host computer or an RDP session's display on a remote computer.
12627	</desc>
12628	<method name="getScreenResolution">
12629	<desc>Queries display width, height and color depth for given screen.</desc>
12630	<param name="screenId" type="unsigned long" dir="in"/>
12631	<param name="width" type="unsigned long" dir="out"/>
12632	<param name="height" type="unsigned long" dir="out"/>
12633	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12634	</method>
12635
12636	<method name="setFramebuffer">
12637	<desc>
12638	Sets the framebuffer for given screen.
12639	</desc>
12640	<param name="screenId" type="unsigned long" dir="in"/>
12641	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12642	</method>
12643
12644	<method name="getFramebuffer">
12645	<desc>
12646	Queries the framebuffer for given screen.
12647	</desc>
12648	<param name="screenId" type="unsigned long" dir="in"/>
12649	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12650	<param name="xOrigin" type="long" dir="out"/>
12651	<param name="yOrigin" type="long" dir="out"/>
12652	</method>
12653
12654	<method name="setVideoModeHint">
12655	<desc>
12656	Asks VirtualBox to request the given video mode from
12657	the guest. This is just a hint and it cannot be guaranteed
12658	that the requested resolution will be used. Guest Additions
12659	are required for the request to be seen by guests. The caller
12660	should issue the request and wait for a resolution change and
12661	after a timeout retry.
12662
12663	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12664	parameters means that the corresponding values should be taken from the
12665	current video mode (i.e. left unchanged).
12666
12667	If the guest OS supports multi-monitor configuration then the @a display
12668	parameter specifies the number of the guest display to send the hint to:
12669	@c 0 is the primary display, @c 1 is the first secondary and
12670	so on. If the multi-monitor configuration is not supported, @a display
12671	must be @c 0.
12672
12673	<result name="E_INVALIDARG">
12674	The @a display is not associated with any monitor.
12675	</result>
12676
12677	</desc>
12678	<param name="width" type="unsigned long" dir="in"/>
12679	<param name="height" type="unsigned long" dir="in"/>
12680	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12681	<param name="display" type="unsigned long" dir="in"/>
12682	</method>
12683
12684	<method name="setSeamlessMode">
12685	<desc>
12686	Enables or disables seamless guest display rendering (seamless desktop
12687	integration) mode.
12688	<note>
12689	Calling this method has no effect if <link
12690	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12691	does not return @c Active.
12692	</note>
12693	</desc>
12694	<param name="enabled" type="boolean" dir="in"/>
12695	</method>
12696
12697	<method name="takeScreenShot">
12698	<desc>
12699	Takes a screen shot of the requested size and copies it to the
12700	32-bpp buffer allocated by the caller and pointed to by @a address.
12701	A pixel consists of 4 bytes in order: B, G, R, 0.
12702
12703	<note>This API can be used only locally by a VM process through the
12704	COM/XPCOM C++ API as it requires pointer support. It is not
12705	available for scripting langages, Java or any webservice clients.
12706	Unless you are writing a new VM frontend use
12707	<link to="#takeScreenShotToArray" />.
12708	</note>
12709
12710	<result name="E_NOTIMPL">
12711	Feature not implemented.
12712	</result>
12713	<result name="VBOX_E_IPRT_ERROR">
12714	Could not take a screenshot.
12715	</result>
12716
12717	</desc>
12718	<param name="screenId" type="unsigned long" dir="in"/>
12719	<param name="address" type="octet" mod="ptr" dir="in"/>
12720	<param name="width" type="unsigned long" dir="in"/>
12721	<param name="height" type="unsigned long" dir="in"/>
12722	</method>
12723
12724	<method name="takeScreenShotToArray">
12725	<desc>
12726	Takes a guest screen shot of the requested size and returns it as
12727	an array of bytes in uncompressed 32-bit RGBA format.
12728	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12729
12730	This API is slow, but could be the only option to get guest screenshot
12731	for scriptable languages not allowed to manipulate with addresses
12732	directly.
12733
12734	<result name="E_NOTIMPL">
12735	Feature not implemented.
12736	</result>
12737	<result name="VBOX_E_IPRT_ERROR">
12738	Could not take a screenshot.
12739	</result>
12740	</desc>
12741	<param name="screenId" type="unsigned long" dir="in">
12742	<desc>
12743	Monitor to take screenshot from.
12744	</desc>
12745	</param>
12746	<param name="width" type="unsigned long" dir="in">
12747	<desc>
12748	Desired image width.
12749	</desc>
12750	</param>
12751	<param name="height" type="unsigned long" dir="in">
12752	<desc>
12753	Desired image height.
12754	</desc>
12755	</param>
12756	<param name="screenData" type="octet" dir="return" safearray="yes">
12757	<desc>
12758	Array with resulting screen data.
12759	</desc>
12760	</param>
12761	</method>
12762
12763	<method name="takeScreenShotPNGToArray">
12764	<desc>
12765	Takes a guest screen shot of the requested size and returns it as
12766	PNG image in array.
12767
12768	<result name="E_NOTIMPL">
12769	Feature not implemented.
12770	</result>
12771	<result name="VBOX_E_IPRT_ERROR">
12772	Could not take a screenshot.
12773	</result>
12774	</desc>
12775	<param name="screenId" type="unsigned long" dir="in">
12776	<desc>
12777	Monitor to take the screenshot from.
12778	</desc>
12779	</param>
12780	<param name="width" type="unsigned long" dir="in">
12781	<desc>
12782	Desired image width.
12783	</desc>
12784	</param>
12785	<param name="height" type="unsigned long" dir="in">
12786	<desc>
12787	Desired image height.
12788	</desc>
12789	</param>
12790	<param name="screenData" type="octet" dir="return" safearray="yes">
12791	<desc>
12792	Array with resulting screen data.
12793	</desc>
12794	</param>
12795	</method>
12796
12797	<method name="drawToScreen">
12798	<desc>
12799	Draws a 32-bpp image of the specified size from the given buffer
12800	to the given point on the VM display.
12801
12802	<result name="E_NOTIMPL">
12803	Feature not implemented.
12804	</result>
12805	<result name="VBOX_E_IPRT_ERROR">
12806	Could not draw to screen.
12807	</result>
12808
12809	</desc>
12810	<param name="screenId" type="unsigned long" dir="in">
12811	<desc>
12812	Monitor to take the screenshot from.
12813	</desc>
12814	</param>
12815	<param name="address" type="octet" mod="ptr" dir="in">
12816	<desc>
12817	Address to store the screenshot to
12818	</desc>
12819	</param>
12820	<param name="x" type="unsigned long" dir="in">
12821	<desc>
12822	Relative to the screen top left corner.
12823	</desc>
12824	</param>
12825	<param name="y" type="unsigned long" dir="in">
12826	<desc>
12827	Relative to the screen top left corner.
12828	</desc>
12829	</param>
12830	<param name="width" type="unsigned long" dir="in">
12831	<desc>
12832	Desired image width.
12833	</desc>
12834	</param>
12835	<param name="height" type="unsigned long" dir="in">
12836	<desc>
12837	Desired image height.
12838	</desc>
12839	</param>
12840	</method>
12841
12842	<method name="invalidateAndUpdate">
12843	<desc>
12844	Does a full invalidation of the VM display and instructs the VM
12845	to update it.
12846
12847	<result name="VBOX_E_IPRT_ERROR">
12848	Could not invalidate and update screen.
12849	</result>
12850
12851	</desc>
12852	</method>
12853
12854	<method name="resizeCompleted">
12855	<desc>
12856	Signals that a framebuffer has completed the resize operation.
12857
12858	<result name="VBOX_E_NOT_SUPPORTED">
12859	Operation only valid for external frame buffers.
12860	</result>
12861
12862	</desc>
12863	<param name="screenId" type="unsigned long" dir="in"/>
12864	</method>
12865
12866	<method name="completeVHWACommand">
12867	<desc>
12868	Signals that the Video HW Acceleration command has completed.
12869	</desc>
12870
12871	<param name="command" type="octet" mod="ptr" dir="in">
12872	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12873	</param>
12874	</method>
12875
12876	</interface>
12877
12878	<!--
12879	// INetworkAdapter
12880	/////////////////////////////////////////////////////////////////////////
12881	-->
12882
12883	<enum
12884	name="NetworkAttachmentType"
12885	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12886	>
12887	<desc>
12888	Network attachment type.
12889	</desc>
12890
12891	<const name="Null" value="0">
12892	<desc>Null value, also means "not attached".</desc>
12893	</const>
12894	<const name="NAT" value="1"/>
12895	<const name="Bridged" value="2"/>
12896	<const name="Internal" value="3"/>
12897	<const name="HostOnly" value="4"/>
12898	<const name="Generic" value="5"/>
12899	</enum>
12900
12901	<enum
12902	name="NetworkAdapterType"
12903	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12904	>
12905	<desc>
12906	Network adapter type.
12907	</desc>
12908
12909	<const name="Null" value="0">
12910	<desc>Null value (never used by the API).</desc>
12911	</const>
12912	<const name="Am79C970A" value="1">
12913	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12914	</const>
12915	<const name="Am79C973" value="2">
12916	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12917	</const>
12918	<const name="I82540EM" value="3">
12919	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12920	</const>
12921	<const name="I82543GC" value="4">
12922	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12923	</const>
12924	<const name="I82545EM" value="5">
12925	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12926	</const>
12927	<const name="Virtio" value="6">
12928	<desc>Virtio network device.</desc>
12929	</const>
12930	</enum>
12931
12932	<enum
12933	name="NetworkAdapterPromiscModePolicy"
12934	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12935	>
12936	<desc>
12937	The promiscuous mode policy of an interface.
12938	</desc>
12939
12940	<const name="Deny" value="1">
12941	<desc>Deny promiscuous mode requests.</desc>
12942	</const>
12943	<const name="AllowNetwork" value="2">
12944	<desc>
12945	Allow promicuous mode, but restrict the scope it to the internal
12946	network so that it only applies to other VMs.
12947	</desc>
12948	</const>
12949	<const name="AllowAll" value="3">
12950	<desc>
12951	Allow promicuous mode, include unrelated traffic going over the wire
12952	and internally on the host.
12953	</desc>
12954	</const>
12955	</enum>
12956
12957	<interface
12958	name="INetworkAdapter" extends="$unknown"
12959	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12960	wsmap="managed"
12961	>
12962	<desc>
12963	Represents a virtual network adapter that is attached to a virtual machine.
12964	Each virtual machine has a fixed number of network adapter slots with one
12965	instance of this attached to each of them. Call
12966	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12967	is attached to a given slot in a given machine.
12968
12969	Each network adapter can be in one of five attachment modes, which are
12970	represented by the <link to="NetworkAttachmentType" /> enumeration;
12971	see the <link to="#attachmentType" /> attribute.
12972	</desc>
12973
12974	<attribute name="adapterType" type="NetworkAdapterType">
12975	<desc>
12976	Type of the virtual network adapter. Depending on this value,
12977	VirtualBox will provide a different virtual network hardware
12978	to the guest.
12979	</desc>
12980	</attribute>
12981
12982	<attribute name="slot" type="unsigned long" readonly="yes">
12983	<desc>
12984	Slot number this adapter is plugged into. Corresponds to
12985	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12986	to obtain this instance.
12987	</desc>
12988	</attribute>
12989
12990	<attribute name="enabled" type="boolean">
12991	<desc>
12992	Flag whether the network adapter is present in the
12993	guest system. If disabled, the virtual guest hardware will
12994	not contain this network adapter. Can only be changed when
12995	the VM is not running.
12996	</desc>
12997	</attribute>
12998
12999	<attribute name="MACAddress" type="wstring">
13000	<desc>
13001	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
13002	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
13003	</desc>
13004	</attribute>
13005
13006	<attribute name="attachmentType" type="NetworkAttachmentType">
13007	<desc>
13008	Sets/Gets network attachment type of this network adapter.
13009	</desc>
13010	</attribute>
13011
13012	<attribute name="bridgedInterface" type="wstring">
13013	<desc>
13014	Name of the network interface the VM should be bridged to.
13015	</desc>
13016	</attribute>
13017
13018	<attribute name="hostOnlyInterface" type="wstring">
13019	<desc>
13020	Name of the host only network interface the VM is attached to.
13021	</desc>
13022	</attribute>
13023
13024	<attribute name="internalNetwork" type="wstring">
13025	<desc>
13026	Name of the internal network the VM is attached to.
13027	</desc>
13028	</attribute>
13029
13030	<attribute name="NATNetwork" type="wstring">
13031	<desc>
13032	Name of the NAT network the VM is attached to.
13033	</desc>
13034	</attribute>
13035
13036	<attribute name="genericDriver" type="wstring">
13037	<desc>
13038	Name of the driver to use for the "Generic" network attachment type.
13039	</desc>
13040	</attribute>
13041
13042	<attribute name="cableConnected" type="boolean">
13043	<desc>
13044	Flag whether the adapter reports the cable as connected or not.
13045	It can be used to report offline situations to a VM.
13046	</desc>
13047	</attribute>
13048
13049	<attribute name="lineSpeed" type="unsigned long">
13050	<desc>
13051	Line speed reported by custom drivers, in units of 1 kbps.
13052	</desc>
13053	</attribute>
13054
13055	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
13056	<desc>
13057	The promiscuous mode policy of the network adapter when attached to an
13058	internal network, host only network or a bridge.
13059	</desc>
13060	</attribute>
13061
13062	<attribute name="traceEnabled" type="boolean">
13063	<desc>
13064	Flag whether network traffic from/to the network card should be traced.
13065	Can only be toggled when the VM is turned off.
13066	</desc>
13067	</attribute>
13068
13069	<attribute name="traceFile" type="wstring">
13070	<desc>
13071	Filename where a network trace will be stored. If not set, VBox-pid.pcap
13072	will be used.
13073	</desc>
13074	</attribute>
13075
13076	<attribute name="natDriver" type="INATEngine" readonly="yes">
13077	<desc>
13078	Points to the NAT engine which handles the network address translation
13079	for this interface. This is active only when the interface actually uses
13080	NAT.
13081	</desc>
13082	</attribute>
13083
13084	<attribute name="bootPriority" type="unsigned long">
13085	<desc>
13086	Network boot priority of the adapter. Priority 1 is highest. If not set,
13087	the priority is considered to be at the lowest possible setting.
13088	</desc>
13089	</attribute>
13090
13091	<attribute name="bandwidthGroup" type="IBandwidthGroup">
13092	<desc>The bandwidth group this network adapter is assigned to.</desc>
13093	</attribute>
13094
13095	<!-- property methods -->
13096
13097	<method name="getProperty" const="yes">
13098	<desc>
13099	Returns the value of the network attachment property with the given name.
13100
13101	If the requested data @a key does not exist, this function will
13102	succeed and return an empty string in the @a value argument.
13103
13104	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13105	</desc>
13106	<param name="key" type="wstring" dir="in">
13107	<desc>Name of the property to get.</desc>
13108	</param>
13109	<param name="value" type="wstring" dir="return">
13110	<desc>Current property value.</desc>
13111	</param>
13112	</method>
13113
13114	<method name="setProperty">
13115	<desc>
13116	Sets the value of the network attachment property with the given name.
13117
13118	Setting the property value to @c null or an empty string is equivalent
13119	to deleting the existing value.
13120
13121	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13122	</desc>
13123	<param name="key" type="wstring" dir="in">
13124	<desc>Name of the property to set.</desc>
13125	</param>
13126	<param name="value" type="wstring" dir="in">
13127	<desc>Property value to set.</desc>
13128	</param>
13129	</method>
13130
13131	<method name="getProperties" const="yes">
13132	<desc>
13133	Returns values for a group of properties in one call.
13134
13135	The names of the properties to get are specified using the @a names
13136	argument which is a list of comma-separated property names or
13137	an empty string if all properties are to be returned.
13138	<note>Currently the value of this argument is ignored and the method
13139	always returns all existing properties.</note>
13140
13141	The method returns two arrays, the array of property names corresponding
13142	to the @a names argument and the current values of these properties.
13143	Both arrays have the same number of elements with each element at the
13144	given index in the first array corresponds to an element at the same
13145	index in the second array.
13146	</desc>
13147	<param name="names" type="wstring" dir="in">
13148	<desc>
13149	Names of properties to get.
13150	</desc>
13151	</param>
13152	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13153	<desc>Names of returned properties.</desc>
13154	</param>
13155	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13156	<desc>Values of returned properties.</desc>
13157	</param>
13158	</method>
13159
13160	</interface>
13161
13162
13163	<!--
13164	// ISerialPort
13165	/////////////////////////////////////////////////////////////////////////
13166	-->
13167
13168	<enum
13169	name="PortMode"
13170	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13171	>
13172	<desc>
13173	The PortMode enumeration represents possible communication modes for
13174	the virtual serial port device.
13175	</desc>
13176
13177	<const name="Disconnected" value="0">
13178	<desc>Virtual device is not attached to any real host device.</desc>
13179	</const>
13180	<const name="HostPipe" value="1">
13181	<desc>Virtual device is attached to a host pipe.</desc>
13182	</const>
13183	<const name="HostDevice" value="2">
13184	<desc>Virtual device is attached to a host device.</desc>
13185	</const>
13186	<const name="RawFile" value="3">
13187	<desc>Virtual device is attached to a raw file.</desc>
13188	</const>
13189	</enum>
13190
13191	<interface
13192	name="ISerialPort" extends="$unknown"
13193	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13194	wsmap="managed"
13195	>
13196
13197	<desc>
13198	The ISerialPort interface represents the virtual serial port device.
13199
13200	The virtual serial port device acts like an ordinary serial port
13201	inside the virtual machine. This device communicates to the real
13202	serial port hardware in one of two modes: host pipe or host device.
13203
13204	In host pipe mode, the #path attribute specifies the path to the pipe on
13205	the host computer that represents a serial port. The #server attribute
13206	determines if this pipe is created by the virtual machine process at
13207	machine startup or it must already exist before starting machine
13208	execution.
13209
13210	In host device mode, the #path attribute specifies the name of the
13211	serial port device on the host computer.
13212
13213	There is also a third communication mode: the disconnected mode. In this
13214	mode, the guest OS running inside the virtual machine will be able to
13215	detect the serial port, but all port write operations will be discarded
13216	and all port read operations will return no data.
13217
13218	<see><link to="IMachine::getSerialPort"/></see>
13219	</desc>
13220
13221	<attribute name="slot" type="unsigned long" readonly="yes">
13222	<desc>
13223	Slot number this serial port is plugged into. Corresponds to
13224	the value you pass to <link to="IMachine::getSerialPort"/>
13225	to obtain this instance.
13226	</desc>
13227	</attribute>
13228
13229	<attribute name="enabled" type="boolean">
13230	<desc>
13231	Flag whether the serial port is enabled. If disabled,
13232	the serial port will not be reported to the guest OS.
13233	</desc>
13234	</attribute>
13235
13236	<attribute name="IOBase" type="unsigned long">
13237	<desc>Base I/O address of the serial port.</desc>
13238	</attribute>
13239
13240	<attribute name="IRQ" type="unsigned long">
13241	<desc>IRQ number of the serial port.</desc>
13242	</attribute>
13243
13244	<attribute name="hostMode" type="PortMode">
13245	<desc>
13246	How is this port connected to the host.
13247	<note>
13248	Changing this attribute may fail if the conditions for
13249	<link to="#path"/> are not met.
13250	</note>
13251	</desc>
13252	</attribute>
13253
13254	<attribute name="server" type="boolean">
13255	<desc>
13256	Flag whether this serial port acts as a server (creates a new pipe on
13257	the host) or as a client (uses the existing pipe). This attribute is
13258	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13259	</desc>
13260	</attribute>
13261
13262	<attribute name="path" type="wstring">
13263	<desc>
13264	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13265	PortMode_HostPipe, or the host serial device name when
13266	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13267	cases, setting a @c null or empty string as the attribute's value
13268	is an error. Otherwise, the value of this property is ignored.
13269	</desc>
13270	</attribute>
13271
13272	</interface>
13273
13274	<!--
13275	// IParallelPort
13276	/////////////////////////////////////////////////////////////////////////
13277	-->
13278
13279	<interface
13280	name="IParallelPort" extends="$unknown"
13281	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13282	wsmap="managed"
13283	>
13284
13285	<desc>
13286	The IParallelPort interface represents the virtual parallel port device.
13287
13288	The virtual parallel port device acts like an ordinary parallel port
13289	inside the virtual machine. This device communicates to the real
13290	parallel port hardware using the name of the parallel device on the host
13291	computer specified in the #path attribute.
13292
13293	Each virtual parallel port device is assigned a base I/O address and an
13294	IRQ number that will be reported to the guest operating system and used
13295	to operate the given parallel port from within the virtual machine.
13296
13297	<see><link to="IMachine::getParallelPort"/></see>
13298	</desc>
13299
13300	<attribute name="slot" type="unsigned long" readonly="yes">
13301	<desc>
13302	Slot number this parallel port is plugged into. Corresponds to
13303	the value you pass to <link to="IMachine::getParallelPort"/>
13304	to obtain this instance.
13305	</desc>
13306	</attribute>
13307
13308	<attribute name="enabled" type="boolean">
13309	<desc>
13310	Flag whether the parallel port is enabled. If disabled,
13311	the parallel port will not be reported to the guest OS.
13312	</desc>
13313	</attribute>
13314
13315	<attribute name="IOBase" type="unsigned long">
13316	<desc>Base I/O address of the parallel port.</desc>
13317	</attribute>
13318
13319	<attribute name="IRQ" type="unsigned long">
13320	<desc>IRQ number of the parallel port.</desc>
13321	</attribute>
13322
13323	<attribute name="path" type="wstring">
13324	<desc>
13325	Host parallel device name. If this parallel port is enabled, setting a
13326	@c null or an empty string as this attribute's value will result in
13327	an error.
13328	</desc>
13329	</attribute>
13330
13331	</interface>
13332
13333
13334	<!--
13335	// IMachineDebugger
13336	/////////////////////////////////////////////////////////////////////////
13337	-->
13338
13339	<interface
13340	name="IMachineDebugger" extends="$unknown"
13341	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13342	wsmap="suppress"
13343	>
13344	<method name="dumpGuestCore">
13345	<desc>
13346	Takes a core dump of the guest.
13347
13348	See include/VBox/dbgfcorefmt.h for details on the file format.
13349	</desc>
13350	<param name="filename" type="wstring" dir="in">
13351	<desc>
13352	The name of the output file. The file must not exist.
13353	</desc>
13354	</param>
13355	<param name="compression" type="wstring" dir="in">
13356	<desc>
13357	Reserved for future compression method indicator.
13358	</desc>
13359	</param>
13360	</method>
13361
13362	<method name="dumpHostProcessCore">
13363	<desc>
13364	Takes a core dump of the VM process on the host.
13365
13366	This feature is not implemented in the 4.0.0 release but it may show up
13367	in a dot release.
13368	</desc>
13369	<param name="filename" type="wstring" dir="in">
13370	<desc>
13371	The name of the output file. The file must not exist.
13372	</desc>
13373	</param>
13374	<param name="compression" type="wstring" dir="in">
13375	<desc>
13376	Reserved for future compression method indicator.
13377	</desc>
13378	</param>
13379	</method>
13380
13381	<method name="info">
13382	<desc>
13383	Interfaces with the info dumpers (DBGFInfo).
13384
13385	This feature is not implemented in the 4.0.0 release but it may show up
13386	in a dot release.
13387	</desc>
13388	<param name="name" type="wstring" dir="in">
13389	<desc>
13390	The name of the info item.
13391	</desc>
13392	</param>
13393	<param name="args" type="wstring" dir="in">
13394	<desc>
13395	Arguments to the info dumper.
13396	</desc>
13397	</param>
13398	<param name="info" type="wstring" dir="return">
13399	<desc>
13400	The into string.
13401	</desc>
13402	</param>
13403	</method>
13404
13405	<method name="injectNMI">
13406	<desc>
13407	Inject an NMI into a running VT-x/AMD-V VM.
13408	</desc>
13409	</method>
13410
13411	<method name="modifyLogGroups">
13412	<desc>
13413	Modifies the group settings of the debug or release logger.
13414	</desc>
13415	<param name="settings" type="wstring" dir="in">
13416	<desc>
13417	The group settings string. See iprt/log.h for details. To target the
13418	release logger, prefix the string with "release:".
13419	</desc>
13420	</param>
13421	</method>
13422
13423	<method name="modifyLogFlags">
13424	<desc>
13425	Modifies the debug or release logger flags.
13426	</desc>
13427	<param name="settings" type="wstring" dir="in">
13428	<desc>
13429	The flags settings string. See iprt/log.h for details. To target the
13430	release logger, prefix the string with "release:".
13431	</desc>
13432	</param>
13433	</method>
13434
13435	<method name="modifyLogDestinations">
13436	<desc>
13437	Modifies the debug or release logger destinations.
13438	</desc>
13439	<param name="settings" type="wstring" dir="in">
13440	<desc>
13441	The destination settings string. See iprt/log.h for details. To target the
13442	release logger, prefix the string with "release:".
13443	</desc>
13444	</param>
13445	</method>
13446
13447	<method name="readPhysicalMemory">
13448	<desc>
13449	Reads guest physical memory, no side effects (MMIO++).
13450
13451	This feature is not implemented in the 4.0.0 release but may show up
13452	in a dot release.
13453	</desc>
13454	<param name="address" type="long long" dir="in">
13455	<desc>The guest physical address.</desc>
13456	</param>
13457	<param name="size" type="unsigned long" dir="in">
13458	<desc>The number of bytes to read.</desc>
13459	</param>
13460	<param name="bytes" type="octet" safearray="yes" dir="return">
13461	<desc>The bytes read.</desc>
13462	</param>
13463	</method>
13464
13465	<method name="writePhysicalMemory">
13466	<desc>
13467	Writes guest physical memory, access handles (MMIO++) are ignored.
13468
13469	This feature is not implemented in the 4.0.0 release but may show up
13470	in a dot release.
13471	</desc>
13472	<param name="address" type="long long" dir="in">
13473	<desc>The guest physical address.</desc>
13474	</param>
13475	<param name="size" type="unsigned long" dir="in">
13476	<desc>The number of bytes to read.</desc>
13477	</param>
13478	<param name="bytes" type="octet" safearray="yes" dir="in">
13479	<desc>The bytes to write.</desc>
13480	</param>
13481	</method>
13482
13483	<method name="readVirtualMemory">
13484	<desc>
13485	Reads guest virtual memory, no side effects (MMIO++).
13486
13487	This feature is not implemented in the 4.0.0 release but may show up
13488	in a dot release.
13489	</desc>
13490	<param name="cpuId" type="unsigned long" dir="in">
13491	<desc>The identifier of the Virtual CPU.</desc>
13492	</param>
13493	<param name="address" type="long long" dir="in">
13494	<desc>The guest virtual address.</desc>
13495	</param>
13496	<param name="size" type="unsigned long" dir="in">
13497	<desc>The number of bytes to read.</desc>
13498	</param>
13499	<param name="bytes" type="octet" safearray="yes" dir="return">
13500	<desc>The bytes read.</desc>
13501	</param>
13502	</method>
13503
13504	<method name="writeVirtualMemory">
13505	<desc>
13506	Writes guest virtual memory, access handles (MMIO++) are ignored.
13507
13508	This feature is not implemented in the 4.0.0 release but may show up
13509	in a dot release.
13510	</desc>
13511	<param name="cpuId" type="unsigned long" dir="in">
13512	<desc>The identifier of the Virtual CPU.</desc>
13513	</param>
13514	<param name="address" type="long long" dir="in">
13515	<desc>The guest virtual address.</desc>
13516	</param>
13517	<param name="size" type="unsigned long" dir="in">
13518	<desc>The number of bytes to read.</desc>
13519	</param>
13520	<param name="bytes" type="octet" safearray="yes" dir="in">
13521	<desc>The bytes to write.</desc>
13522	</param>
13523	</method>
13524
13525	<method name="detectOS">
13526	<desc>
13527	Tries to (re-)detect the guest OS kernel.
13528
13529	This feature is not implemented in the 4.0.0 release but may show up
13530	in a dot release.
13531	</desc>
13532	<param name="os" type="wstring" dir="return">
13533	<desc>
13534	The detected OS kernel on success.
13535	</desc>
13536	</param>
13537	</method>
13538
13539	<method name="getRegister">
13540	<desc>
13541	Gets one register.
13542
13543	This feature is not implemented in the 4.0.0 release but may show up
13544	in a dot release.
13545	</desc>
13546	<param name="cpuId" type="unsigned long" dir="in">
13547	<desc>The identifier of the Virtual CPU.</desc>
13548	</param>
13549	<param name="name" type="wstring" dir="in">
13550	<desc>The register name, case is ignored.</desc>
13551	</param>
13552	<param name="value" type="wstring" dir="return">
13553	<desc>
13554	The register value. This is usually a hex value (always 0x prefixed)
13555	but other format may be used for floating point registers (TBD).
13556	</desc>
13557	</param>
13558	</method>
13559
13560	<method name="getRegisters">
13561	<desc>
13562	Gets all the registers for the given CPU.
13563
13564	This feature is not implemented in the 4.0.0 release but may show up
13565	in a dot release.
13566	</desc>
13567	<param name="cpuId" type="unsigned long" dir="in">
13568	<desc>The identifier of the Virtual CPU.</desc>
13569	</param>
13570	<param name="names" type="wstring" dir="out" safearray="yes">
13571	<desc>Array containing the lowercase register names.</desc>
13572	</param>
13573	<param name="values" type="wstring" dir="out" safearray="yes">
13574	<desc>
13575	Array paralell to the names holding the register values as if the
13576	register was returned by <link to="IMachineDebugger::getRegister"/>.
13577	</desc>
13578	</param>
13579	</method>
13580
13581	<method name="setRegister">
13582	<desc>
13583	Gets one register.
13584
13585	This feature is not implemented in the 4.0.0 release but may show up
13586	in a dot release.
13587	</desc>
13588	<param name="cpuId" type="unsigned long" dir="in">
13589	<desc>The identifier of the Virtual CPU.</desc>
13590	</param>
13591	<param name="name" type="wstring" dir="in">
13592	<desc>The register name, case is ignored.</desc>
13593	</param>
13594	<param name="value" type="wstring" dir="in">
13595	<desc>
13596	The new register value. Hexadecimal, decimal and octal formattings
13597	are supported in addition to any special formattings returned by
13598	the getters.
13599	</desc>
13600	</param>
13601	</method>
13602
13603	<method name="setRegisters">
13604	<desc>
13605	Sets zero or more registers atomically.
13606
13607	This feature is not implemented in the 4.0.0 release but may show up
13608	in a dot release.
13609	</desc>
13610	<param name="cpuId" type="unsigned long" dir="in">
13611	<desc>The identifier of the Virtual CPU.</desc>
13612	</param>
13613	<param name="names" type="wstring" dir="in" safearray="yes">
13614	<desc>Array containing the register names, case ignored.</desc>
13615	</param>
13616	<param name="values" type="wstring" dir="in" safearray="yes">
13617	<desc>
13618	Array paralell to the names holding the register values. See
13619	<link to="IMachineDebugger::setRegister"/> for formatting
13620	guidelines.
13621	</desc>
13622	</param>
13623	</method>
13624
13625	<method name="dumpGuestStack">
13626	<desc>
13627	Produce a simple stack dump using the current guest state.
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	<param name="cpuId" type="unsigned long" dir="in">
13633	<desc>The identifier of the Virtual CPU.</desc>
13634	</param>
13635	<param name="stack" type="wstring" dir="return">
13636	<desc>String containing the formatted stack dump.</desc>
13637	</param>
13638	</method>
13639
13640	<method name="resetStats">
13641	<desc>
13642	Reset VM statistics.
13643	</desc>
13644	<param name="pattern" type="wstring" dir="in">
13645	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13646	</param>
13647	</method>
13648
13649	<method name="dumpStats">
13650	<desc>
13651	Dumps VM statistics.
13652	</desc>
13653	<param name="pattern" type="wstring" dir="in">
13654	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13655	</param>
13656	</method>
13657
13658	<method name="getStats">
13659	<desc>
13660	Get the VM statistics in a XMLish format.
13661	</desc>
13662	<param name="pattern" type="wstring" dir="in">
13663	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13664	</param>
13665	<param name="withDescriptions" type="boolean" dir="in">
13666	<desc>Whether to include the descriptions.</desc>
13667	</param>
13668	<param name="stats" type="wstring" dir="out">
13669	<desc>The XML document containing the statistics.</desc>
13670	</param>
13671	</method>
13672
13673	<attribute name="singleStep" type="boolean">
13674	<desc>Switch for enabling single-stepping.</desc>
13675	</attribute>
13676
13677	<attribute name="recompileUser" type="boolean">
13678	<desc>Switch for forcing code recompilation for user mode code.</desc>
13679	</attribute>
13680
13681	<attribute name="recompileSupervisor" type="boolean">
13682	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13683	</attribute>
13684
13685	<attribute name="PATMEnabled" type="boolean">
13686	<desc>Switch for enabling and disabling the PATM component.</desc>
13687	</attribute>
13688
13689	<attribute name="CSAMEnabled" type="boolean">
13690	<desc>Switch for enabling and disabling the CSAM component.</desc>
13691	</attribute>
13692
13693	<attribute name="logEnabled" type="boolean">
13694	<desc>Switch for enabling and disabling the debug logger.</desc>
13695	</attribute>
13696
13697	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13698	<desc>The debug logger flags.</desc>
13699	</attribute>
13700
13701	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13702	<desc>The debug logger's group settings.</desc>
13703	</attribute>
13704
13705	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13706	<desc>The debug logger's destination settings.</desc>
13707	</attribute>
13708
13709	<attribute name="logRelFlags" type="wstring" readonly="yes">
13710	<desc>The release logger flags.</desc>
13711	</attribute>
13712
13713	<attribute name="logRelGroups" type="wstring" readonly="yes">
13714	<desc>The release logger's group settings.</desc>
13715	</attribute>
13716
13717	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13718	<desc>The relase logger's destination settings.</desc>
13719	</attribute>
13720
13721	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13722	<desc>
13723	Flag indicating whether the VM is currently making use of CPU hardware
13724	virtualization extensions.
13725	</desc>
13726	</attribute>
13727
13728	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13729	<desc>
13730	Flag indicating whether the VM is currently making use of the nested paging
13731	CPU hardware virtualization extension.
13732	</desc>
13733	</attribute>
13734
13735	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13736	<desc>
13737	Flag indicating whether the VM is currently making use of the VPID
13738	VT-x extension.
13739	</desc>
13740	</attribute>
13741
13742	<attribute name="OSName" type="wstring" readonly="yes">
13743	<desc>
13744	Query the guest OS kernel name as detected by the DBGF.
13745
13746	This feature is not implemented in the 4.0.0 release but may show up
13747	in a dot release.
13748	</desc>
13749	</attribute>
13750
13751	<attribute name="OSVersion" type="wstring" readonly="yes">
13752	<desc>
13753	Query the guest OS kernel version string as detected by the DBGF.
13754
13755	This feature is not implemented in the 4.0.0 release but may show up
13756	in a dot release.
13757	</desc>
13758	</attribute>
13759
13760	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13761	<desc>
13762	Flag indicating whether the VM is currently making use of the Physical
13763	Address Extension CPU feature.
13764	</desc>
13765	</attribute>
13766
13767	<attribute name="virtualTimeRate" type="unsigned long">
13768	<desc>
13769	The rate at which the virtual time runs expressed as a percentage.
13770	The accepted range is 2% to 20000%.
13771	</desc>
13772	</attribute>
13773
13774	<attribute name="VM" type="long long" readonly="yes">
13775	<desc>
13776	Gets the VM handle. This is only for internal use while
13777	we carve the details of this interface.
13778	</desc>
13779	</attribute>
13780
13781	</interface>
13782
13783	<!--
13784	// IUSBController
13785	/////////////////////////////////////////////////////////////////////////
13786	-->
13787
13788	<interface
13789	name="IUSBController" extends="$unknown"
13790	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13791	wsmap="managed"
13792	>
13793	<attribute name="enabled" type="boolean">
13794	<desc>
13795	Flag whether the USB controller is present in the
13796	guest system. If disabled, the virtual guest hardware will
13797	not contain any USB controller. Can only be changed when
13798	the VM is powered off.
13799	</desc>
13800	</attribute>
13801
13802	<attribute name="enabledEhci" type="boolean">
13803	<desc>
13804	Flag whether the USB EHCI controller is present in the
13805	guest system. If disabled, the virtual guest hardware will
13806	not contain a USB EHCI controller. Can only be changed when
13807	the VM is powered off.
13808	</desc>
13809	</attribute>
13810
13811	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13812	<desc>
13813	Flag whether there is an USB proxy available.
13814	</desc>
13815	</attribute>
13816
13817	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13818	<desc>
13819	USB standard version which the controller implements.
13820	This is a BCD which means that the major version is in the
13821	high byte and minor version is in the low byte.
13822	</desc>
13823	</attribute>
13824
13825	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13826	<desc>
13827	List of USB device filters associated with the machine.
13828
13829	If the machine is currently running, these filters are activated
13830	every time a new (supported) USB device is attached to the host
13831	computer that was not ignored by global filters
13832	(<link to="IHost::USBDeviceFilters"/>).
13833
13834	These filters are also activated when the machine is powered up.
13835	They are run against a list of all currently available USB
13836	devices (in states
13837	<link to="USBDeviceState_Available"/>,
13838	<link to="USBDeviceState_Busy"/>,
13839	<link to="USBDeviceState_Held"/>) that were not previously
13840	ignored by global filters.
13841
13842	If at least one filter matches the USB device in question, this
13843	device is automatically captured (attached to) the virtual USB
13844	controller of this machine.
13845
13846	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13847	</desc>
13848	</attribute>
13849
13850	<method name="createDeviceFilter">
13851	<desc>
13852	Creates a new USB device filter. All attributes except
13853	the filter name are set to empty (any match),
13854	<i>active</i> is @c false (the filter is not active).
13855
13856	The created filter can then be added to the list of filters using
13857	<link to="#insertDeviceFilter"/>.
13858
13859	<result name="VBOX_E_INVALID_VM_STATE">
13860	The virtual machine is not mutable.
13861	</result>
13862
13863	<see><link to="#deviceFilters"/></see>
13864	</desc>
13865	<param name="name" type="wstring" dir="in">
13866	<desc>
13867	Filter name. See <link to="IUSBDeviceFilter::name"/>
13868	for more info.
13869	</desc>
13870	</param>
13871	<param name="filter" type="IUSBDeviceFilter" dir="return">
13872	<desc>Created filter object.</desc>
13873	</param>
13874	</method>
13875
13876	<method name="insertDeviceFilter">
13877	<desc>
13878	Inserts the given USB device to the specified position
13879	in the list of filters.
13880
13881	Positions are numbered starting from <tt>0</tt>. If the specified
13882	position is equal to or greater than the number of elements in
13883	the list, the filter is added to the end of the collection.
13884
13885	<note>
13886	Duplicates are not allowed, so an attempt to insert a
13887	filter that is already in the collection, will return an
13888	error.
13889	</note>
13890
13891	<result name="VBOX_E_INVALID_VM_STATE">
13892	Virtual machine is not mutable.
13893	</result>
13894	<result name="E_INVALIDARG">
13895	USB device filter not created within this VirtualBox instance.
13896	</result>
13897	<result name="VBOX_E_INVALID_OBJECT_STATE">
13898	USB device filter already in list.
13899	</result>
13900
13901	<see><link to="#deviceFilters"/></see>
13902	</desc>
13903	<param name="position" type="unsigned long" dir="in">
13904	<desc>Position to insert the filter to.</desc>
13905	</param>
13906	<param name="filter" type="IUSBDeviceFilter" dir="in">
13907	<desc>USB device filter to insert.</desc>
13908	</param>
13909	</method>
13910
13911	<method name="removeDeviceFilter">
13912	<desc>
13913	Removes a USB device filter from the specified position in the
13914	list of filters.
13915
13916	Positions are numbered starting from <tt>0</tt>. Specifying a
13917	position equal to or greater than the number of elements in
13918	the list will produce an error.
13919
13920	<see><link to="#deviceFilters"/></see>
13921
13922	<result name="VBOX_E_INVALID_VM_STATE">
13923	Virtual machine is not mutable.
13924	</result>
13925	<result name="E_INVALIDARG">
13926	USB device filter list empty or invalid @a position.
13927	</result>
13928
13929	</desc>
13930	<param name="position" type="unsigned long" dir="in">
13931	<desc>Position to remove the filter from.</desc>
13932	</param>
13933	<param name="filter" type="IUSBDeviceFilter" dir="return">
13934	<desc>Removed USB device filter.</desc>
13935	</param>
13936	</method>
13937
13938	</interface>
13939
13940
13941	<!--
13942	// IUSBDevice
13943	/////////////////////////////////////////////////////////////////////////
13944	-->
13945
13946	<interface
13947	name="IUSBDevice" extends="$unknown"
13948	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13949	wsmap="managed"
13950	>
13951	<desc>
13952	The IUSBDevice interface represents a virtual USB device attached to the
13953	virtual machine.
13954
13955	A collection of objects implementing this interface is stored in the
13956	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13957	attached to a running virtual machine's USB controller.
13958	</desc>
13959
13960	<attribute name="id" type="uuid" mod="string" readonly="yes">
13961	<desc>
13962	Unique USB device ID. This ID is built from #vendorId,
13963	#productId, #revision and #serialNumber.
13964	</desc>
13965	</attribute>
13966
13967	<attribute name="vendorId" type="unsigned short" readonly="yes">
13968	<desc>Vendor ID.</desc>
13969	</attribute>
13970
13971	<attribute name="productId" type="unsigned short" readonly="yes">
13972	<desc>Product ID.</desc>
13973	</attribute>
13974
13975	<attribute name="revision" type="unsigned short" readonly="yes">
13976	<desc>
13977	Product revision number. This is a packed BCD represented as
13978	unsigned short. The high byte is the integer part and the low
13979	byte is the decimal.
13980	</desc>
13981	</attribute>
13982
13983	<attribute name="manufacturer" type="wstring" readonly="yes">
13984	<desc>Manufacturer string.</desc>
13985	</attribute>
13986
13987	<attribute name="product" type="wstring" readonly="yes">
13988	<desc>Product string.</desc>
13989	</attribute>
13990
13991	<attribute name="serialNumber" type="wstring" readonly="yes">
13992	<desc>Serial number string.</desc>
13993	</attribute>
13994
13995	<attribute name="address" type="wstring" readonly="yes">
13996	<desc>Host specific address of the device.</desc>
13997	</attribute>
13998
13999	<attribute name="port" type="unsigned short" readonly="yes">
14000	<desc>
14001	Host USB port number the device is physically
14002	connected to.
14003	</desc>
14004	</attribute>
14005
14006	<attribute name="version" type="unsigned short" readonly="yes">
14007	<desc>
14008	The major USB version of the device - 1 or 2.
14009	</desc>
14010	</attribute>
14011
14012	<attribute name="portVersion" type="unsigned short" readonly="yes">
14013	<desc>
14014	The major USB version of the host USB port the device is
14015	physically connected to - 1 or 2. For devices not connected to
14016	anything this will have the same value as the version attribute.
14017	</desc>
14018	</attribute>
14019
14020	<attribute name="remote" type="boolean" readonly="yes">
14021	<desc>
14022	Whether the device is physically connected to a remote VRDE
14023	client or to a local host machine.
14024	</desc>
14025	</attribute>
14026
14027	</interface>
14028
14029
14030	<!--
14031	// IUSBDeviceFilter
14032	/////////////////////////////////////////////////////////////////////////
14033	-->
14034
14035	<interface
14036	name="IUSBDeviceFilter" extends="$unknown"
14037	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
14038	wsmap="managed"
14039	>
14040	<desc>
14041	The IUSBDeviceFilter interface represents an USB device filter used
14042	to perform actions on a group of USB devices.
14043
14044	This type of filters is used by running virtual machines to
14045	automatically capture selected USB devices once they are physically
14046	attached to the host computer.
14047
14048	A USB device is matched to the given device filter if and only if all
14049	attributes of the device match the corresponding attributes of the
14050	filter (that is, attributes are joined together using the logical AND
14051	operation). On the other hand, all together, filters in the list of
14052	filters carry the semantics of the logical OR operation. So if it is
14053	desirable to create a match like "this vendor id OR this product id",
14054	one needs to create two filters and specify "any match" (see below)
14055	for unused attributes.
14056
14057	All filter attributes used for matching are strings. Each string
14058	is an expression representing a set of values of the corresponding
14059	device attribute, that will match the given filter. Currently, the
14060	following filtering expressions are supported:
14061
14062	<ul>
14063	<li><i>Interval filters</i>. Used to specify valid intervals for
14064	integer device attributes (Vendor ID, Product ID and Revision).
14065	The format of the string is:
14066
14067	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
14068
14069	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
14070	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
14071	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
14072	is omitted before a dash (<tt>-</tt>), the minimum possible integer
14073	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
14074	possible integer is assumed.
14075	</li>
14076	<li><i>Boolean filters</i>. Used to specify acceptable values for
14077	boolean device attributes. The format of the string is:
14078
14079	<tt>true\|false\|yes\|no\|0\|1</tt>
14080
14081	</li>
14082	<li><i>Exact match</i>. Used to specify a single value for the given
14083	device attribute. Any string that doesn't start with <tt>int:</tt>
14084	represents the exact match. String device attributes are compared to
14085	this string including case of symbols. Integer attributes are first
14086	converted to a string (see individual filter attributes) and then
14087	compared ignoring case.
14088
14089	</li>
14090	<li><i>Any match</i>. Any value of the corresponding device attribute
14091	will match the given filter. An empty or @c null string is
14092	used to construct this type of filtering expressions.
14093
14094	</li>
14095	</ul>
14096
14097	<note>
14098	On the Windows host platform, interval filters are not currently
14099	available. Also all string filter attributes
14100	(<link to="#manufacturer"/>, <link to="#product"/>,
14101	<link to="#serialNumber"/>) are ignored, so they behave as
14102	<i>any match</i> no matter what string expression is specified.
14103	</note>
14104
14105	<see><link to="IUSBController::deviceFilters"/>,
14106	<link to="IHostUSBDeviceFilter"/></see>
14107	</desc>
14108
14109	<attribute name="name" type="wstring">
14110	<desc>
14111	Visible name for this filter.
14112	This name is used to visually distinguish one filter from another,
14113	so it can neither be @c null nor an empty string.
14114	</desc>
14115	</attribute>
14116
14117	<attribute name="active" type="boolean">
14118	<desc>Whether this filter active or has been temporarily disabled.</desc>
14119	</attribute>
14120
14121	<attribute name="vendorId" type="wstring">
14122	<desc>
14123	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14124	The string representation for the <i>exact matching</i>
14125	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14126	(including leading zeroes).
14127	</desc>
14128	</attribute>
14129
14130	<attribute name="productId" type="wstring">
14131	<desc>
14132	<link to="IUSBDevice::productId">Product ID</link> filter.
14133	The string representation for the <i>exact matching</i>
14134	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14135	(including leading zeroes).
14136	</desc>
14137	</attribute>
14138
14139	<attribute name="revision" type="wstring">
14140	<desc>
14141	<link to="IUSBDevice::productId">Product revision number</link>
14142	filter. The string representation for the <i>exact matching</i>
14143	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14144	of the integer part of the revision, and <tt>F</tt> is the
14145	decimal digit of its fractional part (including leading and
14146	trailing zeros).
14147	Note that for interval filters, it's best to use the hexadecimal
14148	form, because the revision is stored as a 16 bit packed BCD value;
14149	so the expression <tt>int:0x0100-0x0199</tt> will match any
14150	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14151	</desc>
14152	</attribute>
14153
14154	<attribute name="manufacturer" type="wstring">
14155	<desc>
14156	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14157	</desc>
14158	</attribute>
14159
14160	<attribute name="product" type="wstring">
14161	<desc>
14162	<link to="IUSBDevice::product">Product</link> filter.
14163	</desc>
14164	</attribute>
14165
14166	<attribute name="serialNumber" type="wstring">
14167	<desc>
14168	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14169	</desc>
14170	</attribute>
14171
14172	<attribute name="port" type="wstring">
14173	<desc>
14174	<link to="IUSBDevice::port">Host USB port</link> filter.
14175	</desc>
14176	</attribute>
14177
14178	<attribute name="remote" type="wstring">
14179	<desc>
14180	<link to="IUSBDevice::remote">Remote state</link> filter.
14181	<note>
14182	This filter makes sense only for machine USB filters,
14183	i.e. it is ignored by IHostUSBDeviceFilter objects.
14184	</note>
14185	</desc>
14186	</attribute>
14187
14188	<attribute name="maskedInterfaces" type="unsigned long">
14189	<desc>
14190	This is an advanced option for hiding one or more USB interfaces
14191	from the guest. The value is a bit mask where the bits that are set
14192	means the corresponding USB interface should be hidden, masked off
14193	if you like.
14194	This feature only works on Linux hosts.
14195	</desc>
14196	</attribute>
14197
14198	</interface>
14199
14200
14201	<!--
14202	// IHostUSBDevice
14203	/////////////////////////////////////////////////////////////////////////
14204	-->
14205
14206	<enum
14207	name="USBDeviceState"
14208	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14209	>
14210	<desc>
14211	USB device state. This enumeration represents all possible states
14212	of the USB device physically attached to the host computer regarding
14213	its state on the host computer and availability to guest computers
14214	(all currently running virtual machines).
14215
14216	Once a supported USB device is attached to the host, global USB
14217	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14218	either ignore the device, or put it to USBDeviceState_Held state, or do
14219	nothing. Unless the device is ignored by global filters, filters of all
14220	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14221	activated that can put it to USBDeviceState_Captured state.
14222
14223	If the device was ignored by global filters, or didn't match
14224	any filters at all (including guest ones), it is handled by the host
14225	in a normal way. In this case, the device state is determined by
14226	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14227	or USBDeviceState_Available, depending on the current device usage.
14228
14229	Besides auto-capturing based on filters, the device can be manually
14230	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14231	state is USBDeviceState_Busy, USBDeviceState_Available or
14232	USBDeviceState_Held.
14233
14234	<note>
14235	Due to differences in USB stack implementations in Linux and Win32,
14236	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14237	only to the Linux version of the product. This also means that (<link
14238	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14239	device state is USBDeviceState_Held.
14240	</note>
14241
14242	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14243	</desc>
14244
14245	<const name="NotSupported" value="0">
14246	<desc>
14247	Not supported by the VirtualBox server, not available to guests.
14248	</desc>
14249	</const>
14250	<const name="Unavailable" value="1">
14251	<desc>
14252	Being used by the host computer exclusively,
14253	not available to guests.
14254	</desc>
14255	</const>
14256	<const name="Busy" value="2">
14257	<desc>
14258	Being used by the host computer, potentially available to guests.
14259	</desc>
14260	</const>
14261	<const name="Available" value="3">
14262	<desc>
14263	Not used by the host computer, available to guests (the host computer
14264	can also start using the device at any time).
14265	</desc>
14266	</const>
14267	<const name="Held" value="4">
14268	<desc>
14269	Held by the VirtualBox server (ignored by the host computer),
14270	available to guests.
14271	</desc>
14272	</const>
14273	<const name="Captured" value="5">
14274	<desc>
14275	Captured by one of the guest computers, not available
14276	to anybody else.
14277	</desc>
14278	</const>
14279	</enum>
14280
14281	<interface
14282	name="IHostUSBDevice" extends="IUSBDevice"
14283	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14284	wsmap="managed"
14285	>
14286	<desc>
14287	The IHostUSBDevice interface represents a physical USB device attached
14288	to the host computer.
14289
14290	Besides properties inherited from IUSBDevice, this interface adds the
14291	<link to="#state"/> property that holds the current state of the USB
14292	device.
14293
14294	<see><link to="IHost::USBDevices"/>,
14295	<link to="IHost::USBDeviceFilters"/></see>
14296	</desc>
14297
14298	<attribute name="state" type="USBDeviceState" readonly="yes">
14299	<desc>
14300	Current state of the device.
14301	</desc>
14302	</attribute>
14303
14304	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14305
14306	</interface>
14307
14308
14309	<!--
14310	// IHostUSBDeviceFilter
14311	/////////////////////////////////////////////////////////////////////////
14312	-->
14313
14314	<enum
14315	name="USBDeviceFilterAction"
14316	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14317	>
14318	<desc>
14319	Actions for host USB device filters.
14320	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14321	</desc>
14322
14323	<const name="Null" value="0">
14324	<desc>Null value (never used by the API).</desc>
14325	</const>
14326	<const name="Ignore" value="1">
14327	<desc>Ignore the matched USB device.</desc>
14328	</const>
14329	<const name="Hold" value="2">
14330	<desc>Hold the matched USB device.</desc>
14331	</const>
14332	</enum>
14333
14334	<interface
14335	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14336	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14337	wsmap="managed"
14338	>
14339	<desc>
14340	The IHostUSBDeviceFilter interface represents a global filter for a
14341	physical USB device used by the host computer. Used indirectly in
14342	<link to="IHost::USBDeviceFilters"/>.
14343
14344	Using filters of this type, the host computer determines the initial
14345	state of the USB device after it is physically attached to the
14346	host's USB controller.
14347
14348	<note>
14349	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14350	filters, because it makes sense only for
14351	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14352	</note>
14353
14354	<see><link to="IHost::USBDeviceFilters"/></see>
14355	</desc>
14356
14357	<attribute name="action" type="USBDeviceFilterAction">
14358	<desc>
14359	Action performed by the host when an attached USB device
14360	matches this filter.
14361	</desc>
14362	</attribute>
14363
14364	</interface>
14365
14366	<!--
14367	// IAudioAdapter
14368	/////////////////////////////////////////////////////////////////////////
14369	-->
14370
14371	<enum
14372	name="AudioDriverType"
14373	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14374	>
14375	<desc>
14376	Host audio driver type.
14377	</desc>
14378
14379	<const name="Null" value="0">
14380	<desc>Null value, also means "dummy audio driver".</desc>
14381	</const>
14382	<const name="WinMM" value="1">
14383	<desc>Windows multimedia (Windows hosts only).</desc>
14384	</const>
14385	<const name="OSS" value="2">
14386	<desc>Open Sound System (Linux hosts only).</desc>
14387	</const>
14388	<const name="ALSA" value="3">
14389	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14390	</const>
14391	<const name="DirectSound" value="4">
14392	<desc>DirectSound (Windows hosts only).</desc>
14393	</const>
14394	<const name="CoreAudio" value="5">
14395	<desc>CoreAudio (Mac hosts only).</desc>
14396	</const>
14397	<const name="MMPM" value="6">
14398	<desc>Reserved for historical reasons.</desc>
14399	</const>
14400	<const name="Pulse" value="7">
14401	<desc>PulseAudio (Linux hosts only).</desc>
14402	</const>
14403	<const name="SolAudio" value="8">
14404	<desc>Solaris audio (Solaris hosts only).</desc>
14405	</const>
14406	</enum>
14407
14408	<enum
14409	name="AudioControllerType"
14410	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14411	>
14412	<desc>
14413	Virtual audio controller type.
14414	</desc>
14415
14416	<const name="AC97" value="0"/>
14417	<const name="SB16" value="1"/>
14418	<const name="HDA" value="2"/>
14419	</enum>
14420
14421	<interface
14422	name="IAudioAdapter" extends="$unknown"
14423	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14424	wsmap="managed"
14425	>
14426	<desc>
14427	The IAudioAdapter interface represents the virtual audio adapter of
14428	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14429	</desc>
14430	<attribute name="enabled" type="boolean">
14431	<desc>
14432	Flag whether the audio adapter is present in the
14433	guest system. If disabled, the virtual guest hardware will
14434	not contain any audio adapter. Can only be changed when
14435	the VM is not running.
14436	</desc>
14437	</attribute>
14438	<attribute name="audioController" type="AudioControllerType">
14439	<desc>
14440	The audio hardware we emulate.
14441	</desc>
14442	</attribute>
14443	<attribute name="audioDriver" type="AudioDriverType">
14444	<desc>
14445	Audio driver the adapter is connected to. This setting
14446	can only be changed when the VM is not running.
14447	</desc>
14448	</attribute>
14449	</interface>
14450
14451	<enum
14452	name="AuthType"
14453	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14454	>
14455	<desc>
14456	VirtualBox authentication type.
14457	</desc>
14458
14459	<const name="Null" value="0">
14460	<desc>Null value, also means "no authentication".</desc>
14461	</const>
14462	<const name="External" value="1"/>
14463	<const name="Guest" value="2"/>
14464	</enum>
14465
14466	<!--
14467	// IVRDEServer
14468	/////////////////////////////////////////////////////////////////////////
14469	-->
14470
14471	<interface
14472	name="IVRDEServer" extends="$unknown"
14473	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14474	wsmap="managed"
14475	>
14476	<attribute name="enabled" type="boolean">
14477	<desc>VRDE server status.</desc>
14478	</attribute>
14479
14480	<attribute name="authType" type="AuthType">
14481	<desc>VRDE authentication method.</desc>
14482	</attribute>
14483
14484	<attribute name="authTimeout" type="unsigned long">
14485	<desc>Timeout for guest authentication. Milliseconds.</desc>
14486	</attribute>
14487
14488	<attribute name="allowMultiConnection" type="boolean">
14489	<desc>
14490	Flag whether multiple simultaneous connections to the VM are permitted.
14491	Note that this will be replaced by a more powerful mechanism in the future.
14492	</desc>
14493	</attribute>
14494
14495	<attribute name="reuseSingleConnection" type="boolean">
14496	<desc>
14497	Flag whether the existing connection must be dropped and a new connection
14498	must be established by the VRDE server, when a new client connects in single
14499	connection mode.
14500	</desc>
14501	</attribute>
14502
14503	<attribute name="VRDEExtPack" type="wstring">
14504	<desc>
14505	The name of Extension Pack providing VRDE for this VM. Overrides
14506	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14507	</desc>
14508	</attribute>
14509
14510	<attribute name="authLibrary" type="wstring">
14511	<desc>
14512	Library used for authentication of RDP clients by this VM. Overrides
14513	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14514	</desc>
14515	</attribute>
14516
14517	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14518	<desc>
14519	Array of names of properties, which are supported by this VRDE server.
14520	</desc>
14521	</attribute>
14522
14523	<method name="setVRDEProperty">
14524	<desc>
14525	Sets a VRDE specific property string.
14526
14527	If you pass @c null or empty string as a key @a value, the given @a key
14528	will be deleted.
14529
14530	</desc>
14531	<param name="key" type="wstring" dir="in">
14532	<desc>Name of the key to set.</desc>
14533	</param>
14534	<param name="value" type="wstring" dir="in">
14535	<desc>Value to assign to the key.</desc>
14536	</param>
14537	</method>
14538
14539	<method name="getVRDEProperty" const="yes">
14540	<desc>
14541	Returns a VRDE specific property string.
14542
14543	If the requested data @a key does not exist, this function will
14544	succeed and return an empty string in the @a value argument.
14545
14546	</desc>
14547	<param name="key" type="wstring" dir="in">
14548	<desc>Name of the key to get.</desc>
14549	</param>
14550	<param name="value" type="wstring" dir="return">
14551	<desc>Value of the requested key.</desc>
14552	</param>
14553	</method>
14554
14555	</interface>
14556
14557
14558	<!--
14559	// ISharedFolder
14560	/////////////////////////////////////////////////////////////////////////
14561	-->
14562
14563	<interface
14564	name="ISharedFolder" extends="$unknown"
14565	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14566	wsmap="struct"
14567	>
14568	<desc>
14569	The ISharedFolder interface represents a folder in the host computer's
14570	file system accessible from the guest OS running inside a virtual
14571	machine using an associated logical name.
14572
14573	There are three types of shared folders:
14574	<ul>
14575	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14576	folders available to all virtual machines.</li>
14577	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14578	VM-specific shared folders available to the given virtual machine at
14579	startup.</li>
14580	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14581	VM-specific shared folders created in the session context (for
14582	example, when the virtual machine is running) and automatically
14583	discarded when the session is closed (the VM is powered off).</li>
14584	</ul>
14585
14586	Logical names of shared folders must be unique within the given scope
14587	(global, permanent or transient). However, they do not need to be unique
14588	across scopes. In this case, the definition of the shared folder in a
14589	more specific scope takes precedence over definitions in all other
14590	scopes. The order of precedence is (more specific to more general):
14591	<ol>
14592	<li>Transient definitions</li>
14593	<li>Permanent definitions</li>
14594	<li>Global definitions</li>
14595	</ol>
14596
14597	For example, if MyMachine has a shared folder named
14598	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14599	transient shared folder named <tt>C_DRIVE</tt> (that points
14600	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14601	of <tt>C_DRIVE</tt> in the guest OS so
14602	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14603	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14604	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14605	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14606	to <tt>C:\\</tt> if it still exists.
14607
14608	Note that permanent and transient shared folders of different machines
14609	are in different name spaces, so they don't overlap and don't need to
14610	have unique logical names.
14611
14612	<note>
14613	Global shared folders are not implemented in the current version of the
14614	product.
14615	</note>
14616	</desc>
14617
14618	<attribute name="name" type="wstring" readonly="yes">
14619	<desc>Logical name of the shared folder.</desc>
14620	</attribute>
14621
14622	<attribute name="hostPath" type="wstring" readonly="yes">
14623	<desc>Full path to the shared folder in the host file system.</desc>
14624	</attribute>
14625
14626	<attribute name="accessible" type="boolean" readonly="yes">
14627	<desc>
14628	Whether the folder defined by the host path is currently
14629	accessible or not.
14630	For example, the folder can be inaccessible if it is placed
14631	on the network share that is not available by the time
14632	this property is read.
14633	</desc>
14634	</attribute>
14635
14636	<attribute name="writable" type="boolean" readonly="yes">
14637	<desc>
14638	Whether the folder defined by the host path is writable or
14639	not.
14640	</desc>
14641	</attribute>
14642
14643	<attribute name="autoMount" type="boolean" readonly="yes">
14644	<desc>
14645	Whether the folder gets automatically mounted by the guest or not.
14646	</desc>
14647	</attribute>
14648
14649	<attribute name="lastAccessError" type="wstring" readonly="yes">
14650	<desc>
14651	Text message that represents the result of the last accessibility
14652	check.
14653
14654	Accessibility checks are performed each time the <link to="#accessible"/>
14655	attribute is read. An empty string is returned if the last
14656	accessibility check was successful. A non-empty string indicates a
14657	failure and should normally describe a reason of the failure (for
14658	example, a file read error).
14659	</desc>
14660	</attribute>
14661
14662	</interface>
14663
14664	<!--
14665	// ISession
14666	/////////////////////////////////////////////////////////////////////////
14667	-->
14668
14669	<interface
14670	name="IInternalSessionControl" extends="$unknown"
14671	uuid="c2b4cd5f-d3ce-4dd6-b915-123272163ef5"
14672	internal="yes"
14673	wsmap="suppress"
14674	>
14675	<method name="getPID">
14676	<desc>PID of the process that has created this Session object.
14677	</desc>
14678	<param name="pid" type="unsigned long" dir="return"/>
14679	</method>
14680
14681	<method name="getRemoteConsole">
14682	<desc>
14683	Returns the console object suitable for remote control.
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	<param name="console" type="IConsole" dir="return"/>
14694	</method>
14695
14696	<method name="assignMachine">
14697	<desc>
14698	Assigns the machine object associated with this direct-type
14699	session or informs the session that it will be a remote one
14700	(if @a machine == @c null).
14701
14702	<result name="VBOX_E_INVALID_VM_STATE">
14703	Session state prevents operation.
14704	</result>
14705	<result name="VBOX_E_INVALID_OBJECT_STATE">
14706	Session type prevents operation.
14707	</result>
14708
14709	</desc>
14710	<param name="machine" type="IMachine" dir="in"/>
14711	</method>
14712
14713	<method name="assignRemoteMachine">
14714	<desc>
14715	Assigns the machine and the (remote) console object associated with
14716	this remote-type session.
14717
14718	<result name="VBOX_E_INVALID_VM_STATE">
14719	Session state prevents operation.
14720	</result>
14721
14722	</desc>
14723	<param name="machine" type="IMachine" dir="in"/>
14724	<param name="console" type="IConsole" dir="in"/>
14725	</method>
14726
14727	<method name="updateMachineState">
14728	<desc>
14729	Updates the machine state in the VM process.
14730	Must be called only in certain cases
14731	(see the method implementation).
14732
14733	<result name="VBOX_E_INVALID_VM_STATE">
14734	Session state prevents operation.
14735	</result>
14736	<result name="VBOX_E_INVALID_OBJECT_STATE">
14737	Session type prevents operation.
14738	</result>
14739
14740	</desc>
14741	<param name="aMachineState" type="MachineState" dir="in"/>
14742	</method>
14743
14744	<method name="uninitialize">
14745	<desc>
14746	Uninitializes (closes) this session. Used by VirtualBox to close
14747	the corresponding remote session when the direct session dies
14748	or gets closed.
14749
14750	<result name="VBOX_E_INVALID_VM_STATE">
14751	Session state prevents operation.
14752	</result>
14753
14754	</desc>
14755	</method>
14756
14757	<method name="onNetworkAdapterChange">
14758	<desc>
14759	Triggered when settings of a network adapter of the
14760	associated virtual machine have changed.
14761
14762	<result name="VBOX_E_INVALID_VM_STATE">
14763	Session state prevents operation.
14764	</result>
14765	<result name="VBOX_E_INVALID_OBJECT_STATE">
14766	Session type prevents operation.
14767	</result>
14768
14769	</desc>
14770	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14771	<param name="changeAdapter" type="boolean" dir="in"/>
14772	</method>
14773
14774	<method name="onSerialPortChange">
14775	<desc>
14776	Triggered when settings of a serial port of the
14777	associated virtual machine have changed.
14778
14779	<result name="VBOX_E_INVALID_VM_STATE">
14780	Session state prevents operation.
14781	</result>
14782	<result name="VBOX_E_INVALID_OBJECT_STATE">
14783	Session type prevents operation.
14784	</result>
14785
14786	</desc>
14787	<param name="serialPort" type="ISerialPort" dir="in"/>
14788	</method>
14789
14790	<method name="onParallelPortChange">
14791	<desc>
14792	Triggered when settings of a parallel port of the
14793	associated virtual machine have changed.
14794
14795	<result name="VBOX_E_INVALID_VM_STATE">
14796	Session state prevents operation.
14797	</result>
14798	<result name="VBOX_E_INVALID_OBJECT_STATE">
14799	Session type prevents operation.
14800	</result>
14801
14802	</desc>
14803	<param name="parallelPort" type="IParallelPort" dir="in"/>
14804	</method>
14805
14806	<method name="onStorageControllerChange">
14807	<desc>
14808	Triggered when settings of a storage controller of the
14809	associated virtual machine have changed.
14810
14811	<result name="VBOX_E_INVALID_VM_STATE">
14812	Session state prevents operation.
14813	</result>
14814	<result name="VBOX_E_INVALID_OBJECT_STATE">
14815	Session type prevents operation.
14816	</result>
14817
14818	</desc>
14819	</method>
14820
14821	<method name="onMediumChange">
14822	<desc>
14823	Triggered when attached media of the
14824	associated virtual machine have changed.
14825
14826	<result name="VBOX_E_INVALID_VM_STATE">
14827	Session state prevents operation.
14828	</result>
14829	<result name="VBOX_E_INVALID_OBJECT_STATE">
14830	Session type prevents operation.
14831	</result>
14832
14833	</desc>
14834
14835	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14836	<desc>The medium attachment which changed.</desc>
14837	</param>
14838	<param name="force" type="boolean" dir="in">
14839	<desc>If the medium change was forced.</desc>
14840	</param>
14841	</method>
14842
14843	<method name="onStorageDeviceChange">
14844	<desc>
14845	Triggered when attached storage devices of the
14846	associated virtual machine have changed.
14847
14848	<result name="VBOX_E_INVALID_VM_STATE">
14849	Session state prevents operation.
14850	</result>
14851	<result name="VBOX_E_INVALID_OBJECT_STATE">
14852	Session type prevents operation.
14853	</result>
14854
14855	</desc>
14856
14857	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14858	<desc>The medium attachment which changed.</desc>
14859	</param>
14860	<param name="remove" type="boolean" dir="in">
14861	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14862	</param>
14863	</method>
14864
14865	<method name="onCPUChange">
14866	<desc>
14867	Notification when a CPU changes.
14868	</desc>
14869	<param name="cpu" type="unsigned long" dir="in">
14870	<desc>The CPU which changed</desc>
14871	</param>
14872	<param name="add" type="boolean" dir="in">
14873	<desc>Flag whether the CPU was added or removed</desc>
14874	</param>
14875	</method>
14876
14877	<method name="onCPUExecutionCapChange">
14878	<desc>
14879	Notification when the CPU execution cap changes.
14880	</desc>
14881	<param name="executionCap" type="unsigned long" dir="in">
14882	<desc>The new CPU execution cap value. (1-100)</desc>
14883	</param>
14884	</method>
14885
14886	<method name="onVRDEServerChange">
14887	<desc>
14888	Triggered when settings of the VRDE server object of the
14889	associated virtual machine have changed.
14890
14891	<result name="VBOX_E_INVALID_VM_STATE">
14892	Session state prevents operation.
14893	</result>
14894	<result name="VBOX_E_INVALID_OBJECT_STATE">
14895	Session type prevents operation.
14896	</result>
14897
14898	</desc>
14899	<param name="restart" type="boolean" dir="in">
14900	<desc>Flag whether the server must be restarted</desc>
14901	</param>
14902	</method>
14903
14904	<method name="onUSBControllerChange">
14905	<desc>
14906	Triggered when settings of the USB controller object of the
14907	associated virtual machine have changed.
14908
14909	<result name="VBOX_E_INVALID_VM_STATE">
14910	Session state prevents operation.
14911	</result>
14912	<result name="VBOX_E_INVALID_OBJECT_STATE">
14913	Session type prevents operation.
14914	</result>
14915
14916	</desc>
14917	</method>
14918
14919	<method name="onSharedFolderChange">
14920	<desc>
14921	Triggered when a permanent (global or machine) shared folder has been
14922	created or removed.
14923	<note>
14924	We don't pass shared folder parameters in this notification because
14925	the order in which parallel notifications are delivered is not defined,
14926	therefore it could happen that these parameters were outdated by the
14927	time of processing this notification.
14928	</note>
14929
14930	<result name="VBOX_E_INVALID_VM_STATE">
14931	Session state prevents operation.
14932	</result>
14933	<result name="VBOX_E_INVALID_OBJECT_STATE">
14934	Session type prevents operation.
14935	</result>
14936
14937	</desc>
14938	<param name="global" type="boolean" dir="in"/>
14939	</method>
14940
14941	<method name="onUSBDeviceAttach">
14942	<desc>
14943	Triggered when a request to capture a USB device (as a result
14944	of matched USB filters or direct call to
14945	<link to="IConsole::attachUSBDevice"/>) has completed.
14946	A @c null @a error object means success, otherwise it
14947	describes a failure.
14948
14949	<result name="VBOX_E_INVALID_VM_STATE">
14950	Session state prevents operation.
14951	</result>
14952	<result name="VBOX_E_INVALID_OBJECT_STATE">
14953	Session type prevents operation.
14954	</result>
14955
14956	</desc>
14957	<param name="device" type="IUSBDevice" dir="in"/>
14958	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14959	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14960	</method>
14961
14962	<method name="onUSBDeviceDetach">
14963	<desc>
14964	Triggered when a request to release the USB device (as a result
14965	of machine termination or direct call to
14966	<link to="IConsole::detachUSBDevice"/>) has completed.
14967	A @c null @a error object means success, otherwise it
14968	describes a failure.
14969
14970	<result name="VBOX_E_INVALID_VM_STATE">
14971	Session state prevents operation.
14972	</result>
14973	<result name="VBOX_E_INVALID_OBJECT_STATE">
14974	Session type prevents operation.
14975	</result>
14976
14977	</desc>
14978	<param name="id" type="uuid" mod="string" dir="in"/>
14979	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14980	</method>
14981
14982	<method name="onShowWindow">
14983	<desc>
14984	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14985	<link to="IMachine::showConsoleWindow"/> in order to notify
14986	console listeners
14987	<link to="ICanShowWindowEvent"/>
14988	and <link to="IShowWindowEvent"/>.
14989
14990	<result name="VBOX_E_INVALID_OBJECT_STATE">
14991	Session type prevents operation.
14992	</result>
14993
14994	</desc>
14995	<param name="check" type="boolean" dir="in"/>
14996	<param name="canShow" type="boolean" dir="out"/>
14997	<param name="winId" type="long long" dir="out"/>
14998	</method>
14999
15000	<method name="onBandwidthGroupChange">
15001	<desc>
15002	Notification when one of the bandwidth groups change.
15003	</desc>
15004	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
15005	<desc>The bandwidth group which changed.</desc>
15006	</param>
15007	</method>
15008
15009	<method name="accessGuestProperty">
15010	<desc>
15011	Called by <link to="IMachine::getGuestProperty"/> and by
15012	<link to="IMachine::setGuestProperty"/> in order to read and
15013	modify guest properties.
15014
15015	<result name="VBOX_E_INVALID_VM_STATE">
15016	Machine session is not open.
15017	</result>
15018	<result name="VBOX_E_INVALID_OBJECT_STATE">
15019	Session type is not direct.
15020	</result>
15021
15022	</desc>
15023	<param name="name" type="wstring" dir="in"/>
15024	<param name="value" type="wstring" dir="in"/>
15025	<param name="flags" type="wstring" dir="in"/>
15026	<param name="isSetter" type="boolean" dir="in"/>
15027	<param name="retValue" type="wstring" dir="out"/>
15028	<param name="retTimestamp" type="long long" dir="out"/>
15029	<param name="retFlags" type="wstring" dir="out"/>
15030	</method>
15031
15032	<method name="enumerateGuestProperties" const="yes">
15033	<desc>
15034	Return a list of the guest properties matching a set of patterns along
15035	with their values, time stamps and flags.
15036
15037	<result name="VBOX_E_INVALID_VM_STATE">
15038	Machine session is not open.
15039	</result>
15040	<result name="VBOX_E_INVALID_OBJECT_STATE">
15041	Session type is not direct.
15042	</result>
15043
15044	</desc>
15045	<param name="patterns" type="wstring" dir="in">
15046	<desc>
15047	The patterns to match the properties against as a comma-separated
15048	string. If this is empty, all properties currently set will be
15049	returned.
15050	</desc>
15051	</param>
15052	<param name="key" type="wstring" dir="out" safearray="yes">
15053	<desc>
15054	The key names of the properties returned.
15055	</desc>
15056	</param>
15057	<param name="value" type="wstring" dir="out" safearray="yes">
15058	<desc>
15059	The values of the properties returned. The array entries match the
15060	corresponding entries in the @a key array.
15061	</desc>
15062	</param>
15063	<param name="timestamp" type="long long" dir="out" safearray="yes">
15064	<desc>
15065	The time stamps of the properties returned. The array entries match
15066	the corresponding entries in the @a key array.
15067	</desc>
15068	</param>
15069	<param name="flags" type="wstring" dir="out" safearray="yes">
15070	<desc>
15071	The flags of the properties returned. The array entries match the
15072	corresponding entries in the @a key array.
15073	</desc>
15074	</param>
15075	</method>
15076
15077	<method name="onlineMergeMedium">
15078	<desc>
15079	Triggers online merging of a hard disk. Used internally when deleting
15080	a snapshot while a VM referring to the same hard disk chain is running.
15081
15082	<result name="VBOX_E_INVALID_VM_STATE">
15083	Machine session is not open.
15084	</result>
15085	<result name="VBOX_E_INVALID_OBJECT_STATE">
15086	Session type is not direct.
15087	</result>
15088
15089	</desc>
15090	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
15091	<desc>The medium attachment to identify the medium chain.</desc>
15092	</param>
15093	<param name="sourceIdx" type="unsigned long" dir="in">
15094	<desc>The index of the source image in the chain.
15095	Redundant, but drastically reduces IPC.</desc>
15096	</param>
15097	<param name="targetIdx" type="unsigned long" dir="in">
15098	<desc>The index of the target image in the chain.
15099	Redundant, but drastically reduces IPC.</desc>
15100	</param>
15101	<param name="source" type="IMedium" dir="in">
15102	<desc>Merge source medium.</desc>
15103	</param>
15104	<param name="target" type="IMedium" dir="in">
15105	<desc>Merge target medium.</desc>
15106	</param>
15107	<param name="mergeForward" type="boolean" dir="in">
15108	<desc>Merge direction.</desc>
15109	</param>
15110	<param name="parentForTarget" type="IMedium" dir="in">
15111	<desc>For forward merges: new parent for target medium.</desc>
15112	</param>
15113	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
15114	<desc>For backward merges: list of media which need their parent UUID
15115	updated.</desc>
15116	</param>
15117	<param name="progress" type="IProgress" dir="in">
15118	<desc>
15119	Progress object for this operation.
15120	</desc>
15121	</param>
15122	</method>
15123
15124	<method name="enableVMMStatistics">
15125	<desc>
15126	Enables or disables collection of VMM RAM statistics.
15127
15128	<result name="VBOX_E_INVALID_VM_STATE">
15129	Machine session is not open.
15130	</result>
15131	<result name="VBOX_E_INVALID_OBJECT_STATE">
15132	Session type is not direct.
15133	</result>
15134
15135	</desc>
15136	<param name="enable" type="boolean" dir="in">
15137	<desc>True enables statistics collection.</desc>
15138	</param>
15139	</method>
15140
15141	</interface>
15142
15143	<interface
15144	name="ISession" extends="$unknown"
15145	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15146	wsmap="managed"
15147	>
15148	<desc>
15149	The ISession interface represents a client process and allows for locking
15150	virtual machines (represented by IMachine objects) to prevent conflicting
15151	changes to the machine.
15152
15153	Any caller wishing to manipulate a virtual machine needs to create a session
15154	object first, which lives in its own process space. Such session objects are
15155	then associated with <link to="IMachine" /> objects living in the VirtualBox
15156	server process to coordinate such changes.
15157
15158	There are two typical scenarios in which sessions are used:
15159
15160	<ul>
15161	<li>To alter machine settings or control a running virtual machine, one
15162	needs to lock a machine for a given session (client process) by calling
15163	<link to="IMachine::lockMachine"/>.
15164
15165	Whereas multiple sessions may control a running virtual machine, only
15166	one process can obtain a write lock on the machine to prevent conflicting
15167	changes. A write lock is also needed if a process wants to actually run a
15168	virtual machine in its own context, such as the VirtualBox GUI or
15169	VBoxHeadless front-ends. They must also lock a machine for their own
15170	sessions before they are allowed to power up the virtual machine.
15171
15172	As a result, no machine settings can be altered while another process is
15173	already using it, either because that process is modifying machine settings
15174	or because the machine is running.
15175	</li>
15176	<li>
15177	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15178	VirtualBox GUI or VBoxHeadless), one would use
15179	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15180	as its first parameter. This session then identifies the caller and lets the
15181	caller control the started machine (for example, pause machine execution or
15182	power it down) as well as be notified about machine execution state changes.
15183	</li>
15184	</ul>
15185
15186	How sessions objects are created in a client process depends on whether you use
15187	the Main API via COM or via the webservice:
15188
15189	<ul>
15190	<li>When using the COM API directly, an object of the Session class from the
15191	VirtualBox type library needs to be created. In regular COM C++ client code,
15192	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15193	This object will then act as a local session object in further calls to open
15194	a session.
15195	</li>
15196
15197	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15198	a session object automatically whenever <link to="IWebsessionManager::logon" />
15199	is called. A managed object reference to that session object can be retrieved by
15200	calling <link to="IWebsessionManager::getSessionObject" />.
15201	</li>
15202	</ul>
15203	</desc>
15204
15205	<attribute name="state" type="SessionState" readonly="yes">
15206	<desc>Current state of this session.</desc>
15207	</attribute>
15208
15209	<attribute name="type" type="SessionType" readonly="yes">
15210	<desc>
15211	Type of this session. The value of this attribute is valid only
15212	if the session currently has a machine locked (i.e. its
15213	<link to="#state" /> is Locked), otherwise an error will be returned.
15214	</desc>
15215	</attribute>
15216
15217	<attribute name="machine" type="IMachine" readonly="yes">
15218	<desc>Machine object associated with this session.</desc>
15219	</attribute>
15220
15221	<attribute name="console" type="IConsole" readonly="yes">
15222	<desc>Console object associated with this session.</desc>
15223	</attribute>
15224
15225	<method name="unlockMachine">
15226	<desc>
15227	Unlocks a machine that was previously locked for the current session.
15228
15229	Calling this method is required every time a machine has been locked
15230	for a particular session using the <link to="IMachine::launchVMProcess" />
15231	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15232	the machine will be set to <link to="MachineState_Aborted" /> on the
15233	server, and changes made to the machine settings will be lost.
15234
15235	Generally, it is recommended to unlock all machines explicitly
15236	before terminating the application (regardless of the reason for
15237	the termination).
15238
15239	<note>
15240	Do not expect the session state (<link to="ISession::state" />
15241	to return to "Unlocked" immediately after you invoke this method,
15242	particularly if you have started a new VM process. The session
15243	state will automatically return to "Unlocked" once the VM is no
15244	longer executing, which can of course take a very long time.
15245	</note>
15246
15247	<result name="E_UNEXPECTED">
15248	Session is not locked.
15249	</result>
15250
15251	</desc>
15252	</method>
15253
15254	</interface>
15255
15256	<!--
15257	// IStorageController
15258	/////////////////////////////////////////////////////////////////////////
15259	-->
15260
15261	<enum
15262	name="StorageBus"
15263	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15264	>
15265	<desc>
15266	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15267	see <link to="IStorageController::bus" />.
15268	</desc>
15269	<const name="Null" value="0">
15270	<desc>@c null value. Never used by the API.</desc>
15271	</const>
15272	<const name="IDE" value="1"/>
15273	<const name="SATA" value="2"/>
15274	<const name="SCSI" value="3"/>
15275	<const name="Floppy" value="4"/>
15276	<const name="SAS" value="5"/>
15277	</enum>
15278
15279	<enum
15280	name="StorageControllerType"
15281	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15282	>
15283	<desc>
15284	The exact variant of storage controller hardware presented
15285	to the guest; see <link to="IStorageController::controllerType" />.
15286	</desc>
15287
15288	<const name="Null" value="0">
15289	<desc>@c null value. Never used by the API.</desc>
15290	</const>
15291	<const name="LsiLogic" value="1">
15292	<desc>A SCSI controller of the LsiLogic variant.</desc>
15293	</const>
15294	<const name="BusLogic" value="2">
15295	<desc>A SCSI controller of the BusLogic variant.</desc>
15296	</const>
15297	<const name="IntelAhci" value="3">
15298	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15299	</const>
15300	<const name="PIIX3" value="4">
15301	<desc>An IDE controller of the PIIX3 variant.</desc>
15302	</const>
15303	<const name="PIIX4" value="5">
15304	<desc>An IDE controller of the PIIX4 variant.</desc>
15305	</const>
15306	<const name="ICH6" value="6">
15307	<desc>An IDE controller of the ICH6 variant.</desc>
15308	</const>
15309	<const name="I82078" value="7">
15310	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15311	</const>
15312	<const name="LsiLogicSas" value="8">
15313	<desc>A variant of the LsiLogic controller using SAS.</desc>
15314	</const>
15315	</enum>
15316
15317	<enum
15318	name="ChipsetType"
15319	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15320	>
15321	<desc>
15322	Type of emulated chipset (mostly southbridge).
15323	</desc>
15324
15325	<const name="Null" value="0">
15326	<desc>@c null value. Never used by the API.</desc>
15327	</const>
15328	<const name="PIIX3" value="1">
15329	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15330	</const>
15331	<const name="ICH9" value="2">
15332	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15333	</const>
15334	</enum>
15335
15336	<interface
15337	name="IStorageController" extends="$unknown"
15338	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15339	wsmap="managed"
15340	>
15341	<desc>
15342	Represents a storage controller that is attached to a virtual machine
15343	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15344	attached to storage controllers in a real computer, virtual drives
15345	(represented by <link to="IMediumAttachment" />) are attached to virtual
15346	storage controllers, represented by this interface.
15347
15348	As opposed to physical hardware, VirtualBox has a very generic concept
15349	of a storage controller, and for purposes of the Main API, all virtual
15350	storage is attached to virtual machines via instances of this interface.
15351	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15352	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15353	is used, certain sub-types may be available and can be selected in
15354	<link to="#controllerType" />.
15355
15356	Depending on these settings, the guest operating system might see
15357	significantly different virtual hardware.
15358	</desc>
15359
15360	<attribute name="name" type="wstring" readonly="yes">
15361	<desc>
15362	Name of the storage controller, as originally specified with
15363	<link to="IMachine::addStorageController" />. This then uniquely
15364	identifies this controller with other method calls such as
15365	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15366	</desc>
15367	</attribute>
15368
15369	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15370	<desc>
15371	Maximum number of devices which can be attached to one port.
15372	</desc>
15373	</attribute>
15374
15375	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15376	<desc>
15377	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15378	</desc>
15379	</attribute>
15380
15381	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15382	<desc>
15383	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15384	</desc>
15385	</attribute>
15386
15387	<attribute name="instance" type="unsigned long">
15388	<desc>
15389	The instance number of the device in the running VM.
15390	</desc>
15391	</attribute>
15392
15393	<attribute name="portCount" type="unsigned long">
15394	<desc>
15395	The number of currently usable ports on the controller.
15396	The minimum and maximum number of ports for one controller are
15397	stored in <link to="IStorageController::minPortCount"/>
15398	and <link to="IStorageController::maxPortCount"/>.
15399	</desc>
15400	</attribute>
15401
15402	<attribute name="bus" type="StorageBus" readonly="yes">
15403	<desc>
15404	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15405	</desc>
15406	</attribute>
15407
15408	<attribute name="controllerType" type="StorageControllerType">
15409	<desc>
15410	The exact variant of storage controller hardware presented
15411	to the guest.
15412	Depending on this value, VirtualBox will provide a different
15413	virtual storage controller hardware to the guest.
15414	For SATA, SAS and floppy controllers, only one variant is
15415	available, but for IDE and SCSI, there are several.
15416
15417	For SCSI controllers, the default type is LsiLogic.
15418	</desc>
15419	</attribute>
15420
15421	<attribute name="useHostIOCache" type="boolean">
15422	<desc>
15423	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15424	caches and use synchronous file APIs on the host. This was the only option in the API before
15425	VirtualBox 3.2 and is still the default for IDE controllers.
15426
15427	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15428	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15429	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15430	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15431	virtual machines are running at the same time to prevent I/O cache related hangs.
15432	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15433	</desc>
15434	</attribute>
15435
15436	<attribute name="bootable" type="boolean" readonly="yes">
15437	<desc>
15438	Returns whether it is possible to boot from disks attached to this controller.
15439	</desc>
15440	</attribute>
15441
15442	<method name="getIDEEmulationPort">
15443	<desc>
15444	Gets the corresponding port number which is emulated as an IDE device.
15445	Works only with SATA controllers.
15446
15447	<result name="E_INVALIDARG">
15448	The @a devicePosition is not in the range 0 to 3.
15449	</result>
15450	<result name="E_NOTIMPL">
15451	The storage controller type is not SATAIntelAhci.
15452	</result>
15453
15454	</desc>
15455	<param name="devicePosition" type="long" dir="in"/>
15456	<param name="portNumber" type="long" dir="return"/>
15457	</method>
15458
15459	<method name="setIDEEmulationPort">
15460	<desc>
15461	Sets the port number which is emulated as an IDE device.
15462	Works only with SATA controllers.
15463
15464	<result name="E_INVALIDARG">
15465	The @a devicePosition is not in the range 0 to 3 or the
15466	@a portNumber is not in the range 0 to 29.
15467	</result>
15468	<result name="E_NOTIMPL">
15469	The storage controller type is not SATAIntelAhci.
15470	</result>
15471
15472	</desc>
15473	<param name="devicePosition" type="long" dir="in"/>
15474	<param name="portNumber" type="long" dir="in"/>
15475	</method>
15476
15477	</interface>
15478
15479	<if target="wsdl">
15480
15481	<!--
15482	// IManagedObjectRef
15483	/////////////////////////////////////////////////////////////////////////
15484	-->
15485
15486	<interface
15487	name="IManagedObjectRef" extends="$unknown"
15488	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15489	internal="yes"
15490	wsmap="managed"
15491	wscpp="hardcoded"
15492	>
15493	<desc>
15494	Managed object reference.
15495
15496	Only within the webservice, a managed object reference (which is really
15497	an opaque number) allows a webservice client to address an object
15498	that lives in the address space of the webservice server.
15499
15500	Behind each managed object reference, there is a COM object that lives
15501	in the webservice server's address space. The COM object is not freed
15502	until the managed object reference is released, either by an explicit
15503	call to <link to="IManagedObjectRef::release" /> or by logging off from
15504	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15505	all objects created during the webservice session.
15506
15507	Whenever a method call of the VirtualBox API returns a COM object, the
15508	webservice representation of that method will instead return a
15509	managed object reference, which can then be used to invoke methods
15510	on that object.
15511	</desc>
15512
15513	<method name="getInterfaceName">
15514	<desc>
15515	Returns the name of the interface that this managed object represents,
15516	for example, "IMachine", as a string.
15517	</desc>
15518	<param name="return" type="wstring" dir="return"/>
15519	</method>
15520
15521	<method name="release">
15522	<desc>
15523	Releases this managed object reference and frees the resources that
15524	were allocated for it in the webservice server process. After calling
15525	this method, the identifier of the reference can no longer be used.
15526	</desc>
15527	</method>
15528
15529	</interface>
15530
15531	<!--
15532	// IWebsessionManager
15533	/////////////////////////////////////////////////////////////////////////
15534	-->
15535
15536	<interface
15537	name="IWebsessionManager" extends="$unknown"
15538	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15539	internal="yes"
15540	wsmap="global"
15541	wscpp="hardcoded"
15542	>
15543	<desc>
15544	Websession manager. This provides essential services
15545	to webservice clients.
15546	</desc>
15547	<method name="logon">
15548	<desc>
15549	Logs a new client onto the webservice and returns a managed object reference to
15550	the IVirtualBox instance, which the client can then use as a basis to further
15551	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15552	interface, in one way or the other.
15553	</desc>
15554	<param name="username" type="wstring" dir="in"/>
15555	<param name="password" type="wstring" dir="in"/>
15556	<param name="return" type="IVirtualBox" dir="return"/>
15557	</method>
15558
15559	<method name="getSessionObject">
15560	<desc>
15561	Returns a managed object reference to the internal ISession object that was created
15562	for this web service session when the client logged on.
15563
15564	<see><link to="ISession"/></see>
15565	</desc>
15566	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15567	<param name="return" type="ISession" dir="return"/>
15568	</method>
15569
15570	<method name="logoff">
15571	<desc>
15572	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
15573	and destroys all resources associated with the session (most importantly, all
15574	managed objects created in the server while the session was active).
15575	</desc>
15576	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15577	</method>
15578
15579	</interface>
15580
15581	</if>
15582
15583	<!--
15584	// IPerformanceCollector & friends
15585	/////////////////////////////////////////////////////////////////////////
15586	-->
15587
15588	<interface
15589	name="IPerformanceMetric" extends="$unknown"
15590	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15591	>
15592	<desc>
15593	The IPerformanceMetric interface represents parameters of the given
15594	performance metric.
15595	</desc>
15596
15597	<attribute name="metricName" type="wstring" readonly="yes">
15598	<desc>
15599	Name of the metric.
15600	</desc>
15601	</attribute>
15602
15603	<attribute name="object" type="$unknown" readonly="yes">
15604	<desc>
15605	Object this metric belongs to.
15606	</desc>
15607	</attribute>
15608
15609	<attribute name="description" type="wstring" readonly="yes">
15610	<desc>
15611	Textual description of the metric.
15612	</desc>
15613	</attribute>
15614
15615	<attribute name="period" type="unsigned long" readonly="yes">
15616	<desc>
15617	Time interval between samples, measured in seconds.
15618	</desc>
15619	</attribute>
15620
15621	<attribute name="count" type="unsigned long" readonly="yes">
15622	<desc>
15623	Number of recent samples retained by the performance collector for this
15624	metric.
15625
15626	When the collected sample count exceeds this number, older samples
15627	are discarded.
15628	</desc>
15629	</attribute>
15630
15631	<attribute name="unit" type="wstring" readonly="yes">
15632	<desc>
15633	Unit of measurement.
15634	</desc>
15635	</attribute>
15636
15637	<attribute name="minimumValue" type="long" readonly="yes">
15638	<desc>
15639	Minimum possible value of this metric.
15640	</desc>
15641	</attribute>
15642
15643	<attribute name="maximumValue" type="long" readonly="yes">
15644	<desc>
15645	Maximum possible value of this metric.
15646	</desc>
15647	</attribute>
15648	</interface>
15649
15650	<interface
15651	name="IPerformanceCollector" extends="$unknown"
15652	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15653	wsmap="managed"
15654	>
15655	<desc>
15656	The IPerformanceCollector interface represents a service that collects
15657	and stores performance metrics data.
15658
15659	Performance metrics are associated with objects of interfaces like IHost
15660	and IMachine. Each object has a distinct set of performance metrics. The
15661	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15662
15663	Metric data is collected at the specified intervals and is retained
15664	internally. The interval and the number of retained samples can be set
15665	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15666	and collection settings are not persistent, they are discarded as soon as
15667	VBoxSVC process terminates. Moreover, metric settings and data associated
15668	with a particular VM only exist while VM is running. They disappear as
15669	soon as VM shuts down. It is not possible to set up metrics for machines
15670	that are powered off. One needs to start VM first, then set up metric
15671	collection parameters.
15672
15673	Metrics are organized hierarchically, with each level separated by a
15674	slash (/) character. Generally, the scheme for metric names is like this:
15675
15676	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15677
15678	"Category/Metric" together form the base metric name. A base metric is
15679	the smallest unit for which a sampling interval and the number of
15680	retained samples can be set. Only base metrics can be enabled and
15681	disabled. All sub-metrics are collected when their base metric is
15682	collected. Collected values for any set of sub-metrics can be queried
15683	with <link to="IPerformanceCollector::queryMetricsData" />.
15684
15685	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15686	category, "Load" metric, "User" submetric, "average" aggregate. An
15687	aggregate function is computed over all retained data. Valid aggregate
15688	functions are:
15689
15690	<ul>
15691	<li>avg -- average</li>
15692	<li>min -- minimum</li>
15693	<li>max -- maximum</li>
15694	</ul>
15695
15696	When setting up metric parameters, querying metric data, enabling or
15697	disabling metrics wildcards can be used in metric names to specify a
15698	subset of metrics. For example, to select all CPU-related metrics
15699	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15700	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15701
15702	The valid names for base metrics are:
15703
15704	<ul>
15705	<li>CPU/Load</li>
15706	<li>CPU/MHz</li>
15707	<li>RAM/Usage</li>
15708	<li>RAM/VMM</li>
15709	</ul>
15710
15711	The general sequence for collecting and retrieving the metrics is:
15712	<ul>
15713	<li>
15714	Obtain an instance of IPerformanceCollector with
15715	<link to="IVirtualBox::performanceCollector" />
15716	</li>
15717	<li>
15718	Allocate and populate an array with references to objects the metrics
15719	will be collected for. Use references to IHost and IMachine objects.
15720	</li>
15721	<li>
15722	Allocate and populate an array with base metric names the data will
15723	be collected for.
15724	</li>
15725	<li>
15726	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15727	the metric data will be collected and stored.
15728	</li>
15729	<li>
15730	Wait for the data to get collected.
15731	</li>
15732	<li>
15733	Allocate and populate an array with references to objects the metric
15734	values will be queried for. You can re-use the object array used for
15735	setting base metrics.
15736	</li>
15737	<li>
15738	Allocate and populate an array with metric names the data will be
15739	collected for. Note that metric names differ from base metric names.
15740	</li>
15741	<li>
15742	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15743	that have been collected so far are returned. Note that the values
15744	are still retained internally and data collection continues.
15745	</li>
15746	</ul>
15747
15748	For an example of usage refer to the following files in VirtualBox SDK:
15749	<ul>
15750	<li>
15751	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15752	</li>
15753	<li>
15754	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15755	</li>
15756	</ul>
15757	</desc>
15758
15759	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15760	<desc>
15761	Array of unique names of metrics.
15762
15763	This array represents all metrics supported by the performance
15764	collector. Individual objects do not necessarily support all of them.
15765	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15766	list of supported metrics for a particular object.
15767	</desc>
15768	</attribute>
15769
15770	<method name="getMetrics">
15771	<desc>
15772	Returns parameters of specified metrics for a set of objects.
15773	<note>
15774	@c Null metrics array means all metrics. @c Null object array means
15775	all existing objects.
15776	</note>
15777	</desc>
15778	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15779	<desc>
15780	Metric name filter. Currently, only a comma-separated list of metrics
15781	is supported.
15782	</desc>
15783	</param>
15784	<param name="objects" type="$unknown" dir="in" safearray="yes">
15785	<desc>
15786	Set of objects to return metric parameters for.
15787	</desc>
15788	</param>
15789	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15790	<desc>
15791	Array of returned metric parameters.
15792	</desc>
15793	</param>
15794	</method>
15795
15796	<method name="setupMetrics">
15797	<desc>
15798	Sets parameters of specified base metrics for a set of objects. Returns
15799	an array of <link to="IPerformanceMetric" /> describing the metrics
15800	have been affected.
15801	<note>
15802	@c Null or empty metric name array means all metrics. @c Null or
15803	empty object array means all existing objects. If metric name array
15804	contains a single element and object array contains many, the single
15805	metric name array element is applied to each object array element to
15806	form metric/object pairs.
15807	</note>
15808	</desc>
15809	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15810	<desc>
15811	Metric name filter. Comma-separated list of metrics with wildcard
15812	support.
15813	</desc>
15814	</param>
15815	<param name="objects" type="$unknown" dir="in" safearray="yes">
15816	<desc>
15817	Set of objects to setup metric parameters for.
15818	</desc>
15819	</param>
15820	<param name="period" type="unsigned long" dir="in">
15821	<desc>
15822	Time interval in seconds between two consecutive samples of
15823	performance data.
15824	</desc>
15825	</param>
15826	<param name="count" type="unsigned long" dir="in">
15827	<desc>
15828	Number of samples to retain in performance data history. Older
15829	samples get discarded.
15830	</desc>
15831	</param>
15832	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15833	<desc>
15834	Array of metrics that have been modified by the call to this method.
15835	</desc>
15836	</param>
15837	</method>
15838
15839	<method name="enableMetrics">
15840	<desc>
15841	Turns on collecting specified base metrics. Returns an array of
15842	<link to="IPerformanceMetric" /> describing the metrics have been
15843	affected.
15844	<note>
15845	@c Null or empty metric name array means all metrics. @c Null or
15846	empty object array means all existing objects. If metric name array
15847	contains a single element and object array contains many, the single
15848	metric name array element is applied to each object array element to
15849	form metric/object pairs.
15850	</note>
15851	</desc>
15852	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15853	<desc>
15854	Metric name filter. Comma-separated list of metrics with wildcard
15855	support.
15856	</desc>
15857	</param>
15858	<param name="objects" type="$unknown" dir="in" safearray="yes">
15859	<desc>
15860	Set of objects to enable metrics for.
15861	</desc>
15862	</param>
15863	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15864	<desc>
15865	Array of metrics that have been modified by the call to this method.
15866	</desc>
15867	</param>
15868	</method>
15869
15870	<method name="disableMetrics">
15871	<desc>
15872	Turns off collecting specified base metrics. Returns an array of
15873	<link to="IPerformanceMetric" /> describing the metrics have been
15874	affected.
15875	<note>
15876	@c Null or empty metric name array means all metrics. @c Null or
15877	empty object array means all existing objects. If metric name array
15878	contains a single element and object array contains many, the single
15879	metric name array element is applied to each object array element to
15880	form metric/object pairs.
15881	</note>
15882	</desc>
15883	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15884	<desc>
15885	Metric name filter. Comma-separated list of metrics with wildcard
15886	support.
15887	</desc>
15888	</param>
15889	<param name="objects" type="$unknown" dir="in" safearray="yes">
15890	<desc>
15891	Set of objects to disable metrics for.
15892	</desc>
15893	</param>
15894	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15895	<desc>
15896	Array of metrics that have been modified by the call to this method.
15897	</desc>
15898	</param>
15899	</method>
15900
15901	<method name="queryMetricsData">
15902	<desc>
15903	Queries collected metrics data for a set of objects.
15904
15905	The data itself and related metric information are returned in seven
15906	parallel and one flattened array of arrays. Elements of
15907	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15908	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15909	the same index describe one set of values corresponding to a single
15910	metric.
15911
15912	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15913	start and length of a sub-array is indicated by
15914	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15915	value for metric <tt>metricNames[i]</tt> is at
15916	<tt>returnData[returnIndices[i]]</tt>.
15917
15918	<note>
15919	@c Null or empty metric name array means all metrics. @c Null or
15920	empty object array means all existing objects. If metric name array
15921	contains a single element and object array contains many, the single
15922	metric name array element is applied to each object array element to
15923	form metric/object pairs.
15924	</note>
15925	<note>
15926	Data collection continues behind the scenes after call to @c
15927	queryMetricsData. The return data can be seen as the snapshot of the
15928	current state at the time of @c queryMetricsData call. The internally
15929	kept metric values are not cleared by the call. This makes possible
15930	querying different subsets of metrics or aggregates with subsequent
15931	calls. If periodic querying is needed it is highly suggested to query
15932	the values with @c interval*count period to avoid confusion. This way
15933	a completely new set of data values will be provided by each query.
15934	</note>
15935	</desc>
15936	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15937	<desc>
15938	Metric name filter. Comma-separated list of metrics with wildcard
15939	support.
15940	</desc>
15941	</param>
15942	<param name="objects" type="$unknown" dir="in" safearray="yes">
15943	<desc>
15944	Set of objects to query metrics for.
15945	</desc>
15946	</param>
15947	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15948	<desc>
15949	Names of metrics returned in @c returnData.
15950	</desc>
15951	</param>
15952	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15953	<desc>
15954	Objects associated with metrics returned in @c returnData.
15955	</desc>
15956	</param>
15957	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15958	<desc>
15959	Units of measurement for each returned metric.
15960	</desc>
15961	</param>
15962	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15963	<desc>
15964	Divisor that should be applied to return values in order to get
15965	floating point values. For example:
15966	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15967	will retrieve the floating point value of i-th sample of the first
15968	metric.
15969	</desc>
15970	</param>
15971	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15972	<desc>
15973	Sequence numbers of the first elements of value sequences of
15974	particular metrics returned in @c returnData. For aggregate metrics
15975	it is the sequence number of the sample the aggregate started
15976	calculation from.
15977	</desc>
15978	</param>
15979	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15980	<desc>
15981	Indices of the first elements of value sequences of particular
15982	metrics returned in @c returnData.
15983	</desc>
15984	</param>
15985	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15986	<desc>
15987	Lengths of value sequences of particular metrics.
15988	</desc>
15989	</param>
15990	<param name="returnData" type="long" dir="return" safearray="yes">
15991	<desc>
15992	Flattened array of all metric data containing sequences of values for
15993	each metric.
15994	</desc>
15995	</param>
15996	</method>
15997
15998	</interface>
15999
16000	<enum
16001	name="NATAliasMode"
16002	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
16003	>
16004	<desc></desc>
16005	<const name="AliasLog" value="0x1">
16006	<desc></desc>
16007	</const>
16008	<const name="AliasProxyOnly" value="0x02">
16009	<desc></desc>
16010	</const>
16011	<const name="AliasUseSamePorts" value="0x04">
16012	<desc></desc>
16013	</const>
16014	</enum>
16015
16016	<enum
16017	name="NATProtocol"
16018	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
16019	>
16020	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
16021	<const name="UDP" value="0">
16022	<desc>Port-forwarding uses UDP protocol.</desc>
16023	</const>
16024	<const name="TCP" value="1">
16025	<desc>Port-forwarding uses TCP protocol.</desc>
16026	</const>
16027	</enum>
16028
16029	<interface
16030	name="INATEngine" extends="$unknown"
16031	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
16032	wsmap="managed"
16033	>
16034	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
16035	allows for changing NAT behavior such as port-forwarding rules. This interface is
16036	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
16037	<attribute name="network" type="wstring">
16038	<desc>The network attribute of the NAT engine (the same value is used with built-in
16039	DHCP server to fill corresponding fields of DHCP leases).</desc>
16040	</attribute>
16041	<attribute name="hostIP" type="wstring">
16042	<desc>IP of host interface to bind all opened sockets to.
16043	<note>Changing this does not change binding of port forwarding.</note>
16044	</desc>
16045	</attribute>
16046	<attribute name="tftpPrefix" type="wstring">
16047	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
16048	the corresponding fields of DHCP leases.</desc>
16049	</attribute>
16050	<attribute name="tftpBootFile" type="wstring">
16051	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
16052	the corresponding fields of DHCP leases.</desc>
16053	</attribute>
16054	<attribute name="tftpNextServer" type="wstring">
16055	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
16056	the corresponding fields of DHCP leases.
16057	<note>The preferred form is IPv4 addresses.</note>
16058	</desc>
16059	</attribute>
16060	<attribute name="aliasMode" type="unsigned long">
16061	<desc></desc>
16062	</attribute>
16063	<attribute name="dnsPassDomain" type="boolean">
16064	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
16065	</attribute>
16066	<attribute name="dnsProxy" type="boolean">
16067	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16068	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
16069	</attribute>
16070	<attribute name="dnsUseHostResolver" type="boolean">
16071	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16072	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
16073	</attribute>
16074	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
16075	<desc>Array of NAT port-forwarding rules in string representation, in the following
16076	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
16077	</attribute>
16078	<method name="setNetworkSettings">
16079	<desc>Sets network configuration of the NAT engine.</desc>
16080	<param name="mtu" type="unsigned long" dir="in">
16081	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
16082	</param>
16083	<param name="sockSnd" type="unsigned long" dir="in">
16084	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
16085	</param>
16086	<param name="sockRcv" type="unsigned long" dir="in">
16087	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
16088	</param>
16089	<param name="TcpWndSnd" type="unsigned long" dir="in">
16090	<desc>Initial size of the NAT engine's sending TCP window in bytes when
16091	establishing a new TCP connection.</desc>
16092	</param>
16093	<param name="TcpWndRcv" type="unsigned long" dir="in">
16094	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
16095	establishing a new TCP connection.</desc>
16096	</param>
16097	</method>
16098	<method name="getNetworkSettings">
16099	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
16100	for parameter descriptions.</desc>
16101	<param name="mtu" type="unsigned long" dir="out" />
16102	<param name="sockSnd" type="unsigned long" dir="out" />
16103	<param name="sockRcv" type="unsigned long" dir="out" />
16104	<param name="TcpWndSnd" type="unsigned long" dir="out" />
16105	<param name="TcpWndRcv" type="unsigned long" dir="out" />
16106	</method>
16107	<method name="addRedirect">
16108	<desc>Adds a new NAT port-forwarding rule.</desc>
16109	<param name="name" type="wstring" dir="in">
16110	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
16111	auto-generates one using the other parameters.</desc>
16112	</param>
16113	<param name="proto" type="NATProtocol" dir="in">
16114	<desc>Protocol handled with the rule.</desc>
16115	</param>
16116	<param name="hostIp" type="wstring" dir="in">
16117	<desc>IP of the host interface to which the rule should apply. An empty ip address is
16118	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
16119	</param>
16120	<param name="hostPort" type="unsigned short" dir="in">
16121	<desc>The port number to listen on.</desc>
16122	</param>
16123	<param name="guestIp" type="wstring" dir="in">
16124	<desc>The IP address of the guest which the NAT engine will forward matching packets
16125	to. An empty IP address is acceptable, in which case the NAT engine will forward
16126	packets to the first DHCP lease (x.x.x.15).</desc>
16127	</param>
16128	<param name="guestPort" type="unsigned short" dir="in">
16129	<desc>The port number to forward.</desc>
16130	</param>
16131	</method>
16132	<method name="removeRedirect">
16133	<desc>Removes a port-forwarding rule that was previously registered.</desc>
16134	<param name="name" type="wstring" dir="in">
16135	<desc>The name of the rule to delete.</desc>
16136	</param>
16137	</method>
16138	</interface>
16139
16140	<!--
16141	// IExtPackManager
16142	/////////////////////////////////////////////////////////////////////////
16143	-->
16144
16145	<interface
16146	name="IExtPackPlugIn" extends="$unknown"
16147	uuid="58000040-e718-4746-bbce-4b86d96da461"
16148	wsmap="suppress"
16149	>
16150	<desc>
16151	Interface for keeping information about a plug-in that ships with an
16152	extension pack.
16153	</desc>
16154	<attribute name="name" type="wstring" readonly="yes">
16155	<desc>The plug-in name.</desc>
16156	</attribute>
16157	<attribute name="description" type="wstring" readonly="yes">
16158	<desc>The plug-in description.</desc>
16159	</attribute>
16160	<attribute name="frontend" type="wstring" readonly="yes">
16161	<desc>
16162	The name of the frontend or component name this plug-in plugs into.
16163	</desc>
16164	</attribute>
16165	<attribute name="modulePath" type="wstring" readonly="yes">
16166	<desc> The module path. </desc>
16167	</attribute>
16168	</interface>
16169
16170	<interface
16171	name="IExtPackBase" extends="$unknown"
16172	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16173	wsmap="suppress"
16174	>
16175	<desc>
16176	Interface for querying information about an extension pack as well as
16177	accessing COM objects within it.
16178	</desc>
16179	<attribute name="name" type="wstring" readonly="yes">
16180	<desc>The extension pack name. This is unique.</desc>
16181	</attribute>
16182	<attribute name="description" type="wstring" readonly="yes">
16183	<desc>The extension pack description.</desc>
16184	</attribute>
16185	<attribute name="version" type="wstring" readonly="yes">
16186	<desc>
16187	The extension pack version string. This is restricted to the dotted
16188	version number and optionally a build indicator. No tree revision or
16189	tag will be included in the string as those things are available as
16190	separate properties. An optional publisher tag may be present like for
16191	<link to="IVirtualBox::version"/>.
16192
16193	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16194	</desc>
16195	</attribute>
16196	<attribute name="revision" type="unsigned long" readonly="yes">
16197	<desc>The extension pack internal revision number.</desc>
16198	</attribute>
16199	<attribute name="edition" type="wstring" readonly="yes">
16200	<desc>
16201	Edition indicator. This is usually empty.
16202
16203	Can for instance be used to help distinguishing between two editions
16204	of the same extension pack where only the license, service contract or
16205	something differs.
16206	</desc>
16207	</attribute>
16208	<attribute name="VRDEModule" type="wstring" readonly="yes">
16209	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16210	</attribute>
16211	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16212	<desc>Plug-ins provided by this extension pack.</desc>
16213	</attribute>
16214	<attribute name="usable" type="boolean" readonly="yes">
16215	<desc>
16216	Indicates whether the extension pack is usable or not.
16217
16218	There are a number of reasons why an extension pack might be unusable,
16219	typical examples would be broken installation/file or that it is
16220	incompatible with the current VirtualBox version.
16221	</desc>
16222	</attribute>
16223	<attribute name="whyUnusable" type="wstring" readonly="yes">
16224	<desc>
16225	String indicating why the extension pack is not usable. This is an
16226	empty string if usable and always a non-empty string if not usable.
16227	</desc>
16228	</attribute>
16229	<attribute name="showLicense" type="boolean" readonly="yes">
16230	<desc>Whether to show the license before installation</desc>
16231	</attribute>
16232	<attribute name="license" type="wstring" readonly="yes">
16233	<desc>
16234	The default HTML license text for the extension pack. Same as
16235	calling <link to="#queryLicense">queryLicense</link> with
16236	preferredLocale and preferredLanguage as empty strings and format set
16237	to html.
16238	</desc>
16239	</attribute>
16240
16241	<method name="queryLicense">
16242	<desc>
16243	Full feature version of the license attribute.
16244	</desc>
16245	<param name="preferredLocale" type="wstring" dir="in">
16246	<desc>
16247	The preferred license locale. Pass an empty string to get the default
16248	license.
16249	</desc>
16250	</param>
16251	<param name="preferredLanguage" type="wstring" dir="in">
16252	<desc>
16253	The preferred license language. Pass an empty string to get the
16254	default language for the locale.
16255	</desc>
16256	</param>
16257	<param name="format" type="wstring" dir="in">
16258	<desc>
16259	The license format: html, rtf or txt. If a license is present there
16260	will always be an HTML of it, the rich text format (RTF) and plain
16261	text (txt) versions are optional. If
16262	</desc>
16263	</param>
16264	<param name="licenseText" type="wstring" dir="return">
16265	<desc>The license text.</desc>
16266	</param>
16267	</method>
16268
16269	</interface>
16270
16271	<interface
16272	name="IExtPack" extends="IExtPackBase"
16273	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16274	wsmap="suppress"
16275	>
16276	<desc>
16277	Interface for querying information about an extension pack as well as
16278	accessing COM objects within it.
16279	</desc>
16280	<method name="queryObject">
16281	<desc>
16282	Queries the IUnknown interface to an object in the extension pack
16283	main module. This allows plug-ins and others to talk directly to an
16284	extension pack.
16285	</desc>
16286	<param name="objUuid" type="wstring" dir="in">
16287	<desc>The object ID. What exactly this is </desc>
16288	</param>
16289	<param name="returnInterface" type="$unknown" dir="return">
16290	<desc>The queried interface.</desc>
16291	</param>
16292	</method>
16293	</interface>
16294
16295	<interface
16296	name="IExtPackFile" extends="IExtPackBase"
16297	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16298	wsmap="suppress"
16299	>
16300	<desc>
16301	Extension pack file (aka tarball, .vbox-extpack) representation returned
16302	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16303	extension pack information with the addition of the file name.
16304	</desc>
16305	<attribute name="filePath" type="wstring" readonly="yes">
16306	<desc>
16307	The path to the extension pack file.
16308	</desc>
16309	</attribute>
16310
16311	<method name="install">
16312	<desc>
16313	Install the extension pack.
16314	</desc>
16315	<param name="replace" type="boolean" dir="in">
16316	<desc>
16317	Set this to automatically uninstall any existing extension pack with
16318	the same name as the one being installed.
16319	</desc>
16320	</param>
16321	<param name="displayInfo" type="wstring" dir="in">
16322	<desc>
16323	Platform specific display information. Reserved for future hacks.
16324	</desc>
16325	</param>
16326	<param name="progess" type="IProgress" dir="return">
16327	<desc>
16328	Progress object for the operation.
16329	</desc>
16330	</param>
16331	</method>
16332	</interface>
16333
16334	<interface
16335	name="IExtPackManager" extends="$unknown"
16336	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16337	wsmap="suppress"
16338	>
16339	<desc>
16340	Interface for managing VirtualBox Extension Packs.
16341
16342	TODO: Describe extension packs, how they are managed and how to create
16343	one.
16344	</desc>
16345
16346	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16347	<desc>
16348	List of the installed extension packs.
16349	</desc>
16350	</attribute>
16351
16352	<method name="find">
16353	<desc>
16354	Returns the extension pack with the specified name if found.
16355
16356	<result name="VBOX_E_OBJECT_NOT_FOUND">
16357	No extension pack matching @a name was found.
16358	</result>
16359	</desc>
16360	<param name="name" type="wstring" dir="in">
16361	<desc>The name of the extension pack to locate.</desc>
16362	</param>
16363	<param name="returnData" type="IExtPack" dir="return">
16364	<desc>The extension pack if found.</desc>
16365	</param>
16366	</method>
16367
16368	<method name="openExtPackFile">
16369	<desc>
16370	Attempts to open an extension pack file in preparation for
16371	installation.
16372	</desc>
16373	<param name="path" type="wstring" dir="in">
16374	<desc>The path of the extension pack tarball. This can optionally be
16375	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16376	</param>
16377	<param name="file" type="IExtPackFile" dir="return">
16378	<desc>The interface of the extension pack file object.</desc>
16379	</param>
16380	</method>
16381
16382	<method name="uninstall">
16383	<desc>Uninstalls an extension pack, removing all related files.</desc>
16384	<param name="name" type="wstring" dir="in">
16385	<desc>The name of the extension pack to uninstall.</desc>
16386	</param>
16387	<param name="forcedRemoval" type="boolean" dir="in">
16388	<desc>
16389	Forced removal of the extension pack. This means that the uninstall
16390	hook will not be called.
16391	</desc>
16392	</param>
16393	<param name="displayInfo" type="wstring" dir="in">
16394	<desc>
16395	Platform specific display information. Reserved for future hacks.
16396	</desc>
16397	</param>
16398	<param name="progess" type="IProgress" dir="return">
16399	<desc>
16400	Progress object for the operation.
16401	</desc>
16402	</param>
16403	</method>
16404
16405	<method name="cleanup">
16406	<desc>Cleans up failed installs and uninstalls</desc>
16407	</method>
16408
16409	<method name="queryAllPlugInsForFrontend">
16410	<desc>
16411	Gets the path to all the plug-in modules for a given frontend.
16412
16413	This is a convenience method that is intended to simplify the plug-in
16414	loading process for a frontend.
16415	</desc>
16416	<param name="frontendName" type="wstring" dir="in">
16417	<desc>The name of the frontend or component.</desc>
16418	</param>
16419	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16420	<desc>Array containing the plug-in modules (full paths).</desc>
16421	</param>
16422	</method>
16423
16424	<method name="isExtPackUsable">
16425	<desc>Check if the given extension pack is loaded and usable.</desc>
16426	<param name="name" type="wstring" dir="in">
16427	<desc>The name of the extension pack to check for.</desc>
16428	</param>
16429	<param name="usable" type="boolean" dir="return">
16430	<desc>Is the given extension pack loaded and usable.</desc>
16431	</param>
16432	</method>
16433
16434	</interface>
16435
16436	<!--
16437	// BandwidthGroupType
16438	/////////////////////////////////////////////////////////////////////////
16439	-->
16440	<enum
16441	name="BandwidthGroupType"
16442	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16443
16444	<desc>
16445	Type of a bandwidth control group.
16446	</desc>
16447
16448	<const name="Null" value="0">
16449	<desc>
16450	Null type, must be first.
16451	</desc>
16452	</const>
16453
16454	<const name="Disk" value="1">
16455	<desc>
16456	The bandwidth group controls disk I/O.
16457	</desc>
16458	</const>
16459
16460	<const name="Network" value="2">
16461	<desc>
16462	The bandwidth group controls network I/O.
16463	</desc>
16464	</const>
16465
16466	</enum>
16467
16468	<!--
16469	// IBandwidthGroup
16470	/////////////////////////////////////////////////////////////////////////
16471	-->
16472	<interface
16473	name="IBandwidthGroup" extends="$unknown"
16474	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16475	wsmap="managed"
16476	>
16477	<desc>Represents one bandwidth group.</desc>
16478
16479	<attribute name="name" type="wstring" readonly="yes">
16480	<desc>Name of the group.</desc>
16481	</attribute>
16482
16483	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16484	<desc>Type of the group.</desc>
16485	</attribute>
16486
16487	<attribute name="reference" type="unsigned long" readonly="yes">
16488	<desc>How many devices/medium attachements use this group.</desc>
16489	</attribute>
16490
16491	<attribute name="maxMbPerSec" type="unsigned long">
16492	<desc>The maximum number of MBytes which can be transfered by all
16493	entities attached to this group during one second.</desc>
16494	</attribute>
16495
16496	</interface>
16497
16498	<!--
16499	// IBandwidthControl
16500	/////////////////////////////////////////////////////////////////////////
16501	-->
16502	<interface
16503	name="IBandwidthControl" extends="$unknown"
16504	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16505	wsmap="managed"
16506	>
16507	<desc>
16508	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16509	This includes network and disk I/O.
16510	</desc>
16511
16512	<attribute name="numGroups" type="unsigned long" readonly="yes">
16513	<desc>
16514	The current number of existing bandwidth groups managed.
16515	</desc>
16516	</attribute>
16517
16518	<method name="createBandwidthGroup">
16519	<desc>
16520	Creates a new bandwidth group.
16521	</desc>
16522
16523	<param name="name" type="wstring" dir="in">
16524	<desc>Name of the bandwidth group.</desc>
16525	</param>
16526	<param name="type" type="BandwidthGroupType" dir="in">
16527	<desc>The type of the bandwidth group (network or disk).</desc>
16528	</param>
16529	<param name="maxMbPerSec" type="unsigned long" dir="in">
16530	<desc>The maximum number of MBytes which can be transfered by all
16531	entities attached to this group during one second.</desc>
16532	</param>
16533	</method>
16534
16535	<method name="deleteBandwidthGroup">
16536	<desc>
16537	Deletes a new bandwidth group.
16538	</desc>
16539
16540	<param name="name" type="wstring" dir="in">
16541	<desc>Name of the bandwidth group to delete.</desc>
16542	</param>
16543	</method>
16544
16545	<method name="getBandwidthGroup" const="yes">
16546	<desc>
16547	Get a bandwidth group by name.
16548	</desc>
16549
16550	<param name="name" type="wstring" dir="in">
16551	<desc>Name of the bandwidth group to get.</desc>
16552	</param>
16553	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16554	<desc>Where to store the bandwidth group on success.</desc>
16555	</param>
16556	</method>
16557
16558	<method name="getAllBandwidthGroups" const="yes">
16559	<desc>
16560	Get all managed bandwidth groups.
16561	</desc>
16562
16563	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16564	<desc>The array of managed bandwidth groups.</desc>
16565	</param>
16566	</method>
16567	</interface>
16568
16569	<!--
16570	// IVirtualBoxClient
16571	/////////////////////////////////////////////////////////////////////////
16572	-->
16573
16574	<interface
16575	name="IVirtualBoxClient" extends="$unknown"
16576	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16577	wsmap="suppress"
16578	>
16579	<desc>
16580	Convenience interface for client applications. Treat this as a
16581	singleton, i.e. never create more than one instance of this interface.
16582
16583	At the moment only available for clients of the local API (not usable
16584	via the webservice). Once the session logic is redesigned this might
16585	change.
16586	</desc>
16587
16588	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16589	<desc>
16590	Reference to the server-side API root object.
16591	</desc>
16592	</attribute>
16593
16594	<attribute name="session" type="ISession" readonly="yes">
16595	<desc>
16596	Create a new session object and return the reference to it.
16597	</desc>
16598	</attribute>
16599
16600	<attribute name="eventSource" type="IEventSource" readonly="yes">
16601	<desc>
16602	Event source for VirtualBoxClient events.
16603	</desc>
16604	</attribute>
16605
16606	</interface>
16607
16608	<!--
16609	// Events
16610	/////////////////////////////////////////////////////////////////////////
16611	-->
16612	<enum
16613	name="VBoxEventType"
16614	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16615	>
16616
16617	<desc>
16618	Type of an event.
16619	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16620	</desc>
16621
16622	<const name="Invalid" value="0">
16623	<desc>
16624	Invalid event, must be first.
16625	</desc>
16626	</const>
16627
16628	<const name="Any" value="1">
16629	<desc>
16630	Wildcard for all events.
16631	Events of this type are never delivered, and only used in
16632	<link to="IEventSource::registerListener"/> call to simplify registration.
16633	</desc>
16634	</const>
16635
16636	<const name="Vetoable" value="2">
16637	<desc>
16638	Wildcard for all vetoable events. Events of this type are never delivered, and only
16639	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16640	</desc>
16641	</const>
16642
16643	<const name="MachineEvent" value="3">
16644	<desc>
16645	Wildcard for all machine events. Events of this type are never delivered, and only used in
16646	<link to="IEventSource::registerListener"/> call to simplify registration.
16647	</desc>
16648	</const>
16649
16650	<const name="SnapshotEvent" value="4">
16651	<desc>
16652	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16653	<link to="IEventSource::registerListener"/> call to simplify registration.
16654	</desc>
16655	</const>
16656
16657	<const name="InputEvent" value="5">
16658	<desc>
16659	Wildcard for all input device (keyboard, mouse) events.
16660	Events of this type are never delivered, and only used in
16661	<link to="IEventSource::registerListener"/> call to simplify registration.
16662	</desc>
16663	</const>
16664
16665	<const name="LastWildcard" value="31">
16666	<desc>
16667	Last wildcard.
16668	</desc>
16669	</const>
16670
16671	<const name="OnMachineStateChanged" value="32">
16672	<desc>
16673	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16674	</desc>
16675	</const>
16676	<const name="OnMachineDataChanged" value="33">
16677	<desc>
16678	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16679	</desc>
16680	</const>
16681	<const name="OnExtraDataChanged" value="34">
16682	<desc>
16683	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16684	</desc>
16685	</const>
16686	<const name="OnExtraDataCanChange" value="35">
16687	<desc>
16688	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16689	</desc>
16690	</const>
16691	<const name="OnMediumRegistered" value="36">
16692	<desc>
16693	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16694	</desc>
16695	</const>
16696	<const name="OnMachineRegistered" value="37">
16697	<desc>
16698	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16699	</desc>
16700	</const>
16701	<const name="OnSessionStateChanged" value="38">
16702	<desc>
16703	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16704	</desc>
16705	</const>
16706	<const name="OnSnapshotTaken" value="39">
16707	<desc>
16708	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16709	</desc>
16710	</const>
16711	<const name="OnSnapshotDeleted" value="40">
16712	<desc>
16713	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16714	</desc>
16715	</const>
16716	<const name="OnSnapshotChanged" value="41">
16717	<desc>
16718	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16719	</desc>
16720	</const>
16721	<const name="OnGuestPropertyChanged" value="42">
16722	<desc>
16723	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16724	</desc>
16725	</const>
16726	<!-- Console events -->
16727	<const name="OnMousePointerShapeChanged" value="43">
16728	<desc>
16729	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16730	</desc>
16731	</const>
16732	<const name="OnMouseCapabilityChanged" value="44">
16733	<desc>
16734	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16735	</desc>
16736	</const>
16737	<const name="OnKeyboardLedsChanged" value="45">
16738	<desc>
16739	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16740	</desc>
16741	</const>
16742	<const name="OnStateChanged" value="46">
16743	<desc>
16744	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16745	</desc>
16746	</const>
16747	<const name="OnAdditionsStateChanged" value="47">
16748	<desc>
16749	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16750	</desc>
16751	</const>
16752	<const name="OnNetworkAdapterChanged" value="48">
16753	<desc>
16754	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16755	</desc>
16756	</const>
16757	<const name="OnSerialPortChanged" value="49">
16758	<desc>
16759	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16760	</desc>
16761	</const>
16762	<const name="OnParallelPortChanged" value="50">
16763	<desc>
16764	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16765	</desc>
16766	</const>
16767	<const name="OnStorageControllerChanged" value="51">
16768	<desc>
16769	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16770	</desc>
16771	</const>
16772	<const name="OnMediumChanged" value="52">
16773	<desc>
16774	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16775	</desc>
16776	</const>
16777	<const name="OnVRDEServerChanged" value="53">
16778	<desc>
16779	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16780	</desc>
16781	</const>
16782	<const name="OnUSBControllerChanged" value="54">
16783	<desc>
16784	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16785	</desc>
16786	</const>
16787	<const name="OnUSBDeviceStateChanged" value="55">
16788	<desc>
16789	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16790	</desc>
16791	</const>
16792	<const name="OnSharedFolderChanged" value="56">
16793	<desc>
16794	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16795	</desc>
16796	</const>
16797	<const name="OnRuntimeError" value="57">
16798	<desc>
16799	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16800	</desc>
16801	</const>
16802	<const name="OnCanShowWindow" value="58">
16803	<desc>
16804	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16805	</desc>
16806	</const>
16807	<const name="OnShowWindow" value="59">
16808	<desc>
16809	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16810	</desc>
16811	</const>
16812	<const name="OnCPUChanged" value="60">
16813	<desc>
16814	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16815	</desc>
16816	</const>
16817	<const name="OnVRDEServerInfoChanged" value="61">
16818	<desc>
16819	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16820	</desc>
16821	</const>
16822	<const name="OnEventSourceChanged" value="62">
16823	<desc>
16824	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16825	</desc>
16826	</const>
16827	<const name="OnCPUExecutionCapChanged" value="63">
16828	<desc>
16829	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16830	</desc>
16831	</const>
16832	<const name="OnGuestKeyboard" value="64">
16833	<desc>
16834	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16835	</desc>
16836	</const>
16837	<const name="OnGuestMouse" value="65">
16838	<desc>
16839	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16840	</desc>
16841	</const>
16842	<const name="OnNATRedirect" value="66">
16843	<desc>
16844	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16845	</desc>
16846	</const>
16847	<const name="OnHostPciDevicePlug" value="67">
16848	<desc>
16849	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16850	</desc>
16851	</const>
16852	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16853	<desc>
16854	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16855	</desc>
16856	</const>
16857	<const name="OnBandwidthGroupChanged" value="69">
16858	<desc>
16859	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16860	</desc>
16861	</const>
16862	<const name="OnGuestMonitorChanged" value="70">
16863	<desc>
16864	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16865	</desc>
16866	</const>
16867	<const name="OnStorageDeviceChanged" value="71">
16868	<desc>
16869	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16870	</desc>
16871	</const>
16872
16873	<!-- Last event marker -->
16874	<const name="Last" value="72">
16875	<desc>
16876	Must be last event, used for iterations and structures relying on numerical event values.
16877	</desc>
16878	</const>
16879
16880	</enum>
16881
16882	<interface
16883	name="IEventSource" extends="$unknown"
16884	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16885	wsmap="managed"
16886	>
16887	<desc>
16888	Event source. Generally, any object which could generate events can be an event source,
16889	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16890	an event source can work with listeners in either active or passive mode. In active mode it is up to
16891	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16892	event source keeps track of pending events for each listener and returns available events on demand.
16893
16894	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16895	</desc>
16896
16897	<method name="createListener">
16898	<desc>
16899	Creates a new listener object, useful for passive mode.
16900	</desc>
16901	<param name="listener" type="IEventListener" dir="return"/>
16902	</method>
16903
16904	<method name="createAggregator">
16905	<desc>
16906	Creates an aggregator event source, collecting events from multiple sources.
16907	This way a single listener can listen for events coming from multiple sources,
16908	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16909	</desc>
16910	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16911	<desc>
16912	Subordinate event source this one aggregatres.
16913	</desc>
16914	</param>
16915	<param name="result" type="IEventSource" dir="return">
16916	<desc>
16917	Event source aggregating passed sources.
16918	</desc>
16919	</param>
16920	</method>
16921
16922	<method name="registerListener">
16923	<desc>
16924	Register an event listener.
16925
16926	<note>
16927	To avoid system overload, the VirtualBox server process checks if passive event
16928	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16929	current implementation, if more than 500 pending events are detected for a passive
16930	event listener, it is forcefully unregistered by the system, and further
16931	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16932	</note>
16933	</desc>
16934	<param name="listener" type="IEventListener" dir="in">
16935	<desc>Listener to register.</desc>
16936	</param>
16937	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16938	<desc>
16939	Event types listener is interested in. One can use wildcards like -
16940	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16941	than one event.
16942	</desc>
16943	</param>
16944	<param name="active" type="boolean" dir="in">
16945	<desc>
16946	Which mode this listener is operating in.
16947	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16948	In passive mode, an internal event queue is created for this this IEventListener.
16949	For each event coming in, it is added to queues for all interested registered passive
16950	listeners. It is then up to the external code to call the listener's
16951	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16952	external code must call <link to="#eventProcessed" />.
16953	</desc>
16954	</param>
16955	</method>
16956
16957	<method name="unregisterListener">
16958	<desc>
16959	Unregister an event listener. If listener is passive, and some waitable events are still
16960	in queue they are marked as processed automatically.
16961	</desc>
16962	<param name="listener" type="IEventListener" dir="in">
16963	<desc>Listener to unregister.</desc>
16964	</param>
16965	</method>
16966
16967	<method name="fireEvent">
16968	<desc>
16969	Fire an event for this source.
16970	</desc>
16971	<param name="event" type="IEvent" dir="in">
16972	<desc>Event to deliver.</desc>
16973	</param>
16974	<param name="timeout" type="long" dir="in">
16975	<desc>
16976	Maximum time to wait for event processing (if event is waitable), in ms;
16977	0 = no wait, -1 = indefinite wait.
16978	</desc>
16979	</param>
16980	<param name="result" type="boolean" dir="return">
16981	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16982	</param>
16983	</method>
16984
16985	<method name="getEvent">
16986	<desc>
16987	Get events from this peer's event queue (for passive mode). Calling this method
16988	regularly is required for passive event listeners to avoid system overload;
16989	see <link to="IEventSource::registerListener" /> for details.
16990
16991	<result name="VBOX_E_OBJECT_NOT_FOUND">
16992	Listener is not registered, or autounregistered.
16993	</result>
16994	</desc>
16995	<param name="listener" type="IEventListener" dir="in">
16996	<desc>Which listener to get data for.</desc>
16997	</param>
16998	<param name="timeout" type="long" dir="in">
16999	<desc>
17000	Maximum time to wait for events, in ms;
17001	0 = no wait, -1 = indefinite wait.
17002	</desc>
17003	</param>
17004	<param name="event" type="IEvent" dir="return">
17005	<desc>Event retrieved, or null if none available.</desc>
17006	</param>
17007	</method>
17008
17009	<method name="eventProcessed">
17010	<desc>
17011	Must be called for waitable events after a particular listener finished its
17012	event processing. When all listeners of a particular event have called this
17013	method, the system will then call <link to="IEvent::setProcessed" />.
17014	</desc>
17015	<param name="listener" type="IEventListener" dir="in">
17016	<desc>Which listener processed event.</desc>
17017	</param>
17018	<param name="event" type="IEvent" dir="in">
17019	<desc>Which event.</desc>
17020	</param>
17021	</method>
17022
17023	</interface>
17024
17025	<interface
17026	name="IEventListener" extends="$unknown"
17027	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
17028	wsmap="managed"
17029	>
17030	<desc>
17031	Event listener. An event listener can work in either active or passive mode, depending on the way
17032	it was registered.
17033	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
17034	</desc>
17035
17036	<method name="handleEvent">
17037	<desc>
17038	Handle event callback for active listeners. It is not called for
17039	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
17040	and having received acknowledgement from all passive listeners via
17041	<link to="IEventSource::eventProcessed"/>, the event is marked as
17042	processed and <link to="IEvent::waitProcessed"/> will return
17043	immediately.
17044	</desc>
17045	<param name="event" type="IEvent" dir="in">
17046	<desc>Event available.</desc>
17047	</param>
17048	</method>
17049
17050	</interface>
17051
17052	<interface
17053	name="IEvent" extends="$unknown"
17054	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
17055	wsmap="managed"
17056	>
17057	<desc>
17058	Abstract parent interface for VirtualBox events. Actual events will typically implement
17059	a more specific interface which derives from this (see below).
17060
17061	<b>Introduction to VirtualBox events</b>
17062
17063	Generally speaking, an event (represented by this interface) signals that something
17064	happened, while an event listener (see <link to="IEventListener" />) represents an
17065	entity that is interested in certain events. In order for this to work with
17066	unidirectional protocols (i.e. web services), the concepts of passive and active
17067	listener are used.
17068
17069	Event consumers can register themselves as listeners, providing an array of
17070	events they are interested in (see <link to="IEventSource::registerListener" />).
17071	When an event triggers, the listener is notified about the event. The exact
17072	mechanism of the notification depends on whether the listener was registered as
17073	an active or passive listener:
17074
17075	<ul>
17076	<li>An active listener is very similar to a callback: it is a function invoked
17077	by the API. As opposed to the callbacks that were used in the API before
17078	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
17079	</li>
17080
17081	<li>Passive listeners are somewhat trickier to implement, but do not require
17082	a client function to be callable, which is not an option with scripting
17083	languages or web service clients. Internally the <link to="IEventSource" />
17084	implementation maintains an event queue for each passive listener, and
17085	newly arrived events are put in this queue. When the listener calls
17086	<link to="IEventSource::getEvent"/>, first element from its internal event
17087	queue is returned. When the client completes processing of an event,
17088	the <link to="IEventSource::eventProcessed" /> function must be called,
17089	acknowledging that the event was processed. It supports implementing
17090	waitable events. On passive listener unregistration, all events from its
17091	queue are auto-acknowledged.
17092	</li>
17093	</ul>
17094
17095	Waitable events are useful in situations where the event generator wants to track
17096	delivery or a party wants to wait until all listeners have completed the event. A
17097	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
17098	listeners might veto a certain action, and thus the event producer has to make
17099	sure that all listeners have processed the event and not vetoed before taking
17100	the action.
17101
17102	A given event may have both passive and active listeners at the same time.
17103
17104	<b>Using events</b>
17105
17106	Any VirtualBox object capable of producing externally visible events provides an
17107	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
17108	This event source object is notified by VirtualBox once something has happened, so
17109	consumers may register event listeners with this event source. To register a listener,
17110	an object implementing the <link to="IEventListener" /> interface must be provided.
17111	For active listeners, such an object is typically created by the consumer, while for
17112	passive listeners <link to="IEventSource::createListener" /> should be used. Please
17113	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
17114
17115	Once created, the listener must be registered to listen for the desired events
17116	(see <link to="IEventSource::registerListener" />), providing an array of
17117	<link to="VBoxEventType" /> enums. Those elements can either be the individual
17118	event IDs or wildcards matching multiple event IDs.
17119
17120	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
17121	called automatically when the event is triggered, while passive listeners have to call
17122	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
17123	an event processing loop.
17124
17125	The IEvent interface is an abstract parent interface for all such VirtualBox events
17126	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
17127	or the event processing loop is to check the <link to="#type" /> attribute of the event and
17128	then cast to the appropriate specific interface using @c QueryInterface().
17129	</desc>
17130
17131	<attribute name="type" readonly="yes" type="VBoxEventType">
17132	<desc>
17133	Event type.
17134	</desc>
17135	</attribute>
17136
17137	<attribute name="source" readonly="yes" type="IEventSource">
17138	<desc>
17139	Source of this event.
17140	</desc>
17141	</attribute>
17142
17143	<attribute name="waitable" readonly="yes" type="boolean">
17144	<desc>
17145	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17146	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17147	as no additional overhead associated with waitability imposed.
17148	Waitable events are needed when one need to be able to wait for particular event processed,
17149	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17150	until all consumers confirmed events.
17151	</desc>
17152	</attribute>
17153
17154	<method name="setProcessed">
17155	<desc>
17156	Internal method called by the system when all listeners of a particular event have called
17157	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17158	</desc>
17159	</method>
17160
17161	<method name="waitProcessed">
17162	<desc>
17163	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17164	described semantics, for non-waitable returns true immediately.
17165	</desc>
17166	<param name="timeout" type="long" dir="in">
17167	<desc>
17168	Maximum time to wait for event processeing, in ms;
17169	0 = no wait, -1 = indefinite wait.
17170	</desc>
17171	</param>
17172	<param name="result" type="boolean" dir="return">
17173	<desc>If this event was processed before timeout.</desc>
17174	</param>
17175	</method>
17176	</interface>
17177
17178
17179	<interface
17180	name="IReusableEvent" extends="IEvent"
17181	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17182	wsmap="managed"
17183	>
17184	<desc>Base abstract interface for all reusable events.</desc>
17185
17186	<attribute name="generation" readonly="yes" type="unsigned long">
17187	<desc>Current generation of event, incremented on reuse.</desc>
17188	</attribute>
17189
17190	<method name="reuse">
17191	<desc>
17192	Marks an event as reused, increments 'generation', fields shall no
17193	longer be considered valid.
17194	</desc>
17195	</method>
17196	</interface>
17197
17198	<interface
17199	name="IMachineEvent" extends="IEvent"
17200	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17201	wsmap="managed" id="MachineEvent"
17202	>
17203	<desc>Base abstract interface for all machine events.</desc>
17204
17205	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17206	<desc>ID of the machine this event relates to.</desc>
17207	</attribute>
17208
17209	</interface>
17210
17211	<interface
17212	name="IMachineStateChangedEvent" extends="IMachineEvent"
17213	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17214	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17215	>
17216	<desc>Machine state change event.</desc>
17217
17218	<attribute name="state" readonly="yes" type="MachineState">
17219	<desc>New execution state.</desc>
17220	</attribute>
17221	</interface>
17222
17223	<interface
17224	name="IMachineDataChangedEvent" extends="IMachineEvent"
17225	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17226	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17227	>
17228	<desc>
17229	Any of the settings of the given machine has changed.
17230	</desc>
17231
17232	<attribute name="temporary" readonly="yes" type="boolean">
17233	<desc>@c true if the settings change is temporary. All permanent
17234	settings changes will trigger an event, and only temporary settings
17235	changes for running VMs will trigger an event. Note: sending events
17236	for temporary changes is NOT IMPLEMENTED.</desc>
17237	</attribute>
17238	</interface>
17239
17240	<interface
17241	name="IMediumRegisteredEvent" extends="IEvent"
17242	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17243	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17244	>
17245	<desc>
17246	The given medium was registered or unregistered
17247	within this VirtualBox installation.
17248	</desc>
17249
17250	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17251	<desc>ID of the medium this event relates to.</desc>
17252	</attribute>
17253
17254	<attribute name="mediumType" readonly="yes" type="DeviceType">
17255	<desc>Type of the medium this event relates to.</desc>
17256	</attribute>
17257
17258	<attribute name="registered" type="boolean" readonly="yes">
17259	<desc>
17260	If @c true, the medium was registered, otherwise it was
17261	unregistered.
17262	</desc>
17263	</attribute>
17264	</interface>
17265
17266	<interface
17267	name="IMachineRegisteredEvent" extends="IMachineEvent"
17268	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17269	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17270	>
17271	<desc>
17272	The given machine was registered or unregistered
17273	within this VirtualBox installation.
17274	</desc>
17275
17276	<attribute name="registered" type="boolean" readonly="yes">
17277	<desc>
17278	If @c true, the machine was registered, otherwise it was
17279	unregistered.
17280	</desc>
17281	</attribute>
17282	</interface>
17283
17284	<interface
17285	name="ISessionStateChangedEvent" extends="IMachineEvent"
17286	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17287	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17288	>
17289	<desc>
17290	The state of the session for the given machine was changed.
17291	<see><link to="IMachine::sessionState"/></see>
17292	</desc>
17293
17294	<attribute name="state" type="SessionState" readonly="yes">
17295	<desc>
17296	New session state.
17297	</desc>
17298	</attribute>
17299	</interface>
17300
17301	<interface
17302	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17303	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17304	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17305	>
17306	<desc>
17307	Notification when a guest property has changed.
17308	</desc>
17309
17310	<attribute name="name" readonly="yes" type="wstring">
17311	<desc>
17312	The name of the property that has changed.
17313	</desc>
17314	</attribute>
17315
17316	<attribute name="value" readonly="yes" type="wstring">
17317	<desc>
17318	The new property value.
17319	</desc>
17320	</attribute>
17321
17322	<attribute name="flags" readonly="yes" type="wstring">
17323	<desc>
17324	The new property flags.
17325	</desc>
17326	</attribute>
17327
17328	</interface>
17329
17330	<interface
17331	name="ISnapshotEvent" extends="IMachineEvent"
17332	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17333	wsmap="managed" id="SnapshotEvent"
17334	>
17335	<desc>Base interface for all snapshot events.</desc>
17336
17337	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17338	<desc>ID of the snapshot this event relates to.</desc>
17339	</attribute>
17340
17341	</interface>
17342
17343	<interface
17344	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17345	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17346	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17347	>
17348	<desc>
17349	A new snapshot of the machine has been taken.
17350	<see><link to="ISnapshot"/></see>
17351	</desc>
17352	</interface>
17353
17354	<interface
17355	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17356	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17357	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17358	>
17359	<desc>
17360	Snapshot of the given machine has been deleted.
17361
17362	<note>
17363	This notification is delivered <b>after</b> the snapshot
17364	object has been uninitialized on the server (so that any
17365	attempt to call its methods will return an error).
17366	</note>
17367
17368	<see><link to="ISnapshot"/></see>
17369	</desc>
17370	</interface>
17371
17372	<interface
17373	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17374	uuid="07541941-8079-447a-a33e-47a69c7980db"
17375	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17376	>
17377	<desc>
17378	Snapshot properties (name and/or description) have been changed.
17379	<see><link to="ISnapshot"/></see>
17380	</desc>
17381	</interface>
17382
17383	<interface
17384	name="IMousePointerShapeChangedEvent" extends="IEvent"
17385	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17386	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17387	>
17388	<desc>
17389	Notification when the guest mouse pointer shape has
17390	changed. The new shape data is given.
17391	</desc>
17392
17393	<attribute name="visible" type="boolean" readonly="yes">
17394	<desc>
17395	Flag whether the pointer is visible.
17396	</desc>
17397	</attribute>
17398	<attribute name="alpha" type="boolean" readonly="yes">
17399	<desc>
17400	Flag whether the pointer has an alpha channel.
17401	</desc>
17402	</attribute>
17403	<attribute name="xhot" type="unsigned long" readonly="yes">
17404	<desc>
17405	The pointer hot spot X coordinate.
17406	</desc>
17407	</attribute>
17408	<attribute name="yhot" type="unsigned long" readonly="yes">
17409	<desc>
17410	The pointer hot spot Y coordinate.
17411	</desc>
17412	</attribute>
17413	<attribute name="width" type="unsigned long" readonly="yes">
17414	<desc>
17415	Width of the pointer shape in pixels.
17416	</desc>
17417	</attribute>
17418	<attribute name="height" type="unsigned long" readonly="yes">
17419	<desc>
17420	Height of the pointer shape in pixels.
17421	</desc>
17422	</attribute>
17423	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17424	<desc>
17425	Shape buffer arrays.
17426
17427	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17428	followed by a 32-bpp XOR (color) mask.
17429
17430	For pointers without alpha channel the XOR mask pixels are 32
17431	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17432	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17433
17434	An AND mask is used for pointers with alpha channel, so if the
17435	callback does not support alpha, the pointer could be
17436	displayed as a normal color pointer.
17437
17438	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17439	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17440	height</tt>. The padding bits at the end of each scanline are
17441	undefined.
17442
17443	The XOR mask follows the AND mask on the next 4-byte aligned
17444	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17445	Bytes in the gap between the AND and the XOR mask are undefined.
17446	The XOR mask scanlines have no gap between them and the size of
17447	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17448
17449	<note>
17450	If @a shape is 0, only the pointer visibility is changed.
17451	</note>
17452	</desc>
17453	</attribute>
17454	</interface>
17455
17456	<interface
17457	name="IMouseCapabilityChangedEvent" extends="IEvent"
17458	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17459	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17460	>
17461	<desc>
17462	Notification when the mouse capabilities reported by the
17463	guest have changed. The new capabilities are passed.
17464	</desc>
17465	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17466	<desc>
17467	Supports absolute coordinates.
17468	</desc>
17469	</attribute>
17470	<attribute name="supportsRelative" type="boolean" readonly="yes">
17471	<desc>
17472	Supports relative coordinates.
17473	</desc>
17474	</attribute>
17475	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17476	<desc>
17477	If host cursor is needed.
17478	</desc>
17479	</attribute>
17480	</interface>
17481
17482	<interface
17483	name="IKeyboardLedsChangedEvent" extends="IEvent"
17484	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17485	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17486	>
17487	<desc>
17488	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17489	to alter the state of the keyboard LEDs.
17490	</desc>
17491	<attribute name="numLock" type="boolean" readonly="yes">
17492	<desc>
17493	NumLock status.
17494	</desc>
17495	</attribute>
17496	<attribute name="capsLock" type="boolean" readonly="yes">
17497	<desc>
17498	CapsLock status.
17499	</desc>
17500	</attribute>
17501	<attribute name="scrollLock" type="boolean" readonly="yes">
17502	<desc>
17503	ScrollLock status.
17504	</desc>
17505	</attribute>
17506	</interface>
17507
17508	<interface
17509	name="IStateChangedEvent" extends="IEvent"
17510	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17511	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17512	>
17513	<desc>
17514	Notification when the execution state of the machine has changed.
17515	The new state is given.
17516	</desc>
17517	<attribute name="state" type="MachineState" readonly="yes">
17518	<desc>
17519	New machine state.
17520	</desc>
17521	</attribute>
17522	</interface>
17523
17524	<interface
17525	name="IAdditionsStateChangedEvent" extends="IEvent"
17526	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17527	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17528	>
17529	<desc>
17530	Notification when a Guest Additions property changes.
17531	Interested callees should query IGuest attributes to
17532	find out what has changed.
17533	</desc>
17534	</interface>
17535
17536	<interface
17537	name="INetworkAdapterChangedEvent" extends="IEvent"
17538	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17539	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17540	>
17541	<desc>
17542	Notification when a property of one of the
17543	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17544	changes. Interested callees should use INetworkAdapter methods and
17545	attributes to find out what has changed.
17546	</desc>
17547	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17548	<desc>
17549	Network adapter that is subject to change.
17550	</desc>
17551	</attribute>
17552	</interface>
17553
17554	<interface
17555	name="ISerialPortChangedEvent" extends="IEvent"
17556	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17557	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17558	>
17559	<desc>
17560	Notification when a property of one of the
17561	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17562	Interested callees should use ISerialPort methods and attributes
17563	to find out what has changed.
17564	</desc>
17565	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17566	<desc>
17567	Serial port that is subject to change.
17568	</desc>
17569	</attribute>
17570	</interface>
17571
17572	<interface
17573	name="IParallelPortChangedEvent" extends="IEvent"
17574	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17575	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17576	>
17577	<desc>
17578	Notification when a property of one of the
17579	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17580	changes. Interested callees should use ISerialPort methods and
17581	attributes to find out what has changed.
17582	</desc>
17583	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17584	<desc>
17585	Parallel port that is subject to change.
17586	</desc>
17587	</attribute>
17588	</interface>
17589
17590	<interface
17591	name="IStorageControllerChangedEvent" extends="IEvent"
17592	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17593	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17594	>
17595	<desc>
17596	Notification when a
17597	<link to="IMachine::mediumAttachments">medium attachment</link>
17598	changes.
17599	</desc>
17600	</interface>
17601
17602	<interface
17603	name="IMediumChangedEvent" extends="IEvent"
17604	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17605	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17606	>
17607	<desc>
17608	Notification when a
17609	<link to="IMachine::mediumAttachments">medium attachment</link>
17610	changes.
17611	</desc>
17612	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17613	<desc>
17614	Medium attachment that is subject to change.
17615	</desc>
17616	</attribute>
17617	</interface>
17618
17619	<interface
17620	name="ICPUChangedEvent" extends="IEvent"
17621	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17622	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17623	>
17624	<desc>
17625	Notification when a CPU changes.
17626	</desc>
17627	<attribute name="cpu" type="unsigned long" readonly="yes">
17628	<desc>
17629	The CPU which changed.
17630	</desc>
17631	</attribute>
17632	<attribute name="add" type="boolean" readonly="yes">
17633	<desc>
17634	Flag whether the CPU was added or removed.
17635	</desc>
17636	</attribute>
17637	</interface>
17638
17639	<interface
17640	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17641	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17642	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17643	>
17644	<desc>
17645	Notification when the CPU execution cap changes.
17646	</desc>
17647	<attribute name="executionCap" type="unsigned long" readonly="yes">
17648	<desc>
17649	The new CPU execution cap value. (1-100)
17650	</desc>
17651	</attribute>
17652	</interface>
17653
17654	<interface
17655	name="IGuestKeyboardEvent" extends="IEvent"
17656	uuid="88394258-7006-40d4-b339-472ee3801844"
17657	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17658	>
17659	<desc>
17660	Notification when guest keyboard event happens.
17661	</desc>
17662	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17663	<desc>
17664	Array of scancodes.
17665	</desc>
17666	</attribute>
17667	</interface>
17668
17669	<interface
17670	name="IGuestMouseEvent" extends="IReusableEvent"
17671	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17672	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17673	>
17674	<desc>
17675	Notification when guest mouse event happens.
17676	</desc>
17677
17678	<attribute name="absolute" type="boolean" readonly="yes">
17679	<desc>
17680	If this event is relative or absolute.
17681	</desc>
17682	</attribute>
17683
17684	<attribute name="x" type="long" readonly="yes">
17685	<desc>
17686	New X position, or X delta.
17687	</desc>
17688	</attribute>
17689
17690	<attribute name="y" type="long" readonly="yes">
17691	<desc>
17692	New Y position, or Y delta.
17693	</desc>
17694	</attribute>
17695
17696	<attribute name="z" type="long" readonly="yes">
17697	<desc>
17698	Z delta.
17699	</desc>
17700	</attribute>
17701
17702	<attribute name="w" type="long" readonly="yes">
17703	<desc>
17704	W delta.
17705	</desc>
17706	</attribute>
17707
17708	<attribute name="buttons" type="long" readonly="yes">
17709	<desc>
17710	Button state bitmask.
17711	</desc>
17712	</attribute>
17713
17714	</interface>
17715
17716
17717	<interface
17718	name="IVRDEServerChangedEvent" extends="IEvent"
17719	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17720	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17721	>
17722	<desc>
17723	Notification when a property of the
17724	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17725	Interested callees should use IVRDEServer methods and attributes to
17726	find out what has changed.
17727	</desc>
17728	</interface>
17729
17730	<interface
17731	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17732	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17733	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17734	>
17735	<desc>
17736	Notification when the status of the VRDE server changes. Interested callees
17737	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17738	attributes to find out what is the current status.
17739	</desc>
17740	</interface>
17741
17742	<interface
17743	name="IUSBControllerChangedEvent" extends="IEvent"
17744	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17745	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17746	>
17747	<desc>
17748	Notification when a property of the virtual
17749	<link to="IMachine::USBController">USB controller</link> changes.
17750	Interested callees should use IUSBController methods and attributes to
17751	find out what has changed.
17752	</desc>
17753	</interface>
17754
17755	<interface
17756	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17757	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17758	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17759	>
17760	<desc>
17761	Notification when a USB device is attached to or detached from
17762	the virtual USB controller.
17763
17764	This notification is sent as a result of the indirect
17765	request to attach the device because it matches one of the
17766	machine USB filters, or as a result of the direct request
17767	issued by <link to="IConsole::attachUSBDevice"/> or
17768	<link to="IConsole::detachUSBDevice"/>.
17769
17770	This notification is sent in case of both a succeeded and a
17771	failed request completion. When the request succeeds, the
17772	@a error parameter is @c null, and the given device has been
17773	already added to (when @a attached is @c true) or removed from
17774	(when @a attached is @c false) the collection represented by
17775	<link to="IConsole::USBDevices"/>. On failure, the collection
17776	doesn't change and the @a error parameter represents the error
17777	message describing the failure.
17778	</desc>
17779	<attribute name="device" type="IUSBDevice" readonly="yes">
17780	<desc>
17781	Device that is subject to state change.
17782	</desc>
17783	</attribute>
17784	<attribute name="attached" type="boolean" readonly="yes">
17785	<desc>
17786	@c true if the device was attached and @c false otherwise.
17787	</desc>
17788	</attribute>
17789	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17790	<desc>
17791	@c null on success or an error message object on failure.
17792	</desc>
17793	</attribute>
17794	</interface>
17795
17796	<interface
17797	name="ISharedFolderChangedEvent" extends="IEvent"
17798	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17799	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17800	>
17801	<desc>
17802	Notification when a shared folder is added or removed.
17803	The @a scope argument defines one of three scopes:
17804	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17805	(<link to="Scope_Global">Global</link>),
17806	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17807	the machine (<link to="Scope_Machine">Machine</link>) or <link
17808	to="IConsole::sharedFolders">transient shared folders</link> of the
17809	machine (<link to="Scope_Session">Session</link>). Interested callees
17810	should use query the corresponding collections to find out what has
17811	changed.
17812	</desc>
17813	<attribute name="scope" type="Scope" readonly="yes">
17814	<desc>
17815	Scope of the notification.
17816	</desc>
17817	</attribute>
17818	</interface>
17819
17820	<interface
17821	name="IRuntimeErrorEvent" extends="IEvent"
17822	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17823	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17824	>
17825	<desc>
17826	Notification when an error happens during the virtual
17827	machine execution.
17828
17829	There are three kinds of runtime errors:
17830	<ul>
17831	<li><i>fatal</i></li>
17832	<li><i>non-fatal with retry</i></li>
17833	<li><i>non-fatal warnings</i></li>
17834	</ul>
17835
17836	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17837	to @c true. In case of fatal errors, the virtual machine
17838	execution is always paused before calling this notification, and
17839	the notification handler is supposed either to immediately save
17840	the virtual machine state using <link to="IConsole::saveState"/>
17841	or power it off using <link to="IConsole::powerDown"/>.
17842	Resuming the execution can lead to unpredictable results.
17843
17844	<b>Non-fatal</b> errors and warnings are indicated by the
17845	@a fatal parameter set to @c false. If the virtual machine
17846	is in the Paused state by the time the error notification is
17847	received, it means that the user can <i>try to resume</i> the machine
17848	execution after attempting to solve the problem that caused the
17849	error. In this case, the notification handler is supposed
17850	to show an appropriate message to the user (depending on the
17851	value of the @a id parameter) that offers several actions such
17852	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17853	wants to retry, the notification handler should continue
17854	the machine execution using the <link to="IConsole::resume"/>
17855	call. If the machine execution is not Paused during this
17856	notification, then it means this notification is a <i>warning</i>
17857	(for example, about a fatal condition that can happen very soon);
17858	no immediate action is required from the user, the machine
17859	continues its normal execution.
17860
17861	Note that in either case the notification handler
17862	<b>must not</b> perform any action directly on a thread
17863	where this notification is called. Everything it is allowed to
17864	do is to post a message to another thread that will then talk
17865	to the user and take the corresponding action.
17866
17867	Currently, the following error identifiers are known:
17868	<ul>
17869	<li><tt>"HostMemoryLow"</tt></li>
17870	<li><tt>"HostAudioNotResponding"</tt></li>
17871	<li><tt>"VDIStorageFull"</tt></li>
17872	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17873	</ul>
17874	</desc>
17875	<attribute name="fatal" type="boolean" readonly="yes">
17876	<desc>
17877	Whether the error is fatal or not.
17878	</desc>
17879	</attribute>
17880	<attribute name="id" type="wstring" readonly="yes">
17881	<desc>
17882	Error identifier.
17883	</desc>
17884	</attribute>
17885	<attribute name="message" type="wstring" readonly="yes">
17886	<desc>
17887	Optional error message.
17888	</desc>
17889	</attribute>
17890	</interface>
17891
17892
17893	<interface
17894	name="IEventSourceChangedEvent" extends="IEvent"
17895	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17896	waitable="yes"
17897	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17898	>
17899	<desc>
17900	Notification when an event source state changes (listener added or removed).
17901	</desc>
17902
17903	<attribute name="listener" type="IEventListener" readonly="yes">
17904	<desc>
17905	Event listener which has changed.
17906	</desc>
17907	</attribute>
17908
17909	<attribute name="add" type="boolean" readonly="yes">
17910	<desc>
17911	Flag whether listener was added or removed.
17912	</desc>
17913	</attribute>
17914	</interface>
17915
17916	<interface
17917	name="IExtraDataChangedEvent" extends="IEvent"
17918	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17919	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17920	>
17921	<desc>
17922	Notification when machine specific or global extra data
17923	has changed.
17924	</desc>
17925	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17926	<desc>
17927	ID of the machine this event relates to.
17928	Null for global extra data changes.
17929	</desc>
17930	</attribute>
17931	<attribute name="key" type="wstring" readonly="yes">
17932	<desc>
17933	Extra data key that has changed.
17934	</desc>
17935	</attribute>
17936	<attribute name="value" type="wstring" readonly="yes">
17937	<desc>
17938	Extra data value for the given key.
17939	</desc>
17940	</attribute>
17941	</interface>
17942
17943	<interface
17944	name="IVetoEvent" extends="IEvent"
17945	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17946	wsmap="managed"
17947	>
17948	<desc>Base abstract interface for veto events.</desc>
17949
17950	<method name="addVeto">
17951	<desc>
17952	Adds a veto on this event.
17953	</desc>
17954	<param name="reason" type="wstring" dir="in">
17955	<desc>
17956	Reason for veto, could be null or empty string.
17957	</desc>
17958	</param>
17959	</method>
17960
17961	<method name="isVetoed">
17962	<desc>
17963	If this event was vetoed.
17964	</desc>
17965	<param name="result" type="boolean" dir="return">
17966	<desc>
17967	Reason for veto.
17968	</desc>
17969	</param>
17970	</method>
17971
17972	<method name="getVetos">
17973	<desc>
17974	Current veto reason list, if size is 0 - no veto.
17975	</desc>
17976	<param name="result" type="wstring" dir="return" safearray="yes">
17977	<desc>
17978	Array of reasons for veto provided by different event handlers.
17979	</desc>
17980	</param>
17981	</method>
17982
17983	</interface>
17984
17985	<interface
17986	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17987	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17988	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17989	waitable="true"
17990	>
17991	<desc>
17992	Notification when someone tries to change extra data for
17993	either the given machine or (if @c null) global extra data.
17994	This gives the chance to veto against changes.
17995	</desc>
17996	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17997	<desc>
17998	ID of the machine this event relates to.
17999	Null for global extra data changes.
18000	</desc>
18001	</attribute>
18002	<attribute name="key" type="wstring" readonly="yes">
18003	<desc>
18004	Extra data key that has changed.
18005	</desc>
18006	</attribute>
18007	<attribute name="value" type="wstring" readonly="yes">
18008	<desc>
18009	Extra data value for the given key.
18010	</desc>
18011	</attribute>
18012	</interface>
18013
18014	<interface
18015	name="ICanShowWindowEvent" extends="IVetoEvent"
18016	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
18017	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
18018	waitable="true"
18019	>
18020	<desc>
18021	Notification when a call to
18022	<link to="IMachine::canShowConsoleWindow"/> is made by a
18023	front-end to check if a subsequent call to
18024	<link to="IMachine::showConsoleWindow"/> can succeed.
18025
18026	The callee should give an answer appropriate to the current
18027	machine state using event veto. This answer must
18028	remain valid at least until the next
18029	<link to="IConsole::state">machine state</link> change.
18030	</desc>
18031	</interface>
18032
18033	<interface
18034	name="IShowWindowEvent" extends="IEvent"
18035	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
18036	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
18037	waitable="true"
18038	>
18039	<desc>
18040	Notification when a call to
18041	<link to="IMachine::showConsoleWindow"/>
18042	requests the console window to be activated and brought to
18043	foreground on the desktop of the host PC.
18044
18045	This notification should cause the VM console process to
18046	perform the requested action as described above. If it is
18047	impossible to do it at a time of this notification, this
18048	method should return a failure.
18049
18050	Note that many modern window managers on many platforms
18051	implement some sort of focus stealing prevention logic, so
18052	that it may be impossible to activate a window without the
18053	help of the currently active application (which is supposedly
18054	an initiator of this notification). In this case, this method
18055	must return a non-zero identifier that represents the
18056	top-level window of the VM console process. The caller, if it
18057	represents a currently active process, is responsible to use
18058	this identifier (in a platform-dependent manner) to perform
18059	actual window activation.
18060
18061	This method must set @a winId to zero if it has performed all
18062	actions necessary to complete the request and the console
18063	window is now active and in foreground, to indicate that no
18064	further action is required on the caller's side.
18065	</desc>
18066	<attribute name="winId" type="long long">
18067	<desc>
18068	Platform-dependent identifier of the top-level VM console
18069	window, or zero if this method has performed all actions
18070	necessary to implement the <i>show window</i> semantics for
18071	the given platform and/or this VirtualBox front-end.
18072	</desc>
18073	</attribute>
18074	</interface>
18075
18076	<interface
18077	name="INATRedirectEvent" extends="IMachineEvent"
18078	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
18079	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
18080	>
18081	<desc>
18082	Notification when NAT redirect rule added or removed.
18083	</desc>
18084	<attribute name="slot" type="unsigned long" readonly="yes">
18085	<desc>
18086	Adapter which NAT attached to.
18087	</desc>
18088	</attribute>
18089	<attribute name="remove" type="boolean" readonly="yes">
18090	<desc>
18091	Whether rule remove or add.
18092	</desc>
18093	</attribute>
18094	<attribute name="name" type="wstring" readonly="yes">
18095	<desc>
18096	Name of the rule.
18097	</desc>
18098	</attribute>
18099	<attribute name="proto" type="NATProtocol" readonly="yes">
18100	<desc>
18101	Protocol (TCP or UDP) of the redirect rule.
18102	</desc>
18103	</attribute>
18104	<attribute name="hostIp" type="wstring" readonly="yes">
18105	<desc>
18106	Host ip address to bind socket on.
18107	</desc>
18108	</attribute>
18109	<attribute name="hostPort" type="long" readonly="yes">
18110	<desc>
18111	Host port to bind socket on.
18112	</desc>
18113	</attribute>
18114	<attribute name="guestIp" type="wstring" readonly="yes">
18115	<desc>
18116	Guest ip address to redirect to.
18117	</desc>
18118	</attribute>
18119	<attribute name="guestPort" type="long" readonly="yes">
18120	<desc>
18121	Guest port to redirect to.
18122	</desc>
18123	</attribute>
18124	</interface>
18125
18126	<interface
18127	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
18128	waitable="yes"
18129	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
18130	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
18131	>
18132	<desc>
18133	Notification when host PCI device is plugged/unplugged. Plugging
18134	usually takes place on VM startup, unplug - when
18135	<link to="IMachine::detachHostPciDevice"/> is called.
18136
18137	<see><link to="IMachine::detachHostPciDevice"/></see>
18138
18139	</desc>
18140
18141	<attribute name="plugged" type="boolean" readonly="yes">
18142	<desc>
18143	If device successfully plugged or unplugged.
18144	</desc>
18145	</attribute>
18146
18147	<attribute name="success" type="boolean" readonly="yes">
18148	<desc>
18149	If operation was successful, if false - 'message' attribute
18150	may be of interest.
18151	</desc>
18152	</attribute>
18153
18154	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18155	<desc>
18156	Attachment info for this device.
18157	</desc>
18158	</attribute>
18159
18160	<attribute name="message" type="wstring" readonly="yes">
18161	<desc>
18162	Optional error message.
18163	</desc>
18164	</attribute>
18165
18166	</interface>
18167
18168	<interface
18169	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18170	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18171	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18172	>
18173	<desc>
18174	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18175	unexpected circumstances) or available again.
18176	</desc>
18177
18178	<attribute name="available" type="boolean" readonly="yes">
18179	<desc>
18180	Whether VBoxSVC is available now.
18181	</desc>
18182	</attribute>
18183	</interface>
18184
18185	<interface
18186	name="IBandwidthGroupChangedEvent" extends="IEvent"
18187	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18188	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18189	>
18190	<desc>
18191	Notification when one of the bandwidth groups changed
18192	</desc>
18193	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18194	<desc>
18195	The changed bandwidth group.
18196	</desc>
18197	</attribute>
18198	</interface>
18199
18200	<enum
18201	name="GuestMonitorChangedEventType"
18202	uuid="ef172985-7e36-4297-95be-e46396968d66"
18203	>
18204
18205	<desc>
18206	How the guest monitor has been changed.
18207	</desc>
18208
18209	<const name="Enabled" value="0">
18210	<desc>
18211	The guest monitor has been enabled by the guest.
18212	</desc>
18213	</const>
18214
18215	<const name="Disabled" value="1">
18216	<desc>
18217	The guest monitor has been disabled by the guest.
18218	</desc>
18219	</const>
18220
18221	<const name="NewOrigin" value="2">
18222	<desc>
18223	The guest monitor origin has changed in the guest.
18224	</desc>
18225	</const>
18226	</enum>
18227
18228	<interface
18229	name="IGuestMonitorChangedEvent" extends="IEvent"
18230	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18231	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18232	>
18233	<desc>
18234	Notification when the guest enables one of its monitors.
18235	</desc>
18236
18237	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18238	<desc>
18239	What was changed for this guest monitor.
18240	</desc>
18241	</attribute>
18242
18243	<attribute name="screenId" type="unsigned long" readonly="yes">
18244	<desc>
18245	The monitor which was changed.
18246	</desc>
18247	</attribute>
18248
18249	<attribute name="originX" type="unsigned long" readonly="yes">
18250	<desc>
18251	Physical X origin relative to the primary screen.
18252	Valid for Enabled and NewOrigin.
18253	</desc>
18254	</attribute>
18255
18256	<attribute name="originY" type="unsigned long" readonly="yes">
18257	<desc>
18258	Physical Y origin relative to the primary screen.
18259	Valid for Enabled and NewOrigin.
18260	</desc>
18261	</attribute>
18262
18263	<attribute name="width" type="unsigned long" readonly="yes">
18264	<desc>
18265	Width of the screen.
18266	Valid for Enabled.
18267	</desc>
18268	</attribute>
18269
18270	<attribute name="height" type="unsigned long" readonly="yes">
18271	<desc>
18272	Height of the screen.
18273	Valid for Enabled.
18274	</desc>
18275	</attribute>
18276
18277	</interface>
18278
18279	<interface
18280	name="IStorageDeviceChangedEvent" extends="IEvent"
18281	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18282	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18283	>
18284	<desc>
18285	Notification when a
18286	<link to="IMachine::mediumAttachments">storage device</link>
18287	is attached or removed.
18288	</desc>
18289	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18290	<desc>
18291	Storage device that is subject to change.
18292	</desc>
18293	</attribute>
18294	<attribute name="removed" type="boolean" readonly="yes">
18295	<desc>
18296	Flag whether the device was removed or added to the VM.
18297	</desc>
18298	</attribute>
18299	</interface>
18300
18301	<module name="VBoxSVC" context="LocalServer">
18302	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18303	namespace="virtualbox.org">
18304	<interface name="IVirtualBox" default="yes"/>
18305	</class>
18306	</module>
18307
18308	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18309	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18310	namespace="virtualbox.org">
18311	<interface name="IVirtualBoxClient" default="yes"/>
18312	</class>
18313
18314	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18315	namespace="virtualbox.org">
18316	<interface name="ISession" default="yes"/>
18317	</class>
18318	</module>
18319
18320	</library>
18321
18322	</idl>
18323
18324	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format