VirtualBox.xidl@ 40418

Last change on this file since 40418 was 40418, checked in by vboxsync, 13 years ago
Main: Extended IMachine and the settings XML with three tracing related properties.
Property svn:eol-style set to `native`
File size: 663.7 KB

Line
1	<?xml version="1.0" encoding="utf-8"?>
2
3	<!--
4
5	Copyright (C) 2006-2011 Oracle Corporation
6
7	This file is part of VirtualBox Open Source Edition (OSE), as
8	available from http://www.virtualbox.org. This file is free software;
9	you can redistribute it and/or modify it under the terms of the GNU
10	General Public License (GPL) as published by the Free Software
11	Foundation, in version 2 as it comes in the "COPYING" file of the
12	VirtualBox OSE distribution. VirtualBox OSE is distributed in the
13	hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
14	-->
15
16	<!--
17	This is the master declaration for VirtualBox's Main API,
18	represented by COM/XPCOM and web service interfaces.
19
20	From this document, the build system generates several files
21	via XSLT that are then used during the build process.
22
23	Below is the list of XSL templates that operate on this file and
24	output files they generate. These XSL templates must be updated
25	whenever the schema of this file changes:
26
27	1. src/VBox/Main/idl/midl.xsl =>
28	out/<platform>/bin/sdk/idl/VirtualBox.idl
29	(MS COM interface definition file for Main API)
30
31	2. src/VBox/Main/idl/xpidl.xsl =>
32	out/<platform>/bin/sdk/idl/VirtualBox_XPCOM.idl
33	(XPCOM interface definition file for Main API)
34
35	3. src/VBox/Main/idl/doxygen.xsl =>
36	out/<platform>/obj/src/VBox/Main/VirtualBox.idl
37	(pseudo-IDL for Doxygen to generate the official Main API
38	documentation)
39
40	4. src/VBox/Main/webservice/*.xsl =>
41	a bunch of WSDL and C++ files
42	(VirtualBox web service sources and SOAP mappers;
43	see src/VBox/Main/webservice/Makefile.kmk for details)
44
45	5. src/VBox/Frontends/VirtualBox/include/COMWrappers.xsl =>
46	out/<platform>/obj/src/VBox/Frontends/VirtualBox/VirtualBox/include/COMWrappers.h
47	(smart Qt-based C++ wrapper classes for COM interfaces
48	of the Main API)
49
50	6. src/VBox/Installer/win32/VirtualBox_TypeLib.xsl =>
51	out/<platform>/obj/src/VBox/Installer/win32/VirtualBox_TypeLib.wxi
52	(Main API TypeLib block for the WiX installer)
53
54	7. src/VBox/Runtime/common/err/errmsgvboxcom.xsl =>
55	out/<platform>/obj/Runtime/errmsgvboxcomdata.h
56	(<result> extraction for the %Rhrc format specifier)
57	-->
58
59	<idl>
60
61	<desc>
62	Welcome to the <b>VirtualBox Main API documentation</b>. This documentation
63	describes the so-called <i>VirtualBox Main API</i> which comprises all public
64	COM interfaces and components provided by the VirtualBox server and by the
65	VirtualBox client library.
66
67	VirtualBox employs a client-server design, meaning that whenever any part of
68	VirtualBox is running -- be it the Qt GUI, the VBoxManage command-line
69	interface or any virtual machine --, a dedicated server process named
70	VBoxSVC runs in the background. This allows multiple processes working with
71	VirtualBox to cooperate without conflicts. These processes communicate to each
72	other using inter-process communication facilities provided by the COM
73	implementation of the host computer.
74
75	On Windows platforms, the VirtualBox Main API uses Microsoft COM, a native COM
76	implementation. On all other platforms, Mozilla XPCOM, an open-source COM
77	implementation, is used.
78
79	All the parts that a typical VirtualBox user interacts with (the Qt GUI
80	and the VBoxManage command-line interface) are technically
81	front-ends to the Main API and only use the interfaces that are documented
82	in this Main API documentation. This ensures that, with any given release
83	version of VirtualBox, all capabilities of the product that could be useful
84	to an external client program are always exposed by way of this API.
85
86	The VirtualBox Main API (also called the <i>VirtualBox COM library</i>)
87	contains two public component classes:
88	<tt>%VirtualBox.VirtualBox</tt> and <tt>%VirtualBox.Session</tt>, which
89	implement IVirtualBox and ISession interfaces respectively. These two classes
90	are of supreme importance and will be needed in order for any front-end
91	program to do anything useful. It is recommended to read the documentation of
92	the mentioned interfaces first.
93
94	The <tt>%VirtualBox.VirtualBox</tt> class is a singleton. This means that
95	there can be only one object of this class on the local machine at any given
96	time. This object is a parent of many other objects in the VirtualBox COM
97	library and lives in the VBoxSVC process. In fact, when you create an instance
98	of the <tt>VirtualBox.VirtualBox</tt>, the COM subsystem checks if the VBoxSVC
99	process is already running, starts it if not, and returns you a reference to
100	the <tt>VirtualBox</tt> object created in this process. When the last reference
101	to this object is released, the VBoxSVC process ends (with a 5 second delay to
102	protect from too frequent restarts).
103
104	The <tt>%VirtualBox.Session</tt> class is a regular component. You can create
105	as many <tt>Session</tt> objects as you need but all of them will live in a
106	process which issues the object instantiation call. <tt>Session</tt> objects
107	represent virtual machine sessions which are used to configure virtual
108	machines and control their execution.
109	</desc>
110
111	<if target="midl">
112	<cpp line="enum {"/>
113	<cpp line=" kTypeLibraryMajorVersion = 1,"/>
114	<cpp line=" kTypeLibraryMinorVersion = 0"/>
115	<cpp line="};"/>
116	</if>
117
118	<if target="xpidl">
119	<!-- NS_IMPL_THREADSAFE_ISUPPORTSxx_CI macros are placed here, for convenience -->
120	<cpp>
121	/* currently, nsISupportsImpl.h lacks the below-like macros */
122
123	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI NS_IMPL_QUERY_INTERFACE1_CI
124	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI NS_IMPL_QUERY_INTERFACE2_CI
125	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI NS_IMPL_QUERY_INTERFACE3_CI
126	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI NS_IMPL_QUERY_INTERFACE4_CI
127
128
129	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_CI
130	# define NS_IMPL_THREADSAFE_ISUPPORTS1_CI(_class, _interface) \
131	NS_IMPL_THREADSAFE_ADDREF(_class) \
132	NS_IMPL_THREADSAFE_RELEASE(_class) \
133	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_CI(_class, _interface) \
134	NS_IMPL_CI_INTERFACE_GETTER1(_class, _interface)
135	#endif
136
137	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_CI
138	# define NS_IMPL_THREADSAFE_ISUPPORTS2_CI(_class, _i1, _i2) \
139	NS_IMPL_THREADSAFE_ADDREF(_class) \
140	NS_IMPL_THREADSAFE_RELEASE(_class) \
141	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_CI(_class, _i1, _i2) \
142	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
143	#endif
144
145	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_CI
146	# define NS_IMPL_THREADSAFE_ISUPPORTS3_CI(_class, _i1, _i2, _i3) \
147	NS_IMPL_THREADSAFE_ADDREF(_class) \
148	NS_IMPL_THREADSAFE_RELEASE(_class) \
149	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_CI(_class, _i1, _i2, _i3) \
150	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
151	#endif
152
153	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS4_CI
154	# define NS_IMPL_THREADSAFE_ISUPPORTS4_CI(_class, _i1, _i2, _i3, _i4) \
155	NS_IMPL_THREADSAFE_ADDREF(_class) \
156	NS_IMPL_THREADSAFE_RELEASE(_class) \
157	NS_IMPL_THREADSAFE_QUERY_INTERFACE4_CI(_class, _i1, _i2, _i3, _i4) \
158	NS_IMPL_CI_INTERFACE_GETTER4(_class, _i1, _i2, _i3, _i4)
159	#endif
160
161	#ifndef NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
162	# define NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
163	NS_INTERFACE_MAP_BEGIN(_class) \
164	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
165	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
166	NS_IMPL_QUERY_CLASSINFO(_class) \
167	NS_INTERFACE_MAP_END
168	#endif
169
170	#ifndef NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
171	# define NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
172	_i2, _ic2) \
173	NS_INTERFACE_MAP_BEGIN(_class) \
174	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
175	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
176	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
177	NS_IMPL_QUERY_CLASSINFO(_class) \
178	NS_INTERFACE_MAP_END
179	#endif
180
181	#ifndef NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
182	# define NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
183	_i2, _ic2, _i3, _ic3) \
184	NS_INTERFACE_MAP_BEGIN(_class) \
185	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i1, _ic1) \
186	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i2, _ic2) \
187	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(_i3, _ic3) \
188	NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, _ic1) \
189	NS_IMPL_QUERY_CLASSINFO(_class) \
190	NS_INTERFACE_MAP_END
191	#endif
192
193	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE1_AMBIGUOUS_CI
194	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE2_AMBIGUOUS_CI
195	#define NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI NS_IMPL_QUERY_INTERFACE3_AMBIGUOUS_CI
196
197	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI
198	# define NS_IMPL_THREADSAFE_ISUPPORTS1_AMBIGUOUS_CI(_class, _i1, _ic1) \
199	NS_IMPL_THREADSAFE_ADDREF(_class) \
200	NS_IMPL_THREADSAFE_RELEASE(_class) \
201	NS_IMPL_THREADSAFE_QUERY_INTERFACE1_AMBIGUOUS_CI(_class, _i1, _ic1) \
202	NS_IMPL_CI_INTERFACE_GETTER1(_class, _i1)
203	#endif
204
205	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI
206	# define NS_IMPL_THREADSAFE_ISUPPORTS2_AMBIGUOUS_CI(_class, _i1, _ic1, \
207	_i2, _ic2) \
208	NS_IMPL_THREADSAFE_ADDREF(_class) \
209	NS_IMPL_THREADSAFE_RELEASE(_class) \
210	NS_IMPL_THREADSAFE_QUERY_INTERFACE2_AMBIGUOUS_CI(_class, _i1, _ic1, \
211	_i2, _ic2) \
212	NS_IMPL_CI_INTERFACE_GETTER2(_class, _i1, _i2)
213	#endif
214
215	#ifndef NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI
216	# define NS_IMPL_THREADSAFE_ISUPPORTS3_AMBIGUOUS_CI(_class, _i1, _ic1, \
217	_i2, _ic2, _i3, _ic3) \
218	NS_IMPL_THREADSAFE_ADDREF(_class) \
219	NS_IMPL_THREADSAFE_RELEASE(_class) \
220	NS_IMPL_THREADSAFE_QUERY_INTERFACE3_AMBIGUOUS_CI(_class, _i1, _ic1, \
221	_i2, _ic2, _i3, _ic3) \
222	NS_IMPL_CI_INTERFACE_GETTER3(_class, _i1, _i2, _i3)
223	#endif
224
225	</cpp>
226	</if>
227
228	<library
229	name="VirtualBox"
230	uuid="46137EEC-703B-4fe5-AFD4-7C9BBBBA0259"
231	version="1.3"
232	desc="VirtualBox Type Library"
233	appUuid="819B4D85-9CEE-493C-B6FC-64FFE759B3C9"
234	supportsErrorInfo="yes"
235	>
236
237
238	<!--
239	// COM result codes for VirtualBox
240	/////////////////////////////////////////////////////////////////////////
241	-->
242
243	<descGroup id="VirtualBox_COM_result_codes" title="VirtualBox COM result codes">
244	<desc>
245	This section describes all VirtualBox-specific COM result codes that may
246	be returned by methods of VirtualBox COM interfaces in addition to
247	standard COM result codes.
248
249	Note that along with the result code, every VirtualBox method returns
250	extended error information through the IVirtualBoxErrorInfo interface on
251	failure. This interface is a preferred way to present the error to the end
252	user because it contains a human readable description of the error. Raw
253	result codes, both standard and described in this section, are intended to
254	be used by programs to analyze the reason of a failure and select an
255	appropriate course of action without involving the end user (for example,
256	retry the operation later or make a different call).
257
258	The standard COM result codes that may originate from our methods include:
259
260	<table>
261	<tr><td>E_INVALIDARG</td>
262	<td>
263	Returned when the value of the method's argument is not within the range
264	of valid values. This should not be confused with situations when the
265	value is within the range but simply doesn't suit the current object
266	state and there is a possibility that it will be accepted later (in such
267	cases VirtualBox-specific codes are returned, for example,
268	<link to="VBOX_E_OBJECT_NOT_FOUND"/>).
269	</td>
270	</tr>
271	<tr><td>E_POINTER</td>
272	<td>
273	Returned if a memory pointer for the output argument is invalid (for
274	example, @c null). When pointers representing input arguments (such
275	as strings) are invalid, E_INVALIDARG is returned.
276	</td>
277	</tr>
278	<tr><td>E_ACCESSDENIED</td>
279	<td>
280	Returned when the called object is not ready. Since the lifetime of a
281	public COM object cannot be fully controlled by the implementation,
282	VirtualBox maintains the readiness state for all objects it creates and
283	returns this code in response to any method call on the object that was
284	deactivated by VirtualBox and is not functioning any more.
285	</td>
286	</tr>
287	<tr><td>E_OUTOFMEMORY</td>
288	<td>
289	Returned when a memory allocation operation fails.
290	</td>
291	</tr>
292	</table>
293	</desc>
294	</descGroup>
295
296	<!--
297	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
298	everything in <result>/<desc> after (and including) the first dot, so express
299	the matter of the error code in the first sentence and keep it short.
300	-->
301
302	<result name="VBOX_E_OBJECT_NOT_FOUND" value="0x80BB0001">
303	<desc>
304	Object corresponding to the supplied arguments does not exist.
305	</desc>
306	</result>
307
308	<result name="VBOX_E_INVALID_VM_STATE" value="0x80BB0002">
309	<desc>
310	Current virtual machine state prevents the operation.
311	</desc>
312	</result>
313
314	<result name="VBOX_E_VM_ERROR" value="0x80BB0003">
315	<desc>
316	Virtual machine error occurred attempting the operation.
317	</desc>
318	</result>
319
320	<result name="VBOX_E_FILE_ERROR" value="0x80BB0004">
321	<desc>
322	File not accessible or erroneous file contents.
323	</desc>
324	</result>
325
326	<result name="VBOX_E_IPRT_ERROR" value="0x80BB0005">
327	<desc>
328	Runtime subsystem error.
329	</desc>
330	</result>
331
332	<result name="VBOX_E_PDM_ERROR" value="0x80BB0006">
333	<desc>
334	Pluggable Device Manager error.
335	</desc>
336	</result>
337
338	<result name="VBOX_E_INVALID_OBJECT_STATE" value="0x80BB0007">
339	<desc>
340	Current object state prohibits operation.
341	</desc>
342	</result>
343
344	<result name="VBOX_E_HOST_ERROR" value="0x80BB0008">
345	<desc>
346	Host operating system related error.
347	</desc>
348	</result>
349
350	<result name="VBOX_E_NOT_SUPPORTED" value="0x80BB0009">
351	<desc>
352	Requested operation is not supported.
353	</desc>
354	</result>
355
356	<result name="VBOX_E_XML_ERROR" value="0x80BB000A">
357	<desc>
358	Invalid XML found.
359	</desc>
360	</result>
361
362	<result name="VBOX_E_INVALID_SESSION_STATE" value="0x80BB000B">
363	<desc>
364	Current session state prohibits operation.
365	</desc>
366	</result>
367
368	<result name="VBOX_E_OBJECT_IN_USE" value="0x80BB000C">
369	<desc>
370	Object being in use prohibits operation.
371	</desc>
372	</result>
373
374	<!--
375	Note that src/VBox/Runtime/common/err/errmsgvboxcom.xsl will ignore
376	everything in <result>/<desc> after (and including) the first dot, so express
377	the matter of the error code in the first sentence and keep it short.
378	-->
379
380	<descGroup/>
381
382	<!--
383	// all common enums
384	/////////////////////////////////////////////////////////////////////////
385	-->
386
387	<enum
388	name="SettingsVersion"
389	uuid="52bd6f5f-1adb-4493-975d-581a9c4b803f"
390	>
391	<desc>
392	Settings version of VirtualBox settings files. This is written to
393	the "version" attribute of the root "VirtualBox" element in the settings
394	file XML and indicates which VirtualBox version wrote the file.
395	</desc>
396
397	<const name="Null" value="0">
398	<desc>Null value, indicates invalid version.</desc>
399	</const>
400	<const name="v1_0" value="1">
401	<desc>Legacy settings version, not currently supported.</desc>
402	</const>
403	<const name="v1_1" value="2">
404	<desc>Legacy settings version, not currently supported.</desc>
405	</const>
406	<const name="v1_2" value="3">
407	<desc>Legacy settings version, not currently supported.</desc>
408	</const>
409	<const name="v1_3pre" value="4">
410	<desc>Legacy settings version, not currently supported.</desc>
411	</const>
412	<const name="v1_3" value="5">
413	<desc>Settings version "1.3", written by VirtualBox 2.0.12.</desc>
414	<!--
415	Machine XML: Capitalization of Uart, Lpt elements and many attributes changed.
416	-->
417	</const>
418	<const name="v1_4" value="6">
419	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
420	<!--
421	VirtualBox.xml: big DiskRegistry -> MediaRegistry revamp, various HardDisk types merged
422	(was VirtualDiskImage, VMDKImage, VHDImage, ISCSIHardDisk, CustomHardDisk, DiffHardDisk)
423	-->
424	</const>
425	<const name="v1_5" value="7">
426	<desc>Intermediate settings version, understood by VirtualBox 2.1.x.</desc>
427	<!--
428	2008-09-04: 2.0.0 released
429	2008-11-20: settings version 1.5 introduced
430	2008-12-17: 2.1.0 released
431	Machine changes:
432	guest OS identifiers changed;
433	Machine/Hardware/Display/MonitorCount renamed to monitorCount;
434	Machine/Hardware/Display/Accelerate3D renamed to accelerate3D;
435	Machine/Hardware/CPU/CPUCount/@count changed to CPU/@count
436	-->
437	</const>
438	<const name="v1_6" value="8">
439	<desc>Settings version "1.6", written by VirtualBox 2.1.4 (at least).</desc>
440	<!--
441	2008-12-17: 2.1.0 released
442	2008-12-19: settings version 1.6 introduced (is in 2.1 branch)
443	2009-04-08: 2.2.0 released
444	Machine changes: remove all Machine/Hardware/Network/Adapter/HostInterface[@TAPSetup or @TAPTerminate]/ attributes (done)
445	-->
446	</const>
447	<const name="v1_7" value="9">
448	<desc>Settings version "1.7", written by VirtualBox 2.2.x and 3.0.x.</desc>
449	<!--
450	2008-12-17: 2.1.0 released
451	2009-03-11: settings version 1.7 introduced (is in 2.2 branch)
452	2009-04-08: 2.2.0 released
453	VirtualBox.xml additions: NetserviceRegistry with DHCPServers (done)
454	Machine changes: HardDiskAttachments is now StorageControllers (done)
455	-->
456	</const>
457	<const name="v1_8" value="10">
458	<desc>Intermediate settings version "1.8", understood by VirtualBox 3.1.x.</desc>
459	<!--
460	Machine additions: Display/@accelerate2DVideo (done)
461	-->
462	</const>
463	<const name="v1_9" value="11">
464	<desc>Settings version "1.9", written by VirtualBox 3.1.x.</desc>
465	<!--
466	The big storage controller / DVD / Floppy rework (done)
467	-->
468	</const>
469	<const name="v1_10" value="12">
470	<desc>Settings version "1.10", written by VirtualBox 3.2.x.</desc>
471	<!--
472	Machine changes: RTC localOrUTC (done)
473	CPU hot-plug support
474	-->
475	</const>
476	<const name="v1_11" value="13">
477	<desc>Settings version "1.11", written by VirtualBox 4.0.x.</desc>
478	<!--
479	Machine changes: HD Audio controller, per-machine disk registries,
480	/@format attribute for DVD and floppy images.
481	-->
482	</const>
483	<const name="v1_12" value="14">
484	<desc>Settings version "1.12", written by VirtualBox 4.1.x.</desc>
485	<!--
486	Machine changes: raw PCI device attachment;
487	NetworkAdapter changes: bandwidth group.
488	-->
489	</const>
490	<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="c28be65f-1a8f-43b4-81f1-eb60cb516e66"
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="createAppliance">
1790	<desc>
1791	Creates a new appliance object, which represents an appliance in the Open Virtual Machine
1792	Format (OVF). This can then be used to import an OVF appliance into VirtualBox or to export
1793	machines as an OVF appliance; see the documentation for <link to="IAppliance" /> for details.
1794	</desc>
1795	<param name="appliance" type="IAppliance" dir="return">
1796	<desc>New appliance.</desc>
1797	</param>
1798	</method>
1799
1800	<method name="createHardDisk">
1801	<desc>
1802	Creates a new base medium object that will use the given storage
1803	format and location for medium data.
1804
1805	The actual storage unit is not created by this method. In order to
1806	do it, and before you are able to attach the created medium to
1807	virtual machines, you must call one of the following methods to
1808	allocate a format-specific storage unit at the specified location:
1809	<ul>
1810	<li><link to="IMedium::createBaseStorage"/></li>
1811	<li><link to="IMedium::createDiffStorage"/></li>
1812	</ul>
1813
1814	Some medium attributes, such as <link to="IMedium::id"/>, may
1815	remain uninitialized until the medium storage unit is successfully
1816	created by one of the above methods.
1817
1818	After the storage unit is successfully created, it will be
1819	accessible through the <link to="#findMedium"/> method and can
1820	be found in the <link to="#hardDisks"/> array.
1821
1822	The list of all storage formats supported by this VirtualBox
1823	installation can be obtained using
1824	<link to="ISystemProperties::mediumFormats"/>. If the @a format
1825	attribute is empty or @c null then the default storage format
1826	specified by <link to="ISystemProperties::defaultHardDiskFormat"/> will
1827	be used for creating a storage unit of the medium.
1828
1829	Note that the format of the location string is storage format specific.
1830	See <link to="IMedium::location"/> and IMedium for more details.
1831
1832	<result name="VBOX_E_OBJECT_NOT_FOUND">
1833	@a format identifier is invalid. See
1834	<link to="ISystemProperties::mediumFormats"/>.
1835	</result>
1836	<result name="VBOX_E_FILE_ERROR">
1837	@a location is a not valid file name (for file-based formats only).
1838	</result>
1839	</desc>
1840	<param name="format" type="wstring" dir="in">
1841	<desc>
1842	Identifier of the storage format to use for the new medium.
1843	</desc>
1844	</param>
1845	<param name="location" type="wstring" dir="in">
1846	<desc>
1847	Location of the storage unit for the new medium.
1848	</desc>
1849	</param>
1850	<param name="medium" type="IMedium" dir="return">
1851	<desc>Created medium object.</desc>
1852	</param>
1853	</method>
1854
1855	<method name="openMedium">
1856	<desc>
1857	Opens a medium from an existing storage location.
1858
1859	Once a medium has been opened, it can be passed to other VirtualBox
1860	methods, in particular to <link to="IMachine::attachDevice" />.
1861
1862	Depending on the given device type, the file at the storage location
1863	must be in one of the media formats understood by VirtualBox:
1864
1865	<ul>
1866	<li>With a "HardDisk" device type, the file must be a hard disk image
1867	in one of the formats supported by VirtualBox (see
1868	<link to="ISystemProperties::mediumFormats" />).
1869	After this method succeeds, if the medium is a base medium, it
1870	will be added to the <link to="#hardDisks"/> array attribute. </li>
1871	<li>With a "DVD" device type, the file must be an ISO 9960 CD/DVD image.
1872	After this method succeeds, the medium will be added to the
1873	<link to="#DVDImages"/> array attribute.</li>
1874	<li>With a "Floppy" device type, the file must be an RAW floppy image.
1875	After this method succeeds, the medium will be added to the
1876	<link to="#floppyImages"/> array attribute.</li>
1877	</ul>
1878
1879	After having been opened, the medium can be found by the <link to="#findMedium"/>
1880	method and can be attached to virtual machines. See <link to="IMedium" /> for more details.
1881
1882	The UUID of the newly opened medium will either be retrieved from the
1883	storage location, if the format supports it (e.g. for hard disk images),
1884	or a new UUID will be randomly generated (e.g. for ISO and RAW files).
1885	If for some reason you need to change the medium's UUID, use
1886	<link to="IMedium::setIDs" />.
1887
1888	If a differencing hard disk medium is to be opened by this method, the
1889	operation will succeed only if its parent medium and all ancestors,
1890	if any, are already known to this VirtualBox installation (for example,
1891	were opened by this method before).
1892
1893	This method attempts to guess the storage format of the specified medium
1894	by reading medium data at the specified location.
1895
1896	If @a accessMode is ReadWrite (which it should be for hard disks and floppies),
1897	the image is opened for read/write access and must have according permissions,
1898	as VirtualBox may actually write status information into the disk's metadata
1899	sections.
1900
1901	Note that write access is required for all typical hard disk usage in VirtualBox,
1902	since VirtualBox may need to write metadata such as a UUID into the image.
1903	The only exception is opening a source image temporarily for copying and
1904	cloning (see <link to="IMedium::cloneTo" /> when the image will be closed
1905	again soon.
1906
1907	The format of the location string is storage format specific. See
1908	<link to="IMedium::location"/> and IMedium for more details.
1909
1910	<result name="VBOX_E_FILE_ERROR">
1911	Invalid medium storage file location or could not find the medium
1912	at the specified location.
1913	</result>
1914	<result name="VBOX_E_IPRT_ERROR">
1915	Could not get medium storage format.
1916	</result>
1917	<result name="E_INVALIDARG">
1918	Invalid medium storage format.
1919	</result>
1920	<result name="VBOX_E_INVALID_OBJECT_STATE">
1921	Medium has already been added to a media registry.
1922	</result>
1923	</desc>
1924	<param name="location" type="wstring" dir="in">
1925	<desc>
1926	Location of the storage unit that contains medium data in one of
1927	the supported storage formats.
1928	</desc>
1929	</param>
1930	<param name="deviceType" type="DeviceType" dir="in">
1931	<desc>
1932	Must be one of "HardDisk", "DVD" or "Floppy".
1933	</desc>
1934	</param>
1935	<param name="accessMode" type="AccessMode" dir="in">
1936	<desc>Whether to open the image in read/write or read-only mode. For
1937	a "DVD" device type, this is ignored and read-only mode is always assumed.</desc>
1938	</param>
1939	<param name="forceNewUuid" type="boolean" dir="in">
1940	<desc>Allows the caller to request a completely new medium UUID for
1941	the image which is to be opened. Useful if one intends to open an exact
1942	copy of a previously opened image, as this would normally fail due to
1943	the duplicate UUID.</desc>
1944	</param>
1945	<param name="medium" type="IMedium" dir="return">
1946	<desc>Opened medium object.</desc>
1947	</param>
1948	</method>
1949
1950	<method name="findMedium">
1951	<desc>
1952	Returns a medium of the given type that uses the given fully qualified
1953	location or UUID to store medium data.
1954
1955	The given medium must be known to this VirtualBox installation, i.e.
1956	it must be previously created by <link to="#createHardDisk"/> or opened
1957	by <link to="#openMedium"/>.
1958
1959	The search is done by comparing the value of the @a location argument to
1960	the <link to="IMedium::location"/> and <link to="IMedium::id" />
1961	attributes of each known medium.
1962
1963	On case sensitive file systems, a case sensitive comparison is performed,
1964	otherwise the case of symbols in the file path is ignored.
1965
1966	<result name="VBOX_E_OBJECT_NOT_FOUND">
1967	No medium object matching @a location found.
1968	</result>
1969	</desc>
1970	<param name="location" type="wstring" dir="in">
1971	<desc>What to search for. This can either be the UUID or the location string of an open medium.</desc>
1972	</param>
1973	<param name="type" type="DeviceType" dir="in">
1974	<desc>Device type (must be HardDisk, DVD or Floppy)</desc>
1975	</param>
1976	<param name="medium" type="IMedium" dir="return">
1977	<desc>Medium object, if found.</desc>
1978	</param>
1979	</method>
1980
1981	<method name="getGuestOSType">
1982	<desc>
1983	Returns an object describing the specified guest OS type.
1984
1985	The requested guest OS type is specified using a string which is a
1986	mnemonic identifier of the guest operating system, such as
1987	<tt>"win31"</tt> or <tt>"ubuntu"</tt>. The guest OS type ID of a
1988	particular virtual machine can be read or set using the
1989	<link to="IMachine::OSTypeId"/> attribute.
1990
1991	The <link to="IVirtualBox::guestOSTypes"/> collection contains all
1992	available guest OS type objects. Each object has an
1993	<link to="IGuestOSType::id"/> attribute which contains an identifier of
1994	the guest OS this object describes.
1995
1996	<result name="E_INVALIDARG">
1997	@a id is not a valid Guest OS type.
1998	</result>
1999
2000	</desc>
2001	<param name="id" type="uuid" mod="string" dir="in">
2002	<desc>Guest OS type ID string.</desc>
2003	</param>
2004	<param name="type" type="IGuestOSType" dir="return">
2005	<desc>Guest OS type object.</desc>
2006	</param>
2007	</method>
2008
2009	<method name="createSharedFolder">
2010	<desc>
2011	Creates a new global shared folder by associating the given logical
2012	name with the given host path, adds it to the collection of shared
2013	folders and starts sharing it. Refer to the description of
2014	<link to="ISharedFolder"/> to read more about logical names.
2015	<note>
2016	In the current implementation, this operation is not
2017	implemented.
2018	</note>
2019	</desc>
2020	<param name="name" type="wstring" dir="in">
2021	<desc>Unique logical name of the shared folder.</desc>
2022	</param>
2023	<param name="hostPath" type="wstring" dir="in">
2024	<desc>Full path to the shared folder in the host file system.</desc>
2025	</param>
2026	<param name="writable" type="boolean" dir="in">
2027	<desc>Whether the share is writable or readonly</desc>
2028	</param>
2029	<param name="automount" type="boolean" dir="in">
2030	<desc>Whether the share gets automatically mounted by the guest
2031	or not.</desc>
2032	</param>
2033	</method>
2034
2035	<method name="removeSharedFolder">
2036	<desc>
2037	Removes the global shared folder with the given name previously
2038	created by <link to="#createSharedFolder"/> from the collection of
2039	shared folders and stops sharing it.
2040	<note>
2041	In the current implementation, this operation is not
2042	implemented.
2043	</note>
2044	</desc>
2045	<param name="name" type="wstring" dir="in">
2046	<desc>Logical name of the shared folder to remove.</desc>
2047	</param>
2048	</method>
2049
2050	<method name="getExtraDataKeys">
2051	<desc>
2052	Returns an array representing the global extra data keys which currently
2053	have values defined.
2054	</desc>
2055	<param name="value" type="wstring" dir="return" safearray="yes">
2056	<desc>Array of extra data keys.</desc>
2057	</param>
2058	</method>
2059
2060	<method name="getExtraData">
2061	<desc>
2062	Returns associated global extra data.
2063
2064	If the requested data @a key does not exist, this function will
2065	succeed and return an empty string in the @a value argument.
2066
2067	<result name="VBOX_E_FILE_ERROR">
2068	Settings file not accessible.
2069	</result>
2070	<result name="VBOX_E_XML_ERROR">
2071	Could not parse the settings file.
2072	</result>
2073
2074	</desc>
2075	<param name="key" type="wstring" dir="in">
2076	<desc>Name of the data key to get.</desc>
2077	</param>
2078	<param name="value" type="wstring" dir="return">
2079	<desc>Value of the requested data key.</desc>
2080	</param>
2081	</method>
2082
2083	<method name="setExtraData">
2084	<desc>
2085	Sets associated global extra data.
2086
2087	If you pass @c null or empty string as a key @a value, the given @a key
2088	will be deleted.
2089
2090	<note>
2091	Before performing the actual data change, this method will ask all
2092	registered event listener using the
2093	<link to="IExtraDataCanChangeEvent"/>
2094	notification for a permission. If one of the listeners refuses the
2095	new value, the change will not be performed.
2096	</note>
2097	<note>
2098	On success, the
2099	<link to="IExtraDataChangedEvent"/> notification
2100	is called to inform all registered listeners about a successful data
2101	change.
2102	</note>
2103
2104	<result name="VBOX_E_FILE_ERROR">
2105	Settings file not accessible.
2106	</result>
2107	<result name="VBOX_E_XML_ERROR">
2108	Could not parse the settings file.
2109	</result>
2110	<result name="E_ACCESSDENIED">
2111	Modification request refused.
2112	</result>
2113
2114	</desc>
2115	<param name="key" type="wstring" dir="in">
2116	<desc>Name of the data key to set.</desc>
2117	</param>
2118	<param name="value" type="wstring" dir="in">
2119	<desc>Value to assign to the key.</desc>
2120	</param>
2121	</method>
2122
2123	<!--method name="createDHCPServerForInterface">
2124	<desc>
2125	Creates a dhcp server settings to be used for the given interface
2126	<result name="E_INVALIDARG">
2127	Host network interface @a name already exists.
2128	</result>
2129	</desc>
2130	<param name="interface" type="IHostNetworkInterface" dir="in">
2131	<desc>Network Interface</desc>
2132	</param>
2133	<param name="server" type="IDHCPServer" dir="out">
2134	<desc>Dhcp server settings</desc>
2135	</param>
2136	</method-->
2137
2138	<method name="createDHCPServer">
2139	<desc>
2140	Creates a dhcp server settings to be used for the given internal network name
2141	<result name="E_INVALIDARG">
2142	Host network interface @a name already exists.
2143	</result>
2144	</desc>
2145	<param name="name" type="wstring" dir="in">
2146	<desc>server name</desc>
2147	</param>
2148	<param name="server" type="IDHCPServer" dir="return">
2149	<desc>Dhcp server settings</desc>
2150	</param>
2151	</method>
2152
2153	<method name="findDHCPServerByNetworkName">
2154	<desc>
2155	Searches a dhcp server settings to be used for the given internal network name
2156	<result name="E_INVALIDARG">
2157	Host network interface @a name already exists.
2158	</result>
2159
2160	</desc>
2161	<param name="name" type="wstring" dir="in">
2162	<desc>server name</desc>
2163	</param>
2164	<param name="server" type="IDHCPServer" dir="return">
2165	<desc>Dhcp server settings</desc>
2166	</param>
2167	</method>
2168
2169	<!--method name="findDHCPServerForInterface">
2170	<desc>
2171	Searches a dhcp server settings to be used for the given interface
2172	<result name="E_INVALIDARG">
2173	Host network interface @a name already exists.
2174	</result>
2175	</desc>
2176	<param name="interface" type="IHostNetworkInterface" dir="in">
2177	<desc>Network Interface</desc>
2178	</param>
2179	<param name="server" type="IDHCPServer" dir="out">
2180	<desc>Dhcp server settings</desc>
2181	</param>
2182	</method-->
2183
2184	<method name="removeDHCPServer">
2185	<desc>
2186	Removes the dhcp server settings
2187	<result name="E_INVALIDARG">
2188	Host network interface @a name already exists.
2189	</result>
2190	</desc>
2191	<param name="server" type="IDHCPServer" dir="in">
2192	<desc>Dhcp server settings to be removed</desc>
2193	</param>
2194	</method>
2195
2196
2197	<method name="checkFirmwarePresent">
2198	<desc>
2199	Check if this VirtualBox installation has a firmware
2200	of the given type available, either system-wide or per-user.
2201	Optionally, this may return a hint where this firmware can be
2202	downloaded from.
2203	</desc>
2204	<param name="firmwareType" type="FirmwareType" dir="in">
2205	<desc>
2206	Type of firmware to check.
2207	</desc>
2208	</param>
2209	<param name="version" type="wstring" dir="in">
2210	<desc>Expected version number, usually empty string (presently ignored).</desc>
2211	</param>
2212
2213	<param name="url" type="wstring" dir="out">
2214	<desc>
2215	Suggested URL to download this firmware from.
2216	</desc>
2217	</param>
2218
2219	<param name="file" type="wstring" dir="out">
2220	<desc>
2221	Filename of firmware, only valid if result == TRUE.
2222	</desc>
2223	</param>
2224
2225	<param name="result" type="boolean" dir="return">
2226	<desc>If firmware of this type and version is available.</desc>
2227	</param>
2228	</method>
2229
2230	</interface>
2231
2232	<!--
2233	// IVFSExplorer
2234	/////////////////////////////////////////////////////////////////////////
2235	-->
2236
2237	<enum
2238	name="VFSType"
2239	uuid="813999ba-b949-48a8-9230-aadc6285e2f2"
2240	>
2241	<desc>
2242	Virtual file systems supported by VFSExplorer.
2243	</desc>
2244
2245	<const name="File" value="1" />
2246	<const name="Cloud" value="2" />
2247	<const name="S3" value="3" />
2248	<const name="WebDav" value="4" />
2249	</enum>
2250
2251	<enum
2252	name="VFSFileType"
2253	uuid="714333cd-44e2-415f-a245-d378fa9b1242"
2254	>
2255	<desc>
2256	File types known by VFSExplorer.
2257	</desc>
2258
2259	<const name="Unknown" value="1" />
2260	<const name="Fifo" value="2" />
2261	<const name="DevChar" value="3" />
2262	<const name="Directory" value="4" />
2263	<const name="DevBlock" value="5" />
2264	<const name="File" value="6" />
2265	<const name="SymLink" value="7" />
2266	<const name="Socket" value="8" />
2267	<const name="WhiteOut" value="9" />
2268	</enum>
2269
2270	<interface
2271	name="IVFSExplorer" extends="$unknown"
2272	uuid="003d7f92-d38e-487f-b790-8c5e8631cb2f"
2273	wsmap="managed"
2274	>
2275	<desc>
2276	The VFSExplorer interface unifies access to different file system
2277	types. This includes local file systems as well remote file systems like
2278	S3. For a list of supported types see <link to="VFSType" />.
2279	An instance of this is returned by <link to="IAppliance::createVFSExplorer" />.
2280	</desc>
2281
2282	<attribute name="path" type="wstring" readonly="yes">
2283	<desc>Returns the current path in the virtual file system.</desc>
2284	</attribute>
2285
2286	<attribute name="type" type="VFSType" readonly="yes">
2287	<desc>Returns the file system type which is currently in use.</desc>
2288	</attribute>
2289
2290	<method name="update">
2291	<desc>Updates the internal list of files/directories from the
2292	current directory level. Use <link to="#entryList" /> to get the full list
2293	after a call to this method.</desc>
2294
2295	<param name="aProgress" type="IProgress" dir="return">
2296	<desc>Progress object to track the operation completion.</desc>
2297	</param>
2298	</method>
2299
2300	<method name="cd">
2301	<desc>Change the current directory level.</desc>
2302
2303	<param name="aDir" type="wstring" dir="in">
2304	<desc>The name of the directory to go in.</desc>
2305	</param>
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="cdUp">
2313	<desc>Go one directory upwards from the current directory level.</desc>
2314
2315	<param name="aProgress" type="IProgress" dir="return">
2316	<desc>Progress object to track the operation completion.</desc>
2317	</param>
2318	</method>
2319
2320	<method name="entryList">
2321	<desc>Returns a list of files/directories after a call to <link
2322	to="#update" />. The user is responsible for keeping this internal
2323	list up do date.</desc>
2324
2325	<param name="aNames" type="wstring" safearray="yes" dir="out">
2326	<desc>The list of names for the entries.</desc>
2327	</param>
2328
2329	<param name="aTypes" type="unsigned long" safearray="yes" dir="out">
2330	<desc>The list of types for the entries.</desc>
2331	</param>
2332
2333	<param name="aSizes" type="unsigned long" safearray="yes" dir="out">
2334	<desc>The list of sizes (in bytes) for the entries.</desc>
2335	</param>
2336
2337	<param name="aModes" type="unsigned long" safearray="yes" dir="out">
2338	<desc>The list of file modes (in octal form) for the entries.</desc>
2339	</param>
2340	</method>
2341
2342	<method name="exists">
2343	<desc>Checks if the given file list exists in the current directory
2344	level.</desc>
2345
2346	<param name="aNames" type="wstring" safearray="yes" dir="in">
2347	<desc>The names to check.</desc>
2348	</param>
2349
2350	<param name="aExists" type="wstring" safearray="yes" dir="return">
2351	<desc>The names which exist.</desc>
2352	</param>
2353	</method>
2354
2355	<method name="remove">
2356	<desc>Deletes the given files in the current directory level.</desc>
2357
2358	<param name="aNames" type="wstring" safearray="yes" dir="in">
2359	<desc>The names to remove.</desc>
2360	</param>
2361
2362	<param name="aProgress" type="IProgress" dir="return">
2363	<desc>Progress object to track the operation completion.</desc>
2364	</param>
2365	</method>
2366
2367	</interface>
2368
2369	<enum
2370	name="ImportOptions" extends="$unknown"
2371	uuid="0a981523-3b20-4004-8ee3-dfd322202ace"
2372	>
2373
2374	<desc>
2375	Import options, used with <link to="IAppliance::importMachines" />.
2376	</desc>
2377
2378	<const name="KeepAllMACs" value="1">
2379	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
2380	</const>
2381	<const name="KeepNATMACs" value="2">
2382	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
2383	</const>
2384
2385	</enum>
2386
2387
2388	<!--
2389	// IAppliance
2390	/////////////////////////////////////////////////////////////////////////
2391	-->
2392
2393	<interface
2394	name="IAppliance" extends="$unknown"
2395	uuid="3059cf9e-25c7-4f0b-9fa5-3c42e441670b"
2396	wsmap="managed"
2397	>
2398	<desc>
2399	Represents a platform-independent appliance in OVF format. An instance of this is returned
2400	by <link to="IVirtualBox::createAppliance" />, which can then be used to import and export
2401	virtual machines within an appliance with VirtualBox.
2402
2403	The OVF standard suggests two different physical file formats:
2404
2405	<ol>
2406	<li>If the appliance is distributed as a set of files, there must be at least one XML descriptor
2407	file that conforms to the OVF standard and carries an <tt>.ovf</tt> file extension. If
2408	this descriptor file references other files such as disk images, as OVF appliances typically
2409	do, those additional files must be in the same directory as the descriptor file.</li>
2410
2411	<li>If the appliance is distributed as a single file, it must be in TAR format and have the
2412	<tt>.ova</tt> file extension. This TAR file must then contain at least the OVF descriptor
2413	files and optionally other files.
2414
2415	At this time, VirtualBox does not not yet support the packed (TAR) variant; support will
2416	be added with a later version.</li>
2417	</ol>
2418
2419	<b>Importing</b> an OVF appliance into VirtualBox as instances of
2420	<link to="IMachine" /> involves the following sequence of API calls:
2421
2422	<ol>
2423	<li>Call <link to="IVirtualBox::createAppliance" />. This will create an empty IAppliance object.
2424	</li>
2425
2426	<li>On the new object, call <link to="#read" /> with the full path of the OVF file you
2427	would like to import. So long as this file is syntactically valid, this will succeed
2428	and fill the appliance object with the parsed data from the OVF file.
2429	</li>
2430
2431	<li>Next, call <link to="#interpret" />, which analyzes the OVF data and sets up the
2432	contents of the IAppliance attributes accordingly. These can be inspected by a
2433	VirtualBox front-end such as the GUI, and the suggestions can be displayed to the
2434	user. In particular, the <link to="#virtualSystemDescriptions" /> array contains
2435	instances of <link to="IVirtualSystemDescription" /> which represent the virtual
2436	systems (machines) in the OVF, which in turn describe the virtual hardware prescribed
2437	by the OVF (network and hardware adapters, virtual disk images, memory size and so on).
2438	The GUI can then give the user the option to confirm and/or change these suggestions.
2439	</li>
2440
2441	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2442	virtual system (machine) to override the suggestions made by the <link to="#interpret" /> routine.
2443	</li>
2444
2445	<li>Finally, call <link to="#importMachines" /> to create virtual machines in
2446	VirtualBox as instances of <link to="IMachine" /> that match the information in the
2447	virtual system descriptions. After this call succeeded, the UUIDs of the machines created
2448	can be found in the <link to="#machines" /> array attribute.
2449	</li>
2450	</ol>
2451
2452	<b>Exporting</b> VirtualBox machines into an OVF appliance involves the following steps:
2453
2454	<ol>
2455	<li>As with importing, first call <link to="IVirtualBox::createAppliance" /> to create
2456	an empty IAppliance object.
2457	</li>
2458
2459	<li>For each machine you would like to export, call <link to="IMachine::export" />
2460	with the IAppliance object you just created. Each such call creates one instance of
2461	<link to="IVirtualSystemDescription" /> inside the appliance.
2462	</li>
2463
2464	<li>If desired, call <link to="IVirtualSystemDescription::setFinalValues" /> for each
2465	virtual system (machine) to override the suggestions made by the <link to="IMachine::export"/> routine.
2466	</li>
2467
2468	<li>Finally, call <link to="#write" /> with a path specification to have the OVF
2469	file written.</li>
2470	</ol>
2471
2472	</desc>
2473
2474	<attribute name="path" type="wstring" readonly="yes">
2475	<desc>Path to the main file of the OVF appliance, which is either the <tt>.ovf</tt> or
2476	the <tt>.ova</tt> file passed to <link to="#read" /> (for import) or
2477	<link to="#write" /> (for export).
2478	This attribute is empty until one of these methods has been called.
2479	</desc>
2480	</attribute>
2481
2482	<attribute name="disks" type="wstring" readonly="yes" safearray="yes">
2483	<desc>
2484	Array of virtual disk definitions. One such description exists for each
2485	disk definition in the OVF; each string array item represents one such piece of
2486	disk information, with the information fields separated by tab (\\t) characters.
2487
2488	The caller should be prepared for additional fields being appended to
2489	this string in future versions of VirtualBox and therefore check for
2490	the number of tabs in the strings returned.
2491
2492	In the current version, the following eight fields are returned per string
2493	in the array:
2494
2495	<ol>
2496	<li>Disk ID (unique string identifier given to disk)</li>
2497
2498	<li>Capacity (unsigned integer indicating the maximum capacity of the disk)</li>
2499
2500	<li>Populated size (optional unsigned integer indicating the current size of the
2501	disk; can be approximate; -1 if unspecified)</li>
2502
2503	<li>Format (string identifying the disk format, typically
2504	"http://www.vmware.com/specifications/vmdk.html#sparse")</li>
2505
2506	<li>Reference (where to find the disk image, typically a file name; if empty,
2507	then the disk should be created on import)</li>
2508
2509	<li>Image size (optional unsigned integer indicating the size of the image,
2510	which need not necessarily be the same as the values specified above, since
2511	the image may be compressed or sparse; -1 if not specified)</li>
2512
2513	<li>Chunk size (optional unsigned integer if the image is split into chunks;
2514	presently unsupported and always -1)</li>
2515
2516	<li>Compression (optional string equalling "gzip" if the image is gzip-compressed)</li>
2517	</ol>
2518	</desc>
2519	</attribute>
2520
2521	<attribute name="virtualSystemDescriptions" type="IVirtualSystemDescription" readonly="yes" safearray="yes">
2522	<desc> Array of virtual system descriptions. One such description is created
2523	for each virtual system (machine) found in the OVF.
2524	This array is empty until either <link to="#interpret" /> (for import) or <link to="IMachine::export" />
2525	(for export) has been called.
2526	</desc>
2527	</attribute>
2528
2529	<attribute name="machines" type="wstring" readonly="yes" safearray="yes">
2530	<desc>
2531	Contains the UUIDs of the machines created from the information in this appliances. This is only
2532	relevant for the import case, and will only contain data after a call to <link to="#importMachines" />
2533	succeeded.
2534	</desc>
2535	</attribute>
2536
2537	<method name="read">
2538	<desc>
2539	Reads an OVF file into the appliance object.
2540
2541	This method succeeds if the OVF is syntactically valid and, by itself, without errors. The
2542	mere fact that this method returns successfully does not mean that VirtualBox supports all
2543	features requested by the appliance; this can only be examined after a call to <link to="#interpret" />.
2544	</desc>
2545	<param name="file" type="wstring" dir="in">
2546	<desc>
2547	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2548	on whether the appliance is distributed as a set of files or as a single file, respectively).
2549	</desc>
2550	</param>
2551	<param name="aProgress" type="IProgress" dir="return">
2552	<desc>Progress object to track the operation completion.</desc>
2553	</param>
2554	</method>
2555
2556	<method name="interpret">
2557	<desc>
2558	Interprets the OVF data that was read when the appliance was constructed. After
2559	calling this method, one can inspect the
2560	<link to="#virtualSystemDescriptions" /> array attribute, which will then contain
2561	one <link to="IVirtualSystemDescription" /> for each virtual machine found in
2562	the appliance.
2563
2564	Calling this method is the second step of importing an appliance into VirtualBox;
2565	see <link to="IAppliance" /> for an overview.
2566
2567	After calling this method, one should call <link to="#getWarnings" /> to find out
2568	if problems were encountered during the processing which might later lead to
2569	errors.
2570	</desc>
2571	</method>
2572
2573	<method name="importMachines">
2574	<desc>
2575	Imports the appliance into VirtualBox by creating instances of <link to="IMachine" />
2576	and other interfaces that match the information contained in the appliance as
2577	closely as possible, as represented by the import instructions in the
2578	<link to="#virtualSystemDescriptions" /> array.
2579
2580	Calling this method is the final step of importing an appliance into VirtualBox;
2581	see <link to="IAppliance" /> for an overview.
2582
2583	Since importing the appliance will most probably involve copying and converting
2584	disk images, which can take a long time, this method operates asynchronously and
2585	returns an IProgress object to allow the caller to monitor the progress.
2586
2587	After the import succeeded, the UUIDs of the IMachine instances created can be
2588	retrieved from the <link to="#machines" /> array attribute.
2589	</desc>
2590
2591	<param name="options" type="ImportOptions" dir="in" safearray="yes">
2592	<desc>Options for the importing operation.</desc>
2593	</param>
2594
2595	<param name="aProgress" type="IProgress" dir="return">
2596	<desc>Progress object to track the operation completion.</desc>
2597	</param>
2598	</method>
2599
2600	<method name="createVFSExplorer">
2601	<desc>Returns a <link to="IVFSExplorer" /> object for the given URI.</desc>
2602
2603	<param name="aUri" type="wstring" dir="in">
2604	<desc>The URI describing the file system to use.</desc>
2605	</param>
2606
2607	<param name="aExplorer" type="IVFSExplorer" dir="return">
2608	<desc></desc>
2609	</param>
2610	</method>
2611
2612	<method name="write">
2613	<desc>
2614	Writes the contents of the appliance exports into a new OVF file.
2615
2616	Calling this method is the final step of exporting an appliance from VirtualBox;
2617	see <link to="IAppliance" /> for an overview.
2618
2619	Since exporting the appliance will most probably involve copying and converting
2620	disk images, which can take a long time, this method operates asynchronously and
2621	returns an IProgress object to allow the caller to monitor the progress.
2622	</desc>
2623	<param name="format" type="wstring" dir="in">
2624	<desc>
2625	Output format, as a string. Currently supported formats are "ovf-0.9", "ovf-1.0"
2626	and "ovf-2.0"; future versions of VirtualBox may support additional formats.
2627	</desc>
2628	</param>
2629	<param name="manifest" type="boolean" dir="in">
2630	<desc>
2631	Indicate if the optional manifest file (.mf) should be written. The manifest file
2632	is used for integrity checks prior import.
2633	</desc>
2634	</param>
2635	<param name="path" type="wstring" dir="in">
2636	<desc>
2637	Name of appliance file to open (either with an <tt>.ovf</tt> or <tt>.ova</tt> extension, depending
2638	on whether the appliance is distributed as a set of files or as a single file, respectively).
2639	</desc>
2640	</param>
2641	<param name="progress" type="IProgress" dir="return">
2642	<desc>Progress object to track the operation completion.</desc>
2643	</param>
2644	</method>
2645
2646	<method name="getWarnings">
2647	<desc>Returns textual warnings which occurred during execution of <link to="#interpret" />.</desc>
2648
2649	<param name="aWarnings" type="wstring" dir="return" safearray="yes">
2650	<desc></desc>
2651	</param>
2652	</method>
2653
2654	</interface>
2655
2656	<enum
2657	name="VirtualSystemDescriptionType"
2658	uuid="303c0900-a746-4612-8c67-79003e91f459"
2659	>
2660	<desc>Used with <link to="IVirtualSystemDescription" /> to describe the type of
2661	a configuration value.</desc>
2662
2663	<const name="Ignore" value="1" />
2664	<const name="OS" value="2" />
2665	<const name="Name" value="3" />
2666	<const name="Product" value="4" />
2667	<const name="Vendor" value="5" />
2668	<const name="Version" value="6" />
2669	<const name="ProductUrl" value="7" />
2670	<const name="VendorUrl" value="8" />
2671	<const name="Description" value="9" />
2672	<const name="License" value="10" />
2673	<const name="Miscellaneous" value="11" />
2674	<const name="CPU" value="12" />
2675	<const name="Memory" value="13" />
2676	<const name="HardDiskControllerIDE" value="14" />
2677	<const name="HardDiskControllerSATA" value="15" />
2678	<const name="HardDiskControllerSCSI" value="16" />
2679	<const name="HardDiskControllerSAS" value="17" />
2680	<const name="HardDiskImage" value="18" />
2681	<const name="Floppy" value="19" />
2682	<const name="CDROM" value="20" />
2683	<const name="NetworkAdapter" value="21" />
2684	<const name="USBController" value="22" />
2685	<const name="SoundCard" value="23" />
2686	<const name="SettingsFile" value="24">
2687	<desc>Not used/implemented right now, will be added later in 4.1.x.</desc>
2688	</const>
2689	</enum>
2690
2691	<enum
2692	name="VirtualSystemDescriptionValueType"
2693	uuid="56d9403f-3425-4118-9919-36f2a9b8c77c"
2694	>
2695	<desc>Used with <link to="IVirtualSystemDescription::getValuesByType" /> to describe the value
2696	type to fetch.</desc>
2697
2698	<const name="Reference" value="1" />
2699	<const name="Original" value="2" />
2700	<const name="Auto" value="3" />
2701	<const name="ExtraConfig" value="4" />
2702
2703	</enum>
2704
2705	<interface
2706	name="IVirtualSystemDescription" extends="$unknown"
2707	uuid="d7525e6c-531a-4c51-8e04-41235083a3d8"
2708	wsmap="managed"
2709	>
2710
2711	<desc>Represents one virtual system (machine) in an appliance. This interface is used in
2712	the <link to="IAppliance::virtualSystemDescriptions" /> array. After
2713	<link to="IAppliance::interpret" /> has been called, that array contains information
2714	about how the virtual systems described in the OVF should best be imported into
2715	VirtualBox virtual machines. See <link to="IAppliance" /> for the steps required to
2716	import an OVF into VirtualBox.
2717	</desc>
2718
2719	<attribute name="count" type="unsigned long" readonly="yes">
2720	<desc>Return the number of virtual system description entries.</desc>
2721	</attribute>
2722
2723	<method name="getDescription">
2724	<desc>Returns information about the virtual system as arrays of instruction items. In each array, the
2725	items with the same indices correspond and jointly represent an import instruction for VirtualBox.
2726
2727	The list below identifies the value sets that are possible depending on the
2728	<link to="VirtualSystemDescriptionType" /> enum value in the array item in @a aTypes[]. In each case,
2729	the array item with the same index in @a aOvfValues[] will contain the original value as contained
2730	in the OVF file (just for informational purposes), and the corresponding item in @a aVBoxValues[]
2731	will contain a suggested value to be used for VirtualBox. Depending on the description type,
2732	the @a aExtraConfigValues[] array item may also be used.
2733
2734	<ul>
2735	<li>
2736	"OS": the guest operating system type. There must be exactly one such array item on import. The
2737	corresponding item in @a aVBoxValues[] contains the suggested guest operating system for VirtualBox.
2738	This will be one of the values listed in <link to="IVirtualBox::guestOSTypes" />. The corresponding
2739	item in @a aOvfValues[] will contain a numerical value that described the operating system in the OVF.
2740	</li>
2741	<li>
2742	"Name": the name to give to the new virtual machine. There can be at most one such array item;
2743	if none is present on import, then an automatic name will be created from the operating system
2744	type. The corresponding item im @a aOvfValues[] will contain the suggested virtual machine name
2745	from the OVF file, and @a aVBoxValues[] will contain a suggestion for a unique VirtualBox
2746	<link to="IMachine" /> name that does not exist yet.
2747	</li>
2748	<li>
2749	"Description": an arbitrary description.
2750	</li>
2751	<li>
2752	"License": the EULA section from the OVF, if present. It is the responsibility of the calling
2753	code to display such a license for agreement; the Main API does not enforce any such policy.
2754	</li>
2755	<li>
2756	Miscellaneous: reserved for future use.
2757	</li>
2758	<li>
2759	"CPU": the number of CPUs. There can be at most one such item, which will presently be ignored.
2760	</li>
2761	<li>
2762	"Memory": the amount of guest RAM, in bytes. There can be at most one such array item; if none
2763	is present on import, then VirtualBox will set a meaningful default based on the operating system
2764	type.
2765	</li>
2766	<li>
2767	"HardDiskControllerIDE": an IDE hard disk controller. There can be at most two such items.
2768	An optional value in @a aOvfValues[] and @a aVBoxValues[] can be "PIIX3" or "PIIX4" to specify
2769	the type of IDE controller; this corresponds to the ResourceSubType element which VirtualBox
2770	writes into the OVF.
2771	The matching item in the @a aRefs[] array will contain an integer that items of the "Harddisk"
2772	type can use to specify which hard disk controller a virtual disk should be connected to.
2773	Note that in OVF, an IDE controller has two channels, corresponding to "master" and "slave"
2774	in traditional terminology, whereas the IDE storage controller that VirtualBox supports in
2775	its virtual machines supports four channels (primary master, primary slave, secondary master,
2776	secondary slave) and thus maps to two IDE controllers in the OVF sense.
2777	</li>
2778	<li>
2779	"HardDiskControllerSATA": an SATA hard disk controller. There can be at most one such item. This
2780	has no value in @a aOvfValues[] or @a aVBoxValues[].
2781	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2782	</li>
2783	<li>
2784	"HardDiskControllerSCSI": a SCSI hard disk controller. There can be at most one such item.
2785	The items in @a aOvfValues[] and @a aVBoxValues[] will either be "LsiLogic", "BusLogic" or
2786	"LsiLogicSas". (Note that in OVF, the LsiLogicSas controller is treated as a SCSI controller
2787	whereas VirtualBox considers it a class of storage controllers of its own; see
2788	<link to="StorageControllerType" />).
2789	The matching item in the @a aRefs[] array will be used as with IDE controllers (see above).
2790	</li>
2791	<li>
2792	"HardDiskImage": a virtual hard disk, most probably as a reference to an image file. There can be an
2793	arbitrary number of these items, one for each virtual disk image that accompanies the OVF.
2794
2795	The array item in @a aOvfValues[] will contain the file specification from the OVF file (without
2796	a path since the image file should be in the same location as the OVF file itself), whereas the
2797	item in @a aVBoxValues[] will contain a qualified path specification to where VirtualBox uses the
2798	hard disk image. This means that on import the image will be copied and converted from the
2799	"ovf" location to the "vbox" location; on export, this will be handled the other way round.
2800
2801	The matching item in the @a aExtraConfigValues[] array must contain a string of the following
2802	format: "controller=<index>;channel=<c>"
2803	In this string, <index> must be an integer specifying the hard disk controller to connect
2804	the image to. That number must be the index of an array item with one of the hard disk controller
2805	types (HardDiskControllerSCSI, HardDiskControllerSATA, HardDiskControllerIDE).
2806	In addition, <c> must specify the channel to use on that controller. For IDE controllers,
2807	this can be 0 or 1 for master or slave, respectively. For compatibility with VirtualBox versions
2808	before 3.2, the values 2 and 3 (for secondary master and secondary slave) are also supported, but
2809	no longer exported. For SATA and SCSI controllers, the channel can range from 0-29.
2810	</li>
2811	<li>
2812	"CDROM": a virtual CD-ROM drive. The matching item in @a aExtraConfigValue[] contains the same
2813	attachment information as with "HardDiskImage" items.
2814	</li>
2815	<li>
2816	"CDROM": a virtual floppy drive. The matching item in @a aExtraConfigValue[] contains the same
2817	attachment information as with "HardDiskImage" items.
2818	</li>
2819	<li>
2820	"NetworkAdapter": a network adapter. The array item in @a aVBoxValues[] will specify the hardware
2821	for the network adapter, whereas the array item in @a aExtraConfigValues[] will have a string
2822	of the "type=<X>" format, where <X> must be either "NAT" or "Bridged".
2823	</li>
2824	<li>
2825	"USBController": a USB controller. There can be at most one such item. If and only if such an
2826	item ispresent, USB support will be enabled for the new virtual machine.
2827	</li>
2828	<li>
2829	"SoundCard": a sound card. There can be at most one such item. If and only if such an item is
2830	present, sound support will be enabled for the new virtual machine. Note that the virtual
2831	machine in VirtualBox will always be presented with the standard VirtualBox soundcard, which
2832	may be different from the virtual soundcard expected by the appliance.
2833	</li>
2834	</ul>
2835
2836	</desc>
2837
2838	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2839	<desc></desc>
2840	</param>
2841
2842	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2843	<desc></desc>
2844	</param>
2845
2846	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2847	<desc></desc>
2848	</param>
2849
2850	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2851	<desc></desc>
2852	</param>
2853
2854	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2855	<desc></desc>
2856	</param>
2857
2858	</method>
2859
2860	<method name="getDescriptionByType">
2861	<desc>This is the same as <link to="#getDescription" /> except that you can specify which types
2862	should be returned.</desc>
2863
2864	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2865	<desc></desc>
2866	</param>
2867
2868	<param name="aTypes" type="VirtualSystemDescriptionType" dir="out" safearray="yes">
2869	<desc></desc>
2870	</param>
2871
2872	<param name="aRefs" type="wstring" dir="out" safearray="yes">
2873	<desc></desc>
2874	</param>
2875
2876	<param name="aOvfValues" type="wstring" dir="out" safearray="yes">
2877	<desc></desc>
2878	</param>
2879
2880	<param name="aVBoxValues" type="wstring" dir="out" safearray="yes">
2881	<desc></desc>
2882	</param>
2883
2884	<param name="aExtraConfigValues" type="wstring" dir="out" safearray="yes">
2885	<desc></desc>
2886	</param>
2887
2888	</method>
2889
2890	<method name="getValuesByType">
2891	<desc>This is the same as <link to="#getDescriptionByType" /> except that you can specify which
2892	value types should be returned. See <link to="VirtualSystemDescriptionValueType" /> for possible
2893	values.</desc>
2894
2895	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2896	<desc></desc>
2897	</param>
2898
2899	<param name="aWhich" type="VirtualSystemDescriptionValueType" dir="in">
2900	<desc></desc>
2901	</param>
2902
2903	<param name="aValues" type="wstring" dir="return" safearray="yes">
2904	<desc></desc>
2905	</param>
2906
2907	</method>
2908
2909	<method name="setFinalValues">
2910	<desc>
2911	This method allows the appliance's user to change the configuration for the virtual
2912	system descriptions. For each array item returned from <link to="#getDescription" />,
2913	you must pass in one boolean value and one configuration value.
2914
2915	Each item in the boolean array determines whether the particular configuration item
2916	should be enabled.
2917	You can only disable items of the types HardDiskControllerIDE, HardDiskControllerSATA,
2918	HardDiskControllerSCSI, HardDiskImage, CDROM, Floppy, NetworkAdapter, USBController
2919	and SoundCard.
2920
2921	For the "vbox" and "extra configuration" values, if you pass in the same arrays
2922	as returned in the aVBoxValues and aExtraConfigValues arrays from <link to="#getDescription"/>,
2923	the configuration remains unchanged. Please see the documentation for <link to="#getDescription"/>
2924	for valid configuration values for the individual array item types. If the
2925	corresponding item in the aEnabled array is @c false, the configuration value is ignored.
2926	</desc>
2927
2928	<param name="aEnabled" type="boolean" dir="in" safearray="yes">
2929	<desc></desc>
2930	</param>
2931
2932	<param name="aVBoxValues" type="wstring" dir="in" safearray="yes">
2933	<desc></desc>
2934	</param>
2935
2936	<param name="aExtraConfigValues" type="wstring" dir="in" safearray="yes">
2937	<desc></desc>
2938	</param>
2939	</method>
2940
2941	<method name="addDescription">
2942	<desc>
2943	This method adds an additional description entry to the stack of already
2944	available descriptions for this virtual system. This is handy for writing
2945	values which aren't directly supported by VirtualBox. One example would
2946	be the License type of <link to="VirtualSystemDescriptionType" />.
2947	</desc>
2948
2949	<param name="aType" type="VirtualSystemDescriptionType" dir="in">
2950	<desc></desc>
2951	</param>
2952
2953	<param name="aVBoxValue" type="wstring" dir="in">
2954	<desc></desc>
2955	</param>
2956
2957	<param name="aExtraConfigValue" type="wstring" dir="in">
2958	<desc></desc>
2959	</param>
2960	</method>
2961	</interface>
2962
2963
2964	<!--
2965	// IMachine
2966	/////////////////////////////////////////////////////////////////////////
2967	-->
2968
2969	<interface
2970	name="IInternalMachineControl" extends="$unknown"
2971	uuid="2087906d-bb92-43a0-8014-4cab009e4888"
2972	internal="yes"
2973	wsmap="suppress"
2974	>
2975	<method name="setRemoveSavedStateFile">
2976	<desc>
2977	Updates the flag whether the saved state file is removed on a
2978	machine state change from Saved to PoweredOff.
2979	</desc>
2980	<param name="aRemove" type="boolean" dir="in"/>
2981	</method>
2982
2983	<method name="updateState">
2984	<desc>
2985	Updates the VM state.
2986	<note>
2987	This operation will also update the settings file with the correct
2988	information about the saved state file and delete this file from disk
2989	when appropriate.
2990	</note>
2991	</desc>
2992	<param name="state" type="MachineState" dir="in"/>
2993	</method>
2994
2995	<method name="getIPCId">
2996	<param name="id" type="wstring" dir="return"/>
2997	</method>
2998
2999	<method name="beginPowerUp">
3000	<desc>
3001	Tells VBoxSVC that <link to="IConsole::powerUp"/> is under ways and
3002	gives it the progress object that should be part of any pending
3003	<link to="IMachine::launchVMProcess"/> operations. The progress
3004	object may be called back to reflect an early cancelation, so some care
3005	have to be taken with respect to any cancelation callbacks. The console
3006	object will call <link to="IInternalMachineControl::endPowerUp"/>
3007	to signal the completion of the progress object.
3008	</desc>
3009	<param name="aProgress" type="IProgress" dir="in" />
3010	</method>
3011
3012	<method name="endPowerUp">
3013	<desc>
3014	Tells VBoxSVC that <link to="IConsole::powerUp"/> has completed.
3015	This method may query status information from the progress object it
3016	received in <link to="IInternalMachineControl::beginPowerUp"/> and copy
3017	it over to any in-progress <link to="IMachine::launchVMProcess"/>
3018	call in order to complete that progress object.
3019	</desc>
3020	<param name="result" type="long" dir="in"/>
3021	</method>
3022
3023	<method name="beginPoweringDown">
3024	<desc>
3025	Called by the VM process to inform the server it wants to
3026	stop the VM execution and power down.
3027	</desc>
3028	<param name="progress" type="IProgress" dir="out">
3029	<desc>
3030	Progress object created by VBoxSVC to wait until
3031	the VM is powered down.
3032	</desc>
3033	</param>
3034	</method>
3035
3036	<method name="endPoweringDown">
3037	<desc>
3038	Called by the VM process to inform the server that powering
3039	down previously requested by #beginPoweringDown is either
3040	successfully finished or there was a failure.
3041
3042	<result name="VBOX_E_FILE_ERROR">
3043	Settings file not accessible.
3044	</result>
3045	<result name="VBOX_E_XML_ERROR">
3046	Could not parse the settings file.
3047	</result>
3048
3049	</desc>
3050
3051	<param name="result" type="long" dir="in">
3052	<desc>@c S_OK to indicate success.
3053	</desc>
3054	</param>
3055	<param name="errMsg" type="wstring" dir="in">
3056	<desc>@c human readable error message in case of failure.
3057	</desc>
3058	</param>
3059	</method>
3060
3061	<method name="runUSBDeviceFilters">
3062	<desc>
3063	Asks the server to run USB devices filters of the associated
3064	machine against the given USB device and tell if there is
3065	a match.
3066	<note>
3067	Intended to be used only for remote USB devices. Local
3068	ones don't require to call this method (this is done
3069	implicitly by the Host and USBProxyService).
3070	</note>
3071	</desc>
3072	<param name="device" type="IUSBDevice" dir="in"/>
3073	<param name="matched" type="boolean" dir="out"/>
3074	<param name="maskedInterfaces" type="unsigned long" dir="out"/>
3075	</method>
3076
3077	<method name="captureUSBDevice">
3078	<desc>
3079	Requests a capture of the given host USB device.
3080	When the request is completed, the VM process will
3081	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3082	notification.
3083	</desc>
3084	<param name="id" type="uuid" mod="string" dir="in"/>
3085	</method>
3086
3087	<method name="detachUSBDevice">
3088	<desc>
3089	Notification that a VM is going to detach (@a done = @c false) or has
3090	already detached (@a done = @c true) the given USB device.
3091	When the @a done = @c true request is completed, the VM process will
3092	get a <link to="IInternalSessionControl::onUSBDeviceDetach"/>
3093	notification.
3094	<note>
3095	In the @a done = @c true case, the server must run its own filters
3096	and filters of all VMs but this one on the detached device
3097	as if it were just attached to the host computer.
3098	</note>
3099	</desc>
3100	<param name="id" type="uuid" mod="string" dir="in"/>
3101	<param name="done" type="boolean" dir="in"/>
3102	</method>
3103
3104	<method name="autoCaptureUSBDevices">
3105	<desc>
3106	Requests a capture all matching USB devices attached to the host.
3107	When the request is completed, the VM process will
3108	get a <link to="IInternalSessionControl::onUSBDeviceAttach"/>
3109	notification per every captured device.
3110	</desc>
3111	</method>
3112
3113	<method name="detachAllUSBDevices">
3114	<desc>
3115	Notification that a VM that is being powered down. The done
3116	parameter indicates whether which stage of the power down
3117	we're at. When @a done = @c false the VM is announcing its
3118	intentions, while when @a done = @c true the VM is reporting
3119	what it has done.
3120	<note>
3121	In the @a done = @c true case, the server must run its own filters
3122	and filters of all VMs but this one on all detach devices as
3123	if they were just attached to the host computer.
3124	</note>
3125	</desc>
3126	<param name="done" type="boolean" dir="in"/>
3127	</method>
3128
3129	<method name="onSessionEnd">
3130	<desc>
3131	Triggered by the given session object when the session is about
3132	to close normally.
3133	</desc>
3134	<param name="session" type="ISession" dir="in">
3135	<desc>Session that is being closed</desc>
3136	</param>
3137	<param name="progress" type="IProgress" dir="return">
3138	<desc>
3139	Used to wait until the corresponding machine is actually
3140	dissociated from the given session on the server.
3141	Returned only when this session is a direct one.
3142	</desc>
3143	</param>
3144	</method>
3145
3146	<method name="beginSavingState">
3147	<desc>
3148	Called by the VM process to inform the server it wants to
3149	save the current state and stop the VM execution.
3150	</desc>
3151	<param name="progress" type="IProgress" dir="out">
3152	<desc>
3153	Progress object created by VBoxSVC to wait until
3154	the state is saved.
3155	</desc>
3156	</param>
3157	<param name="stateFilePath" type="wstring" dir="out">
3158	<desc>
3159	File path the VM process must save the execution state to.
3160	</desc>
3161	</param>
3162	</method>
3163
3164	<method name="endSavingState">
3165	<desc>
3166	Called by the VM process to inform the server that saving
3167	the state previously requested by #beginSavingState is either
3168	successfully finished or there was a failure.
3169
3170	<result name="VBOX_E_FILE_ERROR">
3171	Settings file not accessible.
3172	</result>
3173	<result name="VBOX_E_XML_ERROR">
3174	Could not parse the settings file.
3175	</result>
3176
3177	</desc>
3178
3179	<param name="result" type="long" dir="in">
3180	<desc>@c S_OK to indicate success.
3181	</desc>
3182	</param>
3183	<param name="errMsg" type="wstring" dir="in">
3184	<desc>@c human readable error message in case of failure.
3185	</desc>
3186	</param>
3187	</method>
3188
3189	<method name="adoptSavedState">
3190	<desc>
3191	Gets called by <link to="IConsole::adoptSavedState"/>.
3192	<result name="VBOX_E_FILE_ERROR">
3193	Invalid saved state file path.
3194	</result>
3195	</desc>
3196	<param name="savedStateFile" type="wstring" dir="in">
3197	<desc>Path to the saved state file to adopt.</desc>
3198	</param>
3199	</method>
3200
3201	<method name="beginTakingSnapshot">
3202	<desc>
3203	Called from the VM process to request from the server to perform the
3204	server-side actions of creating a snapshot (creating differencing images
3205	and the snapshot object).
3206
3207	<result name="VBOX_E_FILE_ERROR">
3208	Settings file not accessible.
3209	</result>
3210	<result name="VBOX_E_XML_ERROR">
3211	Could not parse the settings file.
3212	</result>
3213	</desc>
3214	<param name="initiator" type="IConsole" dir="in">
3215	<desc>The console object that initiated this call.</desc>
3216	</param>
3217	<param name="name" type="wstring" dir="in">
3218	<desc>Snapshot name.</desc>
3219	</param>
3220	<param name="description" type="wstring" dir="in">
3221	<desc>Snapshot description.</desc>
3222	</param>
3223	<param name="consoleProgress" type="IProgress" dir="in">
3224	<desc>
3225	Progress object created by the VM process tracking the
3226	snapshot's progress. This has the following sub-operations:
3227	<ul>
3228	<li>setting up (weight 1);</li>
3229	<li>one for each medium attachment that needs a differencing image (weight 1 each);</li>
3230	<li>another one to copy the VM state (if offline with saved state, weight is VM memory size in MB);</li>
3231	<li>another one to save the VM state (if online, weight is VM memory size in MB);</li>
3232	<li>finishing up (weight 1)</li>
3233	</ul>
3234	</desc>
3235	</param>
3236	<param name="fTakingSnapshotOnline" type="boolean" dir="in">
3237	<desc>
3238	Whether this is an online snapshot (i.e. the machine is running).
3239	</desc>
3240	</param>
3241	<param name="stateFilePath" type="wstring" dir="out">
3242	<desc>
3243	File path the VM process must save the execution state to.
3244	</desc>
3245	</param>
3246	</method>
3247
3248	<method name="endTakingSnapshot">
3249	<desc>
3250	Called by the VM process to inform the server that the snapshot
3251	previously requested by #beginTakingSnapshot is either
3252	successfully taken or there was a failure.
3253	</desc>
3254
3255	<param name="success" type="boolean" dir="in">
3256	<desc>@c true to indicate success and @c false otherwise</desc>
3257	</param>
3258	</method>
3259
3260	<method name="deleteSnapshot">
3261	<desc>
3262	Gets called by <link to="IConsole::deleteSnapshot"/>,
3263	<link to="IConsole::deleteSnapshotAndAllChildren"/> and
3264	<link to="IConsole::deleteSnapshotRange"/>.
3265	<result name="VBOX_E_INVALID_OBJECT_STATE">
3266	Snapshot has more than one child snapshot. Only possible if the
3267	delete operation does not delete all children or the range does
3268	not meet the linearity condition.
3269	</result>
3270	</desc>
3271	<param name="initiator" type="IConsole" dir="in">
3272	<desc>The console object that initiated this call.</desc>
3273	</param>
3274	<param name="startId" type="uuid" mod="string" dir="in">
3275	<desc>UUID of the first snapshot to delete.</desc>
3276	</param>
3277	<param name="endId" type="uuid" mod="string" dir="in">
3278	<desc>UUID of the last snapshot to delete.</desc>
3279	</param>
3280	<param name="deleteAllChildren" type="boolean" dir="in">
3281	<desc>Whether all children should be deleted.</desc>
3282	</param>
3283	<param name="machineState" type="MachineState" dir="out">
3284	<desc>New machine state after this operation is started.</desc>
3285	</param>
3286	<param name="progress" type="IProgress" dir="return">
3287	<desc>Progress object to track the operation completion.</desc>
3288	</param>
3289	</method>
3290
3291	<method name="finishOnlineMergeMedium">
3292	<desc>
3293	Gets called by <link to="IInternalSessionControl::onlineMergeMedium"/>.
3294	</desc>
3295	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
3296	<desc>The medium attachment which needs to be cleaned up.</desc>
3297	</param>
3298	<param name="source" type="IMedium" dir="in">
3299	<desc>Merge source medium.</desc>
3300	</param>
3301	<param name="target" type="IMedium" dir="in">
3302	<desc>Merge target medium.</desc>
3303	</param>
3304	<param name="mergeForward" type="boolean" dir="in">
3305	<desc>Merge direction.</desc>
3306	</param>
3307	<param name="parentForTarget" type="IMedium" dir="in">
3308	<desc>For forward merges: new parent for target medium.</desc>
3309	</param>
3310	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
3311	<desc>For backward merges: list of media which need their parent UUID
3312	updated.</desc>
3313	</param>
3314	</method>
3315
3316	<method name="restoreSnapshot">
3317	<desc>
3318	Gets called by <link to="IConsole::restoreSnapshot"/>.
3319	</desc>
3320	<param name="initiator" type="IConsole" dir="in">
3321	<desc>The console object that initiated this call.</desc>
3322	</param>
3323	<param name="snapshot" type="ISnapshot" dir="in">
3324	<desc>The snapshot to restore the VM state from.</desc>
3325	</param>
3326	<param name="machineState" type="MachineState" dir="out">
3327	<desc>New machine state after this operation is started.</desc>
3328	</param>
3329	<param name="progress" type="IProgress" dir="return">
3330	<desc>Progress object to track the operation completion.</desc>
3331	</param>
3332	</method>
3333
3334	<method name="pullGuestProperties">
3335	<desc>
3336	Get the list of the guest properties matching a set of patterns along
3337	with their values, time stamps and flags and give responsibility for
3338	managing properties to the console.
3339	</desc>
3340	<param name="name" type="wstring" dir="out" safearray="yes">
3341	<desc>
3342	The names of the properties returned.
3343	</desc>
3344	</param>
3345	<param name="value" type="wstring" dir="out" safearray="yes">
3346	<desc>
3347	The values of the properties returned. The array entries match the
3348	corresponding entries in the @a name array.
3349	</desc>
3350	</param>
3351	<param name="timestamp" type="long long" dir="out" safearray="yes">
3352	<desc>
3353	The time stamps of the properties returned. The array entries match
3354	the corresponding entries in the @a name array.
3355	</desc>
3356	</param>
3357	<param name="flags" type="wstring" dir="out" safearray="yes">
3358	<desc>
3359	The flags of the properties returned. The array entries match the
3360	corresponding entries in the @a name array.
3361	</desc>
3362	</param>
3363	</method>
3364
3365	<method name="pushGuestProperty">
3366	<desc>
3367	Update a single guest property in IMachine.
3368	</desc>
3369	<param name="name" type="wstring" dir="in">
3370	<desc>
3371	The name of the property to be updated.
3372	</desc>
3373	</param>
3374	<param name="value" type="wstring" dir="in">
3375	<desc>
3376	The value of the property.
3377	</desc>
3378	</param>
3379	<param name="timestamp" type="long long" dir="in">
3380	<desc>
3381	The timestamp of the property.
3382	</desc>
3383	</param>
3384	<param name="flags" type="wstring" dir="in">
3385	<desc>
3386	The flags of the property.
3387	</desc>
3388	</param>
3389	</method>
3390
3391	<method name="lockMedia">
3392	<desc>
3393	Locks all media attached to the machine for writing and parents of
3394	attached differencing media (if any) for reading. This operation is
3395	atomic so that if it fails no media is actually locked.
3396
3397	This method is intended to be called when the machine is in Starting or
3398	Restoring state. The locked media will be automatically unlocked when
3399	the machine is powered off or crashed.
3400	</desc>
3401	</method>
3402	<method name="unlockMedia">
3403	<desc>
3404	Unlocks all media previously locked using
3405	<link to="IInternalMachineControl::lockMedia"/>.
3406
3407	This method is intended to be used with teleportation so that it is
3408	possible to teleport between processes on the same machine.
3409	</desc>
3410	</method>
3411
3412	<method name="ejectMedium">
3413	<desc>
3414	Tells VBoxSVC that the guest has ejected the medium associated with
3415	the medium attachment.
3416	</desc>
3417	<param name="attachment" type="IMediumAttachment" dir="in">
3418	<desc>
3419	The medium attachment where the eject happened.
3420	</desc>
3421	</param>
3422	<param name="newAttachment" type="IMediumAttachment" dir="return">
3423	<desc>
3424	A new reference to the medium attachment, as the config change can
3425	result in the creation of a new instance.
3426	</desc>
3427	</param>
3428	</method>
3429
3430	<method name="reportGuestStatistics">
3431	<desc>
3432	Passes collected guest statistics to VBoxSVC.
3433	</desc>
3434	<param name="validStats" type="unsigned long" dir="in">
3435	<desc>
3436	Mask defining which parameters are valid. For example: 0x11 means
3437	that cpuIdle and XXX are valid. Other parameters should be ignored.
3438	</desc>
3439	</param>
3440	<param name="cpuUser" type="unsigned long" dir="in">
3441	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
3442	</param>
3443	<param name="cpuKernel" type="unsigned long" dir="in">
3444	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
3445	</param>
3446	<param name="cpuIdle" type="unsigned long" dir="in">
3447	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
3448	</param>
3449	<param name="memTotal" type="unsigned long" dir="in">
3450	<desc>Total amount of physical guest RAM.</desc>
3451	</param>
3452	<param name="memFree" type="unsigned long" dir="in">
3453	<desc>Free amount of physical guest RAM.</desc>
3454	</param>
3455	<param name="memBalloon" type="unsigned long" dir="in">
3456	<desc>Amount of ballooned physical guest RAM.</desc>
3457	</param>
3458	<param name="memShared" type="unsigned long" dir="in">
3459	<desc>Amount of shared physical guest RAM.</desc>
3460	</param>
3461	<param name="memCache" type="unsigned long" dir="in">
3462	<desc>Total amount of guest (disk) cache memory.</desc>
3463	</param>
3464	<param name="pagedTotal" type="unsigned long" dir="in">
3465	<desc>Total amount of space in the page file.</desc>
3466	</param>
3467	<param name="memAllocTotal" type="unsigned long" dir="in">
3468	<desc>Total amount of memory allocated by the hypervisor.</desc>
3469	</param>
3470	<param name="memFreeTotal" type="unsigned long" dir="in">
3471	<desc>Total amount of free memory available in the hypervisor.</desc>
3472	</param>
3473	<param name="memBalloonTotal" type="unsigned long" dir="in">
3474	<desc>Total amount of memory ballooned by the hypervisor.</desc>
3475	</param>
3476	<param name="memSharedTotal" type="unsigned long" dir="in">
3477	<desc>Total amount of shared memory in the hypervisor.</desc>
3478	</param>
3479	</method>
3480	</interface>
3481
3482	<interface
3483	name="IBIOSSettings" extends="$unknown"
3484	uuid="38b54279-dc35-4f5e-a431-835b867c6b5e"
3485	wsmap="managed"
3486	>
3487	<desc>
3488	The IBIOSSettings interface represents BIOS settings of the virtual
3489	machine. This is used only in the <link to="IMachine::BIOSSettings" /> attribute.
3490	</desc>
3491	<attribute name="logoFadeIn" type="boolean">
3492	<desc>Fade in flag for BIOS logo animation.</desc>
3493	</attribute>
3494
3495	<attribute name="logoFadeOut" type="boolean">
3496	<desc>Fade out flag for BIOS logo animation.</desc>
3497	</attribute>
3498
3499	<attribute name="logoDisplayTime" type="unsigned long">
3500	<desc>BIOS logo display time in milliseconds (0 = default).</desc>
3501	</attribute>
3502
3503	<attribute name="logoImagePath" type="wstring">
3504	<desc>
3505	Local file system path for external BIOS splash image. Empty string
3506	means the default image is shown on boot.
3507	</desc>
3508	</attribute>
3509
3510	<attribute name="bootMenuMode" type="BIOSBootMenuMode">
3511	<desc>Mode of the BIOS boot device menu.</desc>
3512	</attribute>
3513
3514	<attribute name="ACPIEnabled" type="boolean">
3515	<desc>ACPI support flag.</desc>
3516	</attribute>
3517
3518	<attribute name="IOAPICEnabled" type="boolean">
3519	<desc>
3520	IO APIC support flag. If set, VirtualBox will provide an IO APIC
3521	and support IRQs above 15.
3522	</desc>
3523	</attribute>
3524
3525	<attribute name="timeOffset" type="long long">
3526	<desc>
3527	Offset in milliseconds from the host system time. This allows for
3528	guests running with a different system date/time than the host.
3529	It is equivalent to setting the system date/time in the BIOS except
3530	it is not an absolute value but a relative one. Guest Additions
3531	time synchronization honors this offset.
3532	</desc>
3533	</attribute>
3534
3535	<attribute name="PXEDebugEnabled" type="boolean">
3536	<desc>
3537	PXE debug logging flag. If set, VirtualBox will write extensive
3538	PXE trace information to the release log.
3539	</desc>
3540	</attribute>
3541	</interface>
3542
3543	<enum
3544	name="CleanupMode"
3545	uuid="67897c50-7cca-47a9-83f6-ce8fd8eb5441"
3546	>
3547	<desc>Cleanup mode, used with <link to="IMachine::unregister" />.
3548	</desc>
3549	<const name="UnregisterOnly" value="1">
3550	<desc>Unregister only the machine, but neither delete snapshots nor detach media.</desc>
3551	</const>
3552	<const name="DetachAllReturnNone" value="2">
3553	<desc>Delete all snapshots and detach all media but return none; this will keep all media registered.</desc>
3554	</const>
3555	<const name="DetachAllReturnHardDisksOnly" value="3">
3556	<desc>Delete all snapshots, detach all media and return hard disks for closing, but not removable media.</desc>
3557	</const>
3558	<const name="Full" value="4">
3559	<desc>Delete all snapshots, detach all media and return all media for closing.</desc>
3560	</const>
3561	</enum>
3562
3563	<interface
3564	name="IPciAddress" extends="$unknown"
3565	uuid="D88B324F-DB19-4D3B-A1A9-BF5B127199A8"
3566	wsmap="struct"
3567	>
3568
3569	<desc>
3570	Address on the PCI bus.
3571	</desc>
3572
3573	<attribute name="bus" type="short">
3574	<desc>
3575	Bus number.
3576	</desc>
3577	</attribute>
3578
3579	<attribute name="device" type="short">
3580	<desc>
3581	Device number.
3582	</desc>
3583	</attribute>
3584
3585	<attribute name="devFunction" type="short">
3586	<desc>
3587	Device function number.
3588	</desc>
3589	</attribute>
3590
3591	<method name="asLong">
3592	<desc>
3593	Convert PCI address into long.
3594	</desc>
3595	<param name="result" type="long" dir="return" />
3596	</method>
3597
3598	<method name="fromLong">
3599	<desc>
3600	Make PCI address from long.
3601	</desc>
3602	<param name="number" type="long" dir="in" />
3603	</method>
3604	</interface>
3605
3606	<interface
3607	name="IPciDeviceAttachment" extends="$unknown"
3608	uuid="91f33d6f-e621-4f70-a77e-15f0e3c714d5"
3609	wsmap="struct"
3610	>
3611
3612	<desc>
3613	Information about PCI attachments.
3614	</desc>
3615
3616	<attribute name="name" type="wstring" readonly="yes">
3617	<desc>
3618	Device name.
3619	</desc>
3620	</attribute>
3621
3622	<attribute name="isPhysicalDevice" type="boolean" readonly="yes">
3623	<desc>
3624	If this is physical or virtual device.
3625	</desc>
3626	</attribute>
3627
3628	<attribute name="hostAddress" type="long" readonly="yes">
3629	<desc>
3630	Address of device on the host, applicable only to host devices.
3631	</desc>
3632	</attribute>
3633
3634	<attribute name="guestAddress" type="long" readonly="yes">
3635	<desc>
3636	Address of device on the guest.
3637	</desc>
3638	</attribute>
3639
3640	</interface>
3641
3642	<enum
3643	name="CloneMode" extends="$unknown"
3644	uuid="A7A159FE-5096-4B8D-8C3C-D033CB0B35A8"
3645	>
3646
3647	<desc>
3648	Clone mode, used with <link to="IMachine::cloneTo" />.
3649	</desc>
3650
3651	<const name="MachineState" value="1">
3652	<desc>Clone the state of the selected machine.</desc>
3653	</const>
3654	<const name="MachineAndChildStates" value="2">
3655	<desc>Clone the state of the selected machine and its child snapshots if present.</desc>
3656	</const>
3657	<const name="AllStates" value="3">
3658	<desc>Clone all states (including all snapshots) of the machine, regardless of the machine object used.</desc>
3659	</const>
3660
3661	</enum>
3662
3663	<enum
3664	name="CloneOptions" extends="$unknown"
3665	uuid="22243f8e-96ab-497c-8cf0-f40a566c630b"
3666	>
3667
3668	<desc>
3669	Clone options, used with <link to="IMachine::cloneTo" />.
3670	</desc>
3671
3672	<const name="Link" value="1">
3673	<desc>Create a clone VM where all virtual disks are linked to the original VM.</desc>
3674	</const>
3675	<const name="KeepAllMACs" value="2">
3676	<desc>Don't generate new MAC addresses of the attached network adapters.</desc>
3677	</const>
3678	<const name="KeepNATMACs" value="3">
3679	<desc>Don't generate new MAC addresses of the attached network adapters when they are using NAT.</desc>
3680	</const>
3681	<const name="KeepDiskNames" value="4">
3682	<desc>Don't change the disk names.</desc>
3683	</const>
3684
3685	</enum>
3686
3687
3688	<interface
3689	name="IMachine" extends="$unknown"
3690	uuid="b0ce140d-02b6-469a-80f5-412ef8e1318e"
3691	wsmap="managed"
3692	>
3693	<desc>
3694	The IMachine interface represents a virtual machine, or guest, created
3695	in VirtualBox.
3696
3697	This interface is used in two contexts. First of all, a collection of
3698	objects implementing this interface is stored in the
3699	<link to="IVirtualBox::machines"/> attribute which lists all the virtual
3700	machines that are currently registered with this VirtualBox
3701	installation. Also, once a session has been opened for the given virtual
3702	machine (e.g. the virtual machine is running), the machine object
3703	associated with the open session can be queried from the session object;
3704	see <link to="ISession"/> for details.
3705
3706	The main role of this interface is to expose the settings of the virtual
3707	machine and provide methods to change various aspects of the virtual
3708	machine's configuration. For machine objects stored in the
3709	<link to="IVirtualBox::machines"/> collection, all attributes are
3710	read-only unless explicitly stated otherwise in individual attribute
3711	and method descriptions.
3712
3713	In order to change a machine setting, a session for this machine must be
3714	opened using one of the <link to="IMachine::lockMachine" /> or
3715	<link to="IMachine::launchVMProcess"/> methods. After the
3716	machine has been successfully locked for a session, a mutable machine object
3717	needs to be queried from the session object and then the desired settings
3718	changes can be applied to the returned object using IMachine attributes and
3719	methods. See the <link to="ISession"/> interface description for more
3720	information about sessions.
3721
3722	Note that IMachine does not provide methods to control virtual machine
3723	execution (such as start the machine, or power it down) -- these methods
3724	are grouped in a separate interface called <link to="IConsole" />.
3725
3726	<see><link to="ISession"/>, <link to="IConsole"/></see>
3727	</desc>
3728
3729	<attribute name="parent" type="IVirtualBox" readonly="yes">
3730	<desc>Associated parent object.</desc>
3731	</attribute>
3732
3733	<attribute name="accessible" type="boolean" readonly="yes">
3734	<desc>
3735	Whether this virtual machine is currently accessible or not.
3736
3737	A machine is always deemed accessible unless it is registered <i>and</i>
3738	its settings file cannot be read or parsed (either because the file itself
3739	is unavailable or has invalid XML contents).
3740
3741	Every time this property is read, the accessibility state of
3742	this machine is re-evaluated. If the returned value is @c false,
3743	the <link to="#accessError"/> property may be used to get the
3744	detailed error information describing the reason of
3745	inaccessibility, including XML error messages.
3746
3747	When the machine is inaccessible, only the following properties
3748	can be used on it:
3749	<ul>
3750	<li><link to="#parent"/></li>
3751	<li><link to="#id"/></li>
3752	<li><link to="#settingsFilePath"/></li>
3753	<li><link to="#accessible"/></li>
3754	<li><link to="#accessError"/></li>
3755	</ul>
3756
3757	An attempt to access any other property or method will return
3758	an error.
3759
3760	The only possible action you can perform on an inaccessible
3761	machine is to unregister it using the
3762	<link to="IMachine::unregister"/> call (or, to check
3763	for the accessibility state once more by querying this
3764	property).
3765
3766	<note>
3767	In the current implementation, once this property returns
3768	@c true, the machine will never become inaccessible
3769	later, even if its settings file cannot be successfully
3770	read/written any more (at least, until the VirtualBox
3771	server is restarted). This limitation may be removed in
3772	future releases.
3773	</note>
3774	</desc>
3775	</attribute>
3776
3777	<attribute name="accessError" type="IVirtualBoxErrorInfo" readonly="yes">
3778	<desc>
3779	Error information describing the reason of machine
3780	inaccessibility.
3781
3782	Reading this property is only valid after the last call to
3783	<link to="#accessible"/> returned @c false (i.e. the
3784	machine is currently inaccessible). Otherwise, a @c null
3785	IVirtualBoxErrorInfo object will be returned.
3786	</desc>
3787	</attribute>
3788
3789	<attribute name="name" type="wstring">
3790	<desc>
3791	Name of the virtual machine.
3792
3793	Besides being used for human-readable identification purposes
3794	everywhere in VirtualBox, the virtual machine name is also used
3795	as a name of the machine's settings file and as a name of the
3796	subdirectory this settings file resides in. Thus, every time you
3797	change the value of this property, the settings file will be
3798	renamed once you call <link to="#saveSettings"/> to confirm the
3799	change. The containing subdirectory will be also renamed, but
3800	only if it has exactly the same name as the settings file
3801	itself prior to changing this property (for backward compatibility
3802	with previous API releases). The above implies the following
3803	limitations:
3804	<ul>
3805	<li>The machine name cannot be empty.</li>
3806	<li>The machine name can contain only characters that are valid
3807	file name characters according to the rules of the file
3808	system used to store VirtualBox configuration.</li>
3809	<li>You cannot have two or more machines with the same name
3810	if they use the same subdirectory for storing the machine
3811	settings files.</li>
3812	<li>You cannot change the name of the machine if it is running,
3813	or if any file in the directory containing the settings file
3814	is being used by another running machine or by any other
3815	process in the host operating system at a time when
3816	<link to="#saveSettings"/> is called.
3817	</li>
3818	</ul>
3819	If any of the above limitations are hit, <link to="#saveSettings"/>
3820	will return an appropriate error message explaining the exact
3821	reason and the changes you made to this machine will not be saved.
3822
3823	Starting with VirtualBox 4.0, a ".vbox" extension of the settings
3824	file is recommended, but not enforced. (Previous versions always
3825	used a generic ".xml" extension.)
3826	</desc>
3827	</attribute>
3828
3829	<attribute name="description" type="wstring">
3830	<desc>
3831	Description of the virtual machine.
3832
3833	The description attribute can contain any text and is
3834	typically used to describe the hardware and software
3835	configuration of the virtual machine in detail (i.e. network
3836	settings, versions of the installed software and so on).
3837	</desc>
3838	</attribute>
3839
3840	<attribute name="id" type="uuid" mod="string" readonly="yes">
3841	<desc>UUID of the virtual machine.</desc>
3842	</attribute>
3843
3844	<attribute name="OSTypeId" type="wstring">
3845	<desc>
3846	User-defined identifier of the Guest OS type.
3847	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
3848	an IGuestOSType object representing details about the given
3849	Guest OS type.
3850	<note>
3851	This value may differ from the value returned by
3852	<link to="IGuest::OSTypeId"/> if Guest Additions are
3853	installed to the guest OS.
3854	</note>
3855	</desc>
3856	</attribute>
3857
3858	<attribute name="hardwareVersion" type="wstring">
3859	<desc>Hardware version identifier. Internal use only for now.</desc>
3860	</attribute>
3861
3862	<attribute name="hardwareUUID" type="uuid" mod="string">
3863	<desc>
3864	The UUID presented to the guest via memory tables, hardware and guest
3865	properties. For most VMs this is the same as the @a id, but for VMs
3866	which have been cloned or teleported it may be the same as the source
3867	VM. This latter is because the guest shouldn't notice that it was
3868	cloned or teleported.
3869	</desc>
3870	</attribute>
3871
3872	<attribute name="CPUCount" type="unsigned long">
3873	<desc>Number of virtual CPUs in the VM.</desc>
3874	</attribute>
3875
3876	<attribute name="CPUHotPlugEnabled" type="boolean">
3877	<desc>
3878	This setting determines whether VirtualBox allows CPU
3879	hotplugging for this machine.</desc>
3880	</attribute>
3881
3882	<attribute name="CPUExecutionCap" type="unsigned long">
3883	<desc>
3884	Means to limit the number of CPU cycles a guest can use. The unit
3885	is percentage of host CPU cycles per second. The valid range
3886	is 1 - 100. 100 (the default) implies no limit.
3887	</desc>
3888	</attribute>
3889
3890	<attribute name="memorySize" type="unsigned long">
3891	<desc>System memory size in megabytes.</desc>
3892	</attribute>
3893
3894	<attribute name="memoryBalloonSize" type="unsigned long">
3895	<desc>Memory balloon size in megabytes.</desc>
3896	</attribute>
3897
3898	<attribute name="pageFusionEnabled" type="boolean">
3899	<desc>
3900	This setting determines whether VirtualBox allows page
3901	fusion for this machine (64 bits host only).
3902	</desc>
3903	</attribute>
3904
3905	<attribute name="VRAMSize" type="unsigned long">
3906	<desc>Video memory size in megabytes.</desc>
3907	</attribute>
3908
3909	<attribute name="accelerate3DEnabled" type="boolean" default="false">
3910	<desc>
3911	This setting determines whether VirtualBox allows this machine to make
3912	use of the 3D graphics support available on the host.</desc>
3913	</attribute>
3914
3915	<attribute name="accelerate2DVideoEnabled" type="boolean" default="false">
3916	<desc>
3917	This setting determines whether VirtualBox allows this machine to make
3918	use of the 2D video acceleration support available on the host.</desc>
3919	</attribute>
3920
3921	<attribute name="monitorCount" type="unsigned long">
3922	<desc>
3923	Number of virtual monitors.
3924	<note>
3925	Only effective on Windows XP and later guests with
3926	Guest Additions installed.
3927	</note>
3928	</desc>
3929	</attribute>
3930
3931	<attribute name="BIOSSettings" type="IBIOSSettings" readonly="yes">
3932	<desc>Object containing all BIOS settings.</desc>
3933	</attribute>
3934
3935	<attribute name="firmwareType" type="FirmwareType">
3936	<desc>Type of firmware (such as legacy BIOS or EFI), used for initial
3937	bootstrap in this VM.</desc>
3938	</attribute>
3939
3940	<attribute name="pointingHidType" type="PointingHidType">
3941	<desc>Type of pointing HID (such as mouse or tablet) used in this VM.
3942	The default is typically "PS2Mouse" but can vary depending on the
3943	requirements of the guest operating system.</desc>
3944	</attribute>
3945
3946	<attribute name="keyboardHidType" type="KeyboardHidType">
3947	<desc>Type of keyboard HID used in this VM.
3948	The default is typically "PS2Keyboard" but can vary depending on the
3949	requirements of the guest operating system.</desc>
3950	</attribute>
3951
3952	<attribute name="hpetEnabled" type="boolean">
3953	<desc>This attribute controls if High Precision Event Timer (HPET) is
3954	enabled in this VM. Use this property if you want to provide guests
3955	with additional time source, or if guest requires HPET to function correctly.
3956	Default is false.</desc>
3957	</attribute>
3958
3959	<attribute name="chipsetType" type="ChipsetType">
3960	<desc>Chipset type used in this VM.</desc>
3961	</attribute>
3962
3963	<attribute name="snapshotFolder" type="wstring">
3964	<desc>
3965	Full path to the directory used to store snapshot data
3966	(differencing media and saved state files) of this machine.
3967
3968	The initial value of this property is
3969	<tt><</tt><link to="#settingsFilePath">
3970	path_to_settings_file</link><tt>>/<</tt>
3971	<link to="#id">machine_uuid</link>
3972	<tt>></tt>.
3973
3974	Currently, it is an error to try to change this property on
3975	a machine that has snapshots (because this would require to
3976	move possibly large files to a different location).
3977	A separate method will be available for this purpose later.
3978
3979	<note>
3980	Setting this property to @c null or to an empty string will restore
3981	the initial value.
3982	</note>
3983	<note>
3984	When setting this property, the specified path can be
3985	absolute (full path) or relative to the directory where the
3986	<link to="#settingsFilePath">machine settings file</link>
3987	is located. When reading this property, a full path is
3988	always returned.
3989	</note>
3990	<note>
3991	The specified path may not exist, it will be created
3992	when necessary.
3993	</note>
3994	</desc>
3995	</attribute>
3996
3997	<attribute name="VRDEServer" type="IVRDEServer" readonly="yes">
3998	<desc>VirtualBox Remote Desktop Extension (VRDE) server object.</desc>
3999	</attribute>
4000
4001	<attribute name="emulatedUSBWebcameraEnabled" type="boolean" default="false"/>
4002	<attribute name="emulatedUSBCardReaderEnabled" type="boolean" default="false"/>
4003
4004	<attribute name="mediumAttachments" type="IMediumAttachment" readonly="yes" safearray="yes">
4005	<desc>Array of media attached to this machine.</desc>
4006	</attribute>
4007
4008	<attribute name="USBController" type="IUSBController" readonly="yes">
4009	<desc>
4010	Associated USB controller object.
4011
4012	<note>
4013	If USB functionality is not available in the given edition of
4014	VirtualBox, this method will set the result code to @c E_NOTIMPL.
4015	</note>
4016	</desc>
4017	</attribute>
4018
4019	<attribute name="audioAdapter" type="IAudioAdapter" readonly="yes">
4020	<desc>Associated audio adapter, always present.</desc>
4021	</attribute>
4022
4023	<attribute name="storageControllers" type="IStorageController" readonly="yes" safearray="yes">
4024	<desc>Array of storage controllers attached to this machine.</desc>
4025	</attribute>
4026
4027	<attribute name="settingsFilePath" type="wstring" readonly="yes">
4028	<desc>
4029	Full name of the file containing machine settings data.
4030	</desc>
4031	</attribute>
4032
4033	<attribute name="settingsModified" type="boolean" readonly="yes">
4034	<desc>
4035	Whether the settings of this machine have been modified
4036	(but neither yet saved nor discarded).
4037	<note>
4038	Reading this property is only valid on instances returned
4039	by <link to="ISession::machine"/> and on new machines
4040	created by <link to="IVirtualBox::createMachine"/> or opened
4041	by <link to="IVirtualBox::openMachine"/> but not
4042	yet registered, or on unregistered machines after calling
4043	<link to="IMachine::unregister"/>. For all other
4044	cases, the settings can never be modified.
4045	</note>
4046	<note>
4047	For newly created unregistered machines, the value of this
4048	property is always @c true until <link to="#saveSettings"/>
4049	is called (no matter if any machine settings have been
4050	changed after the creation or not). For opened machines
4051	the value is set to @c false (and then follows to normal rules).
4052	</note>
4053	</desc>
4054	</attribute>
4055
4056	<attribute name="sessionState" type="SessionState" readonly="yes">
4057	<desc>Current session state for this machine.</desc>
4058	</attribute>
4059
4060	<attribute name="sessionType" type="wstring" readonly="yes">
4061	<desc>
4062	Type of the session. If <link to="#sessionState"/> is
4063	Spawning or Locked, this attribute contains the
4064	same value as passed to the
4065	<link to="IMachine::launchVMProcess"/> method in the
4066	@a type parameter. If the session was used with
4067	<link to="IMachine::lockMachine" />, or if
4068	<link to="#sessionState"/> is SessionClosed, the value of this
4069	attribute is an empty string.
4070	</desc>
4071	</attribute>
4072
4073	<attribute name="sessionPid" type="unsigned long" readonly="yes">
4074	<desc>
4075	Identifier of the session process. This attribute contains the
4076	platform-dependent identifier of the process whose session was
4077	used with <link to="IMachine::lockMachine" /> call. The returned
4078	value is only valid if <link to="#sessionState"/> is Locked or
4079	Unlocking by the time this property is read.
4080	</desc>
4081	</attribute>
4082
4083	<attribute name="state" type="MachineState" readonly="yes">
4084	<desc>Current execution state of this machine.</desc>
4085	</attribute>
4086
4087	<attribute name="lastStateChange" type="long long" readonly="yes">
4088	<desc>
4089	Time stamp of the last execution state change,
4090	in milliseconds since 1970-01-01 UTC.
4091	</desc>
4092	</attribute>
4093
4094	<attribute name="stateFilePath" type="wstring" readonly="yes">
4095	<desc>
4096	Full path to the file that stores the execution state of
4097	the machine when it is in the <link to="MachineState_Saved"/> state.
4098	<note>
4099	When the machine is not in the Saved state, this attribute is
4100	an empty string.
4101	</note>
4102	</desc>
4103	</attribute>
4104
4105	<attribute name="logFolder" type="wstring" readonly="yes">
4106	<desc>
4107	Full path to the folder that stores a set of rotated log files
4108	recorded during machine execution. The most recent log file is
4109	named <tt>VBox.log</tt>, the previous log file is
4110	named <tt>VBox.log.1</tt> and so on (up to <tt>VBox.log.3</tt>
4111	in the current version).
4112	</desc>
4113	</attribute>
4114
4115	<attribute name="currentSnapshot" type="ISnapshot" readonly="yes">
4116	<desc>
4117	Current snapshot of this machine. This is @c null if the machine
4118	currently has no snapshots. If it is not @c null, then it was
4119	set by one of <link to="IConsole::takeSnapshot" />,
4120	<link to="IConsole::deleteSnapshot" />
4121	or <link to="IConsole::restoreSnapshot" />, depending on which
4122	was called last. See <link to="ISnapshot"/> for details.
4123	</desc>
4124	</attribute>
4125
4126	<attribute name="snapshotCount" type="unsigned long" readonly="yes">
4127	<desc>
4128	Number of snapshots taken on this machine. Zero means the
4129	machine doesn't have any snapshots.
4130	</desc>
4131	</attribute>
4132
4133	<attribute name="currentStateModified" type="boolean" readonly="yes">
4134	<desc>
4135	Returns @c true if the current state of the machine is not
4136	identical to the state stored in the current snapshot.
4137
4138	The current state is identical to the current snapshot only
4139	directly after one of the following calls are made:
4140
4141	<ul>
4142	<li><link to="IConsole::restoreSnapshot"/>
4143	</li>
4144	<li><link to="IConsole::takeSnapshot"/> (issued on a
4145	"powered off" or "saved" machine, for which
4146	<link to="#settingsModified"/> returns @c false)
4147	</li>
4148	</ul>
4149
4150	The current state remains identical until one of the following
4151	happens:
4152	<ul>
4153	<li>settings of the machine are changed</li>
4154	<li>the saved state is deleted</li>
4155	<li>the current snapshot is deleted</li>
4156	<li>an attempt to execute the machine is made</li>
4157	</ul>
4158
4159	<note>
4160	For machines that don't have snapshots, this property is
4161	always @c false.
4162	</note>
4163	</desc>
4164	</attribute>
4165
4166	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
4167	<desc>
4168	Collection of shared folders for this machine (permanent shared
4169	folders). These folders are shared automatically at machine startup
4170	and available only to the guest OS installed within this machine.
4171
4172	New shared folders are added to the collection using
4173	<link to="#createSharedFolder"/>. Existing shared folders can be
4174	removed using <link to="#removeSharedFolder"/>.
4175	</desc>
4176	</attribute>
4177
4178	<attribute name="clipboardMode" type="ClipboardMode">
4179	<desc>
4180	Synchronization mode between the host OS clipboard
4181	and the guest OS clipboard.
4182	</desc>
4183	</attribute>
4184
4185	<attribute name="guestPropertyNotificationPatterns" type="wstring">
4186	<desc>
4187	A comma-separated list of simple glob patterns. Changes to guest
4188	properties whose name matches one of the patterns will generate an
4189	<link to="IGuestPropertyChangedEvent"/> signal.
4190	</desc>
4191	</attribute>
4192
4193	<attribute name="teleporterEnabled" type="boolean">
4194	<desc>
4195	When set to @a true, the virtual machine becomes a target teleporter
4196	the next time it is powered on. This can only set to @a true when the
4197	VM is in the @a PoweredOff or @a Aborted state.
4198
4199	<!-- This property is automatically set to @a false when the VM is powered
4200	on. (bird: This doesn't work yet ) -->
4201	</desc>
4202	</attribute>
4203
4204	<attribute name="teleporterPort" type="unsigned long">
4205	<desc>
4206	The TCP port the target teleporter will listen for incoming
4207	teleportations on.
4208
4209	0 means the port is automatically selected upon power on. The actual
4210	value can be read from this property while the machine is waiting for
4211	incoming teleportations.
4212	</desc>
4213	</attribute>
4214
4215	<attribute name="teleporterAddress" type="wstring">
4216	<desc>
4217	The address the target teleporter will listen on. If set to an empty
4218	string, it will listen on all addresses.
4219	</desc>
4220	</attribute>
4221
4222	<attribute name="teleporterPassword" type="wstring">
4223	<desc>
4224	The password to check for on the target teleporter. This is just a
4225	very basic measure to prevent simple hacks and operators accidentally
4226	beaming a virtual machine to the wrong place.
4227
4228	Note that you SET a plain text password while reading back a HASHED
4229	password. Setting a hashed password is currently not supported.
4230	</desc>
4231	</attribute>
4232
4233	<attribute name="faultToleranceState" type="FaultToleranceState">
4234	<desc>
4235	Fault tolerance state; disabled, source or target.
4236	This property can be changed at any time. If you change it for a running
4237	VM, then the fault tolerance address and port must be set beforehand.
4238	</desc>
4239	</attribute>
4240
4241	<attribute name="faultTolerancePort" type="unsigned long">
4242	<desc>
4243	The TCP port the fault tolerance source or target will use for
4244	communication.
4245	</desc>
4246	</attribute>
4247
4248	<attribute name="faultToleranceAddress" type="wstring">
4249	<desc>
4250	The address the fault tolerance source or target.
4251	</desc>
4252	</attribute>
4253
4254	<attribute name="faultTolerancePassword" type="wstring">
4255	<desc>
4256	The password to check for on the standby VM. This is just a
4257	very basic measure to prevent simple hacks and operators accidentally
4258	choosing the wrong standby VM.
4259	</desc>
4260	</attribute>
4261
4262	<attribute name="faultToleranceSyncInterval" type="unsigned long">
4263	<desc>
4264	The interval in ms used for syncing the state between source and target.
4265	</desc>
4266	</attribute>
4267
4268	<attribute name="RTCUseUTC" type="boolean">
4269	<desc>
4270	When set to @a true, the RTC device of the virtual machine will run
4271	in UTC time, otherwise in local time. Especially Unix guests prefer
4272	the time in UTC.
4273	</desc>
4274	</attribute>
4275
4276	<attribute name="ioCacheEnabled" type="boolean">
4277	<desc>
4278	When set to @a true, the builtin I/O cache of the virtual machine
4279	will be enabled.
4280	</desc>
4281	</attribute>
4282
4283	<attribute name="ioCacheSize" type="unsigned long">
4284	<desc>
4285	Maximum size of the I/O cache in MB.
4286	</desc>
4287	</attribute>
4288
4289	<attribute name="pciDeviceAssignments" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
4290	<desc>Array of PCI devices assigned to this machine, to get list of all
4291	PCI devices attached to the machine use
4292	<link to="IConsole::attachedPciDevices"/> attribute, as this attribute
4293	is intended to list only devices additional to what described in
4294	virtual hardware config. Usually, this list keeps host's physical
4295	devices assigned to the particular machine.
4296	</desc>
4297	</attribute>
4298
4299	<attribute name="bandwidthControl" type="IBandwidthControl" readonly="yes">
4300	<desc>
4301	Bandwidth control manager.
4302	</desc>
4303	</attribute>
4304
4305	<attribute name="tracingEnabled" type="boolean">
4306	<desc>
4307	Enables the tracing facility in the VMM (including PDM devices +
4308	drivers). The VMM will consume about 0.5MB of more memory when
4309	enabled and there may be some extra overhead from tracepoints that are
4310	always enabled.
4311	</desc>
4312	</attribute>
4313
4314	<attribute name="tracingConfig" type="wstring">
4315	<desc>
4316	Tracepoint configuration to apply at startup when
4317	<link to="IMachine::tracingEnabled" /> is true. The string specifies
4318	a space separated of tracepoint group names to enable. The special
4319	group 'all' enables all tracepoints. Check DBGFR3TracingConfig for
4320	more details on available tracepoint groups and such.
4321
4322	Note that on hosts supporting DTrace (or similar), a lot of the
4323	tracepoints may be implemented exclusivly as DTrace probes. So, the
4324	effect of the same config may differ between Solaris and Windows for
4325	example.
4326	</desc>
4327	</attribute>
4328
4329	<attribute name="allowTracingToAccessVM" type="boolean">
4330	<desc>
4331	Enables tracepoints in PDM devices and drivers to use the VMCPU or VM
4332	structures when firing off trace points. This is especially useful
4333	with DTrace tracepoints, as it allow you to use the VMCPU or VM pointer
4334	to obtail useful information such as guest register state.
4335
4336	This is disabled by default because devices and drivers normally has no
4337	business accessing the VMCPU or VM structures, and are therefore unable
4338	to get any pointers to these.
4339	</desc>
4340	</attribute>
4341
4342	<method name="lockMachine">
4343	<desc>
4344	Locks the machine for the given session to enable the caller
4345	to make changes to the machine or start the VM or control
4346	VM execution.
4347
4348	There are two ways to lock a machine for such uses:
4349
4350	<ul>
4351	<li>If you want to make changes to the machine settings,
4352	you must obtain an exclusive write lock on the machine
4353	by setting @a lockType to @c Write.
4354
4355	This will only succeed if no other process has locked
4356	the machine to prevent conflicting changes. Only after
4357	an exclusive write lock has been obtained using this method, one
4358	can change all VM settings or execute the VM in the process
4359	space of the session object. (Note that the latter is only of
4360	interest if you actually want to write a new front-end for
4361	virtual machines; but this API gets called internally by
4362	the existing front-ends such as VBoxHeadless and the VirtualBox
4363	GUI to acquire a write lock on the machine that they are running.)
4364
4365	On success, write-locking the machine for a session creates
4366	a second copy of the IMachine object. It is this second object
4367	upon which changes can be made; in VirtualBox terminology, the
4368	second copy is "mutable". It is only this second, mutable machine
4369	object upon which you can call methods that change the
4370	machine state. After having called this method, you can
4371	obtain this second, mutable machine object using the
4372	<link to="ISession::machine" /> attribute.
4373	</li>
4374	<li>If you only want to check the machine state or control
4375	machine execution without actually changing machine
4376	settings (e.g. to get access to VM statistics or take
4377	a snapshot or save the machine state), then set the
4378	@a lockType argument to @c Shared.
4379
4380	If no other session has obtained a lock, you will obtain an
4381	exclusive write lock as described above. However, if another
4382	session has already obtained such a lock, then a link to that
4383	existing session will be established which allows you
4384	to control that existing session.
4385
4386	To find out which type of lock was obtained, you can
4387	inspect <link to="ISession::type" />, which will have been
4388	set to either @c WriteLock or @c Shared.
4389	</li>
4390	</ul>
4391
4392	In either case, you can get access to the <link to="IConsole" />
4393	object which controls VM execution.
4394
4395	Also in all of the above cases, one must always call
4396	<link to="ISession::unlockMachine" /> to release the lock on the machine, or
4397	the machine's state will eventually be set to "Aborted".
4398
4399	To change settings on a machine, the following sequence is typically
4400	performed:
4401
4402	<ol>
4403	<li>Call this method to obtain an exclusive write lock for the current session.</li>
4404
4405	<li>Obtain a mutable IMachine object from <link to="ISession::machine" />.</li>
4406
4407	<li>Change the settings of the machine by invoking IMachine methods.</li>
4408
4409	<li>Call <link to="IMachine::saveSettings" />.</li>
4410
4411	<li>Release the write lock by calling <link to="ISession::unlockMachine"/>.</li>
4412	</ol>
4413
4414	<result name="E_UNEXPECTED">
4415	Virtual machine not registered.
4416	</result>
4417	<result name="E_ACCESSDENIED">
4418	Process not started by OpenRemoteSession.
4419	</result>
4420	<result name="VBOX_E_INVALID_OBJECT_STATE">
4421	Session already open or being opened.
4422	</result>
4423	<result name="VBOX_E_VM_ERROR">
4424	Failed to assign machine to session.
4425	</result>
4426	</desc>
4427	<param name="session" type="ISession" dir="in">
4428	<desc>
4429	Session object for which the machine will be locked.
4430	</desc>
4431	</param>
4432	<param name="lockType" type="LockType" dir="in">
4433	<desc>
4434	If set to @c Write, then attempt to acquire an exclusive write lock or fail.
4435	If set to @c Shared, then either acquire an exclusive write lock or establish
4436	a link to an existing session.
4437	</desc>
4438	</param>
4439	</method>
4440
4441	<method name="launchVMProcess">
4442	<desc>
4443	Spawns a new process that will execute the virtual machine and obtains a shared
4444	lock on the machine for the calling session.
4445
4446	If launching the VM succeeds, the new VM process will create its own session
4447	and write-lock the machine for it, preventing conflicting changes from other
4448	processes. If the machine is already locked (because it is already running or
4449	because another session has a write lock), launching the VM process will therefore
4450	fail. Reversely, future attempts to obtain a write lock will also fail while the
4451	machine is running.
4452
4453	The caller's session object remains separate from the session opened by the new
4454	VM process. It receives its own <link to="IConsole" /> object which can be used
4455	to control machine execution, but it cannot be used to change all VM settings
4456	which would be available after a <link to="#lockMachine" /> call.
4457
4458	The caller must eventually release the session's shared lock by calling
4459	<link to="ISession::unlockMachine" /> on the local session object once this call
4460	has returned. However, the session's state (see <link to="ISession::state" />)
4461	will not return to "Unlocked" until the remote session has also unlocked
4462	the machine (i.e. the machine has stopped running).
4463
4464	Launching a VM process can take some time (a new VM is started in a new process,
4465	for which memory and other resources need to be set up). Because of this,
4466	an <link to="IProgress" /> object is returned to allow the caller to wait
4467	for this asynchronous operation to be completed. Until then, the caller's
4468	session object remains in the "Unlocked" state, and its <link to="ISession::machine" />
4469	and <link to="ISession::console" /> attributes cannot be accessed.
4470	It is recommended to use <link to="IProgress::waitForCompletion" /> or
4471	similar calls to wait for completion. Completion is signalled when the VM
4472	is powered on. If launching the VM fails, error messages can be queried
4473	via the progress object, if available.
4474
4475	The progress object will have at least 2 sub-operations. The first
4476	operation covers the period up to the new VM process calls powerUp.
4477	The subsequent operations mirror the <link to="IConsole::powerUp"/>
4478	progress object. Because <link to="IConsole::powerUp"/> may require
4479	some extra sub-operations, the <link to="IProgress::operationCount"/>
4480	may change at the completion of operation.
4481
4482	For details on the teleportation progress operation, see
4483	<link to="IConsole::powerUp"/>.
4484
4485	The @a environment argument is a string containing definitions of
4486	environment variables in the following format:
4487	<pre>
4488	NAME[=VALUE]\n
4489	NAME[=VALUE]\n
4490	...
4491	</pre>
4492	where <tt>\\n</tt> is the new line character. These environment
4493	variables will be appended to the environment of the VirtualBox server
4494	process. If an environment variable exists both in the server process
4495	and in this list, the value from this list takes precedence over the
4496	server's variable. If the value of the environment variable is
4497	omitted, this variable will be removed from the resulting environment.
4498	If the environment string is @c null or empty, the server environment
4499	is inherited by the started process as is.
4500
4501	<result name="E_UNEXPECTED">
4502	Virtual machine not registered.
4503	</result>
4504	<result name="E_INVALIDARG">
4505	Invalid session type @a type.
4506	</result>
4507	<result name="VBOX_E_OBJECT_NOT_FOUND">
4508	No machine matching @a machineId found.
4509	</result>
4510	<result name="VBOX_E_INVALID_OBJECT_STATE">
4511	Session already open or being opened.
4512	</result>
4513	<result name="VBOX_E_IPRT_ERROR">
4514	Launching process for machine failed.
4515	</result>
4516	<result name="VBOX_E_VM_ERROR">
4517	Failed to assign machine to session.
4518	</result>
4519	</desc>
4520	<param name="session" type="ISession" dir="in">
4521	<desc>
4522	Client session object to which the VM process will be connected (this
4523	must be in "Unlocked" state).
4524	</desc>
4525	</param>
4526	<param name="type" type="wstring" dir="in">
4527	<desc>
4528	Front-end to use for the new VM process. The following are currently supported:
4529	<ul>
4530	<li><tt>"gui"</tt>: VirtualBox Qt GUI front-end</li>
4531	<li><tt>"headless"</tt>: VBoxHeadless (VRDE Server) front-end</li>
4532	<li><tt>"sdl"</tt>: VirtualBox SDL front-end</li>
4533	<li><tt>"emergencystop"</tt>: reserved value, used for aborting
4534	the currently running VM or session owner. In this case the
4535	@a session parameter may be @c NULL (if it is non-null it isn't
4536	used in any way), and the @a progress return value will be always
4537	NULL. The operation completes immediately.</li>
4538	</ul>
4539	</desc>
4540	</param>
4541	<param name="environment" type="wstring" dir="in">
4542	<desc>
4543	Environment to pass to the VM process.
4544	</desc>
4545	</param>
4546	<param name="progress" type="IProgress" dir="return">
4547	<desc>Progress object to track the operation completion.</desc>
4548	</param>
4549	</method>
4550
4551	<method name="setBootOrder">
4552	<desc>
4553	Puts the given device to the specified position in
4554	the boot order.
4555
4556	To indicate that no device is associated with the given position,
4557	<link to="DeviceType_Null"/> should be used.
4558
4559	@todo setHardDiskBootOrder(), setNetworkBootOrder()
4560
4561	<result name="E_INVALIDARG">
4562	Boot @a position out of range.
4563	</result>
4564	<result name="E_NOTIMPL">
4565	Booting from USB @a device currently not supported.
4566	</result>
4567
4568	</desc>
4569	<param name="position" type="unsigned long" dir="in">
4570	<desc>
4571	Position in the boot order (@c 1 to the total number of
4572	devices the machine can boot from, as returned by
4573	<link to="ISystemProperties::maxBootPosition"/>).
4574	</desc>
4575	</param>
4576	<param name="device" type="DeviceType" dir="in">
4577	<desc>
4578	The type of the device used to boot at the given position.
4579	</desc>
4580	</param>
4581	</method>
4582
4583	<method name="getBootOrder" const="yes">
4584	<desc>
4585	Returns the device type that occupies the specified
4586	position in the boot order.
4587
4588	@todo [remove?]
4589	If the machine can have more than one device of the returned type
4590	(such as hard disks), then a separate method should be used to
4591	retrieve the individual device that occupies the given position.
4592
4593	If here are no devices at the given position, then
4594	<link to="DeviceType_Null"/> is returned.
4595
4596	@todo getHardDiskBootOrder(), getNetworkBootOrder()
4597
4598	<result name="E_INVALIDARG">
4599	Boot @a position out of range.
4600	</result>
4601
4602	</desc>
4603	<param name="position" type="unsigned long" dir="in">
4604	<desc>
4605	Position in the boot order (@c 1 to the total number of
4606	devices the machine can boot from, as returned by
4607	<link to="ISystemProperties::maxBootPosition"/>).
4608	</desc>
4609	</param>
4610	<param name="device" type="DeviceType" dir="return">
4611	<desc>
4612	Device at the given position.
4613	</desc>
4614	</param>
4615	</method>
4616
4617	<method name="attachDevice">
4618	<desc>
4619	Attaches a device and optionally mounts a medium to the given storage
4620	controller (<link to="IStorageController" />, identified by @a name),
4621	at the indicated port and device.
4622
4623	This method is intended for managing storage devices in general while a
4624	machine is powered off. It can be used to attach and detach fixed
4625	and removable media. The following kind of media can be attached
4626	to a machine:
4627
4628	<ul>
4629	<li>For fixed and removable media, you can pass in a medium that was
4630	previously opened using <link to="IVirtualBox::openMedium" />.
4631	</li>
4632
4633	<li>Only for storage devices supporting removable media (such as
4634	DVDs and floppies), you can also specify a null pointer to
4635	indicate an empty drive or one of the medium objects listed
4636	in the <link to="IHost::DVDDrives" /> and <link to="IHost::floppyDrives"/>
4637	arrays to indicate a host drive.
4638	For removable devices, you can also use <link to="IMachine::mountMedium"/>
4639	to change the media while the machine is running.
4640	</li>
4641	</ul>
4642
4643	In a VM's default configuration of virtual machines, the secondary
4644	master of the IDE controller is used for a CD/DVD drive.
4645
4646	After calling this returns successfully, a new instance of
4647	<link to="IMediumAttachment"/> will appear in the machine's list of medium
4648	attachments (see <link to="IMachine::mediumAttachments"/>).
4649
4650	See <link to="IMedium"/> and <link to="IMediumAttachment"/> for more
4651	information about attaching media.
4652
4653	The specified device slot must not have a device attached to it,
4654	or this method will fail.
4655
4656	<note>
4657	You cannot attach a device to a newly created machine until
4658	this machine's settings are saved to disk using
4659	<link to="#saveSettings"/>.
4660	</note>
4661	<note>
4662	If the medium is being attached indirectly, a new differencing medium
4663	will implicitly be created for it and attached instead. If the
4664	changes made to the machine settings (including this indirect
4665	attachment) are later cancelled using <link to="#discardSettings"/>,
4666	this implicitly created differencing medium will implicitly
4667	be deleted.
4668	</note>
4669
4670	<result name="E_INVALIDARG">
4671	SATA device, SATA port, IDE port or IDE slot out of range, or
4672	file or UUID not found.
4673	</result>
4674	<result name="VBOX_E_INVALID_OBJECT_STATE">
4675	Machine must be registered before media can be attached.
4676	</result>
4677	<result name="VBOX_E_INVALID_VM_STATE">
4678	Invalid machine state.
4679	</result>
4680	<result name="VBOX_E_OBJECT_IN_USE">
4681	A medium is already attached to this or another virtual machine.
4682	</result>
4683
4684	</desc>
4685	<param name="name" type="wstring" dir="in">
4686	<desc>Name of the storage controller to attach the device to.</desc>
4687	</param>
4688	<param name="controllerPort" type="long" dir="in">
4689	<desc>Port to attach the device to. For an IDE controller, 0 specifies
4690	the primary controller and 1 specifies the secondary controller.
4691	For a SCSI controller, this must range from 0 to 15; for a SATA controller,
4692	from 0 to 29; for an SAS controller, from 0 to 7.</desc>
4693	</param>
4694	<param name="device" type="long" dir="in">
4695	<desc>Device slot in the given port to attach the device to. This is only
4696	relevant for IDE controllers, for which 0 specifies the master device and
4697	1 specifies the slave device. For all other controller types, this must
4698	be 0.</desc>
4699	</param>
4700	<param name="type" type="DeviceType" dir="in">
4701	<desc>Device type of the attached device. For media opened by
4702	<link to="IVirtualBox::openMedium" />, this must match the device type
4703	specified there.</desc>
4704	</param>
4705	<param name="medium" type="IMedium" dir="in">
4706	<desc>Medium to mount or NULL for an empty drive.</desc>
4707	</param>
4708	</method>
4709
4710	<method name="detachDevice">
4711	<desc>
4712	Detaches the device attached to a device slot of the specified bus.
4713
4714	Detaching the device from the virtual machine is deferred. This means
4715	that the medium remains associated with the machine when this method
4716	returns and gets actually de-associated only after a successful
4717	<link to="#saveSettings"/> call. See <link to="IMedium"/>
4718	for more detailed information about attaching media.
4719
4720	<note>
4721	You cannot detach a device from a running machine.
4722	</note>
4723	<note>
4724	Detaching differencing media implicitly created by <link
4725	to="#attachDevice"/> for the indirect attachment using this
4726	method will <b>not</b> implicitly delete them. The
4727	<link to="IMedium::deleteStorage"/> operation should be
4728	explicitly performed by the caller after the medium is successfully
4729	detached and the settings are saved with
4730	<link to="#saveSettings"/>, if it is the desired action.
4731	</note>
4732
4733	<result name="VBOX_E_INVALID_VM_STATE">
4734	Attempt to detach medium from a running virtual machine.
4735	</result>
4736	<result name="VBOX_E_OBJECT_NOT_FOUND">
4737	No medium attached to given slot/bus.
4738	</result>
4739	<result name="VBOX_E_NOT_SUPPORTED">
4740	Medium format does not support storage deletion.
4741	</result>
4742
4743	</desc>
4744	<param name="name" type="wstring" dir="in">
4745	<desc>Name of the storage controller to detach the medium from.</desc>
4746	</param>
4747	<param name="controllerPort" type="long" dir="in">
4748	<desc>Port number to detach the medium from.</desc>
4749	</param>
4750	<param name="device" type="long" dir="in">
4751	<desc>Device slot number to detach the medium from.</desc>
4752	</param>
4753	</method>
4754
4755	<method name="passthroughDevice">
4756	<desc>
4757	Sets the passthrough mode of an existing DVD device. Changing the
4758	setting while the VM is running is forbidden. The setting is only used
4759	if at VM start the device is configured as a host DVD drive, in all
4760	other cases it is ignored. The device must already exist; see
4761	<link to="IMachine::attachDevice"/> for how to attach a new device.
4762
4763	The @a controllerPort and @a device parameters specify the device slot and
4764	have have the same meaning as with <link to="IMachine::attachDevice" />.
4765
4766	<result name="E_INVALIDARG">
4767	SATA device, SATA port, IDE port or IDE slot out of range.
4768	</result>
4769	<result name="VBOX_E_INVALID_OBJECT_STATE">
4770	Attempt to modify an unregistered virtual machine.
4771	</result>
4772	<result name="VBOX_E_INVALID_VM_STATE">
4773	Invalid machine state.
4774	</result>
4775
4776	</desc>
4777	<param name="name" type="wstring" dir="in">
4778	<desc>Name of the storage controller.</desc>
4779	</param>
4780	<param name="controllerPort" type="long" dir="in">
4781	<desc>Storage controller port.</desc>
4782	</param>
4783	<param name="device" type="long" dir="in">
4784	<desc>Device slot in the given port.</desc>
4785	</param>
4786	<param name="passthrough" type="boolean" dir="in">
4787	<desc>New value for the passthrough setting.</desc>
4788	</param>
4789	</method>
4790
4791	<method name="temporaryEjectDevice">
4792	<desc>
4793	Sets the behavior for guest-triggered medium eject. In some situations
4794	it is desirable that such ejects update the VM configuration, and in
4795	others the eject should keep the VM configuration. The device must
4796	already exist; see <link to="IMachine::attachDevice"/> for how to
4797	attach a new device.
4798
4799	The @a controllerPort and @a device parameters specify the device slot and
4800	have have the same meaning as with <link to="IMachine::attachDevice" />.
4801
4802	<result name="E_INVALIDARG">
4803	SATA device, SATA port, IDE port or IDE slot out of range.
4804	</result>
4805	<result name="VBOX_E_INVALID_OBJECT_STATE">
4806	Attempt to modify an unregistered virtual machine.
4807	</result>
4808	<result name="VBOX_E_INVALID_VM_STATE">
4809	Invalid machine state.
4810	</result>
4811
4812	</desc>
4813	<param name="name" type="wstring" dir="in">
4814	<desc>Name of the storage controller.</desc>
4815	</param>
4816	<param name="controllerPort" type="long" dir="in">
4817	<desc>Storage controller port.</desc>
4818	</param>
4819	<param name="device" type="long" dir="in">
4820	<desc>Device slot in the given port.</desc>
4821	</param>
4822	<param name="temporaryEject" type="boolean" dir="in">
4823	<desc>New value for the eject behavior.</desc>
4824	</param>
4825	</method>
4826
4827	<method name="nonRotationalDevice">
4828	<desc>
4829	Sets a flag in the device information which indicates that the medium
4830	is not based on rotational technology, i.e. that the access times are
4831	more or less independent of the position on the medium. This may or may
4832	not be supported by a particular drive, and is silently ignored in the
4833	latter case. At the moment only hard disks (which is a misnomer in this
4834	context) accept this setting. Changing the setting while the VM is
4835	running is forbidden. The device must already exist; see
4836	<link to="IMachine::attachDevice"/> for how to attach a new device.
4837
4838	The @a controllerPort and @a device parameters specify the device slot and
4839	have have the same meaning as with <link to="IMachine::attachDevice" />.
4840
4841	<result name="E_INVALIDARG">
4842	SATA device, SATA port, IDE port or IDE slot out of range.
4843	</result>
4844	<result name="VBOX_E_INVALID_OBJECT_STATE">
4845	Attempt to modify an unregistered virtual machine.
4846	</result>
4847	<result name="VBOX_E_INVALID_VM_STATE">
4848	Invalid machine state.
4849	</result>
4850
4851	</desc>
4852	<param name="name" type="wstring" dir="in">
4853	<desc>Name of the storage controller.</desc>
4854	</param>
4855	<param name="controllerPort" type="long" dir="in">
4856	<desc>Storage controller port.</desc>
4857	</param>
4858	<param name="device" type="long" dir="in">
4859	<desc>Device slot in the given port.</desc>
4860	</param>
4861	<param name="nonRotational" type="boolean" dir="in">
4862	<desc>New value for the non-rotational device flag.</desc>
4863	</param>
4864	</method>
4865
4866	<method name="setAutoDiscardForDevice">
4867	<desc>
4868	Sets a flag in the device information which indicates that the medium
4869	supports discarding unsused blocks (called trimming for SATA or unmap
4870	for SCSI devices) .This may or may not be supported by a particular drive,
4871	and is silently ignored in the latter case. At the moment only hard disks
4872	(which is a misnomer in this context) accept this setting. Changing the
4873	setting while the VM is running is forbidden. The device must already
4874	exist; see <link to="IMachine::attachDevice"/> for how to attach a new
4875	device.
4876
4877	The @a controllerPort and @a device parameters specify the device slot and
4878	have have the same meaning as with <link to="IMachine::attachDevice" />.
4879
4880	<result name="E_INVALIDARG">
4881	SATA device, SATA port, SCSI port out of range.
4882	</result>
4883	<result name="VBOX_E_INVALID_OBJECT_STATE">
4884	Attempt to modify an unregistered virtual machine.
4885	</result>
4886	<result name="VBOX_E_INVALID_VM_STATE">
4887	Invalid machine state.
4888	</result>
4889
4890	</desc>
4891	<param name="name" type="wstring" dir="in">
4892	<desc>Name of the storage controller.</desc>
4893	</param>
4894	<param name="controllerPort" type="long" dir="in">
4895	<desc>Storage controller port.</desc>
4896	</param>
4897	<param name="device" type="long" dir="in">
4898	<desc>Device slot in the given port.</desc>
4899	</param>
4900	<param name="discard" type="boolean" dir="in">
4901	<desc>New value for the discard device flag.</desc>
4902	</param>
4903	</method>
4904
4905	<method name="setBandwidthGroupForDevice">
4906	<desc>
4907	Sets the bandwidth group of an existing storage device.
4908	The device must already exist; see <link to="IMachine::attachDevice"/>
4909	for how to attach a new device.
4910
4911	The @a controllerPort and @a device parameters specify the device slot and
4912	have have the same meaning as with <link to="IMachine::attachDevice" />.
4913
4914	<result name="E_INVALIDARG">
4915	SATA device, SATA port, IDE port or IDE slot out of range.
4916	</result>
4917	<result name="VBOX_E_INVALID_OBJECT_STATE">
4918	Attempt to modify an unregistered virtual machine.
4919	</result>
4920	<result name="VBOX_E_INVALID_VM_STATE">
4921	Invalid machine state.
4922	</result>
4923
4924	</desc>
4925	<param name="name" type="wstring" dir="in">
4926	<desc>Name of the storage controller.</desc>
4927	</param>
4928	<param name="controllerPort" type="long" dir="in">
4929	<desc>Storage controller port.</desc>
4930	</param>
4931	<param name="device" type="long" dir="in">
4932	<desc>Device slot in the given port.</desc>
4933	</param>
4934	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
4935	<desc>New value for the bandwidth group or NULL for no group.</desc>
4936	</param>
4937	</method>
4938
4939	<method name="mountMedium">
4940	<desc>
4941	Mounts a medium (<link to="IMedium" />, identified
4942	by the given UUID @a id) to the given storage controller
4943	(<link to="IStorageController" />, identified by @a name),
4944	at the indicated port and device. The device must already exist;
4945	see <link to="IMachine::attachDevice"/> for how to attach a new device.
4946
4947	This method is intended only for managing removable media, where the
4948	device is fixed but media is changeable at runtime (such as DVDs
4949	and floppies). It cannot be used for fixed media such as hard disks.
4950
4951	The @a controllerPort and @a device parameters specify the device slot and
4952	have have the same meaning as with <link to="IMachine::attachDevice" />.
4953
4954	The specified device slot can have a medium mounted, which will be
4955	unmounted first. Specifying a zero UUID (or an empty string) for
4956	@a medium does just an unmount.
4957
4958	See <link to="IMedium"/> for more detailed information about
4959	attaching media.
4960
4961	<result name="E_INVALIDARG">
4962	SATA device, SATA port, IDE port or IDE slot out of range.
4963	</result>
4964	<result name="VBOX_E_INVALID_OBJECT_STATE">
4965	Attempt to attach medium to an unregistered virtual machine.
4966	</result>
4967	<result name="VBOX_E_INVALID_VM_STATE">
4968	Invalid machine state.
4969	</result>
4970	<result name="VBOX_E_OBJECT_IN_USE">
4971	Medium already attached to this or another virtual machine.
4972	</result>
4973
4974	</desc>
4975	<param name="name" type="wstring" dir="in">
4976	<desc>Name of the storage controller to attach the medium to.</desc>
4977	</param>
4978	<param name="controllerPort" type="long" dir="in">
4979	<desc>Port to attach the medium to.</desc>
4980	</param>
4981	<param name="device" type="long" dir="in">
4982	<desc>Device slot in the given port to attach the medium to.</desc>
4983	</param>
4984	<param name="medium" type="IMedium" dir="in">
4985	<desc>Medium to mount or NULL for an empty drive.</desc>
4986	</param>
4987	<param name="force" type="boolean" dir="in">
4988	<desc>Allows to force unmount/mount of a medium which is locked by
4989	the device slot in the given port to attach the medium to.</desc>
4990	</param>
4991	</method>
4992
4993	<method name="getMedium" const="yes">
4994	<desc>
4995	Returns the virtual medium attached to a device slot of the specified
4996	bus.
4997
4998	Note that if the medium was indirectly attached by
4999	<link to="#mountMedium"/> to the given device slot then this
5000	method will return not the same object as passed to the
5001	<link to="#mountMedium"/> call. See <link to="IMedium"/> for
5002	more detailed information about mounting a medium.
5003
5004	<result name="VBOX_E_OBJECT_NOT_FOUND">
5005	No medium attached to given slot/bus.
5006	</result>
5007
5008	</desc>
5009	<param name="name" type="wstring" dir="in">
5010	<desc>Name of the storage controller the medium is attached to.</desc>
5011	</param>
5012	<param name="controllerPort" type="long" dir="in">
5013	<desc>Port to query.</desc>
5014	</param>
5015	<param name="device" type="long" dir="in">
5016	<desc>Device slot in the given port to query.</desc>
5017	</param>
5018	<param name="medium" type="IMedium" dir="return">
5019	<desc>Attached medium object.</desc>
5020	</param>
5021	</method>
5022
5023	<method name="getMediumAttachmentsOfController" const="yes">
5024	<desc>
5025	Returns an array of medium attachments which are attached to the
5026	the controller with the given name.
5027
5028	<result name="VBOX_E_OBJECT_NOT_FOUND">
5029	A storage controller with given name doesn't exist.
5030	</result>
5031	</desc>
5032	<param name="name" type="wstring" dir="in"/>
5033	<param name="mediumAttachments" type="IMediumAttachment" safearray="yes" dir="return"/>
5034	</method>
5035
5036	<method name="getMediumAttachment" const="yes">
5037	<desc>
5038	Returns a medium attachment which corresponds to the controller with
5039	the given name, on the given port and device slot.
5040
5041	<result name="VBOX_E_OBJECT_NOT_FOUND">
5042	No attachment exists for the given controller/port/device combination.
5043	</result>
5044	</desc>
5045	<param name="name" type="wstring" dir="in"/>
5046	<param name="controllerPort" type="long" dir="in"/>
5047	<param name="device" type="long" dir="in"/>
5048	<param name="attachment" type="IMediumAttachment" dir="return"/>
5049	</method>
5050
5051	<method name="attachHostPciDevice">
5052	<desc>
5053	Attaches host PCI device with the given (host) PCI address to the
5054	PCI bus of the virtual machine. Please note, that this operation
5055	is two phase, as real attachment will happen when VM will start,
5056	and most information will be delivered as IHostPciDevicePlugEvent
5057	on IVirtualBox event source.
5058
5059	<see><link to="IHostPciDevicePlugEvent"/></see>
5060
5061	<result name="VBOX_E_INVALID_VM_STATE">
5062	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5063	</result>
5064	<result name="VBOX_E_PDM_ERROR">
5065	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5066	</result>
5067	<result name="VBOX_E_NOT_SUPPORTED">
5068	Hardware or host OS doesn't allow PCI device passthrought.
5069	</result>
5070	</desc>
5071	<param name="hostAddress" type="long" dir="in">
5072	<desc>Address of the host PCI device.</desc>
5073	</param>
5074	<param name="desiredGuestAddress" type="long" dir="in">
5075	<desc>Desired position of this device on guest PCI bus.</desc>
5076	</param>
5077	<param name="tryToUnbind" type="boolean" dir="in">
5078	<desc>If VMM shall try to unbind existing drivers from the
5079	device before attaching it to the guest.</desc>
5080	</param>
5081	</method>
5082
5083	<method name="detachHostPciDevice">
5084	<desc>
5085	Detach host PCI device from the virtual machine.
5086	Also HostPciDevicePlugEvent on IVirtualBox event source
5087	will be delivered. As currently we don't support hot device
5088	unplug, IHostPciDevicePlugEvent event is delivered immediately.
5089
5090	<see><link to="IHostPciDevicePlugEvent"/></see>
5091
5092	<result name="VBOX_E_INVALID_VM_STATE">
5093	Virtual machine state is not stopped (PCI hotplug not yet implemented).
5094	</result>
5095	<result name="VBOX_E_OBJECT_NOT_FOUND">
5096	This host device is not attached to this machine.
5097	</result>
5098	<result name="VBOX_E_PDM_ERROR">
5099	Virtual machine does not have a PCI controller allowing attachment of physical devices.
5100	</result>
5101	<result name="VBOX_E_NOT_SUPPORTED">
5102	Hardware or host OS doesn't allow PCI device passthrought.
5103	</result>
5104	</desc>
5105	<param name="hostAddress" type="long" dir="in">
5106	<desc>Address of the host PCI device.</desc>
5107	</param>
5108	</method>
5109
5110	<method name="getNetworkAdapter" const="yes">
5111	<desc>
5112	Returns the network adapter associated with the given slot.
5113	Slots are numbered sequentially, starting with zero. The total
5114	number of adapters per machine is defined by the
5115	<link to="ISystemProperties::getMaxNetworkAdapters"/> property,
5116	so the maximum slot number is one less than that property's value.
5117
5118	<result name="E_INVALIDARG">
5119	Invalid @a slot number.
5120	</result>
5121
5122	</desc>
5123	<param name="slot" type="unsigned long" dir="in"/>
5124	<param name="adapter" type="INetworkAdapter" dir="return"/>
5125	</method>
5126
5127	<method name="addStorageController">
5128	<desc>
5129	Adds a new storage controller (SCSI, SAS or SATA controller) to the
5130	machine and returns it as an instance of
5131	<link to="IStorageController" />.
5132
5133	@a name identifies the controller for subsequent calls such as
5134	<link to="#getStorageControllerByName" />,
5135	<link to="#getStorageControllerByInstance" />,
5136	<link to="#removeStorageController" />,
5137	<link to="#attachDevice" /> or <link to="#mountMedium" />.
5138
5139	After the controller has been added, you can set its exact
5140	type by setting the <link to="IStorageController::controllerType" />.
5141
5142	<result name="VBOX_E_OBJECT_IN_USE">
5143	A storage controller with given name exists already.
5144	</result>
5145	<result name="E_INVALIDARG">
5146	Invalid @a controllerType.
5147	</result>
5148	</desc>
5149	<param name="name" type="wstring" dir="in"/>
5150	<param name="connectionType" type="StorageBus" dir="in"/>
5151	<param name="controller" type="IStorageController" dir="return"/>
5152	</method>
5153
5154	<method name="getStorageControllerByName" const="yes">
5155	<desc>
5156	Returns a storage controller with the given name.
5157
5158	<result name="VBOX_E_OBJECT_NOT_FOUND">
5159	A storage controller with given name doesn't exist.
5160	</result>
5161	</desc>
5162	<param name="name" type="wstring" dir="in"/>
5163	<param name="storageController" type="IStorageController" dir="return"/>
5164	</method>
5165
5166	<method name="getStorageControllerByInstance" const="yes">
5167	<desc>
5168	Returns a storage controller with the given instance number.
5169
5170	<result name="VBOX_E_OBJECT_NOT_FOUND">
5171	A storage controller with given instance number doesn't exist.
5172	</result>
5173	</desc>
5174	<param name="instance" type="unsigned long" dir="in"/>
5175	<param name="storageController" type="IStorageController" dir="return"/>
5176	</method>
5177
5178	<method name="removeStorageController">
5179	<desc>
5180	Removes a storage controller from the machine.
5181
5182	<result name="VBOX_E_OBJECT_NOT_FOUND">
5183	A storage controller with given name doesn't exist.
5184	</result>
5185	</desc>
5186	<param name="name" type="wstring" dir="in"/>
5187	</method>
5188
5189	<method name="setStorageControllerBootable">
5190	<desc>
5191	Sets the bootable flag of the storage controller with the given name.
5192
5193	<result name="VBOX_E_OBJECT_NOT_FOUND">
5194	A storage controller with given name doesn't exist.
5195	</result>
5196	<result name="VBOX_E_OBJECT_IN_USE">
5197	Another storage controller is marked as bootable already.
5198	</result>
5199	</desc>
5200	<param name="name" type="wstring" dir="in"/>
5201	<param name="bootable" type="boolean" dir="in"/>
5202	</method>
5203
5204	<method name="getSerialPort" const="yes">
5205	<desc>
5206	Returns the serial port associated with the given slot.
5207	Slots are numbered sequentially, starting with zero. The total
5208	number of serial ports per machine is defined by the
5209	<link to="ISystemProperties::serialPortCount"/> property,
5210	so the maximum slot number is one less than that property's value.
5211
5212	<result name="E_INVALIDARG">
5213	Invalid @a slot number.
5214	</result>
5215
5216	</desc>
5217	<param name="slot" type="unsigned long" dir="in"/>
5218	<param name="port" type="ISerialPort" dir="return"/>
5219	</method>
5220
5221	<method name="getParallelPort" const="yes">
5222	<desc>
5223	Returns the parallel port associated with the given slot.
5224	Slots are numbered sequentially, starting with zero. The total
5225	number of parallel ports per machine is defined by the
5226	<link to="ISystemProperties::parallelPortCount"/> property,
5227	so the maximum slot number is one less than that property's value.
5228
5229	<result name="E_INVALIDARG">
5230	Invalid @a slot number.
5231	</result>
5232
5233	</desc>
5234	<param name="slot" type="unsigned long" dir="in"/>
5235	<param name="port" type="IParallelPort" dir="return"/>
5236	</method>
5237
5238	<method name="getExtraDataKeys">
5239	<desc>
5240	Returns an array representing the machine-specific extra data keys
5241	which currently have values defined.
5242	</desc>
5243	<param name="value" type="wstring" dir="return" safearray="yes">
5244	<desc>Array of extra data keys.</desc>
5245	</param>
5246	</method>
5247
5248	<method name="getExtraData">
5249	<desc>
5250	Returns associated machine-specific extra data.
5251
5252	If the requested data @a key does not exist, this function will
5253	succeed and return an empty string in the @a value argument.
5254
5255	<result name="VBOX_E_FILE_ERROR">
5256	Settings file not accessible.
5257	</result>
5258	<result name="VBOX_E_XML_ERROR">
5259	Could not parse the settings file.
5260	</result>
5261
5262	</desc>
5263	<param name="key" type="wstring" dir="in">
5264	<desc>Name of the data key to get.</desc>
5265	</param>
5266	<param name="value" type="wstring" dir="return">
5267	<desc>Value of the requested data key.</desc>
5268	</param>
5269	</method>
5270
5271	<method name="setExtraData">
5272	<desc>
5273	Sets associated machine-specific extra data.
5274
5275	If you pass @c null or an empty string as a key @a value, the given
5276	@a key will be deleted.
5277
5278	<note>
5279	Before performing the actual data change, this method will ask all
5280	registered listeners using the
5281	<link to="IExtraDataCanChangeEvent"/>
5282	notification for a permission. If one of the listeners refuses the
5283	new value, the change will not be performed.
5284	</note>
5285	<note>
5286	On success, the
5287	<link to="IExtraDataChangedEvent"/> notification
5288	is called to inform all registered listeners about a successful data
5289	change.
5290	</note>
5291	<note>
5292	This method can be called outside the machine session and therefore
5293	it's a caller's responsibility to handle possible race conditions
5294	when several clients change the same key at the same time.
5295	</note>
5296
5297	<result name="VBOX_E_FILE_ERROR">
5298	Settings file not accessible.
5299	</result>
5300	<result name="VBOX_E_XML_ERROR">
5301	Could not parse the settings file.
5302	</result>
5303
5304	</desc>
5305	<param name="key" type="wstring" dir="in">
5306	<desc>Name of the data key to set.</desc>
5307	</param>
5308	<param name="value" type="wstring" dir="in">
5309	<desc>Value to assign to the key.</desc>
5310	</param>
5311	</method>
5312
5313	<method name="getCPUProperty" const="yes">
5314	<desc>
5315	Returns the virtual CPU boolean value of the specified property.
5316
5317	<result name="E_INVALIDARG">
5318	Invalid property.
5319	</result>
5320
5321	</desc>
5322	<param name="property" type="CPUPropertyType" dir="in">
5323	<desc>
5324	Property type to query.
5325	</desc>
5326	</param>
5327	<param name="value" type="boolean" dir="return">
5328	<desc>
5329	Property value.
5330	</desc>
5331	</param>
5332	</method>
5333
5334	<method name="setCPUProperty">
5335	<desc>
5336	Sets the virtual CPU boolean value of the specified property.
5337
5338	<result name="E_INVALIDARG">
5339	Invalid property.
5340	</result>
5341
5342	</desc>
5343	<param name="property" type="CPUPropertyType" dir="in">
5344	<desc>
5345	Property type to query.
5346	</desc>
5347	</param>
5348	<param name="value" type="boolean" dir="in">
5349	<desc>
5350	Property value.
5351	</desc>
5352	</param>
5353	</method>
5354
5355	<method name="getCPUIDLeaf" const="yes">
5356	<desc>
5357	Returns the virtual CPU cpuid information for the specified leaf.
5358
5359	Currently supported index values for cpuid:
5360	Standard CPUID leafs: 0 - 0xA
5361	Extended CPUID leafs: 0x80000000 - 0x8000000A
5362
5363	See the Intel and AMD programmer's manuals for detailed information
5364	about the cpuid instruction and its leafs.
5365	<result name="E_INVALIDARG">
5366	Invalid id.
5367	</result>
5368
5369	</desc>
5370	<param name="id" type="unsigned long" dir="in">
5371	<desc>
5372	CPUID leaf index.
5373	</desc>
5374	</param>
5375	<param name="valEax" type="unsigned long" dir="out">
5376	<desc>
5377	CPUID leaf value for register eax.
5378	</desc>
5379	</param>
5380	<param name="valEbx" type="unsigned long" dir="out">
5381	<desc>
5382	CPUID leaf value for register ebx.
5383	</desc>
5384	</param>
5385	<param name="valEcx" type="unsigned long" dir="out">
5386	<desc>
5387	CPUID leaf value for register ecx.
5388	</desc>
5389	</param>
5390	<param name="valEdx" type="unsigned long" dir="out">
5391	<desc>
5392	CPUID leaf value for register edx.
5393	</desc>
5394	</param>
5395	</method>
5396
5397	<method name="setCPUIDLeaf">
5398	<desc>
5399	Sets the virtual CPU cpuid information for the specified leaf. Note that these values
5400	are not passed unmodified. VirtualBox clears features that it doesn't support.
5401
5402	Currently supported index values for cpuid:
5403	Standard CPUID leafs: 0 - 0xA
5404	Extended CPUID leafs: 0x80000000 - 0x8000000A
5405
5406	See the Intel and AMD programmer's manuals for detailed information
5407	about the cpuid instruction and its leafs.
5408
5409	Do not use this method unless you know exactly what you're doing. Misuse can lead to
5410	random crashes inside VMs.
5411	<result name="E_INVALIDARG">
5412	Invalid id.
5413	</result>
5414
5415	</desc>
5416	<param name="id" type="unsigned long" dir="in">
5417	<desc>
5418	CPUID leaf index.
5419	</desc>
5420	</param>
5421	<param name="valEax" type="unsigned long" dir="in">
5422	<desc>
5423	CPUID leaf value for register eax.
5424	</desc>
5425	</param>
5426	<param name="valEbx" type="unsigned long" dir="in">
5427	<desc>
5428	CPUID leaf value for register ebx.
5429	</desc>
5430	</param>
5431	<param name="valEcx" type="unsigned long" dir="in">
5432	<desc>
5433	CPUID leaf value for register ecx.
5434	</desc>
5435	</param>
5436	<param name="valEdx" type="unsigned long" dir="in">
5437	<desc>
5438	CPUID leaf value for register edx.
5439	</desc>
5440	</param>
5441	</method>
5442
5443	<method name="removeCPUIDLeaf">
5444	<desc>
5445	Removes the virtual CPU cpuid leaf for the specified index
5446
5447	<result name="E_INVALIDARG">
5448	Invalid id.
5449	</result>
5450
5451	</desc>
5452	<param name="id" type="unsigned long" dir="in">
5453	<desc>
5454	CPUID leaf index.
5455	</desc>
5456	</param>
5457	</method>
5458
5459	<method name="removeAllCPUIDLeaves">
5460	<desc>
5461	Removes all the virtual CPU cpuid leaves
5462	</desc>
5463	</method>
5464
5465	<method name="getHWVirtExProperty" const="yes">
5466	<desc>
5467	Returns the value of the specified hardware virtualization boolean property.
5468
5469	<result name="E_INVALIDARG">
5470	Invalid property.
5471	</result>
5472
5473	</desc>
5474	<param name="property" type="HWVirtExPropertyType" dir="in">
5475	<desc>
5476	Property type to query.
5477	</desc>
5478	</param>
5479	<param name="value" type="boolean" dir="return">
5480	<desc>
5481	Property value.
5482	</desc>
5483	</param>
5484	</method>
5485
5486	<method name="setHWVirtExProperty">
5487	<desc>
5488	Sets a new value for the specified hardware virtualization boolean property.
5489
5490	<result name="E_INVALIDARG">
5491	Invalid property.
5492	</result>
5493
5494	</desc>
5495	<param name="property" type="HWVirtExPropertyType" dir="in">
5496	<desc>
5497	Property type to set.
5498	</desc>
5499	</param>
5500	<param name="value" type="boolean" dir="in">
5501	<desc>
5502	New property value.
5503	</desc>
5504	</param>
5505	</method>
5506
5507	<method name="saveSettings">
5508	<desc>
5509	Saves any changes to machine settings made since the session
5510	has been opened or a new machine has been created, or since the
5511	last call to <link to="#saveSettings"/> or <link to="#discardSettings"/>.
5512	For registered machines, new settings become visible to all
5513	other VirtualBox clients after successful invocation of this
5514	method.
5515	<note>
5516	The method sends <link to="IMachineDataChangedEvent"/>
5517	notification event after the configuration has been successfully
5518	saved (only for registered machines).
5519	</note>
5520	<note>
5521	Calling this method is only valid on instances returned
5522	by <link to="ISession::machine"/> and on new machines
5523	created by <link to="IVirtualBox::createMachine"/> but not
5524	yet registered, or on unregistered machines after calling
5525	<link to="IMachine::unregister"/>.
5526	</note>
5527
5528	<result name="VBOX_E_FILE_ERROR">
5529	Settings file not accessible.
5530	</result>
5531	<result name="VBOX_E_XML_ERROR">
5532	Could not parse the settings file.
5533	</result>
5534	<result name="E_ACCESSDENIED">
5535	Modification request refused.
5536	</result>
5537
5538	</desc>
5539	</method>
5540
5541	<method name="discardSettings">
5542	<desc>
5543	Discards any changes to the machine settings made since the session
5544	has been opened or since the last call to <link to="#saveSettings"/>
5545	or <link to="#discardSettings"/>.
5546	<note>
5547	Calling this method is only valid on instances returned
5548	by <link to="ISession::machine"/> and on new machines
5549	created by <link to="IVirtualBox::createMachine"/> or
5550	opened by <link to="IVirtualBox::openMachine"/> but not
5551	yet registered, or on unregistered machines after calling
5552	<link to="IMachine::unregister"/>.
5553	</note>
5554
5555	<result name="VBOX_E_INVALID_VM_STATE">
5556	Virtual machine is not mutable.
5557	</result>
5558
5559	</desc>
5560	</method>
5561
5562	<method name="unregister">
5563	<desc>
5564	Unregisters a machine previously registered with
5565	<link to="IVirtualBox::registerMachine"/> and optionally do additional
5566	cleanup before the machine is unregistered.
5567
5568	This method does not delete any files. It only changes the machine configuration and
5569	the list of registered machines in the VirtualBox object. To delete the files which
5570	belonged to the machine, including the XML file of the machine itself, call
5571	<link to="#delete"/>, optionally with the array of IMedium objects which was returned
5572	from this method.
5573
5574	How thoroughly this method cleans up the machine configuration before unregistering
5575	the machine depends on the @a cleanupMode argument.
5576
5577	<ul>
5578	<li>With "UnregisterOnly", the machine will only be unregistered, but no additional
5579	cleanup will be performed. The call will fail if the machine is in "Saved" state
5580	or has any snapshots or any media attached (see <link to="IMediumAttachment" />).
5581	It is the responsibility of the caller to delete all such configuration in this mode.
5582	In this mode, the API behaves like the former @c IVirtualBox::unregisterMachine() API
5583	which it replaces.</li>
5584	<li>With "DetachAllReturnNone", the call will succeed even if the machine is in "Saved"
5585	state or if it has snapshots or media attached. All media attached to the current machine
5586	state or in snapshots will be detached. No medium objects will be returned;
5587	all of the machine's media will remain open.</li>
5588	<li>With "DetachAllReturnHardDisksOnly", the call will behave like with "DetachAllReturnNone",
5589	except that all the hard disk medium objects which were detached from the machine will
5590	be returned as an array. This allows for quickly passing them to the <link to="#delete" />
5591	API for closing and deletion.</li>
5592	<li>With "Full", the call will behave like with "DetachAllReturnHardDisksOnly", except
5593	that all media will be returned in the array, including removable media like DVDs and
5594	floppies. This might be useful if the user wants to inspect in detail which media were
5595	attached to the machine. Be careful when passing the media array to <link to="#delete" />
5596	in that case because users will typically want to preserve ISO and RAW image files.</li>
5597	</ul>
5598
5599	A typical implementation will use "DetachAllReturnHardDisksOnly" and then pass the
5600	resulting IMedium array to <link to="#delete"/>. This way, the machine is completely
5601	deleted with all its saved states and hard disk images, but images for removable
5602	drives (such as ISO and RAW files) will remain on disk.
5603
5604	This API does not verify whether the media files returned in the array are still
5605	attached to other machines (i.e. shared between several machines). If such a shared
5606	image is passed to <link to="#delete" /> however, closing the image will fail there
5607	and the image will be silently skipped.
5608
5609	This API may, however, move media from this machine's media registry to other media
5610	registries (see <link to="IMedium" /> for details on media registries). For machines
5611	created with VirtualBox 4.0 or later, if media from this machine's media registry
5612	are also attached to another machine (shared attachments), each such medium will be
5613	moved to another machine's registry. This is because without this machine's media
5614	registry, the other machine cannot find its media any more and would become inaccessible.
5615
5616	This API implicitly calls <link to="#saveSettings"/> to save all current machine settings
5617	before unregistering it. It may also silently call <link to="#saveSettings"/> on other machines
5618	if media are moved to other machines' media registries.
5619
5620	After successful method invocation, the <link to="IMachineRegisteredEvent"/> event
5621	is fired.
5622
5623	The call will fail if the machine is currently locked (see <link to="ISession" />).
5624
5625	<note>
5626	If the given machine is inaccessible (see <link to="#accessible"/>), it
5627	will be unregistered and fully uninitialized right afterwards. As a result,
5628	the returned machine object will be unusable and an attempt to call
5629	<b>any</b> method will return the "Object not ready" error.
5630	</note>
5631
5632	<result name="VBOX_E_INVALID_OBJECT_STATE">
5633	Machine is currently locked for a session.
5634	</result>
5635	</desc>
5636
5637	<param name="cleanupMode" type="CleanupMode" dir="in">
5638	<desc>How to clean up after the machine has been unregistered.</desc>
5639	</param>
5640	<param name="aMedia" type="IMedium" safearray="yes" dir="return">
5641	<desc>List of media detached from the machine, depending on the @a cleanupMode parameter.</desc>
5642	</param>
5643	</method>
5644
5645	<method name="delete">
5646	<desc>
5647	Deletes the files associated with this machine from disk. If medium objects are passed
5648	in with the @a aMedia argument, they are closed and, if closing was successful, their
5649	storage files are deleted as well. For convenience, this array of media files can be
5650	the same as the one returned from a previous <link to="#unregister" /> call.
5651
5652	This method must only be called on machines which are either write-locked (i.e. on instances
5653	returned by <link to="ISession::machine"/>) or on unregistered machines (i.e. not yet
5654	registered machines created by <link to="IVirtualBox::createMachine"/> or opened by
5655	<link to="IVirtualBox::openMachine"/>, or after having called <link to="#unregister"/>).
5656
5657	The following files will be deleted by this method:
5658	<ul>
5659	<li>If <link to="#unregister" /> had been previously called with a @a cleanupMode
5660	argument other than "UnregisterOnly", this will delete all saved state files that
5661	the machine had in use; possibly one if the machine was in "Saved" state and one
5662	for each online snapshot that the machine had.</li>
5663	<li>On each medium object passed in the @a aMedia array, this will call
5664	<link to="IMedium::close" />. If that succeeds, this will attempt to delete the
5665	medium's storage on disk. Since the <link to="IMedium::close"/> call will fail if the medium is still
5666	in use, e.g. because it is still attached to a second machine; in that case the
5667	storage will not be deleted.</li>
5668	<li>Finally, the machine's own XML file will be deleted.</li>
5669	</ul>
5670
5671	Since deleting large disk image files can be a time-consuming I/O operation, this
5672	method operates asynchronously and returns an IProgress object to allow the caller
5673	to monitor the progress. There will be one sub-operation for each file that is
5674	being deleted (saved state or medium storage file).
5675
5676	<note>
5677	<link to="#settingsModified"/> will return @c true after this
5678	method successfully returns.
5679	</note>
5680
5681	<result name="VBOX_E_INVALID_VM_STATE">
5682	Machine is registered but not write-locked.
5683	</result>
5684	<result name="VBOX_E_IPRT_ERROR">
5685	Could not delete the settings file.
5686	</result>
5687	</desc>
5688	<param name="aMedia" type="IMedium" safearray="yes" dir="in">
5689	<desc>List of media to be closed and whose storage files will be deleted.</desc>
5690	</param>
5691	<param name="aProgress" type="IProgress" dir="return">
5692	<desc>Progress object to track the operation completion.</desc>
5693	</param>
5694	</method>
5695
5696	<method name="export">
5697	<desc>Exports the machine to an OVF appliance. See <link to="IAppliance" /> for the
5698	steps required to export VirtualBox machines to OVF.
5699	</desc>
5700
5701	<param name="aAppliance" type="IAppliance" dir="in">
5702	<desc>Appliance to export this machine to.</desc>
5703	</param>
5704	<param name="location" type="wstring" dir="in">
5705	<desc>The target location.</desc>
5706	</param>
5707	<param name="aDescription" type="IVirtualSystemDescription" dir="return">
5708	<desc>VirtualSystemDescription object which is created for this machine.</desc>
5709	</param>
5710	</method >
5711
5712	<method name="findSnapshot">
5713	<desc>
5714	Returns a snapshot of this machine with the given name or UUID.
5715
5716	Returns a snapshot of this machine with the given UUID.
5717	A @c null argument can be used to obtain the first snapshot
5718	taken on this machine. To traverse the whole tree of snapshots
5719	starting from the root, inspect the root snapshot's
5720	<link to="ISnapshot::children" /> attribute and recurse over those children.
5721
5722	<result name="VBOX_E_OBJECT_NOT_FOUND">
5723	Virtual machine has no snapshots or snapshot not found.
5724	</result>
5725
5726	</desc>
5727	<param name="nameOrId" type="wstring" dir="in">
5728	<desc>What to search for. Name or UUID of the snapshot to find</desc>
5729	</param>
5730	<param name="snapshot" type="ISnapshot" dir="return">
5731	<desc>Snapshot object with the given name.</desc>
5732	</param>
5733	</method>
5734
5735	<method name="createSharedFolder">
5736	<desc>
5737	Creates a new permanent shared folder by associating the given logical
5738	name with the given host path, adds it to the collection of shared
5739	folders and starts sharing it. Refer to the description of
5740	<link to="ISharedFolder"/> to read more about logical names.
5741
5742	<result name="VBOX_E_OBJECT_IN_USE">
5743	Shared folder already exists.
5744	</result>
5745	<result name="VBOX_E_FILE_ERROR">
5746	Shared folder @a hostPath not accessible.
5747	</result>
5748
5749	</desc>
5750	<param name="name" type="wstring" dir="in">
5751	<desc>Unique logical name of the shared folder.</desc>
5752	</param>
5753	<param name="hostPath" type="wstring" dir="in">
5754	<desc>Full path to the shared folder in the host file system.</desc>
5755	</param>
5756	<param name="writable" type="boolean" dir="in">
5757	<desc>Whether the share is writable or readonly.</desc>
5758	</param>
5759	<param name="automount" type="boolean" dir="in">
5760	<desc>Whether the share gets automatically mounted by the guest
5761	or not.</desc>
5762	</param>
5763	</method>
5764
5765	<method name="removeSharedFolder">
5766	<desc>
5767	Removes the permanent shared folder with the given name previously
5768	created by <link to="#createSharedFolder"/> from the collection of
5769	shared folders and stops sharing it.
5770
5771	<result name="VBOX_E_INVALID_VM_STATE">
5772	Virtual machine is not mutable.
5773	</result>
5774	<result name="VBOX_E_OBJECT_NOT_FOUND">
5775	Shared folder @a name does not exist.
5776	</result>
5777
5778	</desc>
5779	<param name="name" type="wstring" dir="in">
5780	<desc>Logical name of the shared folder to remove.</desc>
5781	</param>
5782	</method>
5783
5784	<method name="canShowConsoleWindow">
5785	<desc>
5786	Returns @c true if the VM console process can activate the
5787	console window and bring it to foreground on the desktop of
5788	the host PC.
5789	<note>
5790	This method will fail if a session for this machine is not
5791	currently open.
5792	</note>
5793
5794	<result name="VBOX_E_INVALID_VM_STATE">
5795	Machine session is not open.
5796	</result>
5797
5798	</desc>
5799	<param name="canShow" type="boolean" dir="return">
5800	<desc>
5801	@c true if the console window can be shown and @c false otherwise.
5802	</desc>
5803	</param>
5804	</method>
5805
5806	<method name="showConsoleWindow">
5807	<desc>
5808	Activates the console window and brings it to foreground on
5809	the desktop of the host PC. Many modern window managers on
5810	many platforms implement some sort of focus stealing
5811	prevention logic, so that it may be impossible to activate
5812	a window without the help of the currently active
5813	application. In this case, this method will return a non-zero
5814	identifier that represents the top-level window of the VM
5815	console process. The caller, if it represents a currently
5816	active process, is responsible to use this identifier (in a
5817	platform-dependent manner) to perform actual window
5818	activation.
5819	<note>
5820	This method will fail if a session for this machine is not
5821	currently open.
5822	</note>
5823
5824	<result name="VBOX_E_INVALID_VM_STATE">
5825	Machine session is not open.
5826	</result>
5827
5828	</desc>
5829	<param name="winId" type="long long" dir="return">
5830	<desc>
5831	Platform-dependent identifier of the top-level VM console
5832	window, or zero if this method has performed all actions
5833	necessary to implement the <i>show window</i> semantics for
5834	the given platform and/or VirtualBox front-end.
5835	</desc>
5836	</param>
5837	</method>
5838
5839	<method name="getGuestProperty" const="yes">
5840	<desc>
5841	Reads an entry from the machine's guest property store.
5842
5843	<result name="VBOX_E_INVALID_VM_STATE">
5844	Machine session is not open.
5845	</result>
5846
5847	</desc>
5848	<param name="name" type="wstring" dir="in">
5849	<desc>
5850	The name of the property to read.
5851	</desc>
5852	</param>
5853	<param name="value" type="wstring" dir="out">
5854	<desc>
5855	The value of the property. If the property does not exist then this
5856	will be empty.
5857	</desc>
5858	</param>
5859	<param name="timestamp" type="long long" dir="out">
5860	<desc>
5861	The time at which the property was last modified, as seen by the
5862	server process.
5863	</desc>
5864	</param>
5865	<param name="flags" type="wstring" dir="out">
5866	<desc>
5867	Additional property parameters, passed as a comma-separated list of
5868	"name=value" type entries.
5869	</desc>
5870	</param>
5871	</method>
5872
5873	<method name="getGuestPropertyValue" const="yes">
5874	<desc>
5875	Reads a value from the machine's guest property store.
5876
5877	<result name="VBOX_E_INVALID_VM_STATE">
5878	Machine session is not open.
5879	</result>
5880
5881	</desc>
5882	<param name="property" type="wstring" dir="in">
5883	<desc>
5884	The name of the property to read.
5885	</desc>
5886	</param>
5887	<param name="value" type="wstring" dir="return">
5888	<desc>
5889	The value of the property. If the property does not exist then this
5890	will be empty.
5891	</desc>
5892	</param>
5893	</method>
5894
5895	<method name="getGuestPropertyTimestamp" const="yes">
5896	<desc>
5897	Reads a property timestamp from the machine's guest property store.
5898
5899	<result name="VBOX_E_INVALID_VM_STATE">
5900	Machine session is not open.
5901	</result>
5902
5903	</desc>
5904	<param name="property" type="wstring" dir="in">
5905	<desc>
5906	The name of the property to read.
5907	</desc>
5908	</param>
5909	<param name="value" type="long long" dir="return">
5910	<desc>
5911	The timestamp. If the property does not exist then this will be
5912	empty.
5913	</desc>
5914	</param>
5915	</method>
5916
5917	<method name="setGuestProperty">
5918	<desc>
5919	Sets, changes or deletes an entry in the machine's guest property
5920	store.
5921
5922	<result name="E_ACCESSDENIED">
5923	Property cannot be changed.
5924	</result>
5925	<result name="E_INVALIDARG">
5926	Invalid @a flags.
5927	</result>
5928	<result name="VBOX_E_INVALID_VM_STATE">
5929	Virtual machine is not mutable or session not open.
5930	</result>
5931	<result name="VBOX_E_INVALID_OBJECT_STATE">
5932	Cannot set transient property when machine not running.
5933	</result>
5934
5935	</desc>
5936	<param name="property" type="wstring" dir="in">
5937	<desc>
5938	The name of the property to set, change or delete.
5939	</desc>
5940	</param>
5941	<param name="value" type="wstring" dir="in">
5942	<desc>
5943	The new value of the property to set, change or delete. If the
5944	property does not yet exist and value is non-empty, it will be
5945	created. If the value is @c null or empty, the property will be
5946	deleted if it exists.
5947	</desc>
5948	</param>
5949	<param name="flags" type="wstring" dir="in">
5950	<desc>
5951	Additional property parameters, passed as a comma-separated list of
5952	"name=value" type entries.
5953	</desc>
5954	</param>
5955	</method>
5956
5957	<method name="setGuestPropertyValue">
5958	<desc>
5959	Sets, changes or deletes a value in the machine's guest property
5960	store. The flags field will be left unchanged or created empty for a
5961	new property.
5962
5963	<result name="E_ACCESSDENIED">
5964	Property cannot be changed.
5965	</result>
5966	<result name="VBOX_E_INVALID_VM_STATE">
5967	Virtual machine is not mutable or session not open.
5968	</result>
5969	<result name="VBOX_E_INVALID_OBJECT_STATE">
5970	Cannot set transient property when machine not running.
5971	</result>
5972	</desc>
5973
5974	<param name="property" type="wstring" dir="in">
5975	<desc>
5976	The name of the property to set, change or delete.
5977	</desc>
5978	</param>
5979	<param name="value" type="wstring" dir="in">
5980	<desc>
5981	The new value of the property to set, change or delete. If the
5982	property does not yet exist and value is non-empty, it will be
5983	created. If the value is @c null or empty, the property will be
5984	deleted if it exists.
5985	</desc>
5986	</param>
5987	</method>
5988
5989	<method name="deleteGuestProperty" const="yes">
5990	<desc>
5991	Deletes an entry from the machine's guest property store.
5992
5993	<result name="VBOX_E_INVALID_VM_STATE">
5994	Machine session is not open.
5995	</result>
5996
5997	</desc>
5998	<param name="name" type="wstring" dir="in">
5999	<desc>
6000	The name of the property to delete.
6001	</desc>
6002	</param>
6003	</method>
6004
6005	<method name="enumerateGuestProperties" const="yes">
6006	<desc>
6007	Return a list of the guest properties matching a set of patterns along
6008	with their values, time stamps and flags.
6009	</desc>
6010	<param name="patterns" type="wstring" dir="in">
6011	<desc>
6012	The patterns to match the properties against, separated by '\|'
6013	characters. If this is empty or @c null, all properties will match.
6014	</desc>
6015	</param>
6016	<param name="name" type="wstring" dir="out" safearray="yes">
6017	<desc>
6018	The names of the properties returned.
6019	</desc>
6020	</param>
6021	<param name="value" type="wstring" dir="out" safearray="yes">
6022	<desc>
6023	The values of the properties returned. The array entries match the
6024	corresponding entries in the @a name array.
6025	</desc>
6026	</param>
6027	<param name="timestamp" type="long long" dir="out" safearray="yes">
6028	<desc>
6029	The time stamps of the properties returned. The array entries match
6030	the corresponding entries in the @a name array.
6031	</desc>
6032	</param>
6033	<param name="flags" type="wstring" dir="out" safearray="yes">
6034	<desc>
6035	The flags of the properties returned. The array entries match the
6036	corresponding entries in the @a name array.
6037	</desc>
6038	</param>
6039	</method>
6040
6041	<method name="querySavedGuestSize" const="yes">
6042	<desc>
6043	Returns the guest dimensions from the saved state.
6044	</desc>
6045	<param name="screenId" type="unsigned long" dir="in">
6046	<desc>
6047	Saved guest screen to query info from.
6048	</desc>
6049	</param>
6050	<param name="width" type="unsigned long" dir="out">
6051	<desc>
6052	Guest width at the time of the saved state was taken.
6053	</desc>
6054	</param>
6055	<param name="height" type="unsigned long" dir="out">
6056	<desc>
6057	Guest height at the time of the saved state was taken.
6058	</desc>
6059	</param>
6060	</method>
6061
6062	<method name="querySavedThumbnailSize">
6063	<desc>
6064	Returns size in bytes and dimensions in pixels of a saved thumbnail bitmap from saved state.
6065	</desc>
6066	<param name="screenId" type="unsigned long" dir="in">
6067	<desc>
6068	Saved guest screen to query info from.
6069	</desc>
6070	</param>
6071	<param name="size" type="unsigned long" dir="out">
6072	<desc>
6073	Size of buffer required to store the bitmap.
6074	</desc>
6075	</param>
6076	<param name="width" type="unsigned long" dir="out">
6077	<desc>
6078	Bitmap width.
6079	</desc>
6080	</param>
6081	<param name="height" type="unsigned long" dir="out">
6082	<desc>
6083	Bitmap height.
6084	</desc>
6085	</param>
6086	</method>
6087
6088	<method name="readSavedThumbnailToArray">
6089	<desc>
6090	Thumbnail is retrieved to an array of bytes in uncompressed 32-bit BGRA or RGBA format.
6091	</desc>
6092	<param name="screenId" type="unsigned long" dir="in">
6093	<desc>
6094	Saved guest screen to read from.
6095	</desc>
6096	</param>
6097	<param name="BGR" type="boolean" dir="in">
6098	<desc>
6099	How to order bytes in the pixel. A pixel consists of 4 bytes. If this parameter is true, then
6100	bytes order is: B, G, R, 0xFF. If this parameter is false, then bytes order is: R, G, B, 0xFF.
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	<param name="data" type="octet" safearray="yes" dir="return">
6114	<desc>
6115	Array with resulting bitmap data.
6116	</desc>
6117	</param>
6118	</method>
6119
6120	<method name="readSavedThumbnailPNGToArray">
6121	<desc>
6122	Thumbnail in PNG format is retrieved to an array of bytes.
6123	</desc>
6124	<param name="screenId" type="unsigned long" dir="in">
6125	<desc>
6126	Saved guest screen to read from.
6127	</desc>
6128	</param>
6129	<param name="width" type="unsigned long" dir="out">
6130	<desc>
6131	Image width.
6132	</desc>
6133	</param>
6134	<param name="height" type="unsigned long" dir="out">
6135	<desc>
6136	Image height.
6137	</desc>
6138	</param>
6139	<param name="data" type="octet" dir="return" safearray="yes">
6140	<desc>
6141	Array with resulting PNG data.
6142	</desc>
6143	</param>
6144	</method>
6145
6146	<method name="querySavedScreenshotPNGSize">
6147	<desc>
6148	Returns size in bytes and dimensions of a saved PNG image of screenshot from saved state.
6149	</desc>
6150	<param name="screenId" type="unsigned long" dir="in">
6151	<desc>
6152	Saved guest screen to query info from.
6153	</desc>
6154	</param>
6155	<param name="size" type="unsigned long" dir="out">
6156	<desc>
6157	Size of buffer required to store the PNG binary data.
6158	</desc>
6159	</param>
6160	<param name="width" type="unsigned long" dir="out">
6161	<desc>
6162	Image width.
6163	</desc>
6164	</param>
6165	<param name="height" type="unsigned long" dir="out">
6166	<desc>
6167	Image height.
6168	</desc>
6169	</param>
6170	</method>
6171
6172	<method name="readSavedScreenshotPNGToArray">
6173	<desc>
6174	Screenshot in PNG format is retrieved to an array of bytes.
6175	</desc>
6176	<param name="screenId" type="unsigned long" dir="in">
6177	<desc>
6178	Saved guest screen to read from.
6179	</desc>
6180	</param>
6181	<param name="width" type="unsigned long" dir="out">
6182	<desc>
6183	Image width.
6184	</desc>
6185	</param>
6186	<param name="height" type="unsigned long" dir="out">
6187	<desc>
6188	Image height.
6189	</desc>
6190	</param>
6191	<param name="data" type="octet" dir="return" safearray="yes">
6192	<desc>
6193	Array with resulting PNG data.
6194	</desc>
6195	</param>
6196	</method>
6197
6198	<method name="hotPlugCPU">
6199	<desc>
6200	Plugs a CPU into the machine.
6201	</desc>
6202	<param name="cpu" type="unsigned long" dir="in">
6203	<desc>
6204	The CPU id to insert.
6205	</desc>
6206	</param>
6207	</method>
6208
6209	<method name="hotUnplugCPU">
6210	<desc>
6211	Removes a CPU from the machine.
6212	</desc>
6213	<param name="cpu" type="unsigned long" dir="in">
6214	<desc>
6215	The CPU id to remove.
6216	</desc>
6217	</param>
6218	</method>
6219
6220	<method name="getCPUStatus">
6221	<desc>
6222	Returns the current status of the given CPU.
6223	</desc>
6224	<param name="cpu" type="unsigned long" dir="in">
6225	<desc>
6226	The CPU id to check for.
6227	</desc>
6228	</param>
6229	<param name="attached" type="boolean" dir="return">
6230	<desc>
6231	Status of the CPU.
6232	</desc>
6233	</param>
6234	</method>
6235
6236	<method name="queryLogFilename">
6237	<desc>
6238	Queries for the VM log file name of an given index. Returns an empty
6239	string if a log file with that index doesn't exists.
6240	</desc>
6241	<param name="idx" type="unsigned long" dir="in">
6242	<desc>
6243	Which log file name to query. 0=current log file.
6244	</desc>
6245	</param>
6246	<param name="filename" type="wstring" dir="return">
6247	<desc>
6248	On return the full path to the log file or an empty string on error.
6249	</desc>
6250	</param>
6251	</method>
6252
6253	<method name="readLog">
6254	<desc>
6255	Reads the VM log file. The chunk size is limited, so even if you
6256	ask for a big piece there might be less data returned.
6257	</desc>
6258	<param name="idx" type="unsigned long" dir="in">
6259	<desc>
6260	Which log file to read. 0=current log file.
6261	</desc>
6262	</param>
6263	<param name="offset" type="long long" dir="in">
6264	<desc>
6265	Offset in the log file.
6266	</desc>
6267	</param>
6268	<param name="size" type="long long" dir="in">
6269	<desc>
6270	Chunk size to read in the log file.
6271	</desc>
6272	</param>
6273	<param name="data" type="octet" dir="return" safearray="yes">
6274	<desc>
6275	Data read from the log file. A data size of 0 means end of file
6276	if the requested chunk size was not 0. This is the unprocessed
6277	file data, i.e. the line ending style depends on the platform of
6278	the system the server is running on.
6279	</desc>
6280	</param>
6281	</method>
6282
6283	<method name="cloneTo">
6284	<desc>
6285	Creates a clone of this machine, either as a full clone (which means
6286	creating independent copies of the hard disk media, save states and so
6287	on), or as a linked clone (which uses its own differencing media,
6288	sharing the parent media with the source machine).
6289
6290	The target machine object must have been created previously with <link
6291	to="IVirtualBox::createMachine"/>, and all the settings will be
6292	transferred except the VM name and the hardware UUID. You can set the
6293	VM name and the new hardware UUID when creating the target machine. The
6294	network MAC addresses are newly created for all newtwork adapters. You
6295	can change that behaviour with the options parameter. The operation is
6296	performed asynchronously, so the machine object will be not be usable
6297	until the @a progress object signals completion.
6298
6299	<result name="E_INVALIDARG">
6300	@a target is @c null.
6301	</result>
6302	</desc>
6303
6304	<param name="target" type="IMachine" dir="in">
6305	<desc>Target machine object.</desc>
6306	</param>
6307	<param name="mode" type="CloneMode" dir="in">
6308	<desc>Which states should be cloned.</desc>
6309	</param>
6310	<param name="options" type="CloneOptions" dir="in" safearray="yes">
6311	<desc>Options for the cloning operation.</desc>
6312	</param>
6313	<param name="progress" type="IProgress" dir="return">
6314	<desc>Progress object to track the operation completion.</desc>
6315	</param>
6316	</method>
6317
6318	</interface>
6319
6320	<!--
6321	// IConsole
6322	/////////////////////////////////////////////////////////////////////////
6323	-->
6324
6325	<interface
6326	name="IVRDEServerInfo" extends="$unknown"
6327	uuid="714434a1-58c3-4aab-9049-7652c5df113b"
6328	wsmap="struct"
6329	>
6330	<desc>
6331	Contains information about the remote desktop (VRDE) server capabilities and status.
6332	This is used in the <link to="IConsole::VRDEServerInfo" /> attribute.
6333	</desc>
6334
6335	<attribute name="active" type="boolean" readonly="yes">
6336	<desc>
6337	Whether the remote desktop connection is active.
6338	</desc>
6339	</attribute>
6340
6341	<attribute name="port" type="long" readonly="yes">
6342	<desc>
6343	VRDE server port number. If this property is equal to <tt>0</tt>, then
6344	the VRDE server failed to start, usually because there are no free IP
6345	ports to bind to. If this property is equal to <tt>-1</tt>, then the VRDE
6346	server has not yet been started.
6347	</desc>
6348	</attribute>
6349
6350	<attribute name="numberOfClients" type="unsigned long" readonly="yes">
6351	<desc>
6352	How many times a client connected.
6353	</desc>
6354	</attribute>
6355
6356	<attribute name="beginTime" type="long long" readonly="yes">
6357	<desc>
6358	When the last connection was established, in milliseconds since 1970-01-01 UTC.
6359	</desc>
6360	</attribute>
6361
6362	<attribute name="endTime" type="long long" readonly="yes">
6363	<desc>
6364	When the last connection was terminated or the current time, if
6365	connection is still active, in milliseconds since 1970-01-01 UTC.
6366	</desc>
6367	</attribute>
6368
6369	<attribute name="bytesSent" type="long long" readonly="yes">
6370	<desc>
6371	How many bytes were sent in last or current, if still active, connection.
6372	</desc>
6373	</attribute>
6374
6375	<attribute name="bytesSentTotal" type="long long" readonly="yes">
6376	<desc>
6377	How many bytes were sent in all connections.
6378	</desc>
6379	</attribute>
6380
6381	<attribute name="bytesReceived" type="long long" readonly="yes">
6382	<desc>
6383	How many bytes were received in last or current, if still active, connection.
6384	</desc>
6385	</attribute>
6386
6387	<attribute name="bytesReceivedTotal" type="long long" readonly="yes">
6388	<desc>
6389	How many bytes were received in all connections.
6390	</desc>
6391	</attribute>
6392
6393	<attribute name="user" type="wstring" readonly="yes">
6394	<desc>
6395	Login user name supplied by the client.
6396	</desc>
6397	</attribute>
6398
6399	<attribute name="domain" type="wstring" readonly="yes">
6400	<desc>
6401	Login domain name supplied by the client.
6402	</desc>
6403	</attribute>
6404
6405	<attribute name="clientName" type="wstring" readonly="yes">
6406	<desc>
6407	The client name supplied by the client.
6408	</desc>
6409	</attribute>
6410
6411	<attribute name="clientIP" type="wstring" readonly="yes">
6412	<desc>
6413	The IP address of the client.
6414	</desc>
6415	</attribute>
6416
6417	<attribute name="clientVersion" type="unsigned long" readonly="yes">
6418	<desc>
6419	The client software version number.
6420	</desc>
6421	</attribute>
6422
6423	<attribute name="encryptionStyle" type="unsigned long" readonly="yes">
6424	<desc>
6425	Public key exchange method used when connection was established.
6426	Values: 0 - RDP4 public key exchange scheme.
6427	1 - X509 certificates were sent to client.
6428	</desc>
6429	</attribute>
6430
6431	</interface>
6432
6433	<interface
6434	name="IConsole" extends="$unknown"
6435	uuid="1968b7d3-e3bf-4ceb-99e0-cb7c913317bb"
6436	wsmap="managed"
6437	>
6438	<desc>
6439	The IConsole interface represents an interface to control virtual
6440	machine execution.
6441
6442	A console object gets created when a machine has been locked for a
6443	particular session (client process) using <link to="IMachine::lockMachine" />
6444	or <link to="IMachine::launchVMProcess"/>. The console object can
6445	then be found in the session's <link to="ISession::console" /> attribute.
6446
6447	Methods of the IConsole interface allow the caller to query the current
6448	virtual machine execution state, pause the machine or power it down, save
6449	the machine state or take a snapshot, attach and detach removable media
6450	and so on.
6451
6452	<see><link to="ISession"/></see>
6453	</desc>
6454
6455	<attribute name="machine" type="IMachine" readonly="yes">
6456	<desc>
6457	Machine object for this console session.
6458	<note>
6459	This is a convenience property, it has the same value as
6460	<link to="ISession::machine"/> of the corresponding session
6461	object.
6462	</note>
6463	</desc>
6464	</attribute>
6465
6466	<attribute name="state" type="MachineState" readonly="yes">
6467	<desc>
6468	Current execution state of the machine.
6469	<note>
6470	This property always returns the same value as the corresponding
6471	property of the IMachine object for this console session.
6472	For the process that owns (executes) the VM, this is the
6473	preferable way of querying the VM state, because no IPC
6474	calls are made.
6475	</note>
6476	</desc>
6477	</attribute>
6478
6479	<attribute name="guest" type="IGuest" readonly="yes">
6480	<desc>Guest object.</desc>
6481	</attribute>
6482
6483	<attribute name="keyboard" type="IKeyboard" readonly="yes">
6484	<desc>
6485	Virtual keyboard object.
6486	<note>
6487	If the machine is not running, any attempt to use
6488	the returned object will result in an error.
6489	</note>
6490	</desc>
6491	</attribute>
6492
6493	<attribute name="mouse" type="IMouse" readonly="yes">
6494	<desc>
6495	Virtual mouse object.
6496	<note>
6497	If the machine is not running, any attempt to use
6498	the returned object will result in an error.
6499	</note>
6500	</desc>
6501	</attribute>
6502
6503	<attribute name="display" type="IDisplay" readonly="yes">
6504	<desc>Virtual display object.
6505	<note>
6506	If the machine is not running, any attempt to use
6507	the returned object will result in an error.
6508	</note>
6509	</desc>
6510	</attribute>
6511
6512	<attribute name="debugger" type="IMachineDebugger" readonly="yes">
6513	<desc>Debugging interface.</desc>
6514	</attribute>
6515
6516	<attribute name="USBDevices" type="IUSBDevice" readonly="yes" safearray="yes">
6517	<desc>
6518	Collection of USB devices currently attached to the virtual
6519	USB controller.
6520	<note>
6521	The collection is empty if the machine is not running.
6522	</note>
6523	</desc>
6524	</attribute>
6525
6526	<attribute name="remoteUSBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
6527	<desc>
6528	List of USB devices currently attached to the remote VRDE client.
6529	Once a new device is physically attached to the remote host computer,
6530	it appears in this list and remains there until detached.
6531	</desc>
6532	</attribute>
6533
6534	<attribute name="sharedFolders" type="ISharedFolder" readonly="yes" safearray="yes">
6535	<desc>
6536	Collection of shared folders for the current session. These folders
6537	are called transient shared folders because they are available to the
6538	guest OS running inside the associated virtual machine only for the
6539	duration of the session (as opposed to
6540	<link to="IMachine::sharedFolders"/> which represent permanent shared
6541	folders). When the session is closed (e.g. the machine is powered down),
6542	these folders are automatically discarded.
6543
6544	New shared folders are added to the collection using
6545	<link to="#createSharedFolder"/>. Existing shared folders can be
6546	removed using <link to="#removeSharedFolder"/>.
6547	</desc>
6548	</attribute>
6549
6550	<attribute name="VRDEServerInfo" type="IVRDEServerInfo" readonly="yes">
6551	<desc>
6552	Interface that provides information on Remote Desktop Extension (VRDE) connection.
6553	</desc>
6554	</attribute>
6555
6556	<attribute name="eventSource" type="IEventSource" readonly="yes">
6557	<desc>
6558	Event source for console events.
6559	</desc>
6560	</attribute>
6561
6562	<attribute name="attachedPciDevices" type="IPciDeviceAttachment" readonly="yes" safearray="yes">
6563	<desc>Array of PCI devices attached to this machine.</desc>
6564	</attribute>
6565
6566	<attribute name="useHostClipboard" type="boolean">
6567	<desc>
6568	Whether the guest clipboard should be connected to the host one or
6569	whether it should only be allowed access to the VRDE clipboard. This
6570	setting may not affect existing guest clipboard connections which
6571	are already connected to the host clipboard.
6572	</desc>
6573	</attribute>
6574
6575	<method name="powerUp">
6576	<desc>
6577	Starts the virtual machine execution using the current machine
6578	state (that is, its current execution state, current settings and
6579	current storage devices).
6580
6581	<note>
6582	This method is only useful for front-ends that want to actually
6583	execute virtual machines in their own process (like the VirtualBox
6584	or VBoxSDL front-ends). Unless you are intending to write such a
6585	front-end, do not call this method. If you simply want to
6586	start virtual machine execution using one of the existing front-ends
6587	(for example the VirtualBox GUI or headless server), use
6588	<link to="IMachine::launchVMProcess"/> instead; these
6589	front-ends will power up the machine automatically for you.
6590	</note>
6591
6592	If the machine is powered off or aborted, the execution will
6593	start from the beginning (as if the real hardware were just
6594	powered on).
6595
6596	If the machine is in the <link to="MachineState_Saved"/> state,
6597	it will continue its execution the point where the state has
6598	been saved.
6599
6600	If the machine <link to="IMachine::teleporterEnabled"/> property is
6601	enabled on the machine being powered up, the machine will wait for an
6602	incoming teleportation in the <link to="MachineState_TeleportingIn"/>
6603	state. The returned progress object will have at least three
6604	operations where the last three are defined as: (1) powering up and
6605	starting TCP server, (2) waiting for incoming teleportations, and
6606	(3) perform teleportation. These operations will be reflected as the
6607	last three operations of the progress objected returned by
6608	<link to="IMachine::launchVMProcess"/> as well.
6609
6610	<see><link to="#saveState"/></see>
6611
6612	<result name="VBOX_E_INVALID_VM_STATE">
6613	Virtual machine already running.
6614	</result>
6615	<result name="VBOX_E_HOST_ERROR">
6616	Host interface does not exist or name not set.
6617	</result>
6618	<result name="VBOX_E_FILE_ERROR">
6619	Invalid saved state file.
6620	</result>
6621	</desc>
6622	<param name="progress" type="IProgress" dir="return">
6623	<desc>Progress object to track the operation completion.</desc>
6624	</param>
6625	</method>
6626
6627	<method name="powerUpPaused">
6628	<desc>
6629	Identical to powerUp except that the VM will enter the
6630	<link to="MachineState_Paused"/> state, instead of
6631	<link to="MachineState_Running"/>.
6632
6633	<see><link to="#powerUp"/></see>
6634	<result name="VBOX_E_INVALID_VM_STATE">
6635	Virtual machine already running.
6636	</result>
6637	<result name="VBOX_E_HOST_ERROR">
6638	Host interface does not exist or name not set.
6639	</result>
6640	<result name="VBOX_E_FILE_ERROR">
6641	Invalid saved state file.
6642	</result>
6643	</desc>
6644	<param name="progress" type="IProgress" dir="return">
6645	<desc>Progress object to track the operation completion.</desc>
6646	</param>
6647	</method>
6648
6649	<method name="powerDown">
6650	<desc>
6651	Initiates the power down procedure to stop the virtual machine
6652	execution.
6653
6654	The completion of the power down procedure is tracked using the returned
6655	IProgress object. After the operation is complete, the machine will go
6656	to the PoweredOff state.
6657	<result name="VBOX_E_INVALID_VM_STATE">
6658	Virtual machine must be Running, Paused or Stuck to be powered down.
6659	</result>
6660	</desc>
6661	<param name="progress" type="IProgress" dir="return">
6662	<desc>Progress object to track the operation completion.</desc>
6663	</param>
6664	</method>
6665
6666	<method name="reset">
6667	<desc>Resets the virtual machine.
6668	<result name="VBOX_E_INVALID_VM_STATE">
6669	Virtual machine not in Running state.
6670	</result>
6671	<result name="VBOX_E_VM_ERROR">
6672	Virtual machine error in reset operation.
6673	</result>
6674	</desc>
6675	</method>
6676
6677	<method name="pause">
6678	<desc>Pauses the virtual machine execution.
6679	<result name="VBOX_E_INVALID_VM_STATE">
6680	Virtual machine not in Running state.
6681	</result>
6682	<result name="VBOX_E_VM_ERROR">
6683	Virtual machine error in suspend operation.
6684	</result>
6685	</desc>
6686	</method>
6687
6688	<method name="resume">
6689	<desc>Resumes the virtual machine execution.
6690	<result name="VBOX_E_INVALID_VM_STATE">
6691	Virtual machine not in Paused state.
6692	</result>
6693	<result name="VBOX_E_VM_ERROR">
6694	Virtual machine error in resume operation.
6695	</result>
6696	</desc>
6697	</method>
6698
6699	<method name="powerButton">
6700	<desc>Sends the ACPI power button event to the guest.
6701	<result name="VBOX_E_INVALID_VM_STATE">
6702	Virtual machine not in Running state.
6703	</result>
6704	<result name="VBOX_E_PDM_ERROR">
6705	Controlled power off failed.
6706	</result>
6707	</desc>
6708	</method>
6709
6710	<method name="sleepButton">
6711	<desc>Sends the ACPI sleep button event to the guest.
6712	<result name="VBOX_E_INVALID_VM_STATE">
6713	Virtual machine not in Running state.
6714	</result>
6715	<result name="VBOX_E_PDM_ERROR">
6716	Sending sleep button event failed.
6717	</result>
6718	</desc>
6719	</method>
6720
6721	<method name="getPowerButtonHandled">
6722	<desc>Checks if the last power button event was handled by guest.
6723	<result name="VBOX_E_PDM_ERROR">
6724	Checking if the event was handled by the guest OS failed.
6725	</result>
6726	</desc>
6727	<param name="handled" type="boolean" dir="return"/>
6728	</method>
6729
6730	<method name="getGuestEnteredACPIMode">
6731	<desc>Checks if the guest entered the ACPI mode G0 (working) or
6732	G1 (sleeping). If this method returns @c false, the guest will
6733	most likely not respond to external ACPI events.
6734	<result name="VBOX_E_INVALID_VM_STATE">
6735	Virtual machine not in Running state.
6736	</result>
6737	</desc>
6738	<param name="entered" type="boolean" dir="return"/>
6739	</method>
6740
6741	<method name="saveState">
6742	<desc>
6743	Saves the current execution state of a running virtual machine
6744	and stops its execution.
6745
6746	After this operation completes, the machine will go to the
6747	Saved state. Next time it is powered up, this state will
6748	be restored and the machine will continue its execution from
6749	the place where it was saved.
6750
6751	This operation differs from taking a snapshot to the effect
6752	that it doesn't create new differencing media. Also, once
6753	the machine is powered up from the state saved using this method,
6754	the saved state is deleted, so it will be impossible to return
6755	to this state later.
6756
6757	<note>
6758	On success, this method implicitly calls
6759	<link to="IMachine::saveSettings"/> to save all current machine
6760	settings (including runtime changes to the DVD medium, etc.).
6761	Together with the impossibility to change any VM settings when it is
6762	in the Saved state, this guarantees adequate hardware
6763	configuration of the machine when it is restored from the saved
6764	state file.
6765	</note>
6766
6767	<note>
6768	The machine must be in the Running or Paused state, otherwise
6769	the operation will fail.
6770	</note>
6771	<result name="VBOX_E_INVALID_VM_STATE">
6772	Virtual machine state neither Running nor Paused.
6773	</result>
6774	<result name="VBOX_E_FILE_ERROR">
6775	Failed to create directory for saved state file.
6776	</result>
6777
6778	<see><link to="#takeSnapshot"/></see>
6779	</desc>
6780	<param name="progress" type="IProgress" dir="return">
6781	<desc>Progress object to track the operation completion.</desc>
6782	</param>
6783	</method>
6784
6785	<method name="adoptSavedState">
6786	<desc>
6787	Associates the given saved state file to the virtual machine.
6788
6789	On success, the machine will go to the Saved state. Next time it is
6790	powered up, it will be restored from the adopted saved state and
6791	continue execution from the place where the saved state file was
6792	created.
6793
6794	The specified saved state file path may be absolute or relative to the
6795	folder the VM normally saves the state to (usually,
6796	<link to="IMachine::snapshotFolder"/>).
6797
6798	<note>
6799	It's a caller's responsibility to make sure the given saved state
6800	file is compatible with the settings of this virtual machine that
6801	represent its virtual hardware (memory size, storage disk configuration
6802	etc.). If there is a mismatch, the behavior of the virtual machine
6803	is undefined.
6804	</note>
6805	<result name="VBOX_E_INVALID_VM_STATE">
6806	Virtual machine state neither PoweredOff nor Aborted.
6807	</result>
6808	</desc>
6809	<param name="savedStateFile" type="wstring" dir="in">
6810	<desc>Path to the saved state file to adopt.</desc>
6811	</param>
6812	</method>
6813
6814	<method name="discardSavedState">
6815	<desc>
6816	Forcibly resets the machine to "Powered Off" state if it is
6817	currently in the "Saved" state (previously created by <link to="#saveState"/>).
6818	Next time the machine is powered up, a clean boot will occur.
6819	<note>
6820	This operation is equivalent to resetting or powering off
6821	the machine without doing a proper shutdown of the guest
6822	operating system; as with resetting a running phyiscal
6823	computer, it can can lead to data loss.
6824	</note>
6825	If @a fRemoveFile is @c true, the file in the machine directory
6826	into which the machine state was saved is also deleted. If
6827	this is @c false, then the state can be recovered and later
6828	re-inserted into a machine using <link to="#adoptSavedState" />.
6829	The location of the file can be found in the
6830	<link to="IMachine::stateFilePath" /> attribute.
6831	<result name="VBOX_E_INVALID_VM_STATE">
6832	Virtual machine not in state Saved.
6833	</result>
6834	</desc>
6835	<param name="fRemoveFile" type="boolean" dir="in" >
6836	<desc>Whether to also remove the saved state file.</desc>
6837	</param>
6838	</method>
6839
6840	<method name="getDeviceActivity">
6841	<desc>
6842	Gets the current activity type of a given device or device group.
6843	<result name="E_INVALIDARG">
6844	Invalid device type.
6845	</result>
6846	</desc>
6847	<param name="type" type="DeviceType" dir="in"/>
6848	<param name="activity" type="DeviceActivity" dir="return"/>
6849	</method>
6850
6851	<method name="attachUSBDevice">
6852	<desc>
6853	Attaches a host USB device with the given UUID to the
6854	USB controller of the virtual machine.
6855
6856	The device needs to be in one of the following states:
6857	<link to="USBDeviceState_Busy"/>,
6858	<link to="USBDeviceState_Available"/> or
6859	<link to="USBDeviceState_Held"/>,
6860	otherwise an error is immediately returned.
6861
6862	When the device state is
6863	<link to="USBDeviceState_Busy">Busy</link>, an error may also
6864	be returned if the host computer refuses to release it for some reason.
6865
6866	<see><link to="IUSBController::deviceFilters"/>,
6867	<link to="USBDeviceState"/></see>
6868	<result name="VBOX_E_INVALID_VM_STATE">
6869	Virtual machine state neither Running nor Paused.
6870	</result>
6871	<result name="VBOX_E_PDM_ERROR">
6872	Virtual machine does not have a USB controller.
6873	</result>
6874	</desc>
6875	<param name="id" type="uuid" mod="string" dir="in">
6876	<desc>UUID of the host USB device to attach.</desc>
6877	</param>
6878	</method>
6879
6880	<method name="detachUSBDevice">
6881	<desc>
6882	Detaches an USB device with the given UUID from the USB controller
6883	of the virtual machine.
6884
6885	After this method succeeds, the VirtualBox server re-initiates
6886	all USB filters as if the device were just physically attached
6887	to the host, but filters of this machine are ignored to avoid
6888	a possible automatic re-attachment.
6889
6890	<see><link to="IUSBController::deviceFilters"/>,
6891	<link to="USBDeviceState"/></see>
6892
6893	<result name="VBOX_E_PDM_ERROR">
6894	Virtual machine does not have a USB controller.
6895	</result>
6896	<result name="E_INVALIDARG">
6897	USB device not attached to this virtual machine.
6898	</result>
6899	</desc>
6900	<param name="id" type="uuid" mod="string" dir="in">
6901	<desc>UUID of the USB device to detach.</desc>
6902	</param>
6903	<param name="device" type="IUSBDevice" dir="return">
6904	<desc>Detached USB device.</desc>
6905	</param>
6906	</method>
6907
6908	<method name="findUSBDeviceByAddress">
6909	<desc>
6910	Searches for a USB device with the given host address.
6911
6912	<result name="VBOX_E_OBJECT_NOT_FOUND">
6913	Given @c name does not correspond to any USB device.
6914	</result>
6915
6916	<see><link to="IUSBDevice::address"/></see>
6917	</desc>
6918	<param name="name" type="wstring" dir="in">
6919	<desc>
6920	Address of the USB device (as assigned by the host) to
6921	search for.
6922	</desc>
6923	</param>
6924	<param name="device" type="IUSBDevice" dir="return">
6925	<desc>Found USB device object.</desc>
6926	</param>
6927	</method>
6928
6929	<method name="findUSBDeviceById">
6930	<desc>
6931	Searches for a USB device with the given UUID.
6932
6933	<result name="VBOX_E_OBJECT_NOT_FOUND">
6934	Given @c id does not correspond to any USB device.
6935	</result>
6936
6937	<see><link to="IUSBDevice::id"/></see>
6938	</desc>
6939	<param name="id" type="uuid" mod="string" dir="in">
6940	<desc>UUID of the USB device to search for.</desc>
6941	</param>
6942	<param name="device" type="IUSBDevice" dir="return">
6943	<desc>Found USB device object.</desc>
6944	</param>
6945	</method>
6946
6947	<method name="createSharedFolder">
6948	<desc>
6949	Creates a transient new shared folder by associating the given logical
6950	name with the given host path, adds it to the collection of shared
6951	folders and starts sharing it. Refer to the description of
6952	<link to="ISharedFolder"/> to read more about logical names.
6953
6954	<result name="VBOX_E_INVALID_VM_STATE">
6955	Virtual machine in Saved state or currently changing state.
6956	</result>
6957	<result name="VBOX_E_FILE_ERROR">
6958	Shared folder already exists or not accessible.
6959	</result>
6960	</desc>
6961	<param name="name" type="wstring" dir="in">
6962	<desc>Unique logical name of the shared folder.</desc>
6963	</param>
6964	<param name="hostPath" type="wstring" dir="in">
6965	<desc>Full path to the shared folder in the host file system.</desc>
6966	</param>
6967	<param name="writable" type="boolean" dir="in">
6968	<desc>Whether the share is writable or readonly</desc>
6969	</param>
6970	<param name="automount" type="boolean" dir="in">
6971	<desc>Whether the share gets automatically mounted by the guest
6972	or not.</desc>
6973	</param>
6974	</method>
6975
6976	<method name="removeSharedFolder">
6977	<desc>
6978	Removes a transient shared folder with the given name previously
6979	created by <link to="#createSharedFolder"/> from the collection of
6980	shared folders and stops sharing it.
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 does not exists.
6986	</result>
6987	</desc>
6988	<param name="name" type="wstring" dir="in">
6989	<desc>Logical name of the shared folder to remove.</desc>
6990	</param>
6991	</method>
6992
6993	<method name="takeSnapshot">
6994	<desc>
6995	Saves the current execution state
6996	and all settings of the machine and creates differencing images
6997	for all normal (non-independent) media.
6998	See <link to="ISnapshot" /> for an introduction to snapshots.
6999
7000	This method can be called for a PoweredOff, Saved (see
7001	<link to="#saveState"/>), Running or
7002	Paused virtual machine. When the machine is PoweredOff, an
7003	offline snapshot is created. When the machine is Running a live
7004	snapshot is created, and an online snapshot is is created when Paused.
7005
7006	The taken snapshot is always based on the
7007	<link to="IMachine::currentSnapshot">current snapshot</link>
7008	of the associated virtual machine and becomes a new current snapshot.
7009
7010	<note>
7011	This method implicitly calls <link to="IMachine::saveSettings"/> to
7012	save all current machine settings before taking an offline snapshot.
7013	</note>
7014
7015	<result name="VBOX_E_INVALID_VM_STATE">
7016	Virtual machine currently changing state.
7017	</result>
7018	</desc>
7019	<param name="name" type="wstring" dir="in">
7020	<desc>Short name for the snapshot.</desc>
7021	</param>
7022	<param name="description" type="wstring" dir="in">
7023	<desc>Optional description of the snapshot.</desc>
7024	</param>
7025	<param name="progress" type="IProgress" dir="return">
7026	<desc>Progress object to track the operation completion.</desc>
7027	</param>
7028	</method>
7029
7030	<method name="deleteSnapshot">
7031	<desc>
7032	Starts deleting the specified snapshot asynchronously.
7033	See <link to="ISnapshot" /> for an introduction to snapshots.
7034
7035	The execution state and settings of the associated machine stored in
7036	the snapshot will be deleted. The contents of all differencing media of
7037	this snapshot will be merged with the contents of their dependent child
7038	media to keep the medium chain valid (in other words, all changes
7039	represented by media being deleted will be propagated to their child
7040	medium). After that, this snapshot's differencing medium will be
7041	deleted. The parent of this snapshot will become a new parent for all
7042	its child snapshots.
7043
7044	If the deleted snapshot is the current one, its parent snapshot will
7045	become a new current snapshot. The current machine state is not directly
7046	affected in this case, except that currently attached differencing
7047	media based on media of the deleted snapshot will be also merged as
7048	described above.
7049
7050	If the deleted snapshot is the first or current snapshot, then the
7051	respective IMachine attributes will be adjusted. Deleting the current
7052	snapshot will also implicitly call <link to="IMachine::saveSettings"/>
7053	to make all current machine settings permanent.
7054
7055	Deleting a snapshot has the following preconditions:
7056
7057	<ul>
7058	<li>Child media of all normal media of the deleted snapshot
7059	must be accessible (see <link to="IMedium::state"/>) for this
7060	operation to succeed. If only one running VM refers to all images
7061	which participates in merging the operation can be performed while
7062	the VM is running. Otherwise all virtual machines whose media are
7063	directly or indirectly based on the media of deleted snapshot must
7064	be powered off. In any case, online snapshot deleting usually is
7065	slower than the same operation without any running VM.</li>
7066
7067	<li>You cannot delete the snapshot if a medium attached to it has
7068	more than one child medium (differencing images) because otherwise
7069	merging would be impossible. This might be the case if there is
7070	more than one child snapshot or differencing images were created
7071	for other reason (e.g. implicitly because of multiple machine
7072	attachments).</li>
7073	</ul>
7074
7075	The virtual machine's <link to="IMachine::state">state</link> is
7076	changed to "DeletingSnapshot", "DeletingSnapshotOnline" or
7077	"DeletingSnapshotPaused" while this operation is in progress.
7078
7079	<note>
7080	Merging medium contents can be very time and disk space
7081	consuming, if these media are big in size and have many
7082	children. However, if the snapshot being deleted is the last
7083	(head) snapshot on the branch, the operation will be rather
7084	quick.
7085	</note>
7086	<result name="VBOX_E_INVALID_VM_STATE">
7087	The running virtual machine prevents deleting this snapshot. This
7088	happens only in very specific situations, usually snapshots can be
7089	deleted without trouble while a VM is running. The error message
7090	text explains the reason for the failure.
7091	</result>
7092	</desc>
7093	<param name="id" type="uuid" mod="string" dir="in">
7094	<desc>UUID of the snapshot to delete.</desc>
7095	</param>
7096	<param name="progress" type="IProgress" dir="return">
7097	<desc>Progress object to track the operation completion.</desc>
7098	</param>
7099	</method>
7100
7101	<method name="deleteSnapshotAndAllChildren">
7102	<desc>
7103	Starts deleting the specified snapshot and all its children
7104	asynchronously. See <link to="ISnapshot" /> for an introduction to
7105	snapshots. The conditions and many details are the same as with
7106	<link to="#deleteSnapshot"/>.
7107
7108	This operation is very fast if the snapshot subtree does not include
7109	the current state. It is still significantly faster than deleting the
7110	snapshots one by one if the current state is in the subtree and there
7111	are more than one snapshots from current state to the snapshot which
7112	marks the subtree, since it eliminates the incremental image merging.
7113
7114	<note>This API method is right now not implemented!</note>
7115
7116	<result name="VBOX_E_INVALID_VM_STATE">
7117	The running virtual machine prevents deleting this snapshot. This
7118	happens only in very specific situations, usually snapshots can be
7119	deleted without trouble while a VM is running. The error message
7120	text explains the reason for the failure.
7121	</result>
7122	<result name="E_NOTIMPL">
7123	The method is not implemented yet.
7124	</result>
7125	</desc>
7126	<param name="id" type="uuid" mod="string" dir="in">
7127	<desc>UUID of the snapshot to delete, including all its children.</desc>
7128	</param>
7129	<param name="progress" type="IProgress" dir="return">
7130	<desc>Progress object to track the operation completion.</desc>
7131	</param>
7132	</method>
7133
7134	<method name="deleteSnapshotRange">
7135	<desc>
7136	Starts deleting the specified snapshot range. This is limited to
7137	linear snapshot lists, which means there may not be any other child
7138	snapshots other than the direct sequence between the start and end
7139	snapshot. If the start and end snapshot point to the same snapshot this
7140	method is completely equivalent to <link to="#deleteSnapshot"/>. See
7141	<link to="ISnapshot" /> for an introduction to snapshots. The
7142	conditions and many details are the same as with
7143	<link to="#deleteSnapshot"/>.
7144
7145	This operation is generally faster than deleting snapshots one by one
7146	and often also needs less extra disk space before freeing up disk space
7147	by deleting the removed disk images corresponding to the snapshot.
7148
7149	<note>This API method is right now not implemented!</note>
7150
7151	<result name="VBOX_E_INVALID_VM_STATE">
7152	The running virtual machine prevents deleting this snapshot. This
7153	happens only in very specific situations, usually snapshots can be
7154	deleted without trouble while a VM is running. The error message
7155	text explains the reason for the failure.
7156	</result>
7157	<result name="E_NOTIMPL">
7158	The method is not implemented yet.
7159	</result>
7160	</desc>
7161	<param name="startId" type="uuid" mod="string" dir="in">
7162	<desc>UUID of the first snapshot to delete.</desc>
7163	</param>
7164	<param name="endId" type="uuid" mod="string" dir="in">
7165	<desc>UUID of the last snapshot to delete.</desc>
7166	</param>
7167	<param name="progress" type="IProgress" dir="return">
7168	<desc>Progress object to track the operation completion.</desc>
7169	</param>
7170	</method>
7171
7172	<method name="restoreSnapshot">
7173	<desc>
7174	Starts resetting the machine's current state to the state contained
7175	in the given snapshot, asynchronously. All current settings of the
7176	machine will be reset and changes stored in differencing media
7177	will be lost.
7178	See <link to="ISnapshot" /> for an introduction to snapshots.
7179
7180	After this operation is successfully completed, new empty differencing
7181	media are created for all normal media of the machine.
7182
7183	If the given snapshot is an online snapshot, the machine will go to
7184	the <link to="MachineState_Saved"> saved state</link>, so that the
7185	next time it is powered on, the execution state will be restored
7186	from the state of the snapshot.
7187
7188	<note>
7189	The machine must not be running, otherwise the operation will fail.
7190	</note>
7191
7192	<note>
7193	If the machine state is <link to="MachineState_Saved">Saved</link>
7194	prior to this operation, the saved state file will be implicitly
7195	deleted (as if <link to="IConsole::discardSavedState"/> were
7196	called).
7197	</note>
7198
7199	<result name="VBOX_E_INVALID_VM_STATE">
7200	Virtual machine is running.
7201	</result>
7202	</desc>
7203	<param name="snapshot" type="ISnapshot" dir="in">
7204	<desc>The snapshot to restore the VM state from.</desc>
7205	</param>
7206	<param name="progress" type="IProgress" dir="return">
7207	<desc>Progress object to track the operation completion.</desc>
7208	</param>
7209	</method>
7210
7211	<method name="teleport">
7212	<desc>
7213	Teleport the VM to a different host machine or process.
7214
7215	TODO explain the details.
7216
7217	<result name="VBOX_E_INVALID_VM_STATE">
7218	Virtual machine not running or paused.
7219	</result>
7220	</desc>
7221	<param name="hostname" type="wstring" dir="in">
7222	<desc>The name or IP of the host to teleport to.</desc>
7223	</param>
7224	<param name="tcpport" type="unsigned long" dir="in">
7225	<desc>The TCP port to connect to (1..65535).</desc>
7226	</param>
7227	<param name="password" type="wstring" dir="in">
7228	<desc>The password.</desc>
7229	</param>
7230	<param name="maxDowntime" type="unsigned long" dir="in">
7231	<desc>
7232	The maximum allowed downtime given as milliseconds. 0 is not a valid
7233	value. Recommended value: 250 ms.
7234
7235	The higher the value is, the greater the chance for a successful
7236	teleportation. A small value may easily result in the teleportation
7237	process taking hours and eventually fail.
7238
7239	<note>
7240	The current implementation treats this a guideline, not as an
7241	absolute rule.
7242	</note>
7243	</desc>
7244	</param>
7245	<param name="progress" type="IProgress" dir="return">
7246	<desc>Progress object to track the operation completion.</desc>
7247	</param>
7248	</method>
7249
7250	</interface>
7251
7252	<!--
7253	// IHost
7254	/////////////////////////////////////////////////////////////////////////
7255	-->
7256
7257	<enum
7258	name="HostNetworkInterfaceMediumType"
7259	uuid="1aa54aaf-2497-45a2-bfb1-8eb225e93d5b"
7260	>
7261	<desc>
7262	Type of encapsulation. Ethernet encapsulation includes both wired and
7263	wireless Ethernet connections.
7264	<see><link to="IHostNetworkInterface"/></see>
7265	</desc>
7266
7267	<const name="Unknown" value="0">
7268	<desc>
7269	The type of interface cannot be determined.
7270	</desc>
7271	</const>
7272	<const name="Ethernet" value="1">
7273	<desc>
7274	Ethernet frame encapsulation.
7275	</desc>
7276	</const>
7277	<const name="PPP" value="2">
7278	<desc>
7279	Point-to-point protocol encapsulation.
7280	</desc>
7281	</const>
7282	<const name="SLIP" value="3">
7283	<desc>
7284	Serial line IP encapsulation.
7285	</desc>
7286	</const>
7287	</enum>
7288
7289	<enum
7290	name="HostNetworkInterfaceStatus"
7291	uuid="CC474A69-2710-434B-8D99-C38E5D5A6F41"
7292	>
7293	<desc>
7294	Current status of the interface.
7295	<see><link to="IHostNetworkInterface"/></see>
7296	</desc>
7297
7298	<const name="Unknown" value="0">
7299	<desc>
7300	The state of interface cannot be determined.
7301	</desc>
7302	</const>
7303	<const name="Up" value="1">
7304	<desc>
7305	The interface is fully operational.
7306	</desc>
7307	</const>
7308	<const name="Down" value="2">
7309	<desc>
7310	The interface is not functioning.
7311	</desc>
7312	</const>
7313	</enum>
7314
7315	<enum
7316	name="HostNetworkInterfaceType"
7317	uuid="67431b00-9946-48a2-bc02-b25c5919f4f3"
7318	>
7319	<desc>
7320	Network interface type.
7321	</desc>
7322	<const name="Bridged" value="1"/>
7323	<const name="HostOnly" value="2"/>
7324	</enum>
7325
7326	<interface
7327	name="IHostNetworkInterface" extends="$unknown"
7328	uuid="ce6fae58-7642-4102-b5db-c9005c2320a8"
7329	wsmap="managed"
7330	>
7331	<desc>
7332	Represents one of host's network interfaces. IP V6 address and network
7333	mask are strings of 32 hexdecimal digits grouped by four. Groups are
7334	separated by colons.
7335	For example, fe80:0000:0000:0000:021e:c2ff:fed2:b030.
7336	</desc>
7337	<attribute name="name" type="wstring" readonly="yes">
7338	<desc>Returns the host network interface name.</desc>
7339	</attribute>
7340
7341	<attribute name="id" type="uuid" mod="string" readonly="yes">
7342	<desc>Returns the interface UUID.</desc>
7343	</attribute>
7344
7345	<attribute name="networkName" type="wstring" readonly="yes">
7346	<desc>Returns the name of a virtual network the interface gets attached to.</desc>
7347	</attribute>
7348
7349	<attribute name="dhcpEnabled" type="boolean" readonly="yes">
7350	<desc>Specifies whether the DHCP is enabled for the interface.</desc>
7351	</attribute>
7352
7353	<attribute name="IPAddress" type="wstring" readonly="yes">
7354	<desc>Returns the IP V4 address of the interface.</desc>
7355	</attribute>
7356
7357	<attribute name="networkMask" type="wstring" readonly="yes">
7358	<desc>Returns the network mask of the interface.</desc>
7359	</attribute>
7360
7361	<attribute name="IPV6Supported" type="boolean" readonly="yes">
7362	<desc>Specifies whether the IP V6 is supported/enabled for the interface.</desc>
7363	</attribute>
7364
7365	<attribute name="IPV6Address" type="wstring" readonly="yes">
7366	<desc>Returns the IP V6 address of the interface.</desc>
7367	</attribute>
7368
7369	<attribute name="IPV6NetworkMaskPrefixLength" type="unsigned long" readonly="yes">
7370	<desc>Returns the length IP V6 network mask prefix of the interface.</desc>
7371	</attribute>
7372
7373	<attribute name="hardwareAddress" type="wstring" readonly="yes">
7374	<desc>Returns the hardware address. For Ethernet it is MAC address.</desc>
7375	</attribute>
7376
7377	<attribute name="mediumType" type="HostNetworkInterfaceMediumType" readonly="yes">
7378	<desc>Type of protocol encapsulation used.</desc>
7379	</attribute>
7380
7381	<attribute name="status" type="HostNetworkInterfaceStatus" readonly="yes">
7382	<desc>Status of the interface.</desc>
7383	</attribute>
7384
7385	<attribute name="interfaceType" type="HostNetworkInterfaceType" readonly="yes">
7386	<desc>specifies the host interface type.</desc>
7387	</attribute>
7388
7389	<method name="enableStaticIpConfig">
7390	<desc>sets and enables the static IP V4 configuration for the given interface.</desc>
7391	<param name="IPAddress" type="wstring" dir="in">
7392	<desc>
7393	IP address.
7394	</desc>
7395	</param>
7396	<param name="networkMask" type="wstring" dir="in">
7397	<desc>
7398	network mask.
7399	</desc>
7400	</param>
7401	</method>
7402
7403	<method name="enableStaticIpConfigV6">
7404	<desc>sets and enables the static IP V6 configuration for the given interface.</desc>
7405	<param name="IPV6Address" type="wstring" dir="in">
7406	<desc>
7407	IP address.
7408	</desc>
7409	</param>
7410	<param name="IPV6NetworkMaskPrefixLength" type="unsigned long" dir="in">
7411	<desc>
7412	network mask.
7413	</desc>
7414	</param>
7415	</method>
7416
7417	<method name="enableDynamicIpConfig">
7418	<desc>enables the dynamic IP configuration.</desc>
7419	</method>
7420
7421	<method name="dhcpRediscover">
7422	<desc>refreshes the IP configuration for dhcp-enabled interface.</desc>
7423	</method>
7424
7425	</interface>
7426
7427	<interface
7428	name="IHost" extends="$unknown"
7429	uuid="dab4a2b8-c735-4f08-94fc-9bec84182e2f"
7430	wsmap="managed"
7431	>
7432	<desc>
7433	The IHost interface represents the physical machine that this VirtualBox
7434	installation runs on.
7435
7436	An object implementing this interface is returned by the
7437	<link to="IVirtualBox::host" /> attribute. This interface contains
7438	read-only information about the host's physical hardware (such as what
7439	processors and disks are available, what the host operating system is,
7440	and so on) and also allows for manipulating some of the host's hardware,
7441	such as global USB device filters and host interface networking.
7442
7443	</desc>
7444	<attribute name="DVDDrives" type="IMedium" readonly="yes" safearray="yes">
7445	<desc>List of DVD drives available on the host.</desc>
7446	</attribute>
7447
7448	<attribute name="floppyDrives" type="IMedium" readonly="yes" safearray="yes">
7449	<desc>List of floppy drives available on the host.</desc>
7450	</attribute>
7451
7452	<attribute name="USBDevices" type="IHostUSBDevice" readonly="yes" safearray="yes">
7453	<desc>
7454	List of USB devices currently attached to the host.
7455	Once a new device is physically attached to the host computer,
7456	it appears in this list and remains there until detached.
7457
7458	<note>
7459	If USB functionality is not available in the given edition of
7460	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7461	</note>
7462	</desc>
7463	</attribute>
7464
7465	<attribute name="USBDeviceFilters" type="IHostUSBDeviceFilter" readonly="yes" safearray="yes">
7466	<desc>
7467	List of USB device filters in action.
7468	When a new device is physically attached to the host computer,
7469	filters from this list are applied to it (in order they are stored
7470	in the list). The first matched filter will determine the
7471	<link to="IHostUSBDeviceFilter::action">action</link>
7472	performed on the device.
7473
7474	Unless the device is ignored by these filters, filters of all
7475	currently running virtual machines
7476	(<link to="IUSBController::deviceFilters"/>) are applied to it.
7477
7478	<note>
7479	If USB functionality is not available in the given edition of
7480	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7481	</note>
7482
7483	<see><link to="IHostUSBDeviceFilter"/>,
7484	<link to="USBDeviceState"/></see>
7485	</desc>
7486	</attribute>
7487
7488	<attribute name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" readonly="yes">
7489	<desc>List of host network interfaces currently defined on the host.</desc>
7490	</attribute>
7491
7492	<attribute name="processorCount" type="unsigned long" readonly="yes">
7493	<desc>Number of (logical) CPUs installed in the host system.</desc>
7494	</attribute>
7495
7496	<attribute name="processorOnlineCount" type="unsigned long" readonly="yes">
7497	<desc>Number of (logical) CPUs online in the host system.</desc>
7498	</attribute>
7499
7500	<attribute name="processorCoreCount" type="unsigned long" readonly="yes">
7501	<desc>Number of physical processor cores installed in the host system.</desc>
7502	</attribute>
7503
7504	<method name="getProcessorSpeed">
7505	<desc>Query the (approximate) maximum speed of a specified host CPU in
7506	Megahertz.
7507	</desc>
7508	<param name="cpuId" type="unsigned long" dir="in">
7509	<desc>
7510	Identifier of the CPU.
7511	</desc>
7512	</param>
7513	<param name="speed" type="unsigned long" dir="return">
7514	<desc>
7515	Speed value. 0 is returned if value is not known or @a cpuId is
7516	invalid.
7517	</desc>
7518	</param>
7519	</method>
7520
7521	<method name="getProcessorFeature">
7522	<desc>Query whether a CPU feature is supported or not.</desc>
7523	<param name="feature" type="ProcessorFeature" dir="in">
7524	<desc>
7525	CPU Feature identifier.
7526	</desc>
7527	</param>
7528	<param name="supported" type="boolean" dir="return">
7529	<desc>
7530	Feature is supported or not.
7531	</desc>
7532	</param>
7533	</method>
7534
7535	<method name="getProcessorDescription">
7536	<desc>Query the model string of a specified host CPU.
7537	</desc>
7538	<param name="cpuId" type="unsigned long" dir="in">
7539	<desc>
7540	Identifier of the CPU.
7541	<note>
7542	The current implementation might not necessarily return the
7543	description for this exact CPU.
7544	</note>
7545	</desc>
7546	</param>
7547	<param name="description" type="wstring" dir="return">
7548	<desc>
7549	Model string. An empty string is returned if value is not known or
7550	@a cpuId is invalid.
7551	</desc>
7552	</param>
7553	</method>
7554
7555	<method name="getProcessorCPUIDLeaf">
7556	<desc>
7557	Returns the CPU cpuid information for the specified leaf.
7558	</desc>
7559	<param name="cpuId" type="unsigned long" dir="in">
7560	<desc>
7561	Identifier of the CPU. The CPU most be online.
7562	<note>
7563	The current implementation might not necessarily return the
7564	description for this exact CPU.
7565	</note>
7566	</desc>
7567	</param>
7568	<param name="leaf" type="unsigned long" dir="in">
7569	<desc>
7570	CPUID leaf index (eax).
7571	</desc>
7572	</param>
7573	<param name="subLeaf" type="unsigned long" dir="in">
7574	<desc>
7575	CPUID leaf sub index (ecx). This currently only applies to cache
7576	information on Intel CPUs. Use 0 if retrieving values for
7577	<link to="IMachine::setCPUIDLeaf"/>.
7578	</desc>
7579	</param>
7580	<param name="valEax" type="unsigned long" dir="out">
7581	<desc>
7582	CPUID leaf value for register eax.
7583	</desc>
7584	</param>
7585	<param name="valEbx" type="unsigned long" dir="out">
7586	<desc>
7587	CPUID leaf value for register ebx.
7588	</desc>
7589	</param>
7590	<param name="valEcx" type="unsigned long" dir="out">
7591	<desc>
7592	CPUID leaf value for register ecx.
7593	</desc>
7594	</param>
7595	<param name="valEdx" type="unsigned long" dir="out">
7596	<desc>
7597	CPUID leaf value for register edx.
7598	</desc>
7599	</param>
7600	</method>
7601
7602	<attribute name="memorySize" type="unsigned long" readonly="yes">
7603	<desc>Amount of system memory in megabytes installed in the host system.</desc>
7604	</attribute>
7605
7606	<attribute name="memoryAvailable" type="unsigned long" readonly="yes">
7607	<desc>Available system memory in the host system.</desc>
7608	</attribute>
7609
7610	<attribute name="operatingSystem" type="wstring" readonly="yes">
7611	<desc>Name of the host system's operating system.</desc>
7612	</attribute>
7613
7614	<attribute name="OSVersion" type="wstring" readonly="yes">
7615	<desc>Host operating system's version string.</desc>
7616	</attribute>
7617
7618	<attribute name="UTCTime" type="long long" readonly="yes">
7619	<desc>Returns the current host time in milliseconds since 1970-01-01 UTC.</desc>
7620	</attribute>
7621
7622	<attribute name="Acceleration3DAvailable" type="boolean" readonly="yes">
7623	<desc>Returns @c true when the host supports 3D hardware acceleration.</desc>
7624	</attribute>
7625
7626	<method name="createHostOnlyNetworkInterface">
7627	<desc>
7628	Creates a new adapter for Host Only Networking.
7629	<result name="E_INVALIDARG">
7630	Host network interface @a name already exists.
7631	</result>
7632	</desc>
7633	<param name="hostInterface" type="IHostNetworkInterface" dir="out">
7634	<desc>
7635	Created host interface object.
7636	</desc>
7637	</param>
7638	<param name="progress" type="IProgress" dir="return">
7639	<desc>
7640	Progress object to track the operation completion.
7641	</desc>
7642	</param>
7643	</method>
7644
7645	<method name="removeHostOnlyNetworkInterface">
7646	<desc>
7647	Removes the given Host Only Networking interface.
7648	<result name="VBOX_E_OBJECT_NOT_FOUND">
7649	No host network interface matching @a id found.
7650	</result>
7651	</desc>
7652	<param name="id" type="uuid" mod="string" dir="in">
7653	<desc>
7654	Adapter GUID.
7655	</desc>
7656	</param>
7657	<param name="progress" type="IProgress" dir="return">
7658	<desc>
7659	Progress object to track the operation completion.
7660	</desc>
7661	</param>
7662	</method>
7663
7664	<method name="createUSBDeviceFilter">
7665	<desc>
7666	Creates a new USB device filter. All attributes except
7667	the filter name are set to empty (any match),
7668	<i>active</i> is @c false (the filter is not active).
7669
7670	The created filter can be added to the list of filters using
7671	<link to="#insertUSBDeviceFilter"/>.
7672
7673	<see><link to="#USBDeviceFilters"/></see>
7674	</desc>
7675	<param name="name" type="wstring" dir="in">
7676	<desc>
7677	Filter name. See <link to="IUSBDeviceFilter::name"/> for more information.
7678	</desc>
7679	</param>
7680	<param name="filter" type="IHostUSBDeviceFilter" dir="return">
7681	<desc>Created filter object.</desc>
7682	</param>
7683	</method>
7684
7685	<method name="insertUSBDeviceFilter">
7686	<desc>
7687	Inserts the given USB device to the specified position
7688	in the list of filters.
7689
7690	Positions are numbered starting from @c 0. If the specified
7691	position is equal to or greater than the number of elements in
7692	the list, the filter is added at the end of the collection.
7693
7694	<note>
7695	Duplicates are not allowed, so an attempt to insert a
7696	filter already in the list is an error.
7697	</note>
7698	<note>
7699	If USB functionality is not available in the given edition of
7700	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7701	</note>
7702
7703	<see><link to="#USBDeviceFilters"/></see>
7704
7705	<result name="VBOX_E_INVALID_OBJECT_STATE">
7706	USB device filter is not created within this VirtualBox instance.
7707	</result>
7708	<result name="E_INVALIDARG">
7709	USB device filter already in list.
7710	</result>
7711
7712	</desc>
7713	<param name="position" type="unsigned long" dir="in">
7714	<desc>Position to insert the filter to.</desc>
7715	</param>
7716	<param name="filter" type="IHostUSBDeviceFilter" dir="in">
7717	<desc>USB device filter to insert.</desc>
7718	</param>
7719	</method>
7720
7721	<method name="removeUSBDeviceFilter">
7722	<desc>
7723	Removes a USB device filter from the specified position in the
7724	list of filters.
7725
7726	Positions are numbered starting from @c 0. Specifying a
7727	position equal to or greater than the number of elements in
7728	the list will produce an error.
7729
7730	<note>
7731	If USB functionality is not available in the given edition of
7732	VirtualBox, this method will set the result code to @c E_NOTIMPL.
7733	</note>
7734
7735	<see><link to="#USBDeviceFilters"/></see>
7736
7737	<result name="E_INVALIDARG">
7738	USB device filter list empty or invalid @a position.
7739	</result>
7740
7741	</desc>
7742	<param name="position" type="unsigned long" dir="in">
7743	<desc>Position to remove the filter from.</desc>
7744	</param>
7745	</method>
7746
7747	<method name="findHostDVDDrive">
7748	<desc>
7749	Searches for a host DVD drive with the given @c name.
7750
7751	<result name="VBOX_E_OBJECT_NOT_FOUND">
7752	Given @c name does not correspond to any host drive.
7753	</result>
7754
7755	</desc>
7756	<param name="name" type="wstring" dir="in">
7757	<desc>Name of the host drive to search for</desc>
7758	</param>
7759	<param name="drive" type="IMedium" dir="return">
7760	<desc>Found host drive object</desc>
7761	</param>
7762	</method>
7763
7764	<method name="findHostFloppyDrive">
7765	<desc>
7766	Searches for a host floppy drive with the given @c name.
7767
7768	<result name="VBOX_E_OBJECT_NOT_FOUND">
7769	Given @c name does not correspond to any host floppy drive.
7770	</result>
7771
7772	</desc>
7773	<param name="name" type="wstring" dir="in">
7774	<desc>Name of the host floppy drive to search for</desc>
7775	</param>
7776	<param name="drive" type="IMedium" dir="return">
7777	<desc>Found host floppy drive object</desc>
7778	</param>
7779	</method>
7780
7781	<method name="findHostNetworkInterfaceByName">
7782	<desc>
7783	Searches through all host network interfaces for an interface with
7784	the given @c name.
7785	<note>
7786	The method returns an error if the given @c name does not
7787	correspond to any host network interface.
7788	</note>
7789	</desc>
7790	<param name="name" type="wstring" dir="in">
7791	<desc>Name of the host network interface to search for.</desc>
7792	</param>
7793	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7794	<desc>Found host network interface object.</desc>
7795	</param>
7796	</method>
7797	<method name="findHostNetworkInterfaceById">
7798	<desc>
7799	Searches through all host network interfaces for an interface with
7800	the given GUID.
7801	<note>
7802	The method returns an error if the given GUID does not
7803	correspond to any host network interface.
7804	</note>
7805	</desc>
7806	<param name="id" type="uuid" mod="string" dir="in">
7807	<desc>GUID of the host network interface to search for.</desc>
7808	</param>
7809	<param name="networkInterface" type="IHostNetworkInterface" dir="return">
7810	<desc>Found host network interface object.</desc>
7811	</param>
7812	</method>
7813	<method name="findHostNetworkInterfacesOfType">
7814	<desc>
7815	Searches through all host network interfaces and returns a list of interfaces of the specified type
7816	</desc>
7817	<param name="type" type="HostNetworkInterfaceType" dir="in">
7818	<desc>type of the host network interfaces to search for.</desc>
7819	</param>
7820	<param name="networkInterfaces" type="IHostNetworkInterface" safearray="yes" dir="return">
7821	<desc>Found host network interface objects.</desc>
7822	</param>
7823	</method>
7824
7825	<method name="findUSBDeviceById">
7826	<desc>
7827	Searches for a USB device with the given UUID.
7828
7829	<result name="VBOX_E_OBJECT_NOT_FOUND">
7830	Given @c id does not correspond to any USB device.
7831	</result>
7832
7833	<see><link to="IUSBDevice::id"/></see>
7834	</desc>
7835	<param name="id" type="uuid" mod="string" dir="in">
7836	<desc>UUID of the USB device to search for.</desc>
7837	</param>
7838	<param name="device" type="IHostUSBDevice" dir="return">
7839	<desc>Found USB device object.</desc>
7840	</param>
7841	</method>
7842
7843	<method name="findUSBDeviceByAddress">
7844	<desc>
7845	Searches for a USB device with the given host address.
7846
7847	<result name="VBOX_E_OBJECT_NOT_FOUND">
7848	Given @c name does not correspond to any USB device.
7849	</result>
7850
7851	<see><link to="IUSBDevice::address"/></see>
7852	</desc>
7853	<param name="name" type="wstring" dir="in">
7854	<desc>
7855	Address of the USB device (as assigned by the host) to
7856	search for.
7857	</desc>
7858	</param>
7859	<param name="device" type="IHostUSBDevice" dir="return">
7860	<desc>Found USB device object.</desc>
7861	</param>
7862	</method>
7863
7864	<method name="generateMACAddress">
7865	<desc>
7866	Generates a valid Ethernet MAC address, 12 hexadecimal characters.
7867	</desc>
7868	<param name="address" type="wstring" dir="return">
7869	<desc>New Ethernet MAC address.</desc>
7870	</param>
7871	</method>
7872
7873	</interface>
7874
7875	<!--
7876	// ISystemProperties
7877	/////////////////////////////////////////////////////////////////////////
7878	-->
7879
7880	<interface
7881	name="ISystemProperties"
7882	extends="$unknown"
7883	uuid="8a0ab9ab-48c1-4d04-954b-4a751413d084"
7884	wsmap="managed"
7885	>
7886	<desc>
7887	The ISystemProperties interface represents global properties of the given
7888	VirtualBox installation.
7889
7890	These properties define limits and default values for various attributes
7891	and parameters. Most of the properties are read-only, but some can be
7892	changed by a user.
7893	</desc>
7894
7895	<attribute name="minGuestRAM" type="unsigned long" readonly="yes">
7896	<desc>Minimum guest system memory in Megabytes.</desc>
7897	</attribute>
7898
7899	<attribute name="maxGuestRAM" type="unsigned long" readonly="yes">
7900	<desc>Maximum guest system memory in Megabytes.</desc>
7901	</attribute>
7902
7903	<attribute name="minGuestVRAM" type="unsigned long" readonly="yes">
7904	<desc>Minimum guest video memory in Megabytes.</desc>
7905	</attribute>
7906
7907	<attribute name="maxGuestVRAM" type="unsigned long" readonly="yes">
7908	<desc>Maximum guest video memory in Megabytes.</desc>
7909	</attribute>
7910
7911	<attribute name="minGuestCPUCount" type="unsigned long" readonly="yes">
7912	<desc>Minimum CPU count.</desc>
7913	</attribute>
7914
7915	<attribute name="maxGuestCPUCount" type="unsigned long" readonly="yes">
7916	<desc>Maximum CPU count.</desc>
7917	</attribute>
7918
7919	<attribute name="maxGuestMonitors" type="unsigned long" readonly="yes">
7920	<desc>Maximum of monitors which could be connected.</desc>
7921	</attribute>
7922
7923	<attribute name="infoVDSize" type="long long" readonly="yes">
7924	<desc>Maximum size of a virtual disk image in bytes. Informational value,
7925	does not reflect the limits of any virtual disk image format.</desc>
7926	</attribute>
7927
7928	<attribute name="serialPortCount" type="unsigned long" readonly="yes">
7929	<desc>
7930	Maximum number of serial ports associated with every
7931	<link to="IMachine"/> instance.
7932	</desc>
7933	</attribute>
7934
7935	<attribute name="parallelPortCount" type="unsigned long" readonly="yes">
7936	<desc>
7937	Maximum number of parallel ports associated with every
7938	<link to="IMachine"/> instance.
7939	</desc>
7940	</attribute>
7941
7942	<attribute name="maxBootPosition" type="unsigned long" readonly="yes">
7943	<desc>
7944	Maximum device position in the boot order. This value corresponds
7945	to the total number of devices a machine can boot from, to make it
7946	possible to include all possible devices to the boot list.
7947	<see><link to="IMachine::setBootOrder"/></see>
7948	</desc>
7949	</attribute>
7950
7951	<attribute name="defaultMachineFolder" type="wstring">
7952	<desc>
7953	Full path to the default directory used to create new or open
7954	existing machines when a machine settings file name contains no
7955	path.
7956
7957	Starting with VirtualBox 4.0, by default, this attribute contains
7958	the full path of folder named "VirtualBox VMs" in the user's
7959	home directory, which depends on the host platform.
7960
7961	When setting this attribute, a full path must be specified.
7962	Setting this property to @c null or an empty string or the
7963	special value "Machines" (for compatibility reasons) will restore
7964	that default value.
7965
7966	If the folder specified herein does not exist, it will be created
7967	automatically as needed.
7968
7969	<see>
7970	<link to="IVirtualBox::createMachine"/>,
7971	<link to="IVirtualBox::openMachine"/>
7972	</see>
7973	</desc>
7974	</attribute>
7975
7976	<attribute name="mediumFormats" type="IMediumFormat" safearray="yes" readonly="yes">
7977	<desc>
7978	List of all medium storage formats supported by this VirtualBox
7979	installation.
7980
7981	Keep in mind that the medium format identifier
7982	(<link to="IMediumFormat::id"/>) used in other API calls like
7983	<link to="IVirtualBox::createHardDisk"/> to refer to a particular
7984	medium format is a case-insensitive string. This means that, for
7985	example, all of the following strings:
7986	<pre>
7987	"VDI"
7988	"vdi"
7989	"VdI"</pre>
7990	refer to the same medium format.
7991
7992	Note that the virtual medium framework is backend-based, therefore
7993	the list of supported formats depends on what backends are currently
7994	installed.
7995
7996	<see><link to="IMediumFormat"/></see>
7997	</desc>
7998	</attribute>
7999
8000	<attribute name="defaultHardDiskFormat" type="wstring">
8001	<desc>
8002	Identifier of the default medium format used by VirtualBox.
8003
8004	The medium format set by this attribute is used by VirtualBox
8005	when the medium format was not specified explicitly. One example is
8006	<link to="IVirtualBox::createHardDisk"/> with the empty
8007	format argument. A more complex example is implicit creation of
8008	differencing media when taking a snapshot of a virtual machine:
8009	this operation will try to use a format of the parent medium first
8010	and if this format does not support differencing media the default
8011	format specified by this argument will be used.
8012
8013	The list of supported medium formats may be obtained by the
8014	<link to="#mediumFormats"/> call. Note that the default medium
8015	format must have a capability to create differencing media;
8016	otherwise operations that create media implicitly may fail
8017	unexpectedly.
8018
8019	The initial value of this property is <tt>"VDI"</tt> in the current
8020	version of the VirtualBox product, but may change in the future.
8021
8022	<note>
8023	Setting this property to @c null or empty string will restore the
8024	initial value.
8025	</note>
8026
8027	<see>
8028	<link to="#mediumFormats"/>,
8029	<link to="IMediumFormat::id"/>,
8030	<link to="IVirtualBox::createHardDisk"/>
8031	</see>
8032	</desc>
8033	</attribute>
8034
8035	<attribute name="freeDiskSpaceWarning" type="long long">
8036	<desc>Issue a warning if the free disk space is below (or in some disk
8037	intensive operation is expected to go below) the given size in
8038	bytes.</desc>
8039	</attribute>
8040
8041	<attribute name="freeDiskSpacePercentWarning" type="unsigned long">
8042	<desc>Issue a warning if the free disk space is below (or in some disk
8043	intensive operation is expected to go below) the given percentage.</desc>
8044	</attribute>
8045
8046	<attribute name="freeDiskSpaceError" type="long long">
8047	<desc>Issue an error if the free disk space is below (or in some disk
8048	intensive operation is expected to go below) the given size in
8049	bytes.</desc>
8050	</attribute>
8051
8052	<attribute name="freeDiskSpacePercentError" type="unsigned long">
8053	<desc>Issue an error if the free disk space is below (or in some disk
8054	intensive operation is expected to go below) the given percentage.</desc>
8055	</attribute>
8056
8057	<attribute name="VRDEAuthLibrary" type="wstring">
8058	<desc>
8059	Library that provides authentication for Remote Desktop clients. The library
8060	is used if a virtual machine's authentication type is set to "external"
8061	in the VM RemoteDisplay configuration.
8062
8063	The system library extension (".DLL" or ".so") must be omitted.
8064	A full path can be specified; if not, then the library must reside on the
8065	system's default library path.
8066
8067	The default value of this property is <tt>"VBoxAuth"</tt>. There is a library
8068	of that name in one of the default VirtualBox library directories.
8069
8070	For details about VirtualBox authentication libraries and how to implement
8071	them, please refer to the VirtualBox manual.
8072
8073	<note>
8074	Setting this property to @c null or empty string will restore the
8075	initial value.
8076	</note>
8077	</desc>
8078	</attribute>
8079
8080	<attribute name="webServiceAuthLibrary" type="wstring">
8081	<desc>
8082	Library that provides authentication for webservice clients. The library
8083	is used if a virtual machine's authentication type is set to "external"
8084	in the VM RemoteDisplay configuration and will be called from
8085	within the <link to="IWebsessionManager::logon" /> implementation.
8086
8087	As opposed to <link to="ISystemProperties::VRDEAuthLibrary" />,
8088	there is no per-VM setting for this, as the webservice is a global
8089	resource (if it is running). Only for this setting (for the webservice),
8090	setting this value to a literal <tt>"null"</tt> string disables authentication,
8091	meaning that <link to="IWebsessionManager::logon" /> will always succeed,
8092	no matter what user name and password are supplied.
8093
8094	The initial value of this property is <tt>"VBoxAuth"</tt>,
8095	meaning that the webservice will use the same authentication
8096	library that is used by default for VRDE (again, see
8097	<link to="ISystemProperties::VRDEAuthLibrary" />).
8098	The format and calling convention of authentication libraries
8099	is the same for the webservice as it is for VRDE.
8100
8101	<note>
8102	Setting this property to @c null or empty string will restore the
8103	initial value.
8104	</note>
8105	</desc>
8106	</attribute>
8107
8108	<attribute name="defaultVRDEExtPack" type="wstring">
8109	<desc>
8110	The name of the extension pack providing the default VRDE.
8111
8112	This attribute is for choosing between multiple extension packs
8113	providing VRDE. If only one is installed, it will automatically be the
8114	default one. The attribute value can be empty if no VRDE extension
8115	pack is installed.
8116
8117	For details about VirtualBox Remote Desktop Extension and how to
8118	implement one, please refer to the VirtualBox SDK.
8119	</desc>
8120	</attribute>
8121
8122	<attribute name="logHistoryCount" type="unsigned long">
8123	<desc>
8124	This value specifies how many old release log files are kept.
8125	</desc>
8126	</attribute>
8127
8128	<attribute name="defaultAudioDriver" type="AudioDriverType" readonly="yes">
8129	<desc>This value hold the default audio driver for the current
8130	system.</desc>
8131	</attribute>
8132
8133
8134	<method name="getMaxNetworkAdapters">
8135	<desc>
8136	Maximum total number of network adapters associated with every
8137	<link to="IMachine"/> instance.
8138	</desc>
8139
8140	<param name="chipset" type="ChipsetType" dir="in">
8141	<desc>The chipset type to get the value for.</desc>
8142	</param>
8143
8144
8145	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8146	<desc>The maximum total number of network adapters allowed.</desc>
8147	</param>
8148
8149	</method>
8150
8151	<method name="getMaxNetworkAdaptersOfType">
8152	<desc>
8153	Maximum number of network adapters of a given attachment type,
8154	associated with every <link to="IMachine"/> instance.
8155	</desc>
8156
8157	<param name="chipset" type="ChipsetType" dir="in">
8158	<desc>The chipset type to get the value for.</desc>
8159	</param>
8160
8161	<param name="type" type="NetworkAttachmentType" dir="in">
8162	<desc>Type of attachment.</desc>
8163	</param>
8164
8165	<param name="maxNetworkAdapters" type="unsigned long" dir="return">
8166	<desc>The maximum number of network adapters allowed for
8167	particular chipset and attachment type.</desc>
8168	</param>
8169
8170	</method>
8171
8172
8173	<method name="getMaxDevicesPerPortForStorageBus">
8174	<desc>Returns the maximum number of devices which can be attached to a port
8175	for the given storage bus.</desc>
8176
8177	<param name="bus" type="StorageBus" dir="in">
8178	<desc>The storage bus type to get the value for.</desc>
8179	</param>
8180
8181	<param name="maxDevicesPerPort" type="unsigned long" dir="return">
8182	<desc>The maximum number of devices which can be attached to the port for the given
8183	storage bus.</desc>
8184	</param>
8185	</method>
8186
8187	<method name="getMinPortCountForStorageBus">
8188	<desc>Returns the minimum number of ports the given storage bus supports.</desc>
8189
8190	<param name="bus" type="StorageBus" dir="in">
8191	<desc>The storage bus type to get the value for.</desc>
8192	</param>
8193
8194	<param name="minPortCount" type="unsigned long" dir="return">
8195	<desc>The minimum number of ports for the given storage bus.</desc>
8196	</param>
8197	</method>
8198
8199	<method name="getMaxPortCountForStorageBus">
8200	<desc>Returns the maximum number of ports the given storage bus supports.</desc>
8201
8202	<param name="bus" type="StorageBus" dir="in">
8203	<desc>The storage bus type to get the value for.</desc>
8204	</param>
8205
8206	<param name="maxPortCount" type="unsigned long" dir="return">
8207	<desc>The maximum number of ports for the given storage bus.</desc>
8208	</param>
8209	</method>
8210
8211	<method name="getMaxInstancesOfStorageBus">
8212	<desc>Returns the maximum number of storage bus instances which
8213	can be configured for each VM. This corresponds to the number of
8214	storage controllers one can have. Value may depend on chipset type
8215	used.</desc>
8216
8217	<param name="chipset" type="ChipsetType" dir="in">
8218	<desc>The chipset type to get the value for.</desc>
8219	</param>
8220
8221	<param name="bus" type="StorageBus" dir="in">
8222	<desc>The storage bus type to get the value for.</desc>
8223	</param>
8224
8225	<param name="maxInstances" type="unsigned long" dir="return">
8226	<desc>The maximum number of instances for the given storage bus.</desc>
8227	</param>
8228	</method>
8229
8230	<method name="getDeviceTypesForStorageBus">
8231	<desc>Returns list of all the supported device types
8232	(<link to="DeviceType"/>) for the given type of storage
8233	bus.</desc>
8234
8235	<param name="bus" type="StorageBus" dir="in">
8236	<desc>The storage bus type to get the value for.</desc>
8237	</param>
8238
8239	<param name="deviceTypes" type="DeviceType" safearray="yes" dir="return">
8240	<desc>The list of all supported device types for the given storage bus.</desc>
8241	</param>
8242	</method>
8243
8244	<method name="getDefaultIoCacheSettingForStorageController">
8245	<desc>Returns the default I/O cache setting for the
8246	given storage controller</desc>
8247
8248	<param name="controllerType" type="StorageControllerType" dir="in">
8249	<desc>The storage controller to the setting for.</desc>
8250	</param>
8251
8252	<param name="enabled" type="boolean" dir="return">
8253	<desc>Returned flag indicating the default value</desc>
8254	</param>
8255	</method>
8256	</interface>
8257
8258	<!--
8259	// IGuest
8260	/////////////////////////////////////////////////////////////////////////
8261	-->
8262
8263	<interface
8264	name="IGuestOSType" extends="$unknown"
8265	uuid="63a03874-e495-41f7-a6dd-48b92fba8355"
8266	wsmap="struct"
8267	>
8268	<desc>
8269	</desc>
8270
8271	<attribute name="familyId" type="wstring" readonly="yes">
8272	<desc>Guest OS family identifier string.</desc>
8273	</attribute>
8274
8275	<attribute name="familyDescription" type="wstring" readonly="yes">
8276	<desc>Human readable description of the guest OS family.</desc>
8277	</attribute>
8278
8279	<attribute name="id" type="wstring" readonly="yes">
8280	<desc>Guest OS identifier string.</desc>
8281	</attribute>
8282
8283	<attribute name="description" type="wstring" readonly="yes">
8284	<desc>Human readable description of the guest OS.</desc>
8285	</attribute>
8286
8287	<attribute name="is64Bit" type="boolean" readonly="yes">
8288	<desc>Returns @c true if the given OS is 64-bit</desc>
8289	</attribute>
8290
8291	<attribute name="recommendedIOAPIC" type="boolean" readonly="yes">
8292	<desc>Returns @c true if IO APIC recommended for this OS type.</desc>
8293	</attribute>
8294
8295	<attribute name="recommendedVirtEx" type="boolean" readonly="yes">
8296	<desc>Returns @c true if VT-x or AMD-V recommended for this OS type.</desc>
8297	</attribute>
8298
8299	<attribute name="recommendedRAM" type="unsigned long" readonly="yes">
8300	<desc>Recommended RAM size in Megabytes.</desc>
8301	</attribute>
8302
8303	<attribute name="recommendedVRAM" type="unsigned long" readonly="yes">
8304	<desc>Recommended video RAM size in Megabytes.</desc>
8305	</attribute>
8306
8307	<attribute name="recommended2DVideoAcceleration" type="boolean" readonly="yes">
8308	<desc>Returns @c true if 2D video acceleration is recommended for this OS type.</desc>
8309	</attribute>
8310
8311	<attribute name="recommended3DAcceleration" type="boolean" readonly="yes">
8312	<desc>Returns @c true if 3D acceleration is recommended for this OS type.</desc>
8313	</attribute>
8314
8315	<attribute name="recommendedHDD" type="long long" readonly="yes">
8316	<desc>Recommended hard disk size in bytes.</desc>
8317	</attribute>
8318
8319	<attribute name="adapterType" type="NetworkAdapterType" readonly="yes">
8320	<desc>Returns recommended network adapter for this OS type.</desc>
8321	</attribute>
8322
8323	<attribute name="recommendedPae" type="boolean" readonly="yes">
8324	<desc>Returns @c true if using PAE is recommended for this OS type.</desc>
8325	</attribute>
8326
8327	<attribute name="recommendedDvdStorageController" type="StorageControllerType" readonly="yes">
8328	<desc>Recommended storage controller type for DVD/CD drives.</desc>
8329	</attribute>
8330
8331	<attribute name="recommendedDvdStorageBus" type="StorageBus" readonly="yes">
8332	<desc>Recommended storage bus type for DVD/CD drives.</desc>
8333	</attribute>
8334
8335	<attribute name="recommendedHdStorageController" type="StorageControllerType" readonly="yes">
8336	<desc>Recommended storage controller type for HD drives.</desc>
8337	</attribute>
8338
8339	<attribute name="recommendedHdStorageBus" type="StorageBus" readonly="yes">
8340	<desc>Recommended storage bus type for HD drives.</desc>
8341	</attribute>
8342
8343	<attribute name="recommendedFirmware" type="FirmwareType" readonly="yes">
8344	<desc>Recommended firmware type.</desc>
8345	</attribute>
8346
8347	<attribute name="recommendedUsbHid" type="boolean" readonly="yes">
8348	<desc>Returns @c true if using USB Human Interface Devices, such as keyboard and mouse recommended.</desc>
8349	</attribute>
8350
8351	<attribute name="recommendedHpet" type="boolean" readonly="yes">
8352	<desc>Returns @c true if using HPET is recommended for this OS type.</desc>
8353	</attribute>
8354
8355	<attribute name="recommendedUsbTablet" type="boolean" readonly="yes">
8356	<desc>Returns @c true if using a USB Tablet is recommended.</desc>
8357	</attribute>
8358
8359	<attribute name="recommendedRtcUseUtc" type="boolean" readonly="yes">
8360	<desc>Returns @c true if the RTC of this VM should be set to UTC</desc>
8361	</attribute>
8362
8363	<attribute name="recommendedChipset" type="ChipsetType" readonly="yes">
8364	<desc>Recommended chipset type.</desc>
8365	</attribute>
8366
8367	<attribute name="recommendedAudioController" type="AudioControllerType" readonly="yes">
8368	<desc>Recommended audio type.</desc>
8369	</attribute>
8370
8371	<attribute name="recommendedFloppy" type="boolean" readonly="yes">
8372	<desc>Returns @c true a floppy drive is recommended for this OS type.</desc>
8373	</attribute>
8374
8375	<attribute name="recommendedUsb" type="boolean" readonly="yes">
8376	<desc>Returns @c true a USB controller is recommended for this OS type.</desc>
8377	</attribute>
8378
8379	</interface>
8380
8381	<enum
8382	name="AdditionsFacilityType"
8383	uuid="98f7f957-89fb-49b6-a3b1-31e3285eb1d8"
8384	>
8385	<desc>
8386	Guest Additions facility IDs.
8387	</desc>
8388
8389	<const name="None" value="0">
8390	<desc>No/invalid facility.</desc>
8391	</const>
8392	<const name="VBoxGuestDriver" value="20">
8393	<desc>VirtualBox base driver (VBoxGuest).</desc>
8394	</const>
8395	<const name="AutoLogon" value="90">
8396	<desc>Auto-logon modules (VBoxGINA, VBoxCredProv, pam_vbox).</desc>
8397	</const>
8398	<const name="VBoxService" value="100">
8399	<desc>VirtualBox system service (VBoxService).</desc>
8400	</const>
8401	<const name="VBoxTrayClient" value="101">
8402	<desc>VirtualBox desktop integration (VBoxTray on Windows, VBoxClient on non-Windows).</desc>
8403	</const>
8404	<const name="Seamless" value="1000">
8405	<desc>Seamless guest desktop integration.</desc>
8406	</const>
8407	<const name="Graphics" value="1100">
8408	<desc>Guest graphics mode. If not enabled, seamless rendering will not work, resize hints
8409	are not immediately acted on and guest display resizes are probably not initiated by
8410	the guest additions.
8411	</desc>
8412	</const>
8413	<const name="All" value="2147483646">
8414	<desc>All facilities selected.</desc>
8415	</const>
8416	</enum>
8417
8418	<enum
8419	name="AdditionsFacilityClass"
8420	uuid="446451b2-c88d-4e5d-84c9-91bc7f533f5f"
8421	>
8422	<desc>
8423	Guest Additions facility classes.
8424	</desc>
8425
8426	<const name="None" value="0">
8427	<desc>No/invalid class.</desc>
8428	</const>
8429	<const name="Driver" value="10">
8430	<desc>Driver.</desc>
8431	</const>
8432	<const name="Service" value="30">
8433	<desc>System service.</desc>
8434	</const>
8435	<const name="Program" value="50">
8436	<desc>Program.</desc>
8437	</const>
8438	<const name="Feature" value="100">
8439	<desc>Feature.</desc>
8440	</const>
8441	<const name="ThirdParty" value="999">
8442	<desc>Third party.</desc>
8443	</const>
8444	<const name="All" value="2147483646">
8445	<desc>All facility classes selected.</desc>
8446	</const>
8447	</enum>
8448
8449	<enum
8450	name="AdditionsFacilityStatus"
8451	uuid="ce06f9e1-394e-4fe9-9368-5a88c567dbde"
8452	>
8453	<desc>
8454	Guest Additions facility states.
8455	</desc>
8456
8457	<const name="Inactive" value="0">
8458	<desc>Facility is not active.</desc>
8459	</const>
8460	<const name="Paused" value="1">
8461	<desc>Facility has been paused.</desc>
8462	</const>
8463	<const name="PreInit" value="20">
8464	<desc>Facility is preparing to initialize.</desc>
8465	</const>
8466	<const name="Init" value="30">
8467	<desc>Facility is initializing.</desc>
8468	</const>
8469	<const name="Active" value="50">
8470	<desc>Facility is up and running.</desc>
8471	</const>
8472	<const name="Terminating" value="100">
8473	<desc>Facility is shutting down.</desc>
8474	</const>
8475	<const name="Terminated" value="101">
8476	<desc>Facility successfully shut down.</desc>
8477	</const>
8478	<const name="Failed" value="800">
8479	<desc>Facility failed to start.</desc>
8480	</const>
8481	<const name="Unknown" value="999">
8482	<desc>Facility status is unknown.</desc>
8483	</const>
8484	</enum>
8485
8486	<interface
8487	name="IAdditionsFacility" extends="$unknown"
8488	uuid="54992946-6af1-4e49-98ec-58b558b7291e"
8489	wsmap="struct"
8490	>
8491	<desc>
8492	Structure representing a Guest Additions facility.
8493	</desc>
8494
8495	<attribute name="classType" type="AdditionsFacilityClass" readonly="yes">
8496	<desc>The class this facility is part of.</desc>
8497	</attribute>
8498
8499	<attribute name="lastUpdated" type="long long" readonly="yes">
8500	<desc>
8501	Time stamp of the last status update,
8502	in milliseconds since 1970-01-01 UTC.
8503	</desc>
8504	</attribute>
8505
8506	<attribute name="name" type="wstring" readonly="yes">
8507	<desc>The facility's friendly name.</desc>
8508	</attribute>
8509
8510	<attribute name="status" type="AdditionsFacilityStatus" readonly="yes">
8511	<desc>The current status.</desc>
8512	</attribute>
8513
8514	<attribute name="type" type="AdditionsFacilityType" readonly="yes">
8515	<desc>The facility's type ID.</desc>
8516	</attribute>
8517	</interface>
8518
8519	<enum
8520	name="AdditionsRunLevelType"
8521	uuid="a25417ee-a9dd-4f5b-b0dc-377860087754"
8522	>
8523	<desc>
8524	Guest Additions run level type.
8525	</desc>
8526
8527	<const name="None" value="0">
8528	<desc>Guest Additions are not loaded.</desc>
8529	</const>
8530	<const name="System" value="1">
8531	<desc>Guest drivers are loaded.</desc>
8532	</const>
8533	<const name="Userland" value="2">
8534	<desc>Common components (such as application services) are loaded.</desc>
8535	</const>
8536	<const name="Desktop" value="3">
8537	<desc>Per-user desktop components are loaded.</desc>
8538	</const>
8539	</enum>
8540
8541	<enum
8542	name="AdditionsUpdateFlag"
8543	uuid="726a818d-18d6-4389-94e8-3e9e6826171a"
8544	>
8545	<desc>
8546	Guest Additions update flags.
8547	</desc>
8548
8549	<const name="None" value="0">
8550	<desc>No flag set.</desc>
8551	</const>
8552	<const name="WaitForUpdateStartOnly" value="1">
8553	<desc>Only wait for the update process being started and do not
8554	wait while peforming the actual update.</desc>
8555	</const>
8556	</enum>
8557
8558	<enum
8559	name="ExecuteProcessFlag"
8560	uuid="1c49b831-b2c7-4a30-97dd-999a2e2cbf90"
8561	>
8562	<desc>
8563	Guest process execution flags.
8564	</desc>
8565
8566	<const name="None" value="0">
8567	<desc>No flag set.</desc>
8568	</const>
8569	<const name="WaitForProcessStartOnly" value="1">
8570	<desc>Only use the specified timeout value to wait for starting the guest process - the guest
8571	process itself then uses an infinite timeout.</desc>
8572	</const>
8573	<const name="IgnoreOrphanedProcesses" value="2">
8574	<desc>Do not report an error when executed processes are still alive when VBoxService or the guest OS is shutting down.</desc>
8575	</const>
8576	<const name="Hidden" value="4">
8577	<desc>Do not show the started process according to the guest OS guidelines.</desc>
8578	</const>
8579	<const name="NoProfile" value="8">
8580	<desc>Do not use the user's profile data when exeuting a process. Only available for Windows guests.</desc>
8581	</const>
8582	<const name="WaitForStdOut" value="16">
8583	<desc>The guest process waits until all data from stdout is read out.</desc>
8584	</const>
8585	<const name="WaitForStdErr" value="32">
8586	<desc>The guest process waits until all data from stderr is read out.</desc>
8587	</const>
8588	</enum>
8589
8590	<enum
8591	name="ExecuteProcessStatus"
8592	uuid="153768d9-d971-4098-8b5a-c5cb1ab9ea88"
8593	>
8594	<desc>
8595	Guest process execution status.
8596	</desc>
8597	<const name="Undefined" value="0">
8598	<desc>Process is in an undefined state.</desc>
8599	</const>
8600
8601	<const name="Started" value="1">
8602	<desc>Process has been started.</desc>
8603	</const>
8604	<const name="TerminatedNormally" value="2">
8605	<desc>Process terminated normally.</desc>
8606	</const>
8607	<const name="TerminatedSignal" value="3">
8608	<desc>Process terminated via signal.</desc>
8609	</const>
8610	<const name="TerminatedAbnormally" value="4">
8611	<desc>Process terminated abnormally.</desc>
8612	</const>
8613	<const name="TimedOutKilled" value="5">
8614	<desc>Process timed out and was killed.</desc>
8615	</const>
8616	<const name="TimedOutAbnormally" value="6">
8617	<desc>Process timed out and was not killed successfully.</desc>
8618	</const>
8619	<const name="Down" value="7">
8620	<desc>Service/OS is stopping, process was killed.</desc>
8621	</const>
8622	<const name="Error" value="8">
8623	<desc>Something went wrong (error code in flags).</desc>
8624	</const>
8625	</enum>
8626
8627	<enum
8628	name="ProcessInputFlag"
8629	uuid="5d38c1dd-2604-4ddf-92e5-0c0cdd3bdbd5"
8630	>
8631	<desc>
8632	Guest process input flags.
8633	</desc>
8634	<const name="None" value="0">
8635	<desc>No flag set.</desc>
8636	</const>
8637	<const name="EndOfFile" value="1">
8638	<desc>End of file (input) reached.</desc>
8639	</const>
8640	</enum>
8641
8642	<enum
8643	name="ProcessOutputFlag"
8644	uuid="9979e85a-52bb-40b7-870c-57115e27e0f1"
8645	>
8646	<desc>
8647	Guest process output flags for specifying which
8648	type of output to retrieve.
8649	</desc>
8650	<const name="None" value="0">
8651	<desc>No flags set. Get output from stdout.</desc>
8652	</const>
8653	<const name="StdErr" value="1">
8654	<desc>Get output from stderr.</desc>
8655	</const>
8656	</enum>
8657
8658	<enum
8659	name="CopyFileFlag"
8660	uuid="23f79fdf-738a-493d-b80b-42d607c9b916"
8661	>
8662	<desc>
8663	Host/Guest copy flags. At the moment none of these flags
8664	are implemented.
8665	</desc>
8666	<const name="None" value="0">
8667	<desc>No flag set.</desc>
8668	</const>
8669	<const name="Recursive" value="1">
8670	<desc>Copy directories recursively.</desc>
8671	</const>
8672	<const name="Update" value="2">
8673	<desc>Only copy when the source file is newer than the destination file or when the destination file is missing.</desc>
8674	</const>
8675	<const name="FollowLinks" value="4">
8676	<desc>Follow symbolic links.</desc>
8677	</const>
8678	</enum>
8679
8680	<enum
8681	name="DirectoryCreateFlag"
8682	uuid="bd721b0e-ced5-4f79-b368-249897c32a36"
8683	>
8684	<desc>
8685	Directory creation flags.
8686	</desc>
8687	<const name="None" value="0">
8688	<desc>No flag set.</desc>
8689	</const>
8690	<const name="Parents" value="1">
8691	<desc>No error if existing, make parent directories as needed.</desc>
8692	</const>
8693	</enum>
8694
8695	<enum
8696	name="DragAndDropAction"
8697	uuid="47f3b162-c107-4fcd-bfa7-54b8135c441e"
8698	>
8699	<desc>
8700	Possible actions within an Drag and Drop operation.
8701	</desc>
8702
8703	<const name="Ignore" value="0">
8704	<desc>Do nothing.</desc>
8705	</const>
8706
8707	<const name="Copy" value="1">
8708	<desc>Copy the item to the target.</desc>
8709	</const>
8710
8711	<const name="Move" value="2">
8712	<desc>Move the item to the target.</desc>
8713	</const>
8714
8715	<const name="Link" value="3">
8716	<desc>Link the item from within the target.</desc>
8717	</const>
8718	</enum>
8719
8720	<enum
8721	name="DirectoryOpenFlag"
8722	uuid="fc8f6203-0072-4f34-bd08-0b35e50bf071"
8723	>
8724	<desc>
8725	Directory open flags.
8726	</desc>
8727	<const name="None" value="0">
8728	<desc>No flag set.</desc>
8729	</const>
8730	</enum>
8731
8732	<enum
8733	name="GuestDirEntryType"
8734	uuid="6d19d924-1b77-4fc8-b369-a3b2c85c8241"
8735	>
8736	<desc>
8737	Guest directory entry type.
8738	</desc>
8739	<const name="Unknown" value="0">
8740	<desc>Unknown.</desc>
8741	</const>
8742	<const name="Directory" value="4">
8743	<desc>Regular file.</desc>
8744	</const>
8745	<const name="File" value="10">
8746	<desc>Regular file.</desc>
8747	</const>
8748	<const name="Symlink" value="12">
8749	<desc>Symbolic link.</desc>
8750	</const>
8751	</enum>
8752
8753	<interface
8754	name="IGuestDirEntry" extends="$unknown"
8755	uuid="20a66efc-c2f6-4438-826f-38454c04369e"
8756	wsmap="struct"
8757	>
8758	<desc>
8759	Structure representing a directory entry on the guest OS.
8760	</desc>
8761	<attribute name="nodeId" type="long long" readonly="yes">
8762	<desc>The unique identifier (within the guest's file system) of this file system object.</desc>
8763	</attribute>
8764	<attribute name="name" type="wstring" readonly="yes">
8765	<desc>The filename.</desc>
8766	</attribute>
8767	<attribute name="type" type="GuestDirEntryType" readonly="yes">
8768	<desc>The entry type.</desc>
8769	</attribute>
8770	</interface>
8771
8772	<interface
8773	name="IGuest" extends="$unknown"
8774	uuid="88696240-7411-4fe6-bb5e-ef56fb8a61f3"
8775	wsmap="managed"
8776	>
8777	<desc>
8778	The IGuest interface represents information about the operating system
8779	running inside the virtual machine. Used in
8780	<link to="IConsole::guest"/>.
8781
8782	IGuest provides information about the guest operating system, whether
8783	Guest Additions are installed and other OS-specific virtual machine
8784	properties.
8785	</desc>
8786
8787	<attribute name="OSTypeId" type="wstring" readonly="yes">
8788	<desc>
8789	Identifier of the Guest OS type as reported by the Guest
8790	Additions.
8791	You may use <link to="IVirtualBox::getGuestOSType"/> to obtain
8792	an IGuestOSType object representing details about the given
8793	Guest OS type.
8794	<note>
8795	If Guest Additions are not installed, this value will be
8796	the same as <link to="IMachine::OSTypeId"/>.
8797	</note>
8798	</desc>
8799	</attribute>
8800
8801	<attribute name="additionsRunLevel" type="AdditionsRunLevelType" readonly="yes">
8802	<desc>
8803	Current run level of the Guest Additions.
8804	</desc>
8805	</attribute>
8806
8807	<attribute name="additionsVersion" type="wstring" readonly="yes">
8808	<desc>
8809	Version of the Guest Additions in the same format as
8810	<link to="IVirtualBox::version"/>.
8811	</desc>
8812	</attribute>
8813
8814	<attribute name="additionsRevision" type="unsigned long" readonly="yes">
8815	<desc>
8816	The internal build revision number of the additions.
8817
8818	See also <link to="IVirtualBox::revision"/>.
8819	</desc>
8820	</attribute>
8821
8822	<attribute name="facilities" type="IAdditionsFacility" readonly="yes" safearray="yes">
8823	<desc>
8824	Array of current known facilities. Only returns facilities where a status is known,
8825	e.g. facilities with an unknown status will not be returned.
8826	</desc>
8827	</attribute>
8828
8829	<attribute name="memoryBalloonSize" type="unsigned long">
8830	<desc>Guest system memory balloon size in megabytes (transient property).</desc>
8831	</attribute>
8832
8833	<attribute name="statisticsUpdateInterval" type="unsigned long">
8834	<desc>Interval to update guest statistics in seconds.</desc>
8835	</attribute>
8836
8837	<method name="internalGetStatistics">
8838	<desc>
8839	Internal method; do not use as it might change at any time.
8840	</desc>
8841	<param name="cpuUser" type="unsigned long" dir="out">
8842	<desc>Percentage of processor time spent in user mode as seen by the guest.</desc>
8843	</param>
8844	<param name="cpuKernel" type="unsigned long" dir="out">
8845	<desc>Percentage of processor time spent in kernel mode as seen by the guest.</desc>
8846	</param>
8847	<param name="cpuIdle" type="unsigned long" dir="out">
8848	<desc>Percentage of processor time spent idling as seen by the guest.</desc>
8849	</param>
8850	<param name="memTotal" type="unsigned long" dir="out">
8851	<desc>Total amount of physical guest RAM.</desc>
8852	</param>
8853	<param name="memFree" type="unsigned long" dir="out">
8854	<desc>Free amount of physical guest RAM.</desc>
8855	</param>
8856	<param name="memBalloon" type="unsigned long" dir="out">
8857	<desc>Amount of ballooned physical guest RAM.</desc>
8858	</param>
8859	<param name="memShared" type="unsigned long" dir="out">
8860	<desc>Amount of shared physical guest RAM.</desc>
8861	</param>
8862	<param name="memCache" type="unsigned long" dir="out">
8863	<desc>Total amount of guest (disk) cache memory.</desc>
8864	</param>
8865	<param name="pagedTotal" type="unsigned long" dir="out">
8866	<desc>Total amount of space in the page file.</desc>
8867	</param>
8868	<param name="memAllocTotal" type="unsigned long" dir="out">
8869	<desc>Total amount of memory allocated by the hypervisor.</desc>
8870	</param>
8871	<param name="memFreeTotal" type="unsigned long" dir="out">
8872	<desc>Total amount of free memory available in the hypervisor.</desc>
8873	</param>
8874	<param name="memBalloonTotal" type="unsigned long" dir="out">
8875	<desc>Total amount of memory ballooned by the hypervisor.</desc>
8876	</param>
8877	<param name="memSharedTotal" type="unsigned long" dir="out">
8878	<desc>Total amount of shared memory in the hypervisor.</desc>
8879	</param>
8880	</method>
8881
8882	<method name="getFacilityStatus">
8883	<desc>
8884	Get the current status of a Guest Additions facility.
8885	</desc>
8886	<param name="facility" type="AdditionsFacilityType" dir="in">
8887	<desc>Facility to check status for.</desc>
8888	</param>
8889	<param name="timestamp" type="long long" dir="out">
8890	<desc>Timestamp (in ms) of last status update seen by the host.</desc>
8891	</param>
8892	<param name="status" type="AdditionsFacilityStatus" dir="return">
8893	<desc>The current (latest) facility status.</desc>
8894	</param>
8895	</method>
8896
8897	<method name="getAdditionsStatus">
8898	<desc>
8899	Retrieve the current status of a certain Guest Additions run level.
8900
8901	<result name="VBOX_E_NOT_SUPPORTED">
8902	Wrong status level specified.
8903	</result>
8904
8905	</desc>
8906	<param name="level" type="AdditionsRunLevelType" dir="in">
8907	<desc>Status level to check</desc>
8908	</param>
8909	<param name="active" type="boolean" dir="return">
8910	<desc>Flag whether the status level has been reached or not</desc>
8911	</param>
8912	</method>
8913
8914	<method name="setCredentials">
8915	<desc>
8916	Store login credentials that can be queried by guest operating
8917	systems with Additions installed. The credentials are transient
8918	to the session and the guest may also choose to erase them. Note
8919	that the caller cannot determine whether the guest operating system
8920	has queried or made use of the credentials.
8921
8922	<result name="VBOX_E_VM_ERROR">
8923	VMM device is not available.
8924	</result>
8925
8926	</desc>
8927	<param name="userName" type="wstring" dir="in">
8928	<desc>User name string, can be empty</desc>
8929	</param>
8930	<param name="password" type="wstring" dir="in">
8931	<desc>Password string, can be empty</desc>
8932	</param>
8933	<param name="domain" type="wstring" dir="in">
8934	<desc>Domain name (guest logon scheme specific), can be empty</desc>
8935	</param>
8936	<param name="allowInteractiveLogon" type="boolean" dir="in">
8937	<desc>
8938	Flag whether the guest should alternatively allow the user to
8939	interactively specify different credentials. This flag might
8940	not be supported by all versions of the Additions.
8941	</desc>
8942	</param>
8943	</method>
8944
8945	<method name="dragHGEnter">
8946	<desc>
8947	Informs the guest about a Drag and Drop enter event.
8948
8949	This is used in Host - Guest direction.
8950
8951	<result name="VBOX_E_VM_ERROR">
8952	VMM device is not available.
8953	</result>
8954
8955	</desc>
8956	<param name="screenId" type="unsigned long" dir="in">
8957	<desc>The screen id where the Drag and Drop event occured.</desc>
8958	</param>
8959	<param name="y" type="unsigned long" dir="in">
8960	<desc>y-position of the event.</desc>
8961	</param>
8962	<param name="x" type="unsigned long" dir="in">
8963	<desc>x-position of the event.</desc>
8964	</param>
8965	<param name="defaultAction" type="DragAndDropAction" dir="in">
8966	<desc>The default action to use.</desc>
8967	</param>
8968	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
8969	<desc>The actions which are allowed.</desc>
8970	</param>
8971	<param name="formats" type="wstring" dir="in" safearray="yes">
8972	<desc>The supported mime types.</desc>
8973	</param>
8974	<param name="resultAction" type="DragAndDropAction" dir="return">
8975	<desc>The resulting action of this event.</desc>
8976	</param>
8977	</method>
8978
8979	<method name="dragHGMove">
8980	<desc>
8981	Informs the guest about a Drag and Drop move event.
8982
8983	This is used in Host - Guest direction.
8984
8985	<result name="VBOX_E_VM_ERROR">
8986	VMM device is not available.
8987	</result>
8988
8989	</desc>
8990	<param name="screenId" type="unsigned long" dir="in">
8991	<desc>The screen id where the Drag and Drop event occured.</desc>
8992	</param>
8993	<param name="x" type="unsigned long" dir="in">
8994	<desc>x-position of the event.</desc>
8995	</param>
8996	<param name="y" type="unsigned long" dir="in">
8997	<desc>y-position of the event.</desc>
8998	</param>
8999	<param name="defaultAction" type="DragAndDropAction" dir="in">
9000	<desc>The default action to use.</desc>
9001	</param>
9002	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9003	<desc>The actions which are allowed.</desc>
9004	</param>
9005	<param name="formats" type="wstring" dir="in" safearray="yes">
9006	<desc>The supported mime types.</desc>
9007	</param>
9008	<param name="resultAction" type="DragAndDropAction" dir="return">
9009	<desc>The resulting action of this event.</desc>
9010	</param>
9011	</method>
9012
9013	<method name="dragHGLeave">
9014	<desc>
9015	Informs the guest about a Drag and Drop leave event.
9016
9017	This is used in Host - Guest direction.
9018
9019	<result name="VBOX_E_VM_ERROR">
9020	VMM device is not available.
9021	</result>
9022
9023	</desc>
9024	<param name="screenId" type="unsigned long" dir="in">
9025	<desc>The screen id where the Drag and Drop event occured.</desc>
9026	</param>
9027	</method>
9028
9029	<method name="dragHGDrop">
9030	<desc>
9031	Informs the guest about a drop event.
9032
9033	This is used in Host - Guest direction.
9034
9035	<result name="VBOX_E_VM_ERROR">
9036	VMM device is not available.
9037	</result>
9038
9039	</desc>
9040	<param name="screenId" type="unsigned long" dir="in">
9041	<desc>The screen id where the Drag and Drop event occured.</desc>
9042	</param>
9043	<param name="x" type="unsigned long" dir="in">
9044	<desc>x-position of the event.</desc>
9045	</param>
9046	<param name="y" type="unsigned long" dir="in">
9047	<desc>y-position of the event.</desc>
9048	</param>
9049	<param name="defaultAction" type="DragAndDropAction" dir="in">
9050	<desc>The default action to use.</desc>
9051	</param>
9052	<param name="allowedActions" type="DragAndDropAction" dir="in" safearray="yes">
9053	<desc>The actions which are allowed.</desc>
9054	</param>
9055	<param name="formats" type="wstring" dir="in" safearray="yes">
9056	<desc>The supported mime types.</desc>
9057	</param>
9058	<param name="format" type="wstring" dir="out">
9059	<desc>The resulting format of this event.</desc>
9060	</param>
9061	<param name="resultAction" type="DragAndDropAction" dir="return">
9062	<desc>The resulting action of this event.</desc>
9063	</param>
9064	</method>
9065
9066	<method name="dragHGPutData">
9067	<desc>
9068	Informs the guest about a drop data event.
9069
9070	This is used in Host - Guest direction.
9071
9072	<result name="VBOX_E_VM_ERROR">
9073	VMM device is not available.
9074	</result>
9075
9076	</desc>
9077	<param name="screenId" type="unsigned long" dir="in">
9078	<desc>The screen id where the Drag and Drop event occured.</desc>
9079	</param>
9080	<param name="format" type="wstring" dir="in">
9081	<desc>The mime type the data is in.</desc>
9082	</param>
9083	<param name="data" type="octet" dir="in" safearray="yes">
9084	<desc>The actual data.</desc>
9085	</param>
9086	<param name="progress" type="IProgress" dir="return">
9087	<desc>Progress object to track the operation completion.</desc>
9088	</param>
9089	</method>
9090
9091	<method name="dragGHPending">
9092	<desc>
9093	Ask the guest if there is any Drag and Drop operation pending in the guest.
9094
9095	If no Drag and Drop operation is pending currently, Ignore is returned.
9096
9097	This is used in Guest - Host 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="out" safearray="yes">
9108	<desc>On return the supported mime types.</desc>
9109	</param>
9110	<param name="allowedActions" type="DragAndDropAction" dir="out" safearray="yes">
9111	<desc>On return the actions which are allowed.</desc>
9112	</param>
9113	<param name="defaultAction" type="DragAndDropAction" dir="return">
9114	<desc>On return the default action to use.</desc>
9115	</param>
9116	</method>
9117
9118	<method name="dragGHDropped">
9119	<desc>
9120	Informs the guest that a drop event occured for a pending Drag and Drop event.
9121
9122	This is used in Guest - Host direction.
9123
9124	<result name="VBOX_E_VM_ERROR">
9125	VMM device is not available.
9126	</result>
9127
9128	</desc>
9129
9130	<param name="format" type="wstring" dir="in">
9131	<desc>The mime type the data must be in.</desc>
9132	</param>
9133	<param name="action" type="DragAndDropAction" dir="in">
9134	<desc>The action to use.</desc>
9135	</param>
9136	<param name="progress" type="IProgress" dir="return">
9137	<desc>Progress object to track the operation completion.</desc>
9138	</param>
9139	</method>
9140
9141	<method name="dragGHGetData">
9142	<desc>
9143	Fetch the data of a previously Drag and Drop event from the guest.
9144
9145	This is used in Guest - Host direction.
9146
9147	<result name="VBOX_E_VM_ERROR">
9148	VMM device is not available.
9149	</result>
9150
9151	</desc>
9152
9153	<param name="data" type="octet" safearray="yes" dir="return">
9154	<desc>The actual data.</desc>
9155	</param>
9156	</method>
9157
9158	<method name="executeProcess">
9159	<desc>
9160	Executes an existing program inside the guest VM.
9161
9162	<note>
9163	Starting at VirtualBox 4.1.8 guest process execution by default is limited
9164	to serve up to 25 guest processes at a time. If all 25 guest processes
9165	are still active and running, starting a new guest process will result in an
9166	appropriate error message.
9167
9168	If ExecuteProcessFlag_WaitForStdOut and/or respectively
9169	ExecuteProcessFlag_WaitForStdErr of <link to="ExecuteProcessFlag"/> is
9170	set, the guest process will not exit until all data from the specified
9171	stream(s) is/are read out.
9172
9173	To raise or lower the guest process execution limit, either the guest property
9174	"/VirtualBox/GuestAdd/VBoxService/--control-procs-max-kept" or VBoxService'
9175	command line by specifying "--control-procs-max-kept" needs to be modified.
9176	A restart of the guest OS is required afterwards. To serve unlimited guest
9177	processes, a value of "0" needs to be set (not recommended).
9178	</note>
9179
9180	<result name="VBOX_E_IPRT_ERROR">
9181	Could not execute process.
9182	</result>
9183
9184	</desc>
9185	<param name="execName" type="wstring" dir="in">
9186	<desc>
9187	Full path name of the command to execute on the guest; the
9188	commands has to exists in the guest VM in order to be executed.
9189	</desc>
9190	</param>
9191	<param name="flags" type="unsigned long" dir="in">
9192	<desc>
9193	<link to="ExecuteProcessFlag"/> flags.
9194	</desc>
9195	</param>
9196	<param name="arguments" type="wstring" safearray="yes" dir="in">
9197	<desc>
9198	Array of arguments passed to the execution command.
9199	</desc>
9200	</param>
9201	<param name="environment" type="wstring" safearray="yes" dir="in">
9202	<desc>
9203	Environment variables that can be set while the command is being
9204	executed, in form of "NAME=VALUE"; one pair per entry. To unset a
9205	variable just set its name ("NAME") without a value.
9206	</desc>
9207	</param>
9208	<param name="userName" type="wstring" dir="in">
9209	<desc>
9210	User name under which the command will be executed; has to exist
9211	and have the appropriate rights to execute programs in the VM.
9212	</desc>
9213	</param>
9214	<param name="password" type="wstring" dir="in">
9215	<desc>
9216	Password of the user account specified.
9217	</desc>
9218	</param>
9219	<param name="timeoutMS" type="unsigned long" dir="in">
9220	<desc>
9221	The maximum timeout value (in msec) to wait for finished program
9222	execution. Pass 0 for an infinite timeout.
9223	</desc>
9224	</param>
9225	<param name="pid" type="unsigned long" dir="out">
9226	<desc>
9227	The PID (process ID) of the started command for later reference.
9228	</desc>
9229	</param>
9230	<param name="progress" type="IProgress" dir="return">
9231	<desc>Progress object to track the operation completion.</desc>
9232	</param>
9233	</method>
9234
9235	<method name="getProcessOutput">
9236	<desc>
9237	Retrieves output of a formerly started and running guest process.
9238
9239	<note>
9240	Starting with VirtualBox 4.1.8 this only will return output data
9241	from stdout or stderr if flag ExecuteProcessFlag_WaitForStdOut
9242	and/or respectively ExecuteProcessFlag_WaitForStdErr of
9243	<link to="ExecuteProcessFlag"/> is set in the
9244	former <link to="#executeProcess"/> call for this guest process.
9245	</note>
9246
9247	<result name="VBOX_E_IPRT_ERROR">
9248	Could not retrieve output.
9249	</result>
9250
9251	</desc>
9252	<param name="pid" type="unsigned long" dir="in">
9253	<desc>
9254	Process id returned by earlier <link to="#executeProcess"/> call.
9255	</desc>
9256	</param>
9257	<param name="flags" type="unsigned long" dir="in">
9258	<desc>
9259	<link to="ProcessOutputFlag"/> flags.
9260	</desc>
9261	</param>
9262	<param name="timeoutMS" type="unsigned long" dir="in">
9263	<desc>
9264	The maximum timeout value (in msec) to wait for output
9265	data. Pass 0 for an infinite timeout.
9266	</desc>
9267	</param>
9268	<param name="size" type="long long" dir="in">
9269	<desc>
9270	Size in bytes to read in the buffer.
9271	</desc>
9272	</param>
9273	<param name="data" type="octet" safearray="yes" dir="return">
9274	<desc>
9275	Buffer for retrieving the actual output. A data size of 0 means end of file
9276	if the requested size was not 0. This is the unprocessed
9277	output data, i.e. the line ending style depends on the platform of
9278	the system the server is running on.
9279	</desc>
9280	</param>
9281	</method>
9282
9283	<method name="getProcessStatus">
9284	<desc>
9285	Retrieves status, exit code and the exit reason of a formerly started
9286	guest process. If a guest process exited or got terminated this function
9287	returns its final status and removes this process from the list of
9288	known guest processes for further retrieval.
9289
9290	<result name="VBOX_E_IPRT_ERROR">
9291	Process with specified PID was not found.
9292	</result>
9293
9294	</desc>
9295	<param name="pid" type="unsigned long" dir="in">
9296	<desc>
9297	Process id returned by earlier <link to="#executeProcess"/> call.
9298	</desc>
9299	</param>
9300	<param name="exitcode" type="unsigned long" dir="out">
9301	<desc>
9302	The exit code (if available).
9303	</desc>
9304	</param>
9305	<param name="flags" type="unsigned long" dir="out">
9306	<desc>
9307	Additional flags of process status. Not used at the moment and
9308	must be set to 0.
9309	</desc>
9310	</param>
9311	<param name="reason" type="ExecuteProcessStatus" dir="return">
9312	<desc>
9313	The current process status.
9314	</desc>
9315	</param>
9316	</method>
9317
9318	<method name="copyFromGuest">
9319	<desc>
9320	Copies files/directories from guest to the host.
9321
9322	<result name="VBOX_E_IPRT_ERROR">
9323	Error while copying.
9324	</result>
9325
9326	</desc>
9327	<param name="source" type="wstring" dir="in">
9328	<desc>
9329	Source file on the guest to copy.
9330	</desc>
9331	</param>
9332	<param name="dest" type="wstring" dir="in">
9333	<desc>
9334	Destination path on the host.
9335	</desc>
9336	</param>
9337	<param name="userName" type="wstring" dir="in">
9338	<desc>
9339	User name under which the copy command will be executed; the
9340	user has to exist and have the appropriate rights to read from
9341	the source path.
9342	</desc>
9343	</param>
9344	<param name="password" type="wstring" dir="in">
9345	<desc>
9346	Password of the user account specified.
9347	</desc>
9348	</param>
9349	<param name="flags" type="unsigned long" dir="in">
9350	<desc>
9351	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9352	</desc>
9353	</param>
9354	<param name="progress" type="IProgress" dir="return">
9355	<desc>Progress object to track the operation completion.</desc>
9356	</param>
9357	</method>
9358
9359	<method name="copyToGuest">
9360	<desc>
9361	Copies files/directories from host to the guest.
9362
9363	<result name="VBOX_E_IPRT_ERROR">
9364	Error while copying.
9365	</result>
9366
9367	</desc>
9368	<param name="source" type="wstring" dir="in">
9369	<desc>
9370	Source file on the host to copy.
9371	</desc>
9372	</param>
9373	<param name="dest" type="wstring" dir="in">
9374	<desc>
9375	Destination path on the guest.
9376	</desc>
9377	</param>
9378	<param name="userName" type="wstring" dir="in">
9379	<desc>
9380	User name under which the copy command will be executed; the
9381	user has to exist and have the appropriate rights to write to
9382	the destination path.
9383	</desc>
9384	</param>
9385	<param name="password" type="wstring" dir="in">
9386	<desc>
9387	Password of the user account specified.
9388	</desc>
9389	</param>
9390	<param name="flags" type="unsigned long" dir="in">
9391	<desc>
9392	<link to="CopyFileFlag"/> flags. Not used at the moment and should be set to 0.
9393	</desc>
9394	</param>
9395	<param name="progress" type="IProgress" dir="return">
9396	<desc>Progress object to track the operation completion.</desc>
9397	</param>
9398	</method>
9399
9400	<method name="directoryClose">
9401	<desc>
9402	Closes a formerly opened guest directory.
9403
9404	<result name="VBOX_E_IPRT_ERROR">
9405	Error while closing directory.
9406	</result>
9407
9408	</desc>
9409	<param name="handle" type="unsigned long" dir="in">
9410	<desc>
9411	Handle of opened directory to close.
9412	</desc>
9413	</param>
9414	</method>
9415
9416	<method name="directoryCreate">
9417	<desc>
9418	Creates a directory on the guest.
9419
9420	<result name="VBOX_E_IPRT_ERROR">
9421	Error while creating directory.
9422	</result>
9423
9424	</desc>
9425	<param name="directory" type="wstring" dir="in">
9426	<desc>
9427	Directory to create.
9428	</desc>
9429	</param>
9430	<param name="userName" type="wstring" dir="in">
9431	<desc>
9432	User name under which the directory creation will be executed; the
9433	user has to exist and have the appropriate rights to create the
9434	desired directory.
9435	</desc>
9436	</param>
9437	<param name="password" type="wstring" dir="in">
9438	<desc>
9439	Password of the user account specified.
9440	</desc>
9441	</param>
9442	<param name="mode" type="unsigned long" dir="in">
9443	<desc>
9444	File mode.
9445	</desc>
9446	</param>
9447	<param name="flags" type="unsigned long" dir="in">
9448	<desc>
9449	<link to="DirectoryCreateFlag"/> flags.
9450	</desc>
9451	</param>
9452	</method>
9453
9454	<method name="directoryOpen">
9455	<desc>
9456	Opens a directory on the guest.
9457
9458	<result name="VBOX_E_IPRT_ERROR">
9459	Error while opening / reading directory.
9460	</result>
9461
9462	</desc>
9463	<param name="directory" type="wstring" dir="in">
9464	<desc>
9465	Directory to read.
9466	</desc>
9467	</param>
9468	<param name="filter" type="wstring" dir="in">
9469	<desc>
9470	Directory filter (DOS style wildcards). Set to empty
9471	string if no filter required.
9472	</desc>
9473	</param>
9474	<param name="flags" type="unsigned long" dir="in">
9475	<desc>
9476	<link to="DirectoryOpenFlag"/> flags.
9477	</desc>
9478	</param>
9479	<param name="userName" type="wstring" dir="in">
9480	<desc>
9481	User name under which the directory reading will be performed; the
9482	user has to exist and have the appropriate rights to access / read the
9483	desired directory.
9484	</desc>
9485	</param>
9486	<param name="password" type="wstring" dir="in">
9487	<desc>
9488	Password of the user account specified.
9489	</desc>
9490	</param>
9491	<param name="handle" type="unsigned long" dir="return">
9492	<desc>
9493	Handle of opened directory returned by openDirectory.
9494	</desc>
9495	</param>
9496	</method>
9497
9498	<method name="directoryRead">
9499	<desc>
9500	Reads the next directory entry of an opened guest directory.
9501
9502	<result name="E_ABORT">
9503	When the end of the directory has been reached.
9504	</result>
9505
9506	<result name="VBOX_E_IPRT_ERROR">
9507	Error while opening / reading directory.
9508	</result>
9509
9510	</desc>
9511	<param name="handle" type="unsigned long" dir="in">
9512	<desc>
9513	Handle of opened directory returned by openDirectory.
9514	</desc>
9515	</param>
9516	<param name="entry" type="IGuestDirEntry" dir="return">
9517	<desc>
9518	Information about next directory entry on success.
9519	</desc>
9520	</param>
9521	</method>
9522
9523	<method name="fileExists">
9524	<desc>
9525	Checks if the specified file name exists and is a regular file.
9526
9527	If the file name ends with a slash or backslash, the function assumes
9528	it's a directory and will check if the specified directory exists and
9529	is a regular directory.
9530
9531	<result name="VBOX_E_IPRT_ERROR">
9532	Error while looking up information.
9533	</result>
9534
9535	</desc>
9536	<param name="file" type="wstring" dir="in">
9537	<desc>
9538	Full path of file to check.
9539	</desc>
9540	</param>
9541	<param name="userName" type="wstring" dir="in">
9542	<desc>
9543	User name under which the lookup will be performed; the
9544	user has to exist and have the appropriate rights to access / read the
9545	desired directory.
9546	</desc>
9547	</param>
9548	<param name="password" type="wstring" dir="in">
9549	<desc>
9550	Password of the user account specified.
9551	</desc>
9552	</param>
9553	<param name="exists" type="boolean" dir="return">
9554	<desc>
9555	True if it's a regular file, false if it isn't (or doesn't exist).
9556	</desc>
9557	</param>
9558	</method>
9559
9560	<method name="fileQuerySize">
9561	<desc>
9562	Queries the size of a file, given the path to it.
9563
9564	<result name="VBOX_E_IPRT_ERROR">
9565	Error while looking up information.
9566	</result>
9567
9568	</desc>
9569	<param name="file" type="wstring" dir="in">
9570	<desc>
9571	Full path of file to query file size for.
9572	</desc>
9573	</param>
9574	<param name="userName" type="wstring" dir="in">
9575	<desc>
9576	User name under which the lookup will be performed; the
9577	user has to exist and have the appropriate rights to access / read the
9578	desired directory.
9579	</desc>
9580	</param>
9581	<param name="password" type="wstring" dir="in">
9582	<desc>
9583	Password of the user account specified.
9584	</desc>
9585	</param>
9586	<param name="size" type="long long" dir="return">
9587	<desc>
9588	Size (in bytes) of file specified.
9589	</desc>
9590	</param>
9591	</method>
9592
9593	<method name="setProcessInput">
9594	<desc>
9595	Sends input into a formerly started process.
9596
9597	<result name="VBOX_E_IPRT_ERROR">
9598	Could not send input.
9599	</result>
9600
9601	</desc>
9602	<param name="pid" type="unsigned long" dir="in">
9603	<desc>
9604	Process id returned by earlier <link to="#executeProcess"/> call.
9605	</desc>
9606	</param>
9607	<param name="flags" type="unsigned long" dir="in">
9608	<desc>
9609	<link to="ProcessInputFlag"/> flags.
9610	</desc>
9611	</param>
9612	<param name="timeoutMS" type="unsigned long" dir="in">
9613	<desc>
9614	The maximum timeout value (in msec) to wait for getting the
9615	data transfered to the guest. Pass 0 for an infinite timeout.
9616	</desc>
9617	</param>
9618	<param name="data" type="octet" dir="in" safearray="yes">
9619	<desc>
9620	Buffer of input data to send to the started process to.
9621	</desc>
9622	</param>
9623	<param name="written" type="unsigned long" dir="return">
9624	<desc>
9625	Number of bytes written.
9626	</desc>
9627	</param>
9628	</method>
9629
9630	<method name="updateGuestAdditions">
9631	<desc>
9632	Updates already installed Guest Additions in a VM
9633	(Windows guests only).
9634
9635	<result name="VBOX_E_IPRT_ERROR">
9636	Error while updating.
9637	</result>
9638
9639	</desc>
9640	<param name="source" type="wstring" dir="in">
9641	<desc>
9642	Path to the Guest Additions .ISO file to use for the upate.
9643	</desc>
9644	</param>
9645	<param name="flags" type="unsigned long" dir="in">
9646	<desc>
9647	<link to="AdditionsUpdateFlag"/> flags.
9648	</desc>
9649	</param>
9650	<param name="progress" type="IProgress" dir="return">
9651	<desc>Progress object to track the operation completion.</desc>
9652	</param>
9653	</method>
9654
9655	</interface>
9656
9657
9658	<!--
9659	// IProgress
9660	/////////////////////////////////////////////////////////////////////////
9661	-->
9662
9663	<interface
9664	name="IProgress" extends="$unknown"
9665	uuid="c20238e4-3221-4d3f-8891-81ce92d9f913"
9666	wsmap="managed"
9667	>
9668	<desc>
9669	The IProgress interface is used to track and control
9670	asynchronous tasks within VirtualBox.
9671
9672	An instance of this is returned every time VirtualBox starts
9673	an asynchronous task (in other words, a separate thread) which
9674	continues to run after a method call returns. For example,
9675	<link to="IConsole::saveState" />, which saves the state of
9676	a running virtual machine, can take a long time to complete.
9677	To be able to display a progress bar, a user interface such as
9678	the VirtualBox graphical user interface can use the IProgress
9679	object returned by that method.
9680
9681	Note that IProgress is a "read-only" interface in the sense
9682	that only the VirtualBox internals behind the Main API can
9683	create and manipulate progress objects, whereas client code
9684	can only use the IProgress object to monitor a task's
9685	progress and, if <link to="#cancelable" /> is @c true,
9686	cancel the task by calling <link to="#cancel" />.
9687
9688	A task represented by IProgress consists of either one or
9689	several sub-operations that run sequentially, one by one (see
9690	<link to="#operation" /> and <link to="#operationCount" />).
9691	Every operation is identified by a number (starting from 0)
9692	and has a separate description.
9693
9694	You can find the individual percentage of completion of the current
9695	operation in <link to="#operationPercent" /> and the
9696	percentage of completion of the task as a whole
9697	in <link to="#percent" />.
9698
9699	Similarly, you can wait for the completion of a particular
9700	operation via <link to="#waitForOperationCompletion" /> or
9701	for the completion of the whole task via
9702	<link to="#waitForCompletion" />.
9703	</desc>
9704
9705	<attribute name="id" type="uuid" mod="string" readonly="yes">
9706	<desc>ID of the task.</desc>
9707	</attribute>
9708
9709	<attribute name="description" type="wstring" readonly="yes">
9710	<desc>Description of the task.</desc>
9711	</attribute>
9712
9713	<attribute name="initiator" type="$unknown" readonly="yes">
9714	<desc>Initiator of the task.</desc>
9715	</attribute>
9716
9717	<attribute name="cancelable" type="boolean" readonly="yes">
9718	<desc>Whether the task can be interrupted.</desc>
9719	</attribute>
9720
9721	<attribute name="percent" type="unsigned long" readonly="yes">
9722	<desc>
9723	Current progress value of the task as a whole, in percent.
9724	This value depends on how many operations are already complete.
9725	Returns 100 if <link to="#completed" /> is @c true.
9726	</desc>
9727	</attribute>
9728
9729	<attribute name="timeRemaining" type="long" readonly="yes">
9730	<desc>
9731	Estimated remaining time until the task completes, in
9732	seconds. Returns 0 once the task has completed; returns -1
9733	if the remaining time cannot be computed, in particular if
9734	the current progress is 0.
9735
9736	Even if a value is returned, the estimate will be unreliable
9737	for low progress values. It will become more reliable as the
9738	task progresses; it is not recommended to display an ETA
9739	before at least 20% of a task have completed.
9740	</desc>
9741	</attribute>
9742
9743	<attribute name="completed" type="boolean" readonly="yes">
9744	<desc>Whether the task has been completed.</desc>
9745	</attribute>
9746
9747	<attribute name="canceled" type="boolean" readonly="yes">
9748	<desc>Whether the task has been canceled.</desc>
9749	</attribute>
9750
9751	<attribute name="resultCode" type="long" readonly="yes">
9752	<desc>
9753	Result code of the progress task.
9754	Valid only if <link to="#completed"/> is @c true.
9755	</desc>
9756	</attribute>
9757
9758	<attribute name="errorInfo" type="IVirtualBoxErrorInfo" readonly="yes">
9759	<desc>
9760	Extended information about the unsuccessful result of the
9761	progress operation. May be @c null if no extended information
9762	is available.
9763	Valid only if <link to="#completed"/> is @c true and
9764	<link to="#resultCode"/> indicates a failure.
9765	</desc>
9766	</attribute>
9767
9768	<attribute name="operationCount" type="unsigned long" readonly="yes">
9769	<desc>
9770	Number of sub-operations this task is divided into.
9771	Every task consists of at least one suboperation.
9772	</desc>
9773	</attribute>
9774
9775	<attribute name="operation" type="unsigned long" readonly="yes">
9776	<desc>Number of the sub-operation being currently executed.</desc>
9777	</attribute>
9778
9779	<attribute name="operationDescription" type="wstring" readonly="yes">
9780	<desc>
9781	Description of the sub-operation being currently executed.
9782	</desc>
9783	</attribute>
9784
9785	<attribute name="operationPercent" type="unsigned long" readonly="yes">
9786	<desc>Progress value of the current sub-operation only, in percent.</desc>
9787	</attribute>
9788
9789	<attribute name="operationWeight" type="unsigned long" readonly="yes">
9790	<desc>Weight value of the current sub-operation only.</desc>
9791	</attribute>
9792
9793	<attribute name="timeout" type="unsigned long">
9794	<desc>
9795	When non-zero, this specifies the number of milliseconds after which
9796	the operation will automatically be canceled. This can only be set on
9797	cancelable objects.
9798	</desc>
9799	</attribute>
9800
9801	<method name="setCurrentOperationProgress">
9802	<desc>Internal method, not to be called externally.</desc>
9803	<param name="percent" type="unsigned long" dir="in" />
9804	</method>
9805	<method name="setNextOperation">
9806	<desc>Internal method, not to be called externally.</desc>
9807	<param name="nextOperationDescription" type="wstring" dir="in" />
9808	<param name="nextOperationsWeight" type="unsigned long" dir="in" />
9809	</method>
9810
9811	<method name="waitForCompletion">
9812	<desc>
9813	Waits until the task is done (including all sub-operations)
9814	with a given timeout in milliseconds; specify -1 for an indefinite wait.
9815
9816	Note that the VirtualBox/XPCOM/COM/native event queues of the calling
9817	thread are not processed while waiting. Neglecting event queues may
9818	have dire consequences (degrade performance, resource hogs,
9819	deadlocks, etc.), this is specially so for the main thread on
9820	platforms using XPCOM. Callers are adviced wait for short periods
9821	and service their event queues between calls, or to create a worker
9822	thread to do the waiting.
9823
9824	<result name="VBOX_E_IPRT_ERROR">
9825	Failed to wait for task completion.
9826	</result>
9827	</desc>
9828
9829	<param name="timeout" type="long" dir="in">
9830	<desc>
9831	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9832	</desc>
9833	</param>
9834	</method>
9835
9836	<method name="waitForOperationCompletion">
9837	<desc>
9838	Waits until the given operation is done with a given timeout in
9839	milliseconds; specify -1 for an indefinite wait.
9840
9841	See <link to="#waitForCompletion"> for event queue considerations.</link>
9842
9843	<result name="VBOX_E_IPRT_ERROR">
9844	Failed to wait for operation completion.
9845	</result>
9846
9847	</desc>
9848	<param name="operation" type="unsigned long" dir="in">
9849	<desc>
9850	Number of the operation to wait for.
9851	Must be less than <link to="#operationCount"/>.
9852	</desc>
9853	</param>
9854	<param name="timeout" type="long" dir="in">
9855	<desc>
9856	Maximum time in milliseconds to wait or -1 to wait indefinitely.
9857	</desc>
9858	</param>
9859	</method>
9860
9861	<method name="waitForAsyncProgressCompletion">
9862	<desc>
9863	Waits until the other task is completed (including all
9864	sub-operations) and forward all changes from the other progress to
9865	this progress. This means sub-operation number, description, percent
9866	and so on.
9867
9868	You have to take care on setting up at least the same count on
9869	sub-operations in this progress object like there are in the other
9870	progress object.
9871
9872	If the other progress object supports cancel and this object gets any
9873	cancel request (when here enabled as well), it will be forwarded to
9874	the other progress object.
9875
9876	If there is an error in the other progress, this error isn't
9877	automatically transfered to this progress object. So you have to
9878	check any operation error within the other progress object, after
9879	this method returns.
9880	</desc>
9881
9882	<param name="pProgressAsync" type="IProgress" dir="in">
9883	<desc>
9884	The progress object of the asynchrony process.
9885	</desc>
9886	</param>
9887	</method>
9888
9889	<method name="cancel">
9890	<desc>
9891	Cancels the task.
9892	<note>
9893	If <link to="#cancelable"/> is @c false, then this method will fail.
9894	</note>
9895
9896	<result name="VBOX_E_INVALID_OBJECT_STATE">
9897	Operation cannot be canceled.
9898	</result>
9899
9900	</desc>
9901	</method>
9902
9903	</interface>
9904
9905	<!--
9906	// ISnapshot
9907	/////////////////////////////////////////////////////////////////////////
9908	-->
9909
9910	<interface
9911	name="ISnapshot" extends="$unknown"
9912	uuid="0472823b-c6e7-472a-8e9f-d732e86b8463"
9913	wsmap="managed"
9914	>
9915	<desc>
9916	The ISnapshot interface represents a snapshot of the virtual
9917	machine.
9918
9919	Together with the differencing media that are created
9920	when a snapshot is taken, a machine can be brought back to
9921	the exact state it was in when the snapshot was taken.
9922
9923	The ISnapshot interface has no methods, only attributes; snapshots
9924	are controlled through methods of the <link to="IConsole" /> interface
9925	which also manage the media associated with the snapshot.
9926	The following operations exist:
9927
9928	<ul>
9929	<li><link to="IConsole::takeSnapshot"/> creates a new snapshot
9930	by creating new, empty differencing images for the machine's
9931	media and saving the VM settings and (if the VM is running)
9932	the current VM state in the snapshot.
9933
9934	The differencing images will then receive all data written to
9935	the machine's media, while their parent (base) images
9936	remain unmodified after the snapshot has been taken (see
9937	<link to="IMedium" /> for details about differencing images).
9938	This simplifies restoring a machine to the state of a snapshot:
9939	only the differencing images need to be deleted.
9940
9941	The current machine state is not changed by taking a snapshot
9942	except that <link to="IMachine::currentSnapshot" /> is set to
9943	the newly created snapshot, which is also added to the machine's
9944	snapshots tree.
9945	</li>
9946
9947	<li><link to="IConsole::restoreSnapshot"/> resets a machine to
9948	the state of a previous snapshot by deleting the differencing
9949	image of each of the machine's media and setting the machine's
9950	settings and state to the state that was saved in the snapshot (if any).
9951
9952	This destroys the machine's current state. After calling this,
9953	<link to="IMachine::currentSnapshot" /> points to the snapshot
9954	that was restored.
9955	</li>
9956
9957	<li><link to="IConsole::deleteSnapshot"/> deletes a snapshot
9958	without affecting the current machine state.
9959
9960	This does not change the current machine state, but instead frees the
9961	resources allocated when the snapshot was taken: the settings and machine
9962	state file are deleted (if any), and the snapshot's differencing image for
9963	each of the machine's media gets merged with its parent image.
9964
9965	Neither the current machine state nor other snapshots are affected
9966	by this operation, except that parent media will be modified
9967	to contain the disk data associated with the snapshot being deleted.
9968
9969	When deleting the current snapshot, the <link to="IMachine::currentSnapshot" />
9970	attribute is set to the current snapshot's parent or NULL if it
9971	has no parent. Otherwise the attribute is unchanged.
9972	</li>
9973	</ul>
9974
9975	Each snapshot contains a copy of virtual machine's settings (hardware
9976	configuration etc.). This copy is contained in an immutable (read-only)
9977	instance of <link to="IMachine" /> which is available from the snapshot's
9978	<link to="#machine" /> attribute. When restoring the snapshot, these
9979	settings are copied back to the original machine.
9980
9981	In addition, if the machine was running when the
9982	snapshot was taken (<link to="IMachine::state"/> is <link to="MachineState_Running"/>),
9983	the current VM state is saved in the snapshot (similarly to what happens
9984	when a VM's state is saved). The snapshot is then said to be <i>online</i>
9985	because when restoring it, the VM will be running.
9986
9987	If the machine was in <link to="MachineState_Saved">saved</link> saved,
9988	the snapshot receives a copy of the execution state file
9989	(<link to="IMachine::stateFilePath"/>).
9990
9991	Otherwise, if the machine was not running (<link to="MachineState_PoweredOff"/>
9992	or <link to="MachineState_Aborted"/>), the snapshot is <i>offline</i>;
9993	it then contains a so-called "zero execution state", representing a
9994	machine that is powered off.
9995	</desc>
9996
9997	<attribute name="id" type="uuid" mod="string" readonly="yes">
9998	<desc>UUID of the snapshot.</desc>
9999	</attribute>
10000
10001	<attribute name="name" type="wstring">
10002	<desc>Short name of the snapshot.
10003	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10004	be called implicitly.</note>
10005	</desc>
10006	</attribute>
10007
10008	<attribute name="description" type="wstring">
10009	<desc>Optional description of the snapshot.
10010	<note>Setting this attribute causes <link to="IMachine::saveSettings" /> to
10011	be called implicitly.</note>
10012	</desc>
10013	</attribute>
10014
10015	<attribute name="timeStamp" type="long long" readonly="yes">
10016	<desc>
10017	Time stamp of the snapshot, in milliseconds since 1970-01-01 UTC.
10018	</desc>
10019	</attribute>
10020
10021	<attribute name="online" type="boolean" readonly="yes">
10022	<desc>
10023	@c true if this snapshot is an online snapshot and @c false otherwise.
10024
10025	When this attribute is @c true, the
10026	<link to="IMachine::stateFilePath"/> attribute of the
10027	<link to="#machine"/> object associated with this snapshot
10028	will point to the saved state file. Otherwise, it will be
10029	an empty string.
10030	</desc>
10031	</attribute>
10032
10033	<attribute name="machine" type="IMachine" readonly="yes">
10034	<desc>
10035	Virtual machine this snapshot is taken on. This object
10036	stores all settings the machine had when taking this snapshot.
10037	<note>
10038	The returned machine object is immutable, i.e. no
10039	any settings can be changed.
10040	</note>
10041	</desc>
10042	</attribute>
10043
10044	<attribute name="parent" type="ISnapshot" readonly="yes">
10045	<desc>
10046	Parent snapshot (a snapshot this one is based on), or
10047	@c null if the snapshot has no parent (i.e. is the first snapshot).
10048	</desc>
10049	</attribute>
10050
10051	<attribute name="children" type="ISnapshot" readonly="yes" safearray="yes">
10052	<desc>
10053	Child snapshots (all snapshots having this one as a parent).
10054	By inspecting this attribute starting with a machine's root snapshot
10055	(which can be obtained by calling <link to="IMachine::findSnapshot" />
10056	with a @c null UUID), a machine's snapshots tree can be iterated over.
10057	</desc>
10058	</attribute>
10059
10060	<method name="getChildrenCount" const="yes">
10061	<desc>
10062	Returns the number of direct childrens of this snapshot.
10063	</desc>
10064	<param name="childrenCount" type="unsigned long" dir="return">
10065	<desc>
10066	</desc>
10067	</param>
10068	</method>
10069
10070	</interface>
10071
10072
10073	<!--
10074	// IMedium
10075	/////////////////////////////////////////////////////////////////////////
10076	-->
10077
10078	<enum
10079	name="MediumState"
10080	uuid="ef41e980-e012-43cd-9dea-479d4ef14d13"
10081	>
10082	<desc>
10083	Virtual medium state.
10084	<see><link to="IMedium"/></see>
10085	</desc>
10086
10087	<const name="NotCreated" value="0">
10088	<desc>
10089	Associated medium storage does not exist (either was not created yet or
10090	was deleted).
10091	</desc>
10092	</const>
10093	<const name="Created" value="1">
10094	<desc>
10095	Associated storage exists and accessible; this gets set if the
10096	accessibility check performed by <link to="IMedium::refreshState" />
10097	was successful.
10098	</desc>
10099	</const>
10100	<const name="LockedRead" value="2">
10101	<desc>
10102	Medium is locked for reading (see <link to="IMedium::lockRead"/>),
10103	no data modification is possible.
10104	</desc>
10105	</const>
10106	<const name="LockedWrite" value="3">
10107	<desc>
10108	Medium is locked for writing (see <link to="IMedium::lockWrite"/>),
10109	no concurrent data reading or modification is possible.
10110	</desc>
10111	</const>
10112	<const name="Inaccessible" value="4">
10113	<desc>
10114	Medium accessibility check (see <link to="IMedium::refreshState" />) has
10115	not yet been performed, or else, associated medium storage is not
10116	accessible. In the first case, <link to="IMedium::lastAccessError"/>
10117	is empty, in the second case, it describes the error that occurred.
10118	</desc>
10119	</const>
10120	<const name="Creating" value="5">
10121	<desc>
10122	Associated medium storage is being created.
10123	</desc>
10124	</const>
10125	<const name="Deleting" value="6">
10126	<desc>
10127	Associated medium storage is being deleted.
10128	</desc>
10129	</const>
10130	</enum>
10131
10132	<enum
10133	name="MediumType"
10134	uuid="fe663fb5-c244-4e1b-9d81-c628b417dd04"
10135	>
10136	<desc>
10137	Virtual medium type. For each <link to="IMedium" />, this defines how the medium is
10138	attached to a virtual machine (see <link to="IMediumAttachment" />) and what happens
10139	when a snapshot (see <link to="ISnapshot" />) is taken of a virtual machine which has
10140	the medium attached. At the moment DVD and floppy media are always of type "writethrough".
10141	</desc>
10142
10143	<const name="Normal" value="0">
10144	<desc>
10145	Normal medium (attached directly or indirectly, preserved
10146	when taking snapshots).
10147	</desc>
10148	</const>
10149	<const name="Immutable" value="1">
10150	<desc>
10151	Immutable medium (attached indirectly, changes are wiped out
10152	the next time the virtual machine is started).
10153	</desc>
10154	</const>
10155	<const name="Writethrough" value="2">
10156	<desc>
10157	Write through medium (attached directly, ignored when
10158	taking snapshots).
10159	</desc>
10160	</const>
10161	<const name="Shareable" value="3">
10162	<desc>
10163	Allow using this medium concurrently by several machines.
10164	<note>Present since VirtualBox 3.2.0, and accepted since 3.2.8.</note>
10165	</desc>
10166	</const>
10167	<const name="Readonly" value="4">
10168	<desc>
10169	A readonly medium, which can of course be used by several machines.
10170	<note>Present and accepted since VirtualBox 4.0.</note>
10171	</desc>
10172	</const>
10173	<const name="MultiAttach" value="5">
10174	<desc>
10175	A medium which is is indirectly attached, so that one base medium can
10176	be used for several VMs which have their own differencing medium to
10177	store their modifications. In some sense a variant of Immutable
10178	with unset AutoReset flag in each differencing medium.
10179	<note>Present and accepted since VirtualBox 4.0.</note>
10180	</desc>
10181	</const>
10182	</enum>
10183
10184	<enum
10185	name="MediumVariant"
10186	uuid="584ea502-143b-4ab0-ad14-d1028fdf0316"
10187	>
10188	<desc>
10189	Virtual medium image variant. More than one flag may be set.
10190	<see><link to="IMedium"/></see>
10191	</desc>
10192
10193	<const name="Standard" value="0">
10194	<desc>
10195	No particular variant requested, results in using the backend default.
10196	</desc>
10197	</const>
10198	<const name="VmdkSplit2G" value="0x01">
10199	<desc>
10200	VMDK image split in chunks of less than 2GByte.
10201	</desc>
10202	</const>
10203	<const name="VmdkStreamOptimized" value="0x04">
10204	<desc>
10205	VMDK streamOptimized image. Special import/export format which is
10206	read-only/append-only.
10207	</desc>
10208	</const>
10209	<const name="VmdkESX" value="0x08">
10210	<desc>
10211	VMDK format variant used on ESX products.
10212	</desc>
10213	</const>
10214	<const name="Fixed" value="0x10000">
10215	<desc>
10216	Fixed image. Only allowed for base images.
10217	</desc>
10218	</const>
10219	<const name="Diff" value="0x20000">
10220	<desc>
10221	Differencing image. Only allowed for child images.
10222	</desc>
10223	</const>
10224	<const name="NoCreateDir" value="0x40000000">
10225	<desc>
10226	Special flag which suppresses automatic creation of the subdirectory.
10227	Only used when passing the medium variant as an input parameter.
10228	</desc>
10229	</const>
10230	</enum>
10231
10232	<interface
10233	name="IMediumAttachment" extends="$unknown"
10234	uuid="5ee464d6-0613-4331-b154-7ce12170ef9f"
10235	wsmap="struct"
10236	>
10237	<desc>
10238	The IMediumAttachment interface links storage media to virtual machines.
10239	For each medium (<link to="IMedium"/>) which has been attached to a
10240	storage controller (<link to="IStorageController"/>) of a machine
10241	(<link to="IMachine"/>) via the <link to="IMachine::attachDevice" />
10242	method, one instance of IMediumAttachment is added to the machine's
10243	<link to="IMachine::mediumAttachments"/> array attribute.
10244
10245	Each medium attachment specifies the storage controller as well as a
10246	port and device number and the IMedium instance representing a virtual
10247	hard disk or floppy or DVD image.
10248
10249	For removable media (DVDs or floppies), there are two additional
10250	options. For one, the IMedium instance can be @c null to represent
10251	an empty drive with no media inserted (see <link to="IMachine::mountMedium" />);
10252	secondly, the medium can be one of the pseudo-media for host drives
10253	listed in <link to="IHost::DVDDrives"/> or <link to="IHost::floppyDrives"/>.
10254
10255	<h3>Attaching Hard Disks</h3>
10256
10257	Hard disks are attached to virtual machines using the
10258	<link to="IMachine::attachDevice"/> method and detached using the
10259	<link to="IMachine::detachDevice"/> method. Depending on a medium's
10260	type (see <link to="IMedium::type" />), hard disks are attached either
10261	<i>directly</i> or <i>indirectly</i>.
10262
10263	When a hard disk is being attached directly, it is associated with the
10264	virtual machine and used for hard disk operations when the machine is
10265	running. When a hard disk is being attached indirectly, a new differencing
10266	hard disk linked to it is implicitly created and this differencing hard
10267	disk is associated with the machine and used for hard disk operations.
10268	This also means that if <link to="IMachine::attachDevice"/> performs
10269	a direct attachment then the same hard disk will be returned in response
10270	to the subsequent <link to="IMachine::getMedium"/> call; however if
10271	an indirect attachment is performed then
10272	<link to="IMachine::getMedium"/> will return the implicitly created
10273	differencing hard disk, not the original one passed to <link
10274	to="IMachine::attachDevice"/>. In detail:
10275
10276	<ul>
10277	<li><b>Normal base</b> hard disks that do not have children (i.e.
10278	differencing hard disks linked to them) and that are not already
10279	attached to virtual machines in snapshots are attached <b>directly</b>.
10280	Otherwise, they are attached <b>indirectly</b> because having
10281	dependent children or being part of the snapshot makes it impossible
10282	to modify hard disk contents without breaking the integrity of the
10283	dependent party. The <link to="IMedium::readOnly"/> attribute allows to
10284	quickly determine the kind of the attachment for the given hard
10285	disk. Note that if a normal base hard disk is to be indirectly
10286	attached to a virtual machine with snapshots then a special
10287	procedure called <i>smart attachment</i> is performed (see below).</li>
10288	<li><b>Normal differencing</b> hard disks are like normal base hard disks:
10289	they are attached <b>directly</b> if they do not have children and are
10290	not attached to virtual machines in snapshots, and <b>indirectly</b>
10291	otherwise. Note that the smart attachment procedure is never performed
10292	for differencing hard disks.</li>
10293	<li><b>Immutable</b> hard disks are always attached <b>indirectly</b> because
10294	they are designed to be non-writable. If an immutable hard disk is
10295	attached to a virtual machine with snapshots then a special
10296	procedure called smart attachment is performed (see below).</li>
10297	<li><b>Writethrough</b> hard disks are always attached <b>directly</b>,
10298	also as designed. This also means that writethrough hard disks cannot
10299	have other hard disks linked to them at all.</li>
10300	<li><b>Shareable</b> hard disks are always attached <b>directly</b>,
10301	also as designed. This also means that shareable hard disks cannot
10302	have other hard disks linked to them at all. They behave almost
10303	like writethrough hard disks, except that shareable hard disks can
10304	be attached to several virtual machines which are running, allowing
10305	concurrent accesses. You need special cluster software running in
10306	the virtual machines to make use of such disks.</li>
10307	</ul>
10308
10309	Note that the same hard disk, regardless of its type, may be attached to
10310	more than one virtual machine at a time. In this case, the machine that is
10311	started first gains exclusive access to the hard disk and attempts to
10312	start other machines having this hard disk attached will fail until the
10313	first machine is powered down.
10314
10315	Detaching hard disks is performed in a <i>deferred</i> fashion. This means
10316	that the given hard disk remains associated with the given machine after a
10317	successful <link to="IMachine::detachDevice"/> call until
10318	<link to="IMachine::saveSettings"/> is called to save all changes to
10319	machine settings to disk. This deferring is necessary to guarantee that
10320	the hard disk configuration may be restored at any time by a call to
10321	<link to="IMachine::discardSettings"/> before the settings
10322	are saved (committed).
10323
10324	Note that if <link to="IMachine::discardSettings"/> is called after
10325	indirectly attaching some hard disks to the machine but before a call to
10326	<link to="IMachine::saveSettings"/> is made, it will implicitly delete
10327	all differencing hard disks implicitly created by
10328	<link to="IMachine::attachDevice"/> for these indirect attachments.
10329	Such implicitly created hard disks will also be immediately deleted when
10330	detached explicitly using the <link to="IMachine::detachDevice"/>
10331	call if it is made before <link to="IMachine::saveSettings"/>. This
10332	implicit deletion is safe because newly created differencing hard
10333	disks do not contain any user data.
10334
10335	However, keep in mind that detaching differencing hard disks that were
10336	implicitly created by <link to="IMachine::attachDevice"/>
10337	before the last <link to="IMachine::saveSettings"/> call will
10338	<b>not</b> implicitly delete them as they may already contain some data
10339	(for example, as a result of virtual machine execution). If these hard
10340	disks are no more necessary, the caller can always delete them explicitly
10341	using <link to="IMedium::deleteStorage"/> after they are actually de-associated
10342	from this machine by the <link to="IMachine::saveSettings"/> call.
10343
10344	<h3>Smart Attachment</h3>
10345
10346	When normal base or immutable hard disks are indirectly attached to a
10347	virtual machine then some additional steps are performed to make sure the
10348	virtual machine will have the most recent "view" of the hard disk being
10349	attached. These steps include walking through the machine's snapshots
10350	starting from the current one and going through ancestors up to the first
10351	snapshot. Hard disks attached to the virtual machine in all
10352	of the encountered snapshots are checked whether they are descendants of
10353	the given normal base or immutable hard disk. The first found child (which
10354	is the differencing hard disk) will be used instead of the normal base or
10355	immutable hard disk as a parent for creating a new differencing hard disk
10356	that will be actually attached to the machine. And only if no descendants
10357	are found or if the virtual machine does not have any snapshots then the
10358	normal base or immutable hard disk will be used itself as a parent for
10359	this differencing hard disk.
10360
10361	It is easier to explain what smart attachment does using the
10362	following example:
10363	<pre>
10364	BEFORE attaching B.vdi: AFTER attaching B.vdi:
10365
10366	Snapshot 1 (B.vdi) Snapshot 1 (B.vdi)
10367	Snapshot 2 (D1->B.vdi) Snapshot 2 (D1->B.vdi)
10368	Snapshot 3 (D2->D1.vdi) Snapshot 3 (D2->D1.vdi)
10369	Snapshot 4 (none) Snapshot 4 (none)
10370	CurState (none) CurState (D3->D2.vdi)
10371
10372	NOT
10373	...
10374	CurState (D3->B.vdi)
10375	</pre>
10376	The first column is the virtual machine configuration before the base hard
10377	disk <tt>B.vdi</tt> is attached, the second column shows the machine after
10378	this hard disk is attached. Constructs like <tt>D1->B.vdi</tt> and similar
10379	mean that the hard disk that is actually attached to the machine is a
10380	differencing hard disk, <tt>D1.vdi</tt>, which is linked to (based on)
10381	another hard disk, <tt>B.vdi</tt>.
10382
10383	As we can see from the example, the hard disk <tt>B.vdi</tt> was detached
10384	from the machine before taking Snapshot 4. Later, after Snapshot 4 was
10385	taken, the user decides to attach <tt>B.vdi</tt> again. <tt>B.vdi</tt> has
10386	dependent child hard disks (<tt>D1.vdi</tt>, <tt>D2.vdi</tt>), therefore
10387	it cannot be attached directly and needs an indirect attachment (i.e.
10388	implicit creation of a new differencing hard disk). Due to the smart
10389	attachment procedure, the new differencing hard disk
10390	(<tt>D3.vdi</tt>) will be based on <tt>D2.vdi</tt>, not on
10391	<tt>B.vdi</tt> itself, since <tt>D2.vdi</tt> is the most recent view of
10392	<tt>B.vdi</tt> existing for this snapshot branch of the given virtual
10393	machine.
10394
10395	Note that if there is more than one descendant hard disk of the given base
10396	hard disk found in a snapshot, and there is an exact device, channel and
10397	bus match, then this exact match will be used. Otherwise, the youngest
10398	descendant will be picked up.
10399
10400	There is one more important aspect of the smart attachment procedure which
10401	is not related to snapshots at all. Before walking through the snapshots
10402	as described above, the backup copy of the current list of hard disk
10403	attachment is searched for descendants. This backup copy is created when
10404	the hard disk configuration is changed for the first time after the last
10405	<link to="IMachine::saveSettings"/> call and used by
10406	<link to="IMachine::discardSettings"/> to undo the recent hard disk
10407	changes. When such a descendant is found in this backup copy, it will be
10408	simply re-attached back, without creating a new differencing hard disk for
10409	it. This optimization is necessary to make it possible to re-attach the
10410	base or immutable hard disk to a different bus, channel or device slot
10411	without losing the contents of the differencing hard disk actually
10412	attached to the machine in place of it.
10413
10414	</desc>
10415
10416	<attribute name="medium" type="IMedium" readonly="yes">
10417	<desc>Medium object associated with this attachment; it
10418	can be @c null for removable devices.</desc>
10419	</attribute>
10420
10421	<attribute name="controller" type="wstring" readonly="yes">
10422	<desc>Name of the storage controller of this attachment; this
10423	refers to one of the controllers in <link to="IMachine::storageControllers" />
10424	by name.</desc>
10425	</attribute>
10426
10427	<attribute name="port" type="long" readonly="yes">
10428	<desc>Port number of this attachment.
10429	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10430	</desc>
10431	</attribute>
10432
10433	<attribute name="device" type="long" readonly="yes">
10434	<desc>Device slot number of this attachment.
10435	See <link to="IMachine::attachDevice" /> for the meaning of this value for the different controller types.
10436	</desc>
10437	</attribute>
10438
10439	<attribute name="type" type="DeviceType" readonly="yes">
10440	<desc>Device type of this attachment.</desc>
10441	</attribute>
10442
10443	<attribute name="passthrough" type="boolean" readonly="yes">
10444	<desc>Pass I/O requests through to a device on the host.</desc>
10445	</attribute>
10446
10447	<attribute name="temporaryEject" type="boolean" readonly="yes">
10448	<desc>Whether guest-triggered eject results in unmounting the medium.</desc>
10449	</attribute>
10450
10451	<attribute name="isEjected" type="boolean" readonly="yes">
10452	<desc>Signals that the removable medium has been ejected. This is not
10453	necessarily equivalent to having a @c null medium association.</desc>
10454	</attribute>
10455
10456	<attribute name="nonRotational" type="boolean" readonly="yes">
10457	<desc>Whether the associated medium is non-rotational.</desc>
10458	</attribute>
10459
10460	<attribute name="discard" type="boolean" readonly="yes">
10461	<desc>Whether the associated medium supports discarding unused blocks.</desc>
10462	</attribute>
10463
10464	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
10465	<desc>The bandwidth group this medium attachment is assigned to.</desc>
10466	</attribute>
10467
10468	</interface>
10469
10470	<interface
10471	name="IMedium" extends="$unknown"
10472	uuid="53f9cc0c-e0fd-40a5-a404-a7a5272082cd"
10473	wsmap="managed"
10474	>
10475	<desc>
10476	The IMedium interface represents virtual storage for a machine's
10477	hard disks, CD/DVD or floppy drives. It will typically represent
10478	a disk image on the host, for example a VDI or VMDK file representing
10479	a virtual hard disk, or an ISO or RAW file representing virtual
10480	removable media, but can also point to a network location (e.g.
10481	for iSCSI targets).
10482
10483	Instances of IMedium are connected to virtual machines by way of medium
10484	attachments, which link the storage medium to a particular device slot
10485	of a storage controller of the virtual machine.
10486	In the VirtualBox API, virtual storage is therefore always represented
10487	by the following chain of object links:
10488
10489	<ul>
10490	<li><link to="IMachine::storageControllers"/> contains an array of
10491	storage controllers (IDE, SATA, SCSI, SAS or a floppy controller;
10492	these are instances of <link to="IStorageController"/>).</li>
10493	<li><link to="IMachine::mediumAttachments"/> contains an array of
10494	medium attachments (instances of <link to="IMediumAttachment"/>
10495	created by <link to="IMachine::attachDevice" />),
10496	each containing a storage controller from the above array, a
10497	port/device specification, and an instance of IMedium representing
10498	the medium storage (image file).
10499
10500	For removable media, the storage medium is optional; a medium
10501	attachment with no medium represents a CD/DVD or floppy drive
10502	with no medium inserted. By contrast, hard disk attachments
10503	will always have an IMedium object attached.</li>
10504	<li>Each IMedium in turn points to a storage unit (such as a file
10505	on the host computer or a network resource) that holds actual
10506	data. This location is represented by the <link to="#location"/>
10507	attribute.</li>
10508	</ul>
10509
10510	Existing media are opened using <link to="IVirtualBox::openMedium"/>;
10511	new hard disk media can be created with the VirtualBox API using the
10512	<link to="IVirtualBox::createHardDisk"/> method. Differencing hard
10513	disks (see below) are usually implicitly created by VirtualBox as
10514	needed, but may also be created explicitly using <link to="#createDiffStorage"/>.
10515	VirtualBox cannot create CD/DVD or floppy images (ISO and RAW files); these
10516	should be created with external tools and then opened from within VirtualBox.
10517
10518	Only for CD/DVDs and floppies, an IMedium instance can also represent a host
10519	drive. In that case the <link to="#id" /> attribute contains the UUID of
10520	one of the drives in <link to="IHost::DVDDrives" /> or <link to="IHost::floppyDrives" />.
10521
10522	<h3>Media registries</h3>
10523
10524	When a medium has been opened or created using one of the aforementioned
10525	APIs, it becomes "known" to VirtualBox. Known media can be attached
10526	to virtual machines and accessed through <link to="IVirtualBox::findMedium"/>.
10527	They also appear in the global
10528	<link to="IVirtualBox::hardDisks" />,
10529	<link to="IVirtualBox::DVDImages" /> and
10530	<link to="IVirtualBox::floppyImages" /> arrays.
10531
10532	Prior to VirtualBox 4.0, opening a medium added it to a global media registry
10533	in the VirtualBox.xml file, which was shared between all machines and made
10534	transporting machines and their media from one host to another difficult.
10535
10536	Starting with VirtualBox 4.0, media are only added to a registry when they are
10537	<i>attached</i> to a machine using <link to="IMachine::attachDevice" />. For
10538	backwards compatibility, which registry a medium is added to depends on which
10539	VirtualBox version created a machine:
10540
10541	<ul>
10542	<li>If the medium has first been attached to a machine which was created by
10543	VirtualBox 4.0 or later, it is added to that machine's media registry in
10544	the machine XML settings file. This way all information about a machine's
10545	media attachments is contained in a single file and can be transported
10546	easily.</li>
10547	<li>For older media attachments (i.e. if the medium was first attached to a
10548	machine which was created with a VirtualBox version before 4.0), media
10549	continue to be registered in the global VirtualBox settings file, for
10550	backwards compatibility.</li>
10551	</ul>
10552
10553	See <link to="IVirtualBox::openMedium" /> for more information.
10554
10555	Media are removed from media registries by the <link to="IMedium::close"/>,
10556	<link to="#deleteStorage"/> and <link to="#mergeTo"/> methods.
10557
10558	<h3>Accessibility checks</h3>
10559
10560	VirtualBox defers media accessibility checks until the <link to="#refreshState" />
10561	method is called explicitly on a medium. This is done to make the VirtualBox object
10562	ready for serving requests as fast as possible and let the end-user
10563	application decide if it needs to check media accessibility right away or not.
10564
10565	As a result, when VirtualBox starts up (e.g. the VirtualBox
10566	object gets created for the first time), all known media are in the
10567	"Inaccessible" state, but the value of the <link to="#lastAccessError"/>
10568	attribute is an empty string because no actual accessibility check has
10569	been made yet.
10570
10571	After calling <link to="#refreshState" />, a medium is considered
10572	<i>accessible</i> if its storage unit can be read. In that case, the
10573	<link to="#state"/> attribute has a value of "Created". If the storage
10574	unit cannot be read (for example, because it is located on a disconnected
10575	network resource, or was accidentally deleted outside VirtualBox),
10576	the medium is considered <i>inaccessible</i>, which is indicated by the
10577	"Inaccessible" state. The exact reason why the medium is inaccessible can be
10578	obtained by reading the <link to="#lastAccessError"/> attribute.
10579
10580	<h3>Medium types</h3>
10581
10582	There are five types of medium behavior which are stored in the
10583	<link to="#type"/> attribute (see <link to="MediumType" />) and
10584	which define the medium's behavior with attachments and snapshots.
10585
10586	All media can be also divided in two groups: <i>base</i> media and
10587	<i>differencing</i> media. A base medium contains all sectors of the
10588	medium data in its own storage and therefore can be used independently.
10589	In contrast, a differencing medium is a "delta" to some other medium and
10590	contains only those sectors which differ from that other medium, which is
10591	then called a <i>parent</i>. The differencing medium is said to be
10592	<i>linked to</i> that parent. The parent may be itself a differencing
10593	medium, thus forming a chain of linked media. The last element in that
10594	chain must always be a base medium. Note that several differencing
10595	media may be linked to the same parent medium.
10596
10597	Differencing media can be distinguished from base media by querying the
10598	<link to="#parent"/> attribute: base media do not have parents they would
10599	depend on, so the value of this attribute is always @c null for them.
10600	Using this attribute, it is possible to walk up the medium tree (from the
10601	child medium to its parent). It is also possible to walk down the tree
10602	using the <link to="#children"/> attribute.
10603
10604	Note that the type of all differencing media is "normal"; all other
10605	values are meaningless for them. Base media may be of any type.
10606
10607	<h3>Automatic composition of the file name part</h3>
10608
10609	Another extension to the <link to="IMedium::location"/> attribute is that
10610	there is a possibility to cause VirtualBox to compose a unique value for
10611	the file name part of the location using the UUID of the hard disk. This
10612	applies only to hard disks in <link to="MediumState_NotCreated"/> state,
10613	e.g. before the storage unit is created, and works as follows. You set the
10614	value of the <link to="IMedium::location"/> attribute to a location
10615	specification which only contains the path specification but not the file
10616	name part and ends with either a forward slash or a backslash character.
10617	In response, VirtualBox will generate a new UUID for the hard disk and
10618	compose the file name using the following pattern:
10619	<pre>
10620	<path>/{<uuid>}.<ext>
10621	</pre>
10622	where <tt><path></tt> is the supplied path specification,
10623	<tt><uuid></tt> is the newly generated UUID and <tt><ext></tt>
10624	is the default extension for the storage format of this hard disk. After
10625	that, you may call any of the methods that create a new hard disk storage
10626	unit and they will use the generated UUID and file name.
10627	</desc>
10628
10629	<attribute name="id" type="uuid" mod="string" readonly="yes">
10630	<desc>
10631	UUID of the medium. For a newly created medium, this value is a randomly
10632	generated UUID.
10633
10634	<note>
10635	For media in one of MediumState_NotCreated, MediumState_Creating or
10636	MediumState_Deleting states, the value of this property is undefined
10637	and will most likely be an empty UUID.
10638	</note>
10639	</desc>
10640	</attribute>
10641
10642	<attribute name="description" type="wstring">
10643	<desc>
10644	Optional description of the medium. For a newly created medium the value
10645	of this attribute is an empty string.
10646
10647	Medium types that don't support this attribute will return E_NOTIMPL in
10648	attempt to get or set this attribute's value.
10649
10650	<note>
10651	For some storage types, reading this attribute may return an outdated
10652	(last known) value when <link to="#state"/> is <link
10653	to="MediumState_Inaccessible"/> or <link
10654	to="MediumState_LockedWrite"/> because the value of this attribute is
10655	stored within the storage unit itself. Also note that changing the
10656	attribute value is not possible in such case, as well as when the
10657	medium is the <link to="MediumState_LockedRead"/> state.
10658	</note>
10659	</desc>
10660	</attribute>
10661
10662	<attribute name="state" type="MediumState" readonly="yes">
10663	<desc>
10664	Returns the current medium state, which is the last state set by
10665	the accessibility check performed by <link to="#refreshState"/>.
10666	If that method has not yet been called on the medium, the state
10667	is "Inaccessible"; as opposed to truly inaccessible media, the
10668	value of <link to="#lastAccessError"/> will be an empty string in
10669	that case.
10670
10671	<note>As of version 3.1, this no longer performs an accessibility check
10672	automatically; call <link to="#refreshState"/> for that.
10673	</note>
10674	</desc>
10675	</attribute>
10676
10677	<attribute name="variant" type="unsigned long" readonly="yes">
10678	<desc>
10679	Returns the storage format variant information for this medium
10680	as a combination of the flags described at <link to="MediumVariant" />.
10681	Before <link to="#refreshState"/> is called this method returns
10682	an undefined value.
10683	</desc>
10684	</attribute>
10685
10686	<attribute name="location" type="wstring">
10687	<desc>
10688	Location of the storage unit holding medium data.
10689
10690	The format of the location string is medium type specific. For medium
10691	types using regular files in a host's file system, the location
10692	string is the full file name.
10693
10694	Some medium types may support changing the storage unit location by
10695	simply changing the value of this property. If this operation is not
10696	supported, the implementation will return E_NOTIMPL in attempt to set
10697	this attribute's value.
10698
10699	When setting a value of the location attribute which is a regular file
10700	in the host's file system, the given file name may be either relative to
10701	the <link to="IVirtualBox::homeFolder">VirtualBox home folder</link> or
10702	absolute. Note that if the given location specification does not contain
10703	the file extension part then a proper default extension will be
10704	automatically appended by the implementation depending on the medium type.
10705	</desc>
10706	</attribute>
10707
10708	<attribute name="name" type="wstring" readonly="yes">
10709	<desc>
10710	Name of the storage unit holding medium data.
10711
10712	The returned string is a short version of the <link to="#location"/>
10713	attribute that is suitable for representing the medium in situations
10714	where the full location specification is too long (such as lists
10715	and comboboxes in GUI frontends). This string is also used by frontends
10716	to sort the media list alphabetically when needed.
10717
10718	For example, for locations that are regular files in the host's file
10719	system, the value of this attribute is just the file name (+ extension),
10720	without the path specification.
10721
10722	Note that as opposed to the <link to="#location"/> attribute, the name
10723	attribute will not necessary be unique for a list of media of the
10724	given type and format.
10725	</desc>
10726	</attribute>
10727
10728	<attribute name="deviceType" type="DeviceType" readonly="yes">
10729	<desc>Kind of device (DVD/Floppy/HardDisk) which is applicable to this
10730	medium.</desc>
10731	</attribute>
10732
10733	<attribute name="hostDrive" type="boolean" readonly="yes">
10734	<desc>True if this corresponds to a drive on the host.</desc>
10735	</attribute>
10736
10737	<attribute name="size" type="long long" readonly="yes">
10738	<desc>
10739	Physical size of the storage unit used to hold medium data (in bytes).
10740
10741	<note>
10742	For media whose <link to="#state"/> is <link
10743	to="MediumState_Inaccessible"/>, the value of this property is the
10744	last known size. For <link to="MediumState_NotCreated"/> media,
10745	the returned value is zero.
10746	</note>
10747	</desc>
10748	</attribute>
10749
10750	<attribute name="format" type="wstring" readonly="yes">
10751	<desc>
10752	Storage format of this medium.
10753
10754	The value of this attribute is a string that specifies a backend used
10755	to store medium data. The storage format is defined when you create a
10756	new medium or automatically detected when you open an existing medium,
10757	and cannot be changed later.
10758
10759	The list of all storage formats supported by this VirtualBox
10760	installation can be obtained using
10761	<link to="ISystemProperties::mediumFormats"/>.
10762	</desc>
10763	</attribute>
10764
10765	<attribute name="mediumFormat" type="IMediumFormat" readonly="yes">
10766	<desc>
10767	Storage medium format object corresponding to this medium.
10768
10769	The value of this attribute is a reference to the medium format object
10770	that specifies the backend properties used to store medium data. The
10771	storage format is defined when you create a new medium or automatically
10772	detected when you open an existing medium, and cannot be changed later.
10773
10774	<note>@c null is returned if there is no associated medium format
10775	object. This can e.g. happen for medium objects representing host
10776	drives and other special medium objects.</note>
10777	</desc>
10778	</attribute>
10779
10780	<attribute name="type" type="MediumType">
10781	<desc>
10782	Type (role) of this medium.
10783
10784	The following constraints apply when changing the value of this
10785	attribute:
10786	<ul>
10787	<li>If a medium is attached to a virtual machine (either in the
10788	current state or in one of the snapshots), its type cannot be
10789	changed.
10790	</li>
10791	<li>As long as the medium has children, its type cannot be set
10792	to <link to="MediumType_Writethrough"/>.
10793	</li>
10794	<li>The type of all differencing media is
10795	<link to="MediumType_Normal"/> and cannot be changed.
10796	</li>
10797	</ul>
10798
10799	The type of a newly created or opened medium is set to
10800	<link to="MediumType_Normal"/>, except for DVD and floppy media,
10801	which have a type of <link to="MediumType_Writethrough"/>.
10802	</desc>
10803	</attribute>
10804
10805	<attribute name="allowedTypes" type="MediumType" safearray="yes" readonly="yes">
10806	<desc>
10807	Returns which medium types can selected for this medium.
10808
10809	<result name="E_NOTIMPL">
10810	This attribute is not implemented at the moment.
10811	</result>
10812	</desc>
10813	</attribute>
10814
10815	<attribute name="parent" type="IMedium" readonly="yes">
10816	<desc>
10817	Parent of this medium (the medium this medium is directly based
10818	on).
10819
10820	Only differencing media have parents. For base (non-differencing)
10821	media, @c null is returned.
10822	</desc>
10823	</attribute>
10824
10825	<attribute name="children" type="IMedium" safearray="yes" readonly="yes">
10826	<desc>
10827	Children of this medium (all differencing media directly based
10828	on this medium). A @c null array is returned if this medium
10829	does not have any children.
10830	</desc>
10831	</attribute>
10832
10833	<attribute name="base" type="IMedium" readonly="yes">
10834	<desc>
10835	Base medium of this medium.
10836
10837	If this is a differencing medium, its base medium is the medium
10838	the given medium branch starts from. For all other types of media, this
10839	property returns the medium object itself (i.e. the same object this
10840	property is read on).
10841	</desc>
10842	</attribute>
10843
10844	<attribute name="readOnly" type="boolean" readonly="yes">
10845	<desc>
10846	Returns @c true if this medium is read-only and @c false otherwise.
10847
10848	A medium is considered to be read-only when its contents cannot be
10849	modified without breaking the integrity of other parties that depend on
10850	this medium such as its child media or snapshots of virtual machines
10851	where this medium is attached to these machines. If there are no
10852	children and no such snapshots then there is no dependency and the
10853	medium is not read-only.
10854
10855	The value of this attribute can be used to determine the kind of the
10856	attachment that will take place when attaching this medium to a
10857	virtual machine. If the value is @c false then the medium will
10858	be attached directly. If the value is @c true then the medium
10859	will be attached indirectly by creating a new differencing child
10860	medium for that. See the interface description for more information.
10861
10862	Note that all <link to="MediumType_Immutable">Immutable</link> media
10863	are always read-only while all
10864	<link to="MediumType_Writethrough">Writethrough</link> media are
10865	always not.
10866
10867	<note>
10868	The read-only condition represented by this attribute is related to
10869	the medium type and usage, not to the current
10870	<link to="IMedium::state">medium state</link> and not to the read-only
10871	state of the storage unit.
10872	</note>
10873	</desc>
10874	</attribute>
10875
10876	<attribute name="logicalSize" type="long long" readonly="yes">
10877	<desc>
10878	Logical size of this medium (in bytes), as reported to the
10879	guest OS running inside the virtual machine this medium is
10880	attached to. The logical size is defined when the medium is created
10881	and cannot be changed later.
10882
10883	<note>
10884	Reading this property on a differencing medium will return the size
10885	of its <link to="#base"/> medium.
10886	</note>
10887	<note>
10888	For media whose state is <link to="#state"/> is <link
10889	to="MediumState_Inaccessible"/>, the value of this property is the
10890	last known logical size. For <link to="MediumState_NotCreated"/>
10891	media, the returned value is zero.
10892	</note>
10893	</desc>
10894	</attribute>
10895
10896	<attribute name="autoReset" type="boolean">
10897	<desc>
10898	Whether this differencing medium will be automatically reset each
10899	time a virtual machine it is attached to is powered up. This
10900	attribute is automatically set to @c true for the last
10901	differencing image of an "immutable" medium (see
10902	<link to="MediumType" />).
10903
10904	See <link to="#reset"/> for more information about resetting
10905	differencing media.
10906
10907	<note>
10908	Reading this property on a base (non-differencing) medium will
10909	always @c false. Changing the value of this property in this
10910	case is not supported.
10911	</note>
10912
10913	<result name="VBOX_E_NOT_SUPPORTED">
10914	This is not a differencing medium (when changing the attribute
10915	value).
10916	</result>
10917	</desc>
10918	</attribute>
10919
10920	<attribute name="lastAccessError" type="wstring" readonly="yes">
10921	<desc>
10922	Text message that represents the result of the last accessibility
10923	check performed by <link to="#refreshState"/>.
10924
10925	An empty string is returned if the last accessibility check
10926	was successful or has not yet been called. As a result, if
10927	<link to="#state" /> is "Inaccessible" and this attribute is empty,
10928	then <link to="#refreshState"/> has yet to be called; this is the
10929	default value of media after VirtualBox initialization.
10930	A non-empty string indicates a failure and should normally describe
10931	a reason of the failure (for example, a file read error).
10932	</desc>
10933	</attribute>
10934
10935	<attribute name="machineIds" type="uuid" mod="string" safearray="yes" readonly="yes">
10936	<desc>
10937	Array of UUIDs of all machines this medium is attached to.
10938
10939	A @c null array is returned if this medium is not attached to any
10940	machine or to any machine's snapshot.
10941
10942	<note>
10943	The returned array will include a machine even if this medium is not
10944	attached to that machine in the current state but attached to it in
10945	one of the machine's snapshots. See <link to="#getSnapshotIds"/> for
10946	details.
10947	</note>
10948	</desc>
10949	</attribute>
10950
10951	<method name="setIDs">
10952	<desc>
10953	Changes the UUID and parent UUID for a hard disk medium.
10954	</desc>
10955	<param name="setImageId" type="boolean" dir="in">
10956	<desc>
10957	Select whether a new image UUID is set or not.
10958	</desc>
10959	</param>
10960	<param name="imageId" type="uuid" mod="string" dir="in">
10961	<desc>
10962	New UUID for the image. If an empty string is passed, then a new
10963	UUID is automatically created, provided that @a setImageId is @c true.
10964	Specifying a zero UUID is not allowed.
10965	</desc>
10966	</param>
10967	<param name="setParentId" type="boolean" dir="in">
10968	<desc>
10969	Select whether a new parent UUID is set or not.
10970	</desc>
10971	</param>
10972	<param name="parentId" type="uuid" mod="string" dir="in">
10973	<desc>
10974	New parent UUID for the image. If an empty string is passed, then a
10975	new UUID is automatically created, provided @a setParentId is
10976	@c true. A zero UUID is valid.
10977	</desc>
10978	</param>
10979	<result name="E_INVALIDARG">
10980	Invalid parameter combination.
10981	</result>
10982	<result name="VBOX_E_NOT_SUPPORTED">
10983	Medium is not a hard disk medium.
10984	</result>
10985	</method>
10986
10987	<method name="refreshState">
10988	<desc>
10989	If the current medium state (see <link to="MediumState"/>) is one of
10990	"Created", "Inaccessible" or "LockedRead", then this performs an
10991	accessibility check on the medium and sets the value of the <link to="#state"/>
10992	attribute accordingly; that value is also returned for convenience.
10993
10994	For all other state values, this does not perform a refresh but returns
10995	the state only.
10996
10997	The refresh, if performed, may take a long time (several seconds or even
10998	minutes, depending on the storage unit location and format) because it performs an
10999	accessibility check of the storage unit. This check may cause a significant
11000	delay if the storage unit of the given medium is, for example, a file located
11001	on a network share which is not currently accessible due to connectivity
11002	problems. In that case, the call will not return until a timeout
11003	interval defined by the host OS for this operation expires. For this reason,
11004	it is recommended to never read this attribute on the main UI thread to avoid
11005	making the UI unresponsive.
11006
11007	If the last known state of the medium is "Created" and the accessibility
11008	check fails, then the state would be set to "Inaccessible", and
11009	<link to="#lastAccessError"/> may be used to get more details about the
11010	failure. If the state of the medium is "LockedRead", then it remains the
11011	same, and a non-empty value of <link to="#lastAccessError"/> will
11012	indicate a failed accessibility check in this case.
11013
11014	Note that not all medium states are applicable to all medium types.
11015	</desc>
11016	<param name="state" type="MediumState" dir="return">
11017	<desc>
11018	New medium state.
11019	</desc>
11020	</param>
11021	</method>
11022
11023	<method name="getSnapshotIds">
11024	<desc>
11025	Returns an array of UUIDs of all snapshots of the given machine where
11026	this medium is attached to.
11027
11028	If the medium is attached to the machine in the current state, then the
11029	first element in the array will always be the ID of the queried machine
11030	(i.e. the value equal to the @c machineId argument), followed by
11031	snapshot IDs (if any).
11032
11033	If the medium is not attached to the machine in the current state, then
11034	the array will contain only snapshot IDs.
11035
11036	The returned array may be @c null if this medium is not attached
11037	to the given machine at all, neither in the current state nor in one of
11038	the snapshots.
11039	</desc>
11040	<param name="machineId" type="uuid" mod="string" dir="in">
11041	<desc>
11042	UUID of the machine to query.
11043	</desc>
11044	</param>
11045	<param name="snapshotIds" type="uuid" mod="string" safearray="yes" dir="return">
11046	<desc>
11047	Array of snapshot UUIDs of the given machine using this medium.
11048	</desc>
11049	</param>
11050	</method>
11051
11052	<method name="lockRead">
11053	<desc>
11054	Locks this medium for reading.
11055
11056	A read lock is shared: many clients can simultaneously lock the
11057	same medium for reading unless it is already locked for writing (see
11058	<link to="#lockWrite"/>) in which case an error is returned.
11059
11060	When the medium is locked for reading, it cannot be modified
11061	from within VirtualBox. This means that any method that changes
11062	the properties of this medium or contents of the storage unit
11063	will return an error (unless explicitly stated otherwise). That
11064	includes an attempt to start a virtual machine that wants to
11065	write to the the medium.
11066
11067	When the virtual machine is started up, it locks for reading all
11068	media it uses in read-only mode. If some medium cannot be locked
11069	for reading, the startup procedure will fail.
11070	A medium is typically locked for reading while it is used by a running
11071	virtual machine but has a depending differencing image that receives
11072	the actual write operations. This way one base medium can have
11073	multiple child differencing images which can be written to
11074	simultaneously. Read-only media such as DVD and floppy images are
11075	also locked for reading only (so they can be in use by multiple
11076	machines simultaneously).
11077
11078	A medium is also locked for reading when it is the source of a
11079	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11080
11081	The medium locked for reading must be unlocked using the <link
11082	to="#unlockRead"/> method. Calls to <link to="#lockRead"/>
11083	can be nested and must be followed by the same number of paired
11084	<link to="#unlockRead"/> calls.
11085
11086	This method sets the medium state (see <link to="#state"/>) to
11087	"LockedRead" on success. The medium's previous state must be
11088	one of "Created", "Inaccessible" or "LockedRead".
11089
11090	Locking an inaccessible medium is not an error; this method performs
11091	a logical lock that prevents modifications of this medium through
11092	the VirtualBox API, not a physical file-system lock of the underlying
11093	storage unit.
11094
11095	This method returns the current state of the medium
11096	<i>before</i> the operation.
11097
11098	<result name="VBOX_E_INVALID_OBJECT_STATE">
11099	Invalid medium state (e.g. not created, locked, inaccessible,
11100	creating, deleting).
11101	</result>
11102
11103	</desc>
11104	<param name="state" type="MediumState" dir="return">
11105	<desc>
11106	State of the medium after the operation.
11107	</desc>
11108	</param>
11109	</method>
11110
11111	<method name="unlockRead">
11112	<desc>
11113	Cancels the read lock previously set by <link to="#lockRead"/>.
11114
11115	For both success and failure, this method returns the current state
11116	of the medium <i>after</i> the operation.
11117
11118	See <link to="#lockRead"/> for more details.
11119
11120	<result name="VBOX_E_INVALID_OBJECT_STATE">
11121	Medium not locked for reading.
11122	</result>
11123
11124	</desc>
11125	<param name="state" type="MediumState" dir="return">
11126	<desc>
11127	State of the medium after the operation.
11128	</desc>
11129	</param>
11130	</method>
11131
11132	<method name="lockWrite">
11133	<desc>
11134	Locks this medium for writing.
11135
11136	A write lock, as opposed to <link to="#lockRead"/>, is
11137	exclusive: there may be only one client holding a write lock,
11138	and there may be no read locks while the write lock is held.
11139	As a result, read-locking fails if a write lock is held, and
11140	write-locking fails if either a read or another write lock is held.
11141
11142	When a medium is locked for writing, it cannot be modified
11143	from within VirtualBox, and it is not guaranteed that the values
11144	of its properties are up-to-date. Any method that changes the
11145	properties of this medium or contents of the storage unit will
11146	return an error (unless explicitly stated otherwise).
11147
11148	When a virtual machine is started up, it locks for writing all
11149	media it uses to write data to. If any medium could not be locked
11150	for writing, the startup procedure will fail. If a medium has
11151	differencing images, then while the machine is running, only
11152	the last ("leaf") differencing image is locked for writing,
11153	whereas its parents are locked for reading only.
11154
11155	A medium is also locked for writing when it is the target of a
11156	write operation such as <link to="#cloneTo"/> or <link to="#mergeTo"/>.
11157
11158	The medium locked for writing must be unlocked using the <link
11159	to="#unlockWrite"/> method. Write locks <i>cannot</i> be nested.
11160
11161	This method sets the medium state (see <link to="#state"/>) to
11162	"LockedWrite" on success. The medium's previous state must be
11163	either "Created" or "Inaccessible".
11164
11165	Locking an inaccessible medium is not an error; this method performs
11166	a logical lock that prevents modifications of this medium through
11167	the VirtualBox API, not a physical file-system lock of the underlying
11168	storage unit.
11169
11170	For both, success and failure, this method returns the current
11171	state of the medium <i>before</i> the operation.
11172
11173	<result name="VBOX_E_INVALID_OBJECT_STATE">
11174	Invalid medium state (e.g. not created, locked, inaccessible,
11175	creating, deleting).
11176	</result>
11177
11178	</desc>
11179	<param name="state" type="MediumState" dir="return">
11180	<desc>
11181	State of the medium after the operation.
11182	</desc>
11183	</param>
11184	</method>
11185
11186	<method name="unlockWrite">
11187	<desc>
11188	Cancels the write lock previously set by <link to="#lockWrite"/>.
11189
11190	For both success and failure, this method returns the current
11191	state of the medium <i>after</i> the operation.
11192
11193	See <link to="#lockWrite"/> for more details.
11194
11195	<result name="VBOX_E_INVALID_OBJECT_STATE">
11196	Medium not locked for writing.
11197	</result>
11198
11199	</desc>
11200	<param name="state" type="MediumState" dir="return">
11201	<desc>
11202	State of the medium after the operation.
11203	</desc>
11204	</param>
11205	</method>
11206
11207	<method name="close">
11208	<desc>
11209	Closes this medium.
11210
11211	The medium must not be attached to any known virtual machine
11212	and must not have any known child media, otherwise the
11213	operation will fail.
11214
11215	When the medium is successfully closed, it is removed from
11216	the list of registered media, but its storage unit is not
11217	deleted. In particular, this means that this medium can
11218	later be opened again using the <link to="IVirtualBox::openMedium"/>
11219	call.
11220
11221	Note that after this method successfully returns, the given medium
11222	object becomes uninitialized. This means that any attempt
11223	to call any of its methods or attributes will fail with the
11224	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error.
11225
11226	<result name="VBOX_E_INVALID_OBJECT_STATE">
11227	Invalid medium state (other than not created, created or
11228	inaccessible).
11229	</result>
11230	<result name="VBOX_E_OBJECT_IN_USE">
11231	Medium attached to virtual machine.
11232	</result>
11233	<result name="VBOX_E_FILE_ERROR">
11234	Settings file not accessible.
11235	</result>
11236	<result name="VBOX_E_XML_ERROR">
11237	Could not parse the settings file.
11238	</result>
11239
11240	</desc>
11241	</method>
11242
11243	<!-- property methods -->
11244
11245	<method name="getProperty" const="yes">
11246	<desc>
11247	Returns the value of the custom medium property with the given name.
11248
11249	The list of all properties supported by the given medium format can
11250	be obtained with <link to="IMediumFormat::describeProperties"/>.
11251
11252	<note>If this method returns an empty string in @a value, the requested
11253	property is supported but currently not assigned any value.</note>
11254
11255	<result name="VBOX_E_OBJECT_NOT_FOUND">
11256	Requested property does not exist (not supported by the format).
11257	</result>
11258	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11259	</desc>
11260	<param name="name" type="wstring" dir="in">
11261	<desc>Name of the property to get.</desc>
11262	</param>
11263	<param name="value" type="wstring" dir="return">
11264	<desc>Current property value.</desc>
11265	</param>
11266	</method>
11267
11268	<method name="setProperty">
11269	<desc>
11270	Sets the value of the custom medium property with the given name.
11271
11272	The list of all properties supported by the given medium format can
11273	be obtained with <link to="IMediumFormat::describeProperties"/>.
11274
11275	<note>Setting the property value to @c null or an empty string is
11276	equivalent to deleting the existing value. A default value (if it is
11277	defined for this property) will be used by the format backend in this
11278	case.</note>
11279
11280	<result name="VBOX_E_OBJECT_NOT_FOUND">
11281	Requested property does not exist (not supported by the format).
11282	</result>
11283	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
11284	</desc>
11285	<param name="name" type="wstring" dir="in">
11286	<desc>Name of the property to set.</desc>
11287	</param>
11288	<param name="value" type="wstring" dir="in">
11289	<desc>Property value to set.</desc>
11290	</param>
11291	</method>
11292
11293	<method name="getProperties" const="yes">
11294	<desc>
11295	Returns values for a group of properties in one call.
11296
11297	The names of the properties to get are specified using the @a names
11298	argument which is a list of comma-separated property names or
11299	an empty string if all properties are to be returned.
11300	<note>Currently the value of this argument is ignored and the method
11301	always returns all existing properties.</note>
11302
11303	The list of all properties supported by the given medium format can
11304	be obtained with <link to="IMediumFormat::describeProperties"/>.
11305
11306	The method returns two arrays, the array of property names corresponding
11307	to the @a names argument and the current values of these properties.
11308	Both arrays have the same number of elements with each element at the
11309	given index in the first array corresponds to an element at the same
11310	index in the second array.
11311
11312	For properties that do not have assigned values, an empty string is
11313	returned at the appropriate index in the @a returnValues array.
11314
11315	</desc>
11316	<param name="names" type="wstring" dir="in">
11317	<desc>
11318	Names of properties to get.
11319	</desc>
11320	</param>
11321	<param name="returnNames" type="wstring" safearray="yes" dir="out">
11322	<desc>Names of returned properties.</desc>
11323	</param>
11324	<param name="returnValues" type="wstring" safearray="yes" dir="return">
11325	<desc>Values of returned properties.</desc>
11326	</param>
11327	</method>
11328
11329	<method name="setProperties">
11330	<desc>
11331	Sets values for a group of properties in one call.
11332
11333	The names of the properties to set are passed in the @a names
11334	array along with the new values for them in the @a values array. Both
11335	arrays have the same number of elements with each element at the given
11336	index in the first array corresponding to an element at the same index
11337	in the second array.
11338
11339	If there is at least one property name in @a names that is not valid,
11340	the method will fail before changing the values of any other properties
11341	from the @a names array.
11342
11343	Using this method over <link to="#setProperty"/> is preferred if you
11344	need to set several properties at once since it is more efficient.
11345
11346	The list of all properties supported by the given medium format can
11347	be obtained with <link to="IMediumFormat::describeProperties"/>.
11348
11349	Setting the property value to @c null or an empty string is equivalent
11350	to deleting the existing value. A default value (if it is defined for
11351	this property) will be used by the format backend in this case.
11352	</desc>
11353	<param name="names" type="wstring" safearray="yes" dir="in">
11354	<desc>Names of properties to set.</desc>
11355	</param>
11356	<param name="values" type="wstring" safearray="yes" dir="in">
11357	<desc>Values of properties to set.</desc>
11358	</param>
11359	</method>
11360
11361	<!-- storage methods -->
11362
11363	<method name="createBaseStorage">
11364	<desc>
11365	Starts creating a hard disk storage unit (fixed/dynamic, according
11366	to the variant flags) in in the background. The previous storage unit
11367	created for this object, if any, must first be deleted using
11368	<link to="#deleteStorage"/>, otherwise the operation will fail.
11369
11370	Before the operation starts, the medium is placed in
11371	<link to="MediumState_Creating"/> state. If the create operation
11372	fails, the medium will be placed back in <link to="MediumState_NotCreated"/>
11373	state.
11374
11375	After the returned progress object reports that the operation has
11376	successfully completed, the medium state will be set to <link
11377	to="MediumState_Created"/>, the medium will be remembered by this
11378	VirtualBox installation and may be attached to virtual machines.
11379
11380	<result name="VBOX_E_NOT_SUPPORTED">
11381	The variant of storage creation operation is not supported. See <link
11382	to="IMediumFormat::capabilities"/>.
11383	</result>
11384	</desc>
11385	<param name="logicalSize" type="long long" dir="in">
11386	<desc>Maximum logical size of the medium in bytes.</desc>
11387	</param>
11388	<param name="variant" type="unsigned long" dir="in">
11389	<desc>Exact image variant which should be created (as a combination of
11390	<link to="MediumVariant" /> flags).</desc>
11391	</param>
11392	<param name="progress" type="IProgress" dir="return">
11393	<desc>Progress object to track the operation completion.</desc>
11394	</param>
11395	</method>
11396
11397	<method name="deleteStorage">
11398	<desc>
11399	Starts deleting the storage unit of this medium.
11400
11401	The medium must not be attached to any known virtual machine and must
11402	not have any known child media, otherwise the operation will fail.
11403	It will also fail if there is no storage unit to delete or if deletion
11404	is already in progress, or if the medium is being in use (locked for
11405	read or for write) or inaccessible. Therefore, the only valid state for
11406	this operation to succeed is <link to="MediumState_Created"/>.
11407
11408	Before the operation starts, the medium is placed in
11409	<link to="MediumState_Deleting"/> state and gets removed from the list
11410	of remembered hard disks (media registry). If the delete operation
11411	fails, the medium will be remembered again and placed back to
11412	<link to="MediumState_Created"/> state.
11413
11414	After the returned progress object reports that the operation is
11415	complete, the medium state will be set to
11416	<link to="MediumState_NotCreated"/> and you will be able to use one of
11417	the storage creation methods to create it again.
11418
11419	<see><link to="#close"/></see>
11420
11421	<result name="VBOX_E_OBJECT_IN_USE">
11422	Medium is attached to a virtual machine.
11423	</result>
11424	<result name="VBOX_E_NOT_SUPPORTED">
11425	Storage deletion is not allowed because neither of storage creation
11426	operations are supported. See
11427	<link to="IMediumFormat::capabilities"/>.
11428	</result>
11429
11430	<note>
11431	If the deletion operation fails, it is not guaranteed that the storage
11432	unit still exists. You may check the <link to="IMedium::state"/> value
11433	to answer this question.
11434	</note>
11435	</desc>
11436	<param name="progress" type="IProgress" dir="return">
11437	<desc>Progress object to track the operation completion.</desc>
11438	</param>
11439	</method>
11440
11441	<!-- diff methods -->
11442
11443	<method name="createDiffStorage">
11444	<desc>
11445	Starts creating an empty differencing storage unit based on this
11446	medium in the format and at the location defined by the @a target
11447	argument.
11448
11449	The target medium must be in <link to="MediumState_NotCreated"/>
11450	state (i.e. must not have an existing storage unit). Upon successful
11451	completion, this operation will set the type of the target medium to
11452	<link to="MediumType_Normal"/> and create a storage unit necessary to
11453	represent the differencing medium data in the given format (according
11454	to the storage format of the target object).
11455
11456	After the returned progress object reports that the operation is
11457	successfully complete, the target medium gets remembered by this
11458	VirtualBox installation and may be attached to virtual machines.
11459
11460	<note>
11461	The medium will be set to <link to="MediumState_LockedRead"/>
11462	state for the duration of this operation.
11463	</note>
11464	<result name="VBOX_E_OBJECT_IN_USE">
11465	Medium not in @c NotCreated state.
11466	</result>
11467	</desc>
11468	<param name="target" type="IMedium" dir="in">
11469	<desc>Target medium.</desc>
11470	</param>
11471	<param name="variant" type="unsigned long" dir="in">
11472	<desc>Exact image variant which should be created (as a combination of
11473	<link to="MediumVariant" /> flags).</desc>
11474	</param>
11475	<param name="progress" type="IProgress" dir="return">
11476	<desc>Progress object to track the operation completion.</desc>
11477	</param>
11478	</method>
11479
11480	<method name="mergeTo">
11481	<desc>
11482	Starts merging the contents of this medium and all intermediate
11483	differencing media in the chain to the given target medium.
11484
11485	The target medium must be either a descendant of this medium or
11486	its ancestor (otherwise this method will immediately return a failure).
11487	It follows that there are two logical directions of the merge operation:
11488	from ancestor to descendant (<i>forward merge</i>) and from descendant to
11489	ancestor (<i>backward merge</i>). Let us consider the following medium
11490	chain:
11491
11492	<pre>Base <- Diff_1 <- Diff_2</pre>
11493
11494	Here, calling this method on the <tt>Base</tt> medium object with
11495	<tt>Diff_2</tt> as an argument will be a forward merge; calling it on
11496	<tt>Diff_2</tt> with <tt>Base</tt> as an argument will be a backward
11497	merge. Note that in both cases the contents of the resulting medium
11498	will be the same, the only difference is the medium object that takes
11499	the result of the merge operation. In case of the forward merge in the
11500	above example, the result will be written to <tt>Diff_2</tt>; in case of
11501	the backward merge, the result will be written to <tt>Base</tt>. In
11502	other words, the result of the operation is always stored in the target
11503	medium.
11504
11505	Upon successful operation completion, the storage units of all media in
11506	the chain between this (source) medium and the target medium, including
11507	the source medium itself, will be automatically deleted and the
11508	relevant medium objects (including this medium) will become
11509	uninitialized. This means that any attempt to call any of
11510	their methods or attributes will fail with the
11511	<tt>"Object not ready" (E_ACCESSDENIED)</tt> error. Applied to the above
11512	example, the forward merge of <tt>Base</tt> to <tt>Diff_2</tt> will
11513	delete and uninitialize both <tt>Base</tt> and <tt>Diff_1</tt> media.
11514	Note that <tt>Diff_2</tt> in this case will become a base medium
11515	itself since it will no longer be based on any other medium.
11516
11517	Considering the above, all of the following conditions must be met in
11518	order for the merge operation to succeed:
11519	<ul>
11520	<li>
11521	Neither this (source) medium nor any intermediate
11522	differencing medium in the chain between it and the target
11523	medium is attached to any virtual machine.
11524	</li>
11525	<li>
11526	Neither the source medium nor the target medium is an
11527	<link to="MediumType_Immutable"/> medium.
11528	</li>
11529	<li>
11530	The part of the medium tree from the source medium to the
11531	target medium is a linear chain, i.e. all medium in this
11532	chain have exactly one child which is the next medium in this
11533	chain. The only exception from this rule is the target medium in
11534	the forward merge operation; it is allowed to have any number of
11535	child media because the merge operation will not change its
11536	logical contents (as it is seen by the guest OS or by children).
11537	</li>
11538	<li>
11539	None of the involved media are in
11540	<link to="MediumState_LockedRead"/> or
11541	<link to="MediumState_LockedWrite"/> state.
11542	</li>
11543	</ul>
11544
11545	<note>
11546	This (source) medium and all intermediates will be placed to <link
11547	to="MediumState_Deleting"/> state and the target medium will be
11548	placed to <link to="MediumState_LockedWrite"/> state and for the
11549	duration of this operation.
11550	</note>
11551	</desc>
11552	<param name="target" type="IMedium" dir="in">
11553	<desc>Target medium.</desc>
11554	</param>
11555	<param name="progress" type="IProgress" dir="return">
11556	<desc>Progress object to track the operation completion.</desc>
11557	</param>
11558	</method>
11559
11560	<!-- clone method -->
11561
11562	<method name="cloneTo">
11563	<desc>
11564	Starts creating a clone of this medium in the format and at the
11565	location defined by the @a target argument.
11566
11567	The target medium must be either in <link to="MediumState_NotCreated"/>
11568	state (i.e. must not have an existing storage unit) or in
11569	<link to="MediumState_Created"/> state (i.e. created and not locked, and
11570	big enough to hold the data or else the copy will be partial). Upon
11571	successful completion, the cloned medium will contain exactly the
11572	same sector data as the medium being cloned, except that in the
11573	first case a new UUID for the clone will be randomly generated, and in
11574	the second case the UUID will remain unchanged.
11575
11576	The @a parent argument defines which medium will be the parent
11577	of the clone. Passing a @c null reference indicates that the clone will
11578	be a base image, i.e. completely independent. It is possible to specify
11579	an arbitrary medium for this parameter, including the parent of the
11580	medium which is being cloned. Even cloning to a child of the source
11581	medium is possible. Note that when cloning to an existing image, the
11582	@a parent argument is ignored.
11583
11584	After the returned progress object reports that the operation is
11585	successfully complete, the target medium gets remembered by this
11586	VirtualBox installation and may be attached to virtual machines.
11587
11588	<note>
11589	This medium will be placed to <link to="MediumState_LockedRead"/>
11590	state for the duration of this operation.
11591	</note>
11592	<result name="E_NOTIMPL">
11593	The specified cloning variant is not supported at the moment.
11594	</result>
11595	</desc>
11596	<param name="target" type="IMedium" dir="in">
11597	<desc>Target medium.</desc>
11598	</param>
11599	<param name="variant" type="unsigned long" dir="in">
11600	<desc>Exact image variant which should be created (as a combination of
11601	<link to="MediumVariant" /> flags).</desc>
11602	</param>
11603	<param name="parent" type="IMedium" dir="in">
11604	<desc>Parent of the cloned medium.</desc>
11605	</param>
11606	<param name="progress" type="IProgress" dir="return">
11607	<desc>Progress object to track the operation completion.</desc>
11608	</param>
11609	</method>
11610
11611	<!-- other methods -->
11612
11613	<method name="compact">
11614	<desc>
11615	Starts compacting of this medium. This means that the medium is
11616	transformed into a possibly more compact storage representation.
11617	This potentially creates temporary images, which can require a
11618	substantial amount of additional disk space.
11619
11620	This medium will be placed to <link to="MediumState_LockedWrite"/>
11621	state and all its parent media (if any) will be placed to
11622	<link to="MediumState_LockedRead"/> state for the duration of this
11623	operation.
11624
11625	Please note that the results can be either returned straight away,
11626	or later as the result of the background operation via the object
11627	returned via the @a progress parameter.
11628
11629	<result name="VBOX_E_NOT_SUPPORTED">
11630	Medium format does not support compacting (but potentially
11631	needs it).
11632	</result>
11633	</desc>
11634	<param name="progress" type="IProgress" dir="return">
11635	<desc>Progress object to track the operation completion.</desc>
11636	</param>
11637	</method>
11638
11639	<method name="resize">
11640	<desc>
11641	Starts resizing this medium. This means that the nominal size of the
11642	medium is set to the new value. Both increasing and decreasing the
11643	size is possible, and there are no safety checks, since VirtualBox
11644	does not make any assumptions about the medium contents.
11645
11646	Resizing usually needs additional disk space, and possibly also
11647	some temporary disk space. Note that resize does not create a full
11648	temporary copy of the medium, so the additional disk space requirement
11649	is usually much lower than using the clone operation.
11650
11651	This medium will be placed to <link to="MediumState_LockedWrite"/>
11652	state for the duration of this operation.
11653
11654	Please note that the results can be either returned straight away,
11655	or later as the result of the background operation via the object
11656	returned via the @a progress parameter.
11657
11658	<result name="VBOX_E_NOT_SUPPORTED">
11659	Medium format does not support resizing.
11660	</result>
11661	</desc>
11662	<param name="logicalSize" type="long long" dir="in">
11663	<desc>New nominal capacity of the medium in bytes.</desc>
11664	</param>
11665	<param name="progress" type="IProgress" dir="return">
11666	<desc>Progress object to track the operation completion.</desc>
11667	</param>
11668	</method>
11669
11670	<method name="reset">
11671	<desc>
11672	Starts erasing the contents of this differencing medium.
11673
11674	This operation will reset the differencing medium to its initial
11675	state when it does not contain any sector data and any read operation is
11676	redirected to its parent medium. This automatically gets called
11677	during VM power-up for every medium whose <link to="#autoReset" />
11678	attribute is @c true.
11679
11680	The medium will be write-locked for the duration of this operation (see
11681	<link to="#lockWrite" />).
11682
11683	<result name="VBOX_E_NOT_SUPPORTED">
11684	This is not a differencing medium.
11685	</result>
11686	<result name="VBOX_E_INVALID_OBJECT_STATE">
11687	Medium is not in <link to="MediumState_Created"/> or
11688	<link to="MediumState_Inaccessible"/> state.
11689	</result>
11690	</desc>
11691	<param name="progress" type="IProgress" dir="return">
11692	<desc>Progress object to track the operation completion.</desc>
11693	</param>
11694	</method>
11695
11696	</interface>
11697
11698
11699	<!--
11700	// IMediumFormat
11701	/////////////////////////////////////////////////////////////////////////
11702	-->
11703
11704	<enum
11705	name="DataType"
11706	uuid="d90ea51e-a3f1-4a01-beb1-c1723c0d3ba7"
11707	>
11708	<const name="Int32" value="0"/>
11709	<const name="Int8" value="1"/>
11710	<const name="String" value="2"/>
11711	</enum>
11712
11713	<enum
11714	name="DataFlags"
11715	uuid="86884dcf-1d6b-4f1b-b4bf-f5aa44959d60"
11716	>
11717	<const name="None" value="0x00"/>
11718	<const name="Mandatory" value="0x01"/>
11719	<const name="Expert" value="0x02"/>
11720	<const name="Array" value="0x04"/>
11721	<const name="FlagMask" value="0x07"/>
11722	</enum>
11723
11724	<enum
11725	name="MediumFormatCapabilities"
11726	uuid="7342ba79-7ce0-4d94-8f86-5ed5a185d9bd"
11727	>
11728	<desc>
11729	Medium format capability flags.
11730	</desc>
11731
11732	<const name="Uuid" value="0x01">
11733	<desc>
11734	Supports UUIDs as expected by VirtualBox code.
11735	</desc>
11736	</const>
11737
11738	<const name="CreateFixed" value="0x02">
11739	<desc>
11740	Supports creating fixed size images, allocating all space instantly.
11741	</desc>
11742	</const>
11743
11744	<const name="CreateDynamic" value="0x04">
11745	<desc>
11746	Supports creating dynamically growing images, allocating space on
11747	demand.
11748	</desc>
11749	</const>
11750
11751	<const name="CreateSplit2G" value="0x08">
11752	<desc>
11753	Supports creating images split in chunks of a bit less than 2 GBytes.
11754	</desc>
11755	</const>
11756
11757	<const name="Differencing" value="0x10">
11758	<desc>
11759	Supports being used as a format for differencing media (see <link
11760	to="IMedium::createDiffStorage"/>).
11761	</desc>
11762	</const>
11763
11764	<const name="Asynchronous" value="0x20">
11765	<desc>
11766	Supports asynchronous I/O operations for at least some configurations.
11767	</desc>
11768	</const>
11769
11770	<const name="File" value="0x40">
11771	<desc>
11772	The format backend operates on files (the <link to="IMedium::location"/>
11773	attribute of the medium specifies a file used to store medium
11774	data; for a list of supported file extensions see
11775	<link to="IMediumFormat::describeFileExtensions"/>).
11776	</desc>
11777	</const>
11778
11779	<const name="Properties" value="0x80">
11780	<desc>
11781	The format backend uses the property interface to configure the storage
11782	location and properties (the <link to="IMediumFormat::describeProperties"/>
11783	method is used to get access to properties supported by the given medium format).
11784	</desc>
11785	</const>
11786
11787	<const name="TcpNetworking" value="0x100">
11788	<desc>
11789	The format backend uses the TCP networking interface for network access.
11790	</desc>
11791	</const>
11792
11793	<const name="VFS" value="0x200">
11794	<desc>
11795	The format backend supports virtual filesystem functionality.
11796	</desc>
11797	</const>
11798
11799	<const name="CapabilityMask" value="0x3FF"/>
11800	</enum>
11801
11802	<interface
11803	name="IMediumFormat" extends="$unknown"
11804	uuid="9bd5b655-ea47-4637-99f3-aad0948be35b"
11805	wsmap="managed"
11806	>
11807	<desc>
11808	The IMediumFormat interface represents a medium format.
11809
11810	Each medium format has an associated backend which is used to handle
11811	media stored in this format. This interface provides information
11812	about the properties of the associated backend.
11813
11814	Each medium format is identified by a string represented by the
11815	<link to="#id"/> attribute. This string is used in calls like
11816	<link to="IVirtualBox::createHardDisk"/> to specify the desired
11817	format.
11818
11819	The list of all supported medium formats can be obtained using
11820	<link to="ISystemProperties::mediumFormats"/>.
11821
11822	<see><link to="IMedium"/></see>
11823	</desc>
11824
11825	<attribute name="id" type="wstring" readonly="yes">
11826	<desc>
11827	Identifier of this format.
11828
11829	The format identifier is a non-@c null non-empty ASCII string. Note that
11830	this string is case-insensitive. This means that, for example, all of
11831	the following strings:
11832	<pre>
11833	"VDI"
11834	"vdi"
11835	"VdI"</pre>
11836	refer to the same medium format.
11837
11838	This string is used in methods of other interfaces where it is necessary
11839	to specify a medium format, such as
11840	<link to="IVirtualBox::createHardDisk"/>.
11841	</desc>
11842	</attribute>
11843
11844	<attribute name="name" type="wstring" readonly="yes">
11845	<desc>
11846	Human readable description of this format.
11847
11848	Mainly for use in file open dialogs.
11849	</desc>
11850	</attribute>
11851
11852	<attribute name="capabilities" type="unsigned long" readonly="yes">
11853	<desc>
11854	Capabilities of the format as a set of bit flags.
11855
11856	For the meaning of individual capability flags see
11857	<link to="MediumFormatCapabilities"/>.
11858	</desc>
11859	</attribute>
11860
11861	<method name="describeFileExtensions">
11862	<desc>
11863	Returns two arrays describing the supported file extensions.
11864
11865	The first array contains the supported extensions and the seconds one
11866	the type each extension supports. Both have the same size.
11867
11868	Note that some backends do not work on files, so this array may be
11869	empty.
11870
11871	<see><link to="IMediumFormat::capabilities"/></see>
11872	</desc>
11873	<param name="extensions" type="wstring" safearray="yes" dir="out">
11874	<desc>The array of supported extensions.</desc>
11875	</param>
11876	<param name="type" type="DeviceType" safearray="yes" dir="out">
11877	<desc>The array which indicates the device type for every given extension.</desc>
11878	</param>
11879	</method>
11880
11881	<method name="describeProperties" const="yes">
11882	<desc>
11883	Returns several arrays describing the properties supported by this
11884	format.
11885
11886	An element with the given index in each array describes one
11887	property. Thus, the number of elements in each returned array is the
11888	same and corresponds to the number of supported properties.
11889
11890	The returned arrays are filled in only if the
11891	<link to="MediumFormatCapabilities_Properties"/> flag is set.
11892	All arguments must be non-@c null.
11893
11894	<see><link to="DataType"/>, <link to="DataFlags"/></see>
11895	</desc>
11896
11897	<param name="names" type="wstring" safearray="yes" dir="out">
11898	<desc>Array of property names.</desc>
11899	</param>
11900	<param name="description" type="wstring" safearray="yes" dir="out">
11901	<desc>Array of property descriptions.</desc>
11902	</param>
11903	<param name="types" type="DataType" safearray="yes" dir="out">
11904	<desc>Array of property types.</desc>
11905	</param>
11906	<param name="flags" type="unsigned long" safearray="yes" dir="out">
11907	<desc>Array of property flags.</desc>
11908	</param>
11909	<param name="defaults" type="wstring" safearray="yes" dir="out">
11910	<desc>Array of default property values.</desc>
11911	</param>
11912	</method>
11913
11914	</interface>
11915
11916
11917	<!--
11918	// IKeyboard
11919	/////////////////////////////////////////////////////////////////////////
11920	-->
11921
11922	<interface
11923	name="IKeyboard" extends="$unknown"
11924	uuid="f6916ec5-a881-4237-898f-7de58cf88672"
11925	wsmap="managed"
11926	>
11927	<desc>
11928	The IKeyboard interface represents the virtual machine's keyboard. Used
11929	in <link to="IConsole::keyboard"/>.
11930
11931	Use this interface to send keystrokes or the Ctrl-Alt-Del sequence
11932	to the virtual machine.
11933
11934	</desc>
11935	<method name="putScancode">
11936	<desc>Sends a scancode to the keyboard.
11937
11938	<result name="VBOX_E_IPRT_ERROR">
11939	Could not send scan code to virtual keyboard.
11940	</result>
11941
11942	</desc>
11943	<param name="scancode" type="long" dir="in"/>
11944	</method>
11945
11946	<method name="putScancodes">
11947	<desc>Sends an array of scancodes to the keyboard.
11948
11949	<result name="VBOX_E_IPRT_ERROR">
11950	Could not send all scan codes to virtual keyboard.
11951	</result>
11952
11953	</desc>
11954	<param name="scancodes" type="long" dir="in" safearray="yes"/>
11955	<param name="codesStored" type="unsigned long" dir="return"/>
11956	</method>
11957
11958	<method name="putCAD">
11959	<desc>Sends the Ctrl-Alt-Del sequence to the keyboard. This
11960	function is nothing special, it is just a convenience function
11961	calling <link to="IKeyboard::putScancodes"/> with the proper scancodes.
11962
11963	<result name="VBOX_E_IPRT_ERROR">
11964	Could not send all scan codes to virtual keyboard.
11965	</result>
11966
11967	</desc>
11968	</method>
11969
11970	<attribute name="eventSource" type="IEventSource" readonly="yes">
11971	<desc>
11972	Event source for keyboard events.
11973	</desc>
11974	</attribute>
11975
11976	</interface>
11977
11978
11979	<!--
11980	// IMouse
11981	/////////////////////////////////////////////////////////////////////////
11982	-->
11983
11984	<enum
11985	name="MouseButtonState"
11986	uuid="9ee094b8-b28a-4d56-a166-973cb588d7f8"
11987	>
11988	<desc>
11989	Mouse button state.
11990	</desc>
11991
11992	<const name="LeftButton" value="0x01"/>
11993	<const name="RightButton" value="0x02"/>
11994	<const name="MiddleButton" value="0x04"/>
11995	<const name="WheelUp" value="0x08"/>
11996	<const name="WheelDown" value="0x10"/>
11997	<const name="XButton1" value="0x20"/>
11998	<const name="XButton2" value="0x40"/>
11999	<const name="MouseStateMask" value="0x7F"/>
12000	</enum>
12001
12002	<interface
12003	name="IMouse" extends="$unknown"
12004	uuid="05044a52-7811-4f00-ae3a-0ab7ff707b10"
12005	wsmap="managed"
12006	>
12007	<desc>
12008	The IMouse interface represents the virtual machine's mouse. Used in
12009	<link to="IConsole::mouse"/>.
12010
12011	Through this interface, the virtual machine's virtual mouse can be
12012	controlled.
12013	</desc>
12014
12015	<attribute name="absoluteSupported" type="boolean" readonly="yes">
12016	<desc>
12017	Whether the guest OS supports absolute mouse pointer positioning
12018	or not.
12019	<note>
12020	You can use the <link to="IMouseCapabilityChangedEvent"/>
12021	event to be instantly informed about changes of this attribute
12022	during virtual machine execution.
12023	</note>
12024	<see><link to="#putMouseEventAbsolute"/></see>
12025	</desc>
12026	</attribute>
12027
12028	<attribute name="relativeSupported" type="boolean" readonly="yes">
12029	<desc>
12030	Whether the guest OS supports relative mouse pointer positioning
12031	or not.
12032	<note>
12033	You can use the <link to="IMouseCapabilityChangedEvent"/>
12034	event to be instantly informed about changes of this attribute
12035	during virtual machine execution.
12036	</note>
12037	<see><link to="#putMouseEvent"/></see>
12038	</desc>
12039	</attribute>
12040
12041	<attribute name="needsHostCursor" type="boolean" readonly="yes">
12042	<desc>
12043	Whether the guest OS can currently switch to drawing it's own mouse
12044	cursor on demand.
12045	<note>
12046	You can use the <link to="IMouseCapabilityChangedEvent"/>
12047	event to be instantly informed about changes of this attribute
12048	during virtual machine execution.
12049	</note>
12050	<see><link to="#putMouseEvent"/></see>
12051	</desc>
12052	</attribute>
12053
12054	<method name="putMouseEvent">
12055	<desc>
12056	Initiates a mouse event using relative pointer movements
12057	along x and y axis.
12058
12059	<result name="E_ACCESSDENIED">
12060	Console not powered up.
12061	</result>
12062	<result name="VBOX_E_IPRT_ERROR">
12063	Could not send mouse event to virtual mouse.
12064	</result>
12065
12066	</desc>
12067
12068	<param name="dx" type="long" dir="in">
12069	<desc>
12070	Amount of pixels the mouse should move to the right.
12071	Negative values move the mouse to the left.
12072	</desc>
12073	</param>
12074	<param name="dy" type="long" dir="in">
12075	<desc>
12076	Amount of pixels the mouse should move downwards.
12077	Negative values move the mouse upwards.
12078	</desc>
12079	</param>
12080	<param name="dz" type="long" dir="in">
12081	<desc>
12082	Amount of mouse wheel moves.
12083	Positive values describe clockwise wheel rotations,
12084	negative values describe counterclockwise rotations.
12085	</desc>
12086	</param>
12087	<param name="dw" type="long" dir="in">
12088	<desc>
12089	Amount of horizontal mouse wheel moves.
12090	Positive values describe a movement to the left,
12091	negative values describe a movement to the right.
12092	</desc>
12093	</param>
12094	<param name="buttonState" type="long" dir="in">
12095	<desc>
12096	The current state of mouse buttons. Every bit represents
12097	a mouse button as follows:
12098	<table>
12099	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12100	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12101	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12102	</table>
12103	A value of <tt>1</tt> means the corresponding button is pressed.
12104	otherwise it is released.
12105	</desc>
12106	</param>
12107	</method>
12108
12109	<method name="putMouseEventAbsolute">
12110	<desc>
12111	Positions the mouse pointer using absolute x and y coordinates.
12112	These coordinates are expressed in pixels and
12113	start from <tt>[1,1]</tt> which corresponds to the top left
12114	corner of the virtual display.
12115
12116	<result name="E_ACCESSDENIED">
12117	Console not powered up.
12118	</result>
12119	<result name="VBOX_E_IPRT_ERROR">
12120	Could not send mouse event to virtual mouse.
12121	</result>
12122
12123	<note>
12124	This method will have effect only if absolute mouse
12125	positioning is supported by the guest OS.
12126	</note>
12127
12128	<see><link to="#absoluteSupported"/></see>
12129	</desc>
12130
12131	<param name="x" type="long" dir="in">
12132	<desc>
12133	X coordinate of the pointer in pixels, starting from @c 1.
12134	</desc>
12135	</param>
12136	<param name="y" type="long" dir="in">
12137	<desc>
12138	Y coordinate of the pointer in pixels, starting from @c 1.
12139	</desc>
12140	</param>
12141	<param name="dz" type="long" dir="in">
12142	<desc>
12143	Amount of mouse wheel moves.
12144	Positive values describe clockwise wheel rotations,
12145	negative values describe counterclockwise rotations.
12146	</desc>
12147	</param>
12148	<param name="dw" type="long" dir="in">
12149	<desc>
12150	Amount of horizontal mouse wheel moves.
12151	Positive values describe a movement to the left,
12152	negative values describe a movement to the right.
12153	</desc>
12154	</param>
12155	<param name="buttonState" type="long" dir="in">
12156	<desc>
12157	The current state of mouse buttons. Every bit represents
12158	a mouse button as follows:
12159	<table>
12160	<tr><td>Bit 0 (<tt>0x01</tt>)</td><td>left mouse button</td></tr>
12161	<tr><td>Bit 1 (<tt>0x02</tt>)</td><td>right mouse button</td></tr>
12162	<tr><td>Bit 2 (<tt>0x04</tt>)</td><td>middle mouse button</td></tr>
12163	</table>
12164	A value of @c 1 means the corresponding button is pressed.
12165	otherwise it is released.
12166	</desc>
12167	</param>
12168	</method>
12169
12170	<attribute name="eventSource" type="IEventSource" readonly="yes">
12171	<desc>
12172	Event source for mouse events.
12173	</desc>
12174	</attribute>
12175
12176	</interface>
12177
12178	<!--
12179	// IDisplay
12180	/////////////////////////////////////////////////////////////////////////
12181	-->
12182
12183	<enum
12184	name="FramebufferPixelFormat"
12185	uuid="7acfd5ed-29e3-45e3-8136-73c9224f3d2d"
12186	>
12187	<desc>
12188	Format of the video memory buffer. Constants represented by this enum can
12189	be used to test for particular values of <link
12190	to="IFramebuffer::pixelFormat"/>. See also <link
12191	to="IFramebuffer::requestResize"/>.
12192
12193	See also www.fourcc.org for more information about FOURCC pixel formats.
12194	</desc>
12195
12196	<const name="Opaque" value="0">
12197	<desc>
12198	Unknown buffer format (the user may not assume any particular format of
12199	the buffer).
12200	</desc>
12201	</const>
12202	<const name="FOURCC_RGB" value="0x32424752">
12203	<desc>
12204	Basic RGB format (<link to="IFramebuffer::bitsPerPixel"/> determines the
12205	bit layout).
12206	</desc>
12207	</const>
12208	</enum>
12209
12210	<interface
12211	name="IFramebuffer" extends="$unknown"
12212	uuid="b7ed347a-5765-40a0-ae1c-f543eb4ddeaf"
12213	wsmap="suppress"
12214	>
12215	<attribute name="address" type="octet" mod="ptr" readonly="yes">
12216	<desc>Address of the start byte of the frame buffer.</desc>
12217	</attribute>
12218
12219	<attribute name="width" type="unsigned long" readonly="yes">
12220	<desc>Frame buffer width, in pixels.</desc>
12221	</attribute>
12222
12223	<attribute name="height" type="unsigned long" readonly="yes">
12224	<desc>Frame buffer height, in pixels.</desc>
12225	</attribute>
12226
12227	<attribute name="bitsPerPixel" type="unsigned long" readonly="yes">
12228	<desc>
12229	Color depth, in bits per pixel. When <link to="#pixelFormat"/> is <link
12230	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, valid values
12231	are: 8, 15, 16, 24 and 32.
12232	</desc>
12233	</attribute>
12234
12235	<attribute name="bytesPerLine" type="unsigned long" readonly="yes">
12236	<desc>
12237	Scan line size, in bytes. When <link to="#pixelFormat"/> is <link
12238	to="FramebufferPixelFormat_FOURCC_RGB">FOURCC_RGB</link>, the
12239	size of the scan line must be aligned to 32 bits.
12240	</desc>
12241	</attribute>
12242
12243	<attribute name="pixelFormat" type="unsigned long" readonly="yes">
12244	<desc>
12245	Frame buffer pixel format. It's either one of the values defined by <link
12246	to="FramebufferPixelFormat"/> or a raw FOURCC code.
12247	<note>
12248	This attribute must never return <link
12249	to="FramebufferPixelFormat_Opaque"/> -- the format of the buffer
12250	<link to="#address"/> points to must be always known.
12251	</note>
12252	</desc>
12253	</attribute>
12254
12255	<attribute name="usesGuestVRAM" type="boolean" readonly="yes">
12256	<desc>
12257	Defines whether this frame buffer uses the virtual video card's memory
12258	buffer (guest VRAM) directly or not. See <link
12259	to="IFramebuffer::requestResize"/> for more information.
12260	</desc>
12261	</attribute>
12262
12263	<attribute name="heightReduction" type="unsigned long" readonly="yes">
12264	<desc>
12265	Hint from the frame buffer about how much of the standard
12266	screen height it wants to use for itself. This information is
12267	exposed to the guest through the VESA BIOS and VMMDev interface
12268	so that it can use it for determining its video mode table. It
12269	is not guaranteed that the guest respects the value.
12270	</desc>
12271	</attribute>
12272
12273	<attribute name="overlay" type="IFramebufferOverlay" readonly="yes">
12274	<desc>
12275	An alpha-blended overlay which is superposed over the frame buffer.
12276	The initial purpose is to allow the display of icons providing
12277	information about the VM state, including disk activity, in front
12278	ends which do not have other means of doing that. The overlay is
12279	designed to controlled exclusively by IDisplay. It has no locking
12280	of its own, and any changes made to it are not guaranteed to be
12281	visible until the affected portion of IFramebuffer is updated. The
12282	overlay can be created lazily the first time it is requested. This
12283	attribute can also return @c null to signal that the overlay is not
12284	implemented.
12285	</desc>
12286	</attribute>
12287
12288	<attribute name="winId" type="long long" readonly="yes">
12289	<desc>
12290	Platform-dependent identifier of the window where context of this
12291	frame buffer is drawn, or zero if there's no such window.
12292	</desc>
12293	</attribute>
12294
12295	<method name="lock">
12296	<desc>
12297	Locks the frame buffer.
12298	Gets called by the IDisplay object where this frame buffer is
12299	bound to.
12300	</desc>
12301	</method>
12302
12303	<method name="unlock">
12304	<desc>
12305	Unlocks the frame buffer.
12306	Gets called by the IDisplay object where this frame buffer is
12307	bound to.
12308	</desc>
12309	</method>
12310
12311	<method name="notifyUpdate">
12312	<desc>
12313	Informs about an update.
12314	Gets called by the display object where this buffer is
12315	registered.
12316	</desc>
12317	<param name="x" type="unsigned long" dir="in"/>
12318	<param name="y" type="unsigned long" dir="in"/>
12319	<param name="width" type="unsigned long" dir="in"/>
12320	<param name="height" type="unsigned long" dir="in"/>
12321	</method>
12322
12323	<method name="requestResize">
12324	<desc>
12325	Requests a size and pixel format change.
12326
12327	There are two modes of working with the video buffer of the virtual
12328	machine. The <i>indirect</i> mode implies that the IFramebuffer
12329	implementation allocates a memory buffer for the requested display mode
12330	and provides it to the virtual machine. In <i>direct</i> mode, the
12331	IFramebuffer implementation uses the memory buffer allocated and owned
12332	by the virtual machine. This buffer represents the video memory of the
12333	emulated video adapter (so called <i>guest VRAM</i>). The direct mode is
12334	usually faster because the implementation gets a raw pointer to the
12335	guest VRAM buffer which it can directly use for visualizing the contents
12336	of the virtual display, as opposed to the indirect mode where the
12337	contents of guest VRAM are copied to the memory buffer provided by
12338	the implementation every time a display update occurs.
12339
12340	It is important to note that the direct mode is really fast only when
12341	the implementation uses the given guest VRAM buffer directly, for
12342	example, by blitting it to the window representing the virtual machine's
12343	display, which saves at least one copy operation comparing to the
12344	indirect mode. However, using the guest VRAM buffer directly is not
12345	always possible: the format and the color depth of this buffer may be
12346	not supported by the target window, or it may be unknown (opaque) as in
12347	case of text or non-linear multi-plane VGA video modes. In this case,
12348	the indirect mode (that is always available) should be used as a
12349	fallback: when the guest VRAM contents are copied to the
12350	implementation-provided memory buffer, color and format conversion is
12351	done automatically by the underlying code.
12352
12353	The @a pixelFormat parameter defines whether the direct mode is
12354	available or not. If @a pixelFormat is <link
12355	to="FramebufferPixelFormat_Opaque"/> then direct access to the guest
12356	VRAM buffer is not available -- the @a VRAM, @a bitsPerPixel and
12357	@a bytesPerLine parameters must be ignored and the implementation must use
12358	the indirect mode (where it provides its own buffer in one of the
12359	supported formats). In all other cases, @a pixelFormat together with
12360	@a bitsPerPixel and @a bytesPerLine define the format of the video memory
12361	buffer pointed to by the @a VRAM parameter and the implementation is
12362	free to choose which mode to use. To indicate that this frame buffer uses
12363	the direct mode, the implementation of the <link to="#usesGuestVRAM"/>
12364	attribute must return @c true and <link to="#address"/> must
12365	return exactly the same address that is passed in the @a VRAM parameter
12366	of this method; otherwise it is assumed that the indirect strategy is
12367	chosen.
12368
12369	The @a width and @a height parameters represent the size of the
12370	requested display mode in both modes. In case of indirect mode, the
12371	provided memory buffer should be big enough to store data of the given
12372	display mode. In case of direct mode, it is guaranteed that the given
12373	@a VRAM buffer contains enough space to represent the display mode of the
12374	given size. Note that this frame buffer's <link to="#width"/> and <link
12375	to="#height"/> attributes must return exactly the same values as
12376	passed to this method after the resize is completed (see below).
12377
12378	The @a finished output parameter determines if the implementation has
12379	finished resizing the frame buffer or not. If, for some reason, the
12380	resize cannot be finished immediately during this call, @a finished
12381	must be set to @c false, and the implementation must call
12382	<link to="IDisplay::resizeCompleted"/> after it has returned from
12383	this method as soon as possible. If @a finished is @c false, the
12384	machine will not call any frame buffer methods until
12385	<link to="IDisplay::resizeCompleted"/> is called.
12386
12387	Note that if the direct mode is chosen, the <link to="#bitsPerPixel"/>,
12388	<link to="#bytesPerLine"/> and <link to="#pixelFormat"/> attributes of
12389	this frame buffer must return exactly the same values as specified in the
12390	parameters of this method, after the resize is completed. If the
12391	indirect mode is chosen, these attributes must return values describing
12392	the format of the implementation's own memory buffer <link
12393	to="#address"/> points to. Note also that the <link to="#bitsPerPixel"/>
12394	value must always correlate with <link to="#pixelFormat"/>. Note that
12395	the <link to="#pixelFormat"/> attribute must never return <link
12396	to="FramebufferPixelFormat_Opaque"/> regardless of the selected mode.
12397
12398	<note>
12399	This method is called by the IDisplay object under the
12400	<link to="#lock"/> provided by this IFramebuffer
12401	implementation. If this method returns @c false in @a finished, then
12402	this lock is not released until
12403	<link to="IDisplay::resizeCompleted"/> is called.
12404	</note>
12405	</desc>
12406	<param name="screenId" type="unsigned long" dir="in">
12407	<desc>
12408	Logical screen number. Must be used in the corresponding call to
12409	<link to="IDisplay::resizeCompleted"/> if this call is made.
12410	</desc>
12411	</param>
12412	<param name="pixelFormat" type="unsigned long" dir="in">
12413	<desc>
12414	Pixel format of the memory buffer pointed to by @a VRAM.
12415	See also <link to="FramebufferPixelFormat"/>.
12416	</desc>
12417	</param>
12418	<param name="VRAM" type="octet" mod="ptr" dir="in">
12419	<desc>Pointer to the virtual video card's VRAM (may be @c null).</desc>
12420	</param>
12421	<param name="bitsPerPixel" type="unsigned long" dir="in">
12422	<desc>Color depth, bits per pixel.</desc>
12423	</param>
12424	<param name="bytesPerLine" type="unsigned long" dir="in">
12425	<desc>Size of one scan line, in bytes.</desc>
12426	</param>
12427	<param name="width" type="unsigned long" dir="in">
12428	<desc>Width of the guest display, in pixels.</desc>
12429	</param>
12430	<param name="height" type="unsigned long" dir="in">
12431	<desc>Height of the guest display, in pixels.</desc>
12432	</param>
12433	<param name="finished" type="boolean" dir="return">
12434	<desc>
12435	Can the VM start using the new frame buffer immediately
12436	after this method returns or it should wait for
12437	<link to="IDisplay::resizeCompleted"/>.
12438	</desc>
12439	</param>
12440	</method>
12441
12442	<method name="videoModeSupported">
12443	<desc>
12444	Returns whether the frame buffer implementation is willing to
12445	support a given video mode. In case it is not able to render
12446	the video mode (or for some reason not willing), it should
12447	return @c false. Usually this method is called when the guest
12448	asks the VMM device whether a given video mode is supported
12449	so the information returned is directly exposed to the guest.
12450	It is important that this method returns very quickly.
12451	</desc>
12452	<param name="width" type="unsigned long" dir="in"/>
12453	<param name="height" type="unsigned long" dir="in"/>
12454	<param name="bpp" type="unsigned long" dir="in"/>
12455	<param name="supported" type="boolean" dir="return"/>
12456	</method>
12457
12458	<method name="getVisibleRegion">
12459	<desc>
12460	Returns the visible region of this frame buffer.
12461
12462	If the @a rectangles parameter is @c null then the value of the
12463	@a count parameter is ignored and the number of elements necessary to
12464	describe the current visible region is returned in @a countCopied.
12465
12466	If @a rectangles is not @c null but @a count is less
12467	than the required number of elements to store region data, the method
12468	will report a failure. If @a count is equal or greater than the
12469	required number of elements, then the actual number of elements copied
12470	to the provided array will be returned in @a countCopied.
12471
12472	<note>
12473	The address of the provided array must be in the process space of
12474	this IFramebuffer object.
12475	</note>
12476	<note>
12477	Method not yet implemented.
12478	</note>
12479	</desc>
12480	<param name="rectangles" type="octet" mod="ptr" dir="in">
12481	<desc>Pointer to the @c RTRECT array to receive region data.</desc>
12482	</param>
12483	<param name="count" type="unsigned long" dir="in">
12484	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12485	</param>
12486	<param name="countCopied" type="unsigned long" dir="return">
12487	<desc>Number of elements copied to the @a rectangles array.</desc>
12488	</param>
12489	</method>
12490
12491	<method name="setVisibleRegion">
12492	<desc>
12493	Suggests a new visible region to this frame buffer. This region
12494	represents the area of the VM display which is a union of regions of
12495	all top-level windows of the guest operating system running inside the
12496	VM (if the Guest Additions for this system support this
12497	functionality). This information may be used by the frontends to
12498	implement the seamless desktop integration feature.
12499
12500	<note>
12501	The address of the provided array must be in the process space of
12502	this IFramebuffer object.
12503	</note>
12504	<note>
12505	The IFramebuffer implementation must make a copy of the provided
12506	array of rectangles.
12507	</note>
12508	<note>
12509	Method not yet implemented.
12510	</note>
12511	</desc>
12512	<param name="rectangles" type="octet" mod="ptr" dir="in">
12513	<desc>Pointer to the @c RTRECT array.</desc>
12514	</param>
12515	<param name="count" type="unsigned long" dir="in">
12516	<desc>Number of @c RTRECT elements in the @a rectangles array.</desc>
12517	</param>
12518	</method>
12519
12520	<method name="processVHWACommand">
12521	<desc>
12522	Posts a Video HW Acceleration Command to the frame buffer for processing.
12523	The commands used for 2D video acceleration (DDraw surface creation/destroying, blitting, scaling, color conversion, overlaying, etc.)
12524	are posted from quest to the host to be processed by the host hardware.
12525
12526	<note>
12527	The address of the provided command must be in the process space of
12528	this IFramebuffer object.
12529	</note>
12530	</desc>
12531
12532	<param name="command" type="octet" mod="ptr" dir="in">
12533	<desc>Pointer to VBOXVHWACMD containing the command to execute.</desc>
12534	</param>
12535	</method>
12536
12537	</interface>
12538
12539	<interface
12540	name="IFramebufferOverlay" extends="IFramebuffer"
12541	uuid="0bcc1c7e-e415-47d2-bfdb-e4c705fb0f47"
12542	wsmap="suppress"
12543	>
12544	<desc>
12545	The IFramebufferOverlay interface represents an alpha blended overlay
12546	for displaying status icons above an IFramebuffer. It is always created
12547	not visible, so that it must be explicitly shown. It only covers a
12548	portion of the IFramebuffer, determined by its width, height and
12549	co-ordinates. It is always in packed pixel little-endian 32bit ARGB (in
12550	that order) format, and may be written to directly. Do re-read the
12551	width though, after setting it, as it may be adjusted (increased) to
12552	make it more suitable for the front end.
12553	</desc>
12554	<attribute name="x" type="unsigned long" readonly="yes">
12555	<desc>X position of the overlay, relative to the frame buffer.</desc>
12556	</attribute>
12557
12558	<attribute name="y" type="unsigned long" readonly="yes">
12559	<desc>Y position of the overlay, relative to the frame buffer.</desc>
12560	</attribute>
12561
12562	<attribute name="visible" type="boolean" readonly="no">
12563	<desc>
12564	Whether the overlay is currently visible.
12565	</desc>
12566	</attribute>
12567
12568	<attribute name="alpha" type="unsigned long" readonly="no">
12569	<desc>
12570	The global alpha value for the overlay. This may or may not be
12571	supported by a given front end.
12572	</desc>
12573	</attribute>
12574
12575	<method name="move">
12576	<desc>
12577	Changes the overlay's position relative to the IFramebuffer.
12578	</desc>
12579	<param name="x" type="unsigned long" dir="in"/>
12580	<param name="y" type="unsigned long" dir="in"/>
12581	</method>
12582
12583	</interface>
12584
12585	<interface
12586	name="IDisplay" extends="$unknown"
12587	uuid="09EED313-CD56-4D06-BD56-FAC0F716B5DD"
12588	wsmap="managed"
12589	>
12590	<desc>
12591	The IDisplay interface represents the virtual machine's display.
12592
12593	The object implementing this interface is contained in each
12594	<link to="IConsole::display"/> attribute and represents the visual
12595	output of the virtual machine.
12596
12597	The virtual display supports pluggable output targets represented by the
12598	IFramebuffer interface. Examples of the output target are a window on
12599	the host computer or an RDP session's display on a remote computer.
12600	</desc>
12601	<method name="getScreenResolution">
12602	<desc>Queries display width, height and color depth for given screen.</desc>
12603	<param name="screenId" type="unsigned long" dir="in"/>
12604	<param name="width" type="unsigned long" dir="out"/>
12605	<param name="height" type="unsigned long" dir="out"/>
12606	<param name="bitsPerPixel" type="unsigned long" dir="out"/>
12607	</method>
12608
12609	<method name="setFramebuffer">
12610	<desc>
12611	Sets the framebuffer for given screen.
12612	</desc>
12613	<param name="screenId" type="unsigned long" dir="in"/>
12614	<param name="framebuffer" type="IFramebuffer" dir="in"/>
12615	</method>
12616
12617	<method name="getFramebuffer">
12618	<desc>
12619	Queries the framebuffer for given screen.
12620	</desc>
12621	<param name="screenId" type="unsigned long" dir="in"/>
12622	<param name="framebuffer" type="IFramebuffer" dir="out"/>
12623	<param name="xOrigin" type="long" dir="out"/>
12624	<param name="yOrigin" type="long" dir="out"/>
12625	</method>
12626
12627	<method name="setVideoModeHint">
12628	<desc>
12629	Asks VirtualBox to request the given video mode from
12630	the guest. This is just a hint and it cannot be guaranteed
12631	that the requested resolution will be used. Guest Additions
12632	are required for the request to be seen by guests. The caller
12633	should issue the request and wait for a resolution change and
12634	after a timeout retry.
12635
12636	Specifying @c 0 for either @a width, @a height or @a bitsPerPixel
12637	parameters means that the corresponding values should be taken from the
12638	current video mode (i.e. left unchanged).
12639
12640	If the guest OS supports multi-monitor configuration then the @a display
12641	parameter specifies the number of the guest display to send the hint to:
12642	@c 0 is the primary display, @c 1 is the first secondary and
12643	so on. If the multi-monitor configuration is not supported, @a display
12644	must be @c 0.
12645
12646	<result name="E_INVALIDARG">
12647	The @a display is not associated with any monitor.
12648	</result>
12649
12650	</desc>
12651	<param name="width" type="unsigned long" dir="in"/>
12652	<param name="height" type="unsigned long" dir="in"/>
12653	<param name="bitsPerPixel" type="unsigned long" dir="in"/>
12654	<param name="display" type="unsigned long" dir="in"/>
12655	</method>
12656
12657	<method name="setSeamlessMode">
12658	<desc>
12659	Enables or disables seamless guest display rendering (seamless desktop
12660	integration) mode.
12661	<note>
12662	Calling this method has no effect if <link
12663	to="IGuest::getFacilityStatus"/> with facility @c Seamless
12664	does not return @c Active.
12665	</note>
12666	</desc>
12667	<param name="enabled" type="boolean" dir="in"/>
12668	</method>
12669
12670	<method name="takeScreenShot">
12671	<desc>
12672	Takes a screen shot of the requested size and copies it to the
12673	32-bpp buffer allocated by the caller and pointed to by @a address.
12674	A pixel consists of 4 bytes in order: B, G, R, 0.
12675
12676	<note>This API can be used only locally by a VM process through the
12677	COM/XPCOM C++ API as it requires pointer support. It is not
12678	available for scripting langages, Java or any webservice clients.
12679	Unless you are writing a new VM frontend use
12680	<link to="#takeScreenShotToArray" />.
12681	</note>
12682
12683	<result name="E_NOTIMPL">
12684	Feature not implemented.
12685	</result>
12686	<result name="VBOX_E_IPRT_ERROR">
12687	Could not take a screenshot.
12688	</result>
12689
12690	</desc>
12691	<param name="screenId" type="unsigned long" dir="in"/>
12692	<param name="address" type="octet" mod="ptr" dir="in"/>
12693	<param name="width" type="unsigned long" dir="in"/>
12694	<param name="height" type="unsigned long" dir="in"/>
12695	</method>
12696
12697	<method name="takeScreenShotToArray">
12698	<desc>
12699	Takes a guest screen shot of the requested size and returns it as
12700	an array of bytes in uncompressed 32-bit RGBA format.
12701	A pixel consists of 4 bytes in order: R, G, B, 0xFF.
12702
12703	This API is slow, but could be the only option to get guest screenshot
12704	for scriptable languages not allowed to manipulate with addresses
12705	directly.
12706
12707	<result name="E_NOTIMPL">
12708	Feature not implemented.
12709	</result>
12710	<result name="VBOX_E_IPRT_ERROR">
12711	Could not take a screenshot.
12712	</result>
12713	</desc>
12714	<param name="screenId" type="unsigned long" dir="in">
12715	<desc>
12716	Monitor to take screenshot from.
12717	</desc>
12718	</param>
12719	<param name="width" type="unsigned long" dir="in">
12720	<desc>
12721	Desired image width.
12722	</desc>
12723	</param>
12724	<param name="height" type="unsigned long" dir="in">
12725	<desc>
12726	Desired image height.
12727	</desc>
12728	</param>
12729	<param name="screenData" type="octet" dir="return" safearray="yes">
12730	<desc>
12731	Array with resulting screen data.
12732	</desc>
12733	</param>
12734	</method>
12735
12736	<method name="takeScreenShotPNGToArray">
12737	<desc>
12738	Takes a guest screen shot of the requested size and returns it as
12739	PNG image in array.
12740
12741	<result name="E_NOTIMPL">
12742	Feature not implemented.
12743	</result>
12744	<result name="VBOX_E_IPRT_ERROR">
12745	Could not take a screenshot.
12746	</result>
12747	</desc>
12748	<param name="screenId" type="unsigned long" dir="in">
12749	<desc>
12750	Monitor to take the screenshot from.
12751	</desc>
12752	</param>
12753	<param name="width" type="unsigned long" dir="in">
12754	<desc>
12755	Desired image width.
12756	</desc>
12757	</param>
12758	<param name="height" type="unsigned long" dir="in">
12759	<desc>
12760	Desired image height.
12761	</desc>
12762	</param>
12763	<param name="screenData" type="octet" dir="return" safearray="yes">
12764	<desc>
12765	Array with resulting screen data.
12766	</desc>
12767	</param>
12768	</method>
12769
12770	<method name="drawToScreen">
12771	<desc>
12772	Draws a 32-bpp image of the specified size from the given buffer
12773	to the given point on the VM display.
12774
12775	<result name="E_NOTIMPL">
12776	Feature not implemented.
12777	</result>
12778	<result name="VBOX_E_IPRT_ERROR">
12779	Could not draw to screen.
12780	</result>
12781
12782	</desc>
12783	<param name="screenId" type="unsigned long" dir="in">
12784	<desc>
12785	Monitor to take the screenshot from.
12786	</desc>
12787	</param>
12788	<param name="address" type="octet" mod="ptr" dir="in">
12789	<desc>
12790	Address to store the screenshot to
12791	</desc>
12792	</param>
12793	<param name="x" type="unsigned long" dir="in">
12794	<desc>
12795	Relative to the screen top left corner.
12796	</desc>
12797	</param>
12798	<param name="y" type="unsigned long" dir="in">
12799	<desc>
12800	Relative to the screen top left corner.
12801	</desc>
12802	</param>
12803	<param name="width" type="unsigned long" dir="in">
12804	<desc>
12805	Desired image width.
12806	</desc>
12807	</param>
12808	<param name="height" type="unsigned long" dir="in">
12809	<desc>
12810	Desired image height.
12811	</desc>
12812	</param>
12813	</method>
12814
12815	<method name="invalidateAndUpdate">
12816	<desc>
12817	Does a full invalidation of the VM display and instructs the VM
12818	to update it.
12819
12820	<result name="VBOX_E_IPRT_ERROR">
12821	Could not invalidate and update screen.
12822	</result>
12823
12824	</desc>
12825	</method>
12826
12827	<method name="resizeCompleted">
12828	<desc>
12829	Signals that a framebuffer has completed the resize operation.
12830
12831	<result name="VBOX_E_NOT_SUPPORTED">
12832	Operation only valid for external frame buffers.
12833	</result>
12834
12835	</desc>
12836	<param name="screenId" type="unsigned long" dir="in"/>
12837	</method>
12838
12839	<method name="completeVHWACommand">
12840	<desc>
12841	Signals that the Video HW Acceleration command has completed.
12842	</desc>
12843
12844	<param name="command" type="octet" mod="ptr" dir="in">
12845	<desc>Pointer to VBOXVHWACMD containing the completed command.</desc>
12846	</param>
12847	</method>
12848
12849	</interface>
12850
12851	<!--
12852	// INetworkAdapter
12853	/////////////////////////////////////////////////////////////////////////
12854	-->
12855
12856	<enum
12857	name="NetworkAttachmentType"
12858	uuid="2ac4bc71-6b82-417a-acd1-f7426d2570d6"
12859	>
12860	<desc>
12861	Network attachment type.
12862	</desc>
12863
12864	<const name="Null" value="0">
12865	<desc>Null value, also means "not attached".</desc>
12866	</const>
12867	<const name="NAT" value="1"/>
12868	<const name="Bridged" value="2"/>
12869	<const name="Internal" value="3"/>
12870	<const name="HostOnly" value="4"/>
12871	<const name="Generic" value="5"/>
12872	</enum>
12873
12874	<enum
12875	name="NetworkAdapterType"
12876	uuid="3c2281e4-d952-4e87-8c7d-24379cb6a81c"
12877	>
12878	<desc>
12879	Network adapter type.
12880	</desc>
12881
12882	<const name="Null" value="0">
12883	<desc>Null value (never used by the API).</desc>
12884	</const>
12885	<const name="Am79C970A" value="1">
12886	<desc>AMD PCNet-PCI II network card (Am79C970A).</desc>
12887	</const>
12888	<const name="Am79C973" value="2">
12889	<desc>AMD PCNet-FAST III network card (Am79C973).</desc>
12890	</const>
12891	<const name="I82540EM" value="3">
12892	<desc>Intel PRO/1000 MT Desktop network card (82540EM).</desc>
12893	</const>
12894	<const name="I82543GC" value="4">
12895	<desc>Intel PRO/1000 T Server network card (82543GC).</desc>
12896	</const>
12897	<const name="I82545EM" value="5">
12898	<desc>Intel PRO/1000 MT Server network card (82545EM).</desc>
12899	</const>
12900	<const name="Virtio" value="6">
12901	<desc>Virtio network device.</desc>
12902	</const>
12903	</enum>
12904
12905	<enum
12906	name="NetworkAdapterPromiscModePolicy"
12907	uuid="c963768a-376f-4c85-8d84-d8ced4b7269e"
12908	>
12909	<desc>
12910	The promiscuous mode policy of an interface.
12911	</desc>
12912
12913	<const name="Deny" value="1">
12914	<desc>Deny promiscuous mode requests.</desc>
12915	</const>
12916	<const name="AllowNetwork" value="2">
12917	<desc>
12918	Allow promicuous mode, but restrict the scope it to the internal
12919	network so that it only applies to other VMs.
12920	</desc>
12921	</const>
12922	<const name="AllowAll" value="3">
12923	<desc>
12924	Allow promicuous mode, include unrelated traffic going over the wire
12925	and internally on the host.
12926	</desc>
12927	</const>
12928	</enum>
12929
12930	<interface
12931	name="INetworkAdapter" extends="$unknown"
12932	uuid="8b2e705c-0547-4008-b7bc-788757346092"
12933	wsmap="managed"
12934	>
12935	<desc>
12936	Represents a virtual network adapter that is attached to a virtual machine.
12937	Each virtual machine has a fixed number of network adapter slots with one
12938	instance of this attached to each of them. Call
12939	<link to="IMachine::getNetworkAdapter" /> to get the network adapter that
12940	is attached to a given slot in a given machine.
12941
12942	Each network adapter can be in one of five attachment modes, which are
12943	represented by the <link to="NetworkAttachmentType" /> enumeration;
12944	see the <link to="#attachmentType" /> attribute.
12945	</desc>
12946
12947	<attribute name="adapterType" type="NetworkAdapterType">
12948	<desc>
12949	Type of the virtual network adapter. Depending on this value,
12950	VirtualBox will provide a different virtual network hardware
12951	to the guest.
12952	</desc>
12953	</attribute>
12954
12955	<attribute name="slot" type="unsigned long" readonly="yes">
12956	<desc>
12957	Slot number this adapter is plugged into. Corresponds to
12958	the value you pass to <link to="IMachine::getNetworkAdapter"/>
12959	to obtain this instance.
12960	</desc>
12961	</attribute>
12962
12963	<attribute name="enabled" type="boolean">
12964	<desc>
12965	Flag whether the network adapter is present in the
12966	guest system. If disabled, the virtual guest hardware will
12967	not contain this network adapter. Can only be changed when
12968	the VM is not running.
12969	</desc>
12970	</attribute>
12971
12972	<attribute name="MACAddress" type="wstring">
12973	<desc>
12974	Ethernet MAC address of the adapter, 12 hexadecimal characters. When setting
12975	it to @c null or an empty string, VirtualBox will generate a unique MAC address.
12976	</desc>
12977	</attribute>
12978
12979	<attribute name="attachmentType" type="NetworkAttachmentType">
12980	<desc>
12981	Sets/Gets network attachment type of this network adapter.
12982	</desc>
12983	</attribute>
12984
12985	<attribute name="bridgedInterface" type="wstring">
12986	<desc>
12987	Name of the network interface the VM should be bridged to.
12988	</desc>
12989	</attribute>
12990
12991	<attribute name="hostOnlyInterface" type="wstring">
12992	<desc>
12993	Name of the host only network interface the VM is attached to.
12994	</desc>
12995	</attribute>
12996
12997	<attribute name="internalNetwork" type="wstring">
12998	<desc>
12999	Name of the internal network the VM is attached to.
13000	</desc>
13001	</attribute>
13002
13003	<attribute name="NATNetwork" type="wstring">
13004	<desc>
13005	Name of the NAT network the VM is attached to.
13006	</desc>
13007	</attribute>
13008
13009	<attribute name="genericDriver" type="wstring">
13010	<desc>
13011	Name of the driver to use for the "Generic" network attachment type.
13012	</desc>
13013	</attribute>
13014
13015	<attribute name="cableConnected" type="boolean">
13016	<desc>
13017	Flag whether the adapter reports the cable as connected or not.
13018	It can be used to report offline situations to a VM.
13019	</desc>
13020	</attribute>
13021
13022	<attribute name="lineSpeed" type="unsigned long">
13023	<desc>
13024	Line speed reported by custom drivers, in units of 1 kbps.
13025	</desc>
13026	</attribute>
13027
13028	<attribute name="promiscModePolicy" type="NetworkAdapterPromiscModePolicy">
13029	<desc>
13030	The promiscuous mode policy of the network adapter when attached to an
13031	internal network, host only network or a bridge.
13032	</desc>
13033	</attribute>
13034
13035	<attribute name="traceEnabled" type="boolean">
13036	<desc>
13037	Flag whether network traffic from/to the network card should be traced.
13038	Can only be toggled when the VM is turned off.
13039	</desc>
13040	</attribute>
13041
13042	<attribute name="traceFile" type="wstring">
13043	<desc>
13044	Filename where a network trace will be stored. If not set, VBox-pid.pcap
13045	will be used.
13046	</desc>
13047	</attribute>
13048
13049	<attribute name="natDriver" type="INATEngine" readonly="yes">
13050	<desc>
13051	Points to the NAT engine which handles the network address translation
13052	for this interface. This is active only when the interface actually uses
13053	NAT.
13054	</desc>
13055	</attribute>
13056
13057	<attribute name="bootPriority" type="unsigned long">
13058	<desc>
13059	Network boot priority of the adapter. Priority 1 is highest. If not set,
13060	the priority is considered to be at the lowest possible setting.
13061	</desc>
13062	</attribute>
13063
13064	<attribute name="bandwidthGroup" type="IBandwidthGroup">
13065	<desc>The bandwidth group this network adapter is assigned to.</desc>
13066	</attribute>
13067
13068	<!-- property methods -->
13069
13070	<method name="getProperty" const="yes">
13071	<desc>
13072	Returns the value of the network attachment property with the given name.
13073
13074	If the requested data @a key does not exist, this function will
13075	succeed and return an empty string in the @a value argument.
13076
13077	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13078	</desc>
13079	<param name="key" type="wstring" dir="in">
13080	<desc>Name of the property to get.</desc>
13081	</param>
13082	<param name="value" type="wstring" dir="return">
13083	<desc>Current property value.</desc>
13084	</param>
13085	</method>
13086
13087	<method name="setProperty">
13088	<desc>
13089	Sets the value of the network attachment property with the given name.
13090
13091	Setting the property value to @c null or an empty string is equivalent
13092	to deleting the existing value.
13093
13094	<result name="E_INVALIDARG">@a name is @c null or empty.</result>
13095	</desc>
13096	<param name="key" type="wstring" dir="in">
13097	<desc>Name of the property to set.</desc>
13098	</param>
13099	<param name="value" type="wstring" dir="in">
13100	<desc>Property value to set.</desc>
13101	</param>
13102	</method>
13103
13104	<method name="getProperties" const="yes">
13105	<desc>
13106	Returns values for a group of properties in one call.
13107
13108	The names of the properties to get are specified using the @a names
13109	argument which is a list of comma-separated property names or
13110	an empty string if all properties are to be returned.
13111	<note>Currently the value of this argument is ignored and the method
13112	always returns all existing properties.</note>
13113
13114	The method returns two arrays, the array of property names corresponding
13115	to the @a names argument and the current values of these properties.
13116	Both arrays have the same number of elements with each element at the
13117	given index in the first array corresponds to an element at the same
13118	index in the second array.
13119	</desc>
13120	<param name="names" type="wstring" dir="in">
13121	<desc>
13122	Names of properties to get.
13123	</desc>
13124	</param>
13125	<param name="returnNames" type="wstring" safearray="yes" dir="out">
13126	<desc>Names of returned properties.</desc>
13127	</param>
13128	<param name="returnValues" type="wstring" safearray="yes" dir="return">
13129	<desc>Values of returned properties.</desc>
13130	</param>
13131	</method>
13132
13133	</interface>
13134
13135
13136	<!--
13137	// ISerialPort
13138	/////////////////////////////////////////////////////////////////////////
13139	-->
13140
13141	<enum
13142	name="PortMode"
13143	uuid="533b5fe3-0185-4197-86a7-17e37dd39d76"
13144	>
13145	<desc>
13146	The PortMode enumeration represents possible communication modes for
13147	the virtual serial port device.
13148	</desc>
13149
13150	<const name="Disconnected" value="0">
13151	<desc>Virtual device is not attached to any real host device.</desc>
13152	</const>
13153	<const name="HostPipe" value="1">
13154	<desc>Virtual device is attached to a host pipe.</desc>
13155	</const>
13156	<const name="HostDevice" value="2">
13157	<desc>Virtual device is attached to a host device.</desc>
13158	</const>
13159	<const name="RawFile" value="3">
13160	<desc>Virtual device is attached to a raw file.</desc>
13161	</const>
13162	</enum>
13163
13164	<interface
13165	name="ISerialPort" extends="$unknown"
13166	uuid="937f6970-5103-4745-b78e-d28dcf1479a8"
13167	wsmap="managed"
13168	>
13169
13170	<desc>
13171	The ISerialPort interface represents the virtual serial port device.
13172
13173	The virtual serial port device acts like an ordinary serial port
13174	inside the virtual machine. This device communicates to the real
13175	serial port hardware in one of two modes: host pipe or host device.
13176
13177	In host pipe mode, the #path attribute specifies the path to the pipe on
13178	the host computer that represents a serial port. The #server attribute
13179	determines if this pipe is created by the virtual machine process at
13180	machine startup or it must already exist before starting machine
13181	execution.
13182
13183	In host device mode, the #path attribute specifies the name of the
13184	serial port device on the host computer.
13185
13186	There is also a third communication mode: the disconnected mode. In this
13187	mode, the guest OS running inside the virtual machine will be able to
13188	detect the serial port, but all port write operations will be discarded
13189	and all port read operations will return no data.
13190
13191	<see><link to="IMachine::getSerialPort"/></see>
13192	</desc>
13193
13194	<attribute name="slot" type="unsigned long" readonly="yes">
13195	<desc>
13196	Slot number this serial port is plugged into. Corresponds to
13197	the value you pass to <link to="IMachine::getSerialPort"/>
13198	to obtain this instance.
13199	</desc>
13200	</attribute>
13201
13202	<attribute name="enabled" type="boolean">
13203	<desc>
13204	Flag whether the serial port is enabled. If disabled,
13205	the serial port will not be reported to the guest OS.
13206	</desc>
13207	</attribute>
13208
13209	<attribute name="IOBase" type="unsigned long">
13210	<desc>Base I/O address of the serial port.</desc>
13211	</attribute>
13212
13213	<attribute name="IRQ" type="unsigned long">
13214	<desc>IRQ number of the serial port.</desc>
13215	</attribute>
13216
13217	<attribute name="hostMode" type="PortMode">
13218	<desc>
13219	How is this port connected to the host.
13220	<note>
13221	Changing this attribute may fail if the conditions for
13222	<link to="#path"/> are not met.
13223	</note>
13224	</desc>
13225	</attribute>
13226
13227	<attribute name="server" type="boolean">
13228	<desc>
13229	Flag whether this serial port acts as a server (creates a new pipe on
13230	the host) or as a client (uses the existing pipe). This attribute is
13231	used only when <link to="#hostMode"/> is PortMode_HostPipe.
13232	</desc>
13233	</attribute>
13234
13235	<attribute name="path" type="wstring">
13236	<desc>
13237	Path to the serial port's pipe on the host when <link to="ISerialPort::hostMode"/> is
13238	PortMode_HostPipe, or the host serial device name when
13239	<link to="ISerialPort::hostMode"/> is PortMode_HostDevice. For both
13240	cases, setting a @c null or empty string as the attribute's value
13241	is an error. Otherwise, the value of this property is ignored.
13242	</desc>
13243	</attribute>
13244
13245	</interface>
13246
13247	<!--
13248	// IParallelPort
13249	/////////////////////////////////////////////////////////////////////////
13250	-->
13251
13252	<interface
13253	name="IParallelPort" extends="$unknown"
13254	uuid="0c925f06-dd10-4b77-8de8-294d738c3214"
13255	wsmap="managed"
13256	>
13257
13258	<desc>
13259	The IParallelPort interface represents the virtual parallel port device.
13260
13261	The virtual parallel port device acts like an ordinary parallel port
13262	inside the virtual machine. This device communicates to the real
13263	parallel port hardware using the name of the parallel device on the host
13264	computer specified in the #path attribute.
13265
13266	Each virtual parallel port device is assigned a base I/O address and an
13267	IRQ number that will be reported to the guest operating system and used
13268	to operate the given parallel port from within the virtual machine.
13269
13270	<see><link to="IMachine::getParallelPort"/></see>
13271	</desc>
13272
13273	<attribute name="slot" type="unsigned long" readonly="yes">
13274	<desc>
13275	Slot number this parallel port is plugged into. Corresponds to
13276	the value you pass to <link to="IMachine::getParallelPort"/>
13277	to obtain this instance.
13278	</desc>
13279	</attribute>
13280
13281	<attribute name="enabled" type="boolean">
13282	<desc>
13283	Flag whether the parallel port is enabled. If disabled,
13284	the parallel port will not be reported to the guest OS.
13285	</desc>
13286	</attribute>
13287
13288	<attribute name="IOBase" type="unsigned long">
13289	<desc>Base I/O address of the parallel port.</desc>
13290	</attribute>
13291
13292	<attribute name="IRQ" type="unsigned long">
13293	<desc>IRQ number of the parallel port.</desc>
13294	</attribute>
13295
13296	<attribute name="path" type="wstring">
13297	<desc>
13298	Host parallel device name. If this parallel port is enabled, setting a
13299	@c null or an empty string as this attribute's value will result in
13300	an error.
13301	</desc>
13302	</attribute>
13303
13304	</interface>
13305
13306
13307	<!--
13308	// IMachineDebugger
13309	/////////////////////////////////////////////////////////////////////////
13310	-->
13311
13312	<interface
13313	name="IMachineDebugger" extends="$unknown"
13314	uuid="a9abbb7c-d678-43b2-bed2-19ec0e32303d"
13315	wsmap="suppress"
13316	>
13317	<method name="dumpGuestCore">
13318	<desc>
13319	Takes a core dump of the guest.
13320
13321	See include/VBox/dbgfcorefmt.h for details on the file format.
13322	</desc>
13323	<param name="filename" type="wstring" dir="in">
13324	<desc>
13325	The name of the output file. The file must not exist.
13326	</desc>
13327	</param>
13328	<param name="compression" type="wstring" dir="in">
13329	<desc>
13330	Reserved for future compression method indicator.
13331	</desc>
13332	</param>
13333	</method>
13334
13335	<method name="dumpHostProcessCore">
13336	<desc>
13337	Takes a core dump of the VM process on the host.
13338
13339	This feature is not implemented in the 4.0.0 release but it may show up
13340	in a dot release.
13341	</desc>
13342	<param name="filename" type="wstring" dir="in">
13343	<desc>
13344	The name of the output file. The file must not exist.
13345	</desc>
13346	</param>
13347	<param name="compression" type="wstring" dir="in">
13348	<desc>
13349	Reserved for future compression method indicator.
13350	</desc>
13351	</param>
13352	</method>
13353
13354	<method name="info">
13355	<desc>
13356	Interfaces with the info dumpers (DBGFInfo).
13357
13358	This feature is not implemented in the 4.0.0 release but it may show up
13359	in a dot release.
13360	</desc>
13361	<param name="name" type="wstring" dir="in">
13362	<desc>
13363	The name of the info item.
13364	</desc>
13365	</param>
13366	<param name="args" type="wstring" dir="in">
13367	<desc>
13368	Arguments to the info dumper.
13369	</desc>
13370	</param>
13371	<param name="info" type="wstring" dir="return">
13372	<desc>
13373	The into string.
13374	</desc>
13375	</param>
13376	</method>
13377
13378	<method name="injectNMI">
13379	<desc>
13380	Inject an NMI into a running VT-x/AMD-V VM.
13381	</desc>
13382	</method>
13383
13384	<method name="modifyLogGroups">
13385	<desc>
13386	Modifies the group settings of the debug or release logger.
13387	</desc>
13388	<param name="settings" type="wstring" dir="in">
13389	<desc>
13390	The group settings string. See iprt/log.h for details. To target the
13391	release logger, prefix the string with "release:".
13392	</desc>
13393	</param>
13394	</method>
13395
13396	<method name="modifyLogFlags">
13397	<desc>
13398	Modifies the debug or release logger flags.
13399	</desc>
13400	<param name="settings" type="wstring" dir="in">
13401	<desc>
13402	The flags settings string. See iprt/log.h for details. To target the
13403	release logger, prefix the string with "release:".
13404	</desc>
13405	</param>
13406	</method>
13407
13408	<method name="modifyLogDestinations">
13409	<desc>
13410	Modifies the debug or release logger destinations.
13411	</desc>
13412	<param name="settings" type="wstring" dir="in">
13413	<desc>
13414	The destination settings string. See iprt/log.h for details. To target the
13415	release logger, prefix the string with "release:".
13416	</desc>
13417	</param>
13418	</method>
13419
13420	<method name="readPhysicalMemory">
13421	<desc>
13422	Reads guest physical memory, no side effects (MMIO++).
13423
13424	This feature is not implemented in the 4.0.0 release but may show up
13425	in a dot release.
13426	</desc>
13427	<param name="address" type="long long" dir="in">
13428	<desc>The guest physical address.</desc>
13429	</param>
13430	<param name="size" type="unsigned long" dir="in">
13431	<desc>The number of bytes to read.</desc>
13432	</param>
13433	<param name="bytes" type="octet" safearray="yes" dir="return">
13434	<desc>The bytes read.</desc>
13435	</param>
13436	</method>
13437
13438	<method name="writePhysicalMemory">
13439	<desc>
13440	Writes guest physical memory, access handles (MMIO++) are ignored.
13441
13442	This feature is not implemented in the 4.0.0 release but may show up
13443	in a dot release.
13444	</desc>
13445	<param name="address" type="long long" dir="in">
13446	<desc>The guest physical address.</desc>
13447	</param>
13448	<param name="size" type="unsigned long" dir="in">
13449	<desc>The number of bytes to read.</desc>
13450	</param>
13451	<param name="bytes" type="octet" safearray="yes" dir="in">
13452	<desc>The bytes to write.</desc>
13453	</param>
13454	</method>
13455
13456	<method name="readVirtualMemory">
13457	<desc>
13458	Reads guest virtual memory, no side effects (MMIO++).
13459
13460	This feature is not implemented in the 4.0.0 release but may show up
13461	in a dot release.
13462	</desc>
13463	<param name="cpuId" type="unsigned long" dir="in">
13464	<desc>The identifier of the Virtual CPU.</desc>
13465	</param>
13466	<param name="address" type="long long" dir="in">
13467	<desc>The guest virtual address.</desc>
13468	</param>
13469	<param name="size" type="unsigned long" dir="in">
13470	<desc>The number of bytes to read.</desc>
13471	</param>
13472	<param name="bytes" type="octet" safearray="yes" dir="return">
13473	<desc>The bytes read.</desc>
13474	</param>
13475	</method>
13476
13477	<method name="writeVirtualMemory">
13478	<desc>
13479	Writes guest virtual memory, access handles (MMIO++) are ignored.
13480
13481	This feature is not implemented in the 4.0.0 release but may show up
13482	in a dot release.
13483	</desc>
13484	<param name="cpuId" type="unsigned long" dir="in">
13485	<desc>The identifier of the Virtual CPU.</desc>
13486	</param>
13487	<param name="address" type="long long" dir="in">
13488	<desc>The guest virtual address.</desc>
13489	</param>
13490	<param name="size" type="unsigned long" dir="in">
13491	<desc>The number of bytes to read.</desc>
13492	</param>
13493	<param name="bytes" type="octet" safearray="yes" dir="in">
13494	<desc>The bytes to write.</desc>
13495	</param>
13496	</method>
13497
13498	<method name="detectOS">
13499	<desc>
13500	Tries to (re-)detect the guest OS kernel.
13501
13502	This feature is not implemented in the 4.0.0 release but may show up
13503	in a dot release.
13504	</desc>
13505	<param name="os" type="wstring" dir="return">
13506	<desc>
13507	The detected OS kernel on success.
13508	</desc>
13509	</param>
13510	</method>
13511
13512	<method name="getRegister">
13513	<desc>
13514	Gets one register.
13515
13516	This feature is not implemented in the 4.0.0 release but may show up
13517	in a dot release.
13518	</desc>
13519	<param name="cpuId" type="unsigned long" dir="in">
13520	<desc>The identifier of the Virtual CPU.</desc>
13521	</param>
13522	<param name="name" type="wstring" dir="in">
13523	<desc>The register name, case is ignored.</desc>
13524	</param>
13525	<param name="value" type="wstring" dir="return">
13526	<desc>
13527	The register value. This is usually a hex value (always 0x prefixed)
13528	but other format may be used for floating point registers (TBD).
13529	</desc>
13530	</param>
13531	</method>
13532
13533	<method name="getRegisters">
13534	<desc>
13535	Gets all the registers for the given CPU.
13536
13537	This feature is not implemented in the 4.0.0 release but may show up
13538	in a dot release.
13539	</desc>
13540	<param name="cpuId" type="unsigned long" dir="in">
13541	<desc>The identifier of the Virtual CPU.</desc>
13542	</param>
13543	<param name="names" type="wstring" dir="out" safearray="yes">
13544	<desc>Array containing the lowercase register names.</desc>
13545	</param>
13546	<param name="values" type="wstring" dir="out" safearray="yes">
13547	<desc>
13548	Array paralell to the names holding the register values as if the
13549	register was returned by <link to="IMachineDebugger::getRegister"/>.
13550	</desc>
13551	</param>
13552	</method>
13553
13554	<method name="setRegister">
13555	<desc>
13556	Gets one register.
13557
13558	This feature is not implemented in the 4.0.0 release but may show up
13559	in a dot release.
13560	</desc>
13561	<param name="cpuId" type="unsigned long" dir="in">
13562	<desc>The identifier of the Virtual CPU.</desc>
13563	</param>
13564	<param name="name" type="wstring" dir="in">
13565	<desc>The register name, case is ignored.</desc>
13566	</param>
13567	<param name="value" type="wstring" dir="in">
13568	<desc>
13569	The new register value. Hexadecimal, decimal and octal formattings
13570	are supported in addition to any special formattings returned by
13571	the getters.
13572	</desc>
13573	</param>
13574	</method>
13575
13576	<method name="setRegisters">
13577	<desc>
13578	Sets zero or more registers atomically.
13579
13580	This feature is not implemented in the 4.0.0 release but may show up
13581	in a dot release.
13582	</desc>
13583	<param name="cpuId" type="unsigned long" dir="in">
13584	<desc>The identifier of the Virtual CPU.</desc>
13585	</param>
13586	<param name="names" type="wstring" dir="in" safearray="yes">
13587	<desc>Array containing the register names, case ignored.</desc>
13588	</param>
13589	<param name="values" type="wstring" dir="in" safearray="yes">
13590	<desc>
13591	Array paralell to the names holding the register values. See
13592	<link to="IMachineDebugger::setRegister"/> for formatting
13593	guidelines.
13594	</desc>
13595	</param>
13596	</method>
13597
13598	<method name="dumpGuestStack">
13599	<desc>
13600	Produce a simple stack dump using the current guest state.
13601
13602	This feature is not implemented in the 4.0.0 release but may show up
13603	in a dot release.
13604	</desc>
13605	<param name="cpuId" type="unsigned long" dir="in">
13606	<desc>The identifier of the Virtual CPU.</desc>
13607	</param>
13608	<param name="stack" type="wstring" dir="return">
13609	<desc>String containing the formatted stack dump.</desc>
13610	</param>
13611	</method>
13612
13613	<method name="resetStats">
13614	<desc>
13615	Reset VM statistics.
13616	</desc>
13617	<param name="pattern" type="wstring" dir="in">
13618	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13619	</param>
13620	</method>
13621
13622	<method name="dumpStats">
13623	<desc>
13624	Dumps VM statistics.
13625	</desc>
13626	<param name="pattern" type="wstring" dir="in">
13627	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13628	</param>
13629	</method>
13630
13631	<method name="getStats">
13632	<desc>
13633	Get the VM statistics in a XMLish format.
13634	</desc>
13635	<param name="pattern" type="wstring" dir="in">
13636	<desc>The selection pattern. A bit similar to filename globbing.</desc>
13637	</param>
13638	<param name="withDescriptions" type="boolean" dir="in">
13639	<desc>Whether to include the descriptions.</desc>
13640	</param>
13641	<param name="stats" type="wstring" dir="out">
13642	<desc>The XML document containing the statistics.</desc>
13643	</param>
13644	</method>
13645
13646	<attribute name="singleStep" type="boolean">
13647	<desc>Switch for enabling single-stepping.</desc>
13648	</attribute>
13649
13650	<attribute name="recompileUser" type="boolean">
13651	<desc>Switch for forcing code recompilation for user mode code.</desc>
13652	</attribute>
13653
13654	<attribute name="recompileSupervisor" type="boolean">
13655	<desc>Switch for forcing code recompilation for supervisor mode code.</desc>
13656	</attribute>
13657
13658	<attribute name="PATMEnabled" type="boolean">
13659	<desc>Switch for enabling and disabling the PATM component.</desc>
13660	</attribute>
13661
13662	<attribute name="CSAMEnabled" type="boolean">
13663	<desc>Switch for enabling and disabling the CSAM component.</desc>
13664	</attribute>
13665
13666	<attribute name="logEnabled" type="boolean">
13667	<desc>Switch for enabling and disabling the debug logger.</desc>
13668	</attribute>
13669
13670	<attribute name="logDbgFlags" type="wstring" readonly="yes">
13671	<desc>The debug logger flags.</desc>
13672	</attribute>
13673
13674	<attribute name="logDbgGroups" type="wstring" readonly="yes">
13675	<desc>The debug logger's group settings.</desc>
13676	</attribute>
13677
13678	<attribute name="logDbgDestinations" type="wstring" readonly="yes">
13679	<desc>The debug logger's destination settings.</desc>
13680	</attribute>
13681
13682	<attribute name="logRelFlags" type="wstring" readonly="yes">
13683	<desc>The release logger flags.</desc>
13684	</attribute>
13685
13686	<attribute name="logRelGroups" type="wstring" readonly="yes">
13687	<desc>The release logger's group settings.</desc>
13688	</attribute>
13689
13690	<attribute name="logRelDestinations" type="wstring" readonly="yes">
13691	<desc>The relase logger's destination settings.</desc>
13692	</attribute>
13693
13694	<attribute name="HWVirtExEnabled" type="boolean" readonly="yes">
13695	<desc>
13696	Flag indicating whether the VM is currently making use of CPU hardware
13697	virtualization extensions.
13698	</desc>
13699	</attribute>
13700
13701	<attribute name="HWVirtExNestedPagingEnabled" type="boolean" readonly="yes">
13702	<desc>
13703	Flag indicating whether the VM is currently making use of the nested paging
13704	CPU hardware virtualization extension.
13705	</desc>
13706	</attribute>
13707
13708	<attribute name="HWVirtExVPIDEnabled" type="boolean" readonly="yes">
13709	<desc>
13710	Flag indicating whether the VM is currently making use of the VPID
13711	VT-x extension.
13712	</desc>
13713	</attribute>
13714
13715	<attribute name="OSName" type="wstring" readonly="yes">
13716	<desc>
13717	Query the guest OS kernel name as detected by the DBGF.
13718
13719	This feature is not implemented in the 4.0.0 release but may show up
13720	in a dot release.
13721	</desc>
13722	</attribute>
13723
13724	<attribute name="OSVersion" type="wstring" readonly="yes">
13725	<desc>
13726	Query the guest OS kernel version string as detected by the DBGF.
13727
13728	This feature is not implemented in the 4.0.0 release but may show up
13729	in a dot release.
13730	</desc>
13731	</attribute>
13732
13733	<attribute name="PAEEnabled" type="boolean" readonly="yes">
13734	<desc>
13735	Flag indicating whether the VM is currently making use of the Physical
13736	Address Extension CPU feature.
13737	</desc>
13738	</attribute>
13739
13740	<attribute name="virtualTimeRate" type="unsigned long">
13741	<desc>
13742	The rate at which the virtual time runs expressed as a percentage.
13743	The accepted range is 2% to 20000%.
13744	</desc>
13745	</attribute>
13746
13747	<attribute name="VM" type="long long" readonly="yes">
13748	<desc>
13749	Gets the VM handle. This is only for internal use while
13750	we carve the details of this interface.
13751	</desc>
13752	</attribute>
13753
13754	</interface>
13755
13756	<!--
13757	// IUSBController
13758	/////////////////////////////////////////////////////////////////////////
13759	-->
13760
13761	<interface
13762	name="IUSBController" extends="$unknown"
13763	uuid="6fdcccc5-abd3-4fec-9387-2ad3914fc4a8"
13764	wsmap="managed"
13765	>
13766	<attribute name="enabled" type="boolean">
13767	<desc>
13768	Flag whether the USB controller is present in the
13769	guest system. If disabled, the virtual guest hardware will
13770	not contain any USB controller. Can only be changed when
13771	the VM is powered off.
13772	</desc>
13773	</attribute>
13774
13775	<attribute name="enabledEhci" type="boolean">
13776	<desc>
13777	Flag whether the USB EHCI controller is present in the
13778	guest system. If disabled, the virtual guest hardware will
13779	not contain a USB EHCI controller. Can only be changed when
13780	the VM is powered off.
13781	</desc>
13782	</attribute>
13783
13784	<attribute name="proxyAvailable" type="boolean" readonly="yes">
13785	<desc>
13786	Flag whether there is an USB proxy available.
13787	</desc>
13788	</attribute>
13789
13790	<attribute name="USBStandard" type="unsigned short" readonly="yes">
13791	<desc>
13792	USB standard version which the controller implements.
13793	This is a BCD which means that the major version is in the
13794	high byte and minor version is in the low byte.
13795	</desc>
13796	</attribute>
13797
13798	<attribute name="deviceFilters" type="IUSBDeviceFilter" readonly="yes" safearray="yes">
13799	<desc>
13800	List of USB device filters associated with the machine.
13801
13802	If the machine is currently running, these filters are activated
13803	every time a new (supported) USB device is attached to the host
13804	computer that was not ignored by global filters
13805	(<link to="IHost::USBDeviceFilters"/>).
13806
13807	These filters are also activated when the machine is powered up.
13808	They are run against a list of all currently available USB
13809	devices (in states
13810	<link to="USBDeviceState_Available"/>,
13811	<link to="USBDeviceState_Busy"/>,
13812	<link to="USBDeviceState_Held"/>) that were not previously
13813	ignored by global filters.
13814
13815	If at least one filter matches the USB device in question, this
13816	device is automatically captured (attached to) the virtual USB
13817	controller of this machine.
13818
13819	<see><link to="IUSBDeviceFilter"/>, <link to="IUSBController"/></see>
13820	</desc>
13821	</attribute>
13822
13823	<method name="createDeviceFilter">
13824	<desc>
13825	Creates a new USB device filter. All attributes except
13826	the filter name are set to empty (any match),
13827	<i>active</i> is @c false (the filter is not active).
13828
13829	The created filter can then be added to the list of filters using
13830	<link to="#insertDeviceFilter"/>.
13831
13832	<result name="VBOX_E_INVALID_VM_STATE">
13833	The virtual machine is not mutable.
13834	</result>
13835
13836	<see><link to="#deviceFilters"/></see>
13837	</desc>
13838	<param name="name" type="wstring" dir="in">
13839	<desc>
13840	Filter name. See <link to="IUSBDeviceFilter::name"/>
13841	for more info.
13842	</desc>
13843	</param>
13844	<param name="filter" type="IUSBDeviceFilter" dir="return">
13845	<desc>Created filter object.</desc>
13846	</param>
13847	</method>
13848
13849	<method name="insertDeviceFilter">
13850	<desc>
13851	Inserts the given USB device to the specified position
13852	in the list of filters.
13853
13854	Positions are numbered starting from <tt>0</tt>. If the specified
13855	position is equal to or greater than the number of elements in
13856	the list, the filter is added to the end of the collection.
13857
13858	<note>
13859	Duplicates are not allowed, so an attempt to insert a
13860	filter that is already in the collection, will return an
13861	error.
13862	</note>
13863
13864	<result name="VBOX_E_INVALID_VM_STATE">
13865	Virtual machine is not mutable.
13866	</result>
13867	<result name="E_INVALIDARG">
13868	USB device filter not created within this VirtualBox instance.
13869	</result>
13870	<result name="VBOX_E_INVALID_OBJECT_STATE">
13871	USB device filter already in list.
13872	</result>
13873
13874	<see><link to="#deviceFilters"/></see>
13875	</desc>
13876	<param name="position" type="unsigned long" dir="in">
13877	<desc>Position to insert the filter to.</desc>
13878	</param>
13879	<param name="filter" type="IUSBDeviceFilter" dir="in">
13880	<desc>USB device filter to insert.</desc>
13881	</param>
13882	</method>
13883
13884	<method name="removeDeviceFilter">
13885	<desc>
13886	Removes a USB device filter from the specified position in the
13887	list of filters.
13888
13889	Positions are numbered starting from <tt>0</tt>. Specifying a
13890	position equal to or greater than the number of elements in
13891	the list will produce an error.
13892
13893	<see><link to="#deviceFilters"/></see>
13894
13895	<result name="VBOX_E_INVALID_VM_STATE">
13896	Virtual machine is not mutable.
13897	</result>
13898	<result name="E_INVALIDARG">
13899	USB device filter list empty or invalid @a position.
13900	</result>
13901
13902	</desc>
13903	<param name="position" type="unsigned long" dir="in">
13904	<desc>Position to remove the filter from.</desc>
13905	</param>
13906	<param name="filter" type="IUSBDeviceFilter" dir="return">
13907	<desc>Removed USB device filter.</desc>
13908	</param>
13909	</method>
13910
13911	</interface>
13912
13913
13914	<!--
13915	// IUSBDevice
13916	/////////////////////////////////////////////////////////////////////////
13917	-->
13918
13919	<interface
13920	name="IUSBDevice" extends="$unknown"
13921	uuid="f8967b0b-4483-400f-92b5-8b675d98a85b"
13922	wsmap="managed"
13923	>
13924	<desc>
13925	The IUSBDevice interface represents a virtual USB device attached to the
13926	virtual machine.
13927
13928	A collection of objects implementing this interface is stored in the
13929	<link to="IConsole::USBDevices"/> attribute which lists all USB devices
13930	attached to a running virtual machine's USB controller.
13931	</desc>
13932
13933	<attribute name="id" type="uuid" mod="string" readonly="yes">
13934	<desc>
13935	Unique USB device ID. This ID is built from #vendorId,
13936	#productId, #revision and #serialNumber.
13937	</desc>
13938	</attribute>
13939
13940	<attribute name="vendorId" type="unsigned short" readonly="yes">
13941	<desc>Vendor ID.</desc>
13942	</attribute>
13943
13944	<attribute name="productId" type="unsigned short" readonly="yes">
13945	<desc>Product ID.</desc>
13946	</attribute>
13947
13948	<attribute name="revision" type="unsigned short" readonly="yes">
13949	<desc>
13950	Product revision number. This is a packed BCD represented as
13951	unsigned short. The high byte is the integer part and the low
13952	byte is the decimal.
13953	</desc>
13954	</attribute>
13955
13956	<attribute name="manufacturer" type="wstring" readonly="yes">
13957	<desc>Manufacturer string.</desc>
13958	</attribute>
13959
13960	<attribute name="product" type="wstring" readonly="yes">
13961	<desc>Product string.</desc>
13962	</attribute>
13963
13964	<attribute name="serialNumber" type="wstring" readonly="yes">
13965	<desc>Serial number string.</desc>
13966	</attribute>
13967
13968	<attribute name="address" type="wstring" readonly="yes">
13969	<desc>Host specific address of the device.</desc>
13970	</attribute>
13971
13972	<attribute name="port" type="unsigned short" readonly="yes">
13973	<desc>
13974	Host USB port number the device is physically
13975	connected to.
13976	</desc>
13977	</attribute>
13978
13979	<attribute name="version" type="unsigned short" readonly="yes">
13980	<desc>
13981	The major USB version of the device - 1 or 2.
13982	</desc>
13983	</attribute>
13984
13985	<attribute name="portVersion" type="unsigned short" readonly="yes">
13986	<desc>
13987	The major USB version of the host USB port the device is
13988	physically connected to - 1 or 2. For devices not connected to
13989	anything this will have the same value as the version attribute.
13990	</desc>
13991	</attribute>
13992
13993	<attribute name="remote" type="boolean" readonly="yes">
13994	<desc>
13995	Whether the device is physically connected to a remote VRDE
13996	client or to a local host machine.
13997	</desc>
13998	</attribute>
13999
14000	</interface>
14001
14002
14003	<!--
14004	// IUSBDeviceFilter
14005	/////////////////////////////////////////////////////////////////////////
14006	-->
14007
14008	<interface
14009	name="IUSBDeviceFilter" extends="$unknown"
14010	uuid="d6831fb4-1a94-4c2c-96ef-8d0d6192066d"
14011	wsmap="managed"
14012	>
14013	<desc>
14014	The IUSBDeviceFilter interface represents an USB device filter used
14015	to perform actions on a group of USB devices.
14016
14017	This type of filters is used by running virtual machines to
14018	automatically capture selected USB devices once they are physically
14019	attached to the host computer.
14020
14021	A USB device is matched to the given device filter if and only if all
14022	attributes of the device match the corresponding attributes of the
14023	filter (that is, attributes are joined together using the logical AND
14024	operation). On the other hand, all together, filters in the list of
14025	filters carry the semantics of the logical OR operation. So if it is
14026	desirable to create a match like "this vendor id OR this product id",
14027	one needs to create two filters and specify "any match" (see below)
14028	for unused attributes.
14029
14030	All filter attributes used for matching are strings. Each string
14031	is an expression representing a set of values of the corresponding
14032	device attribute, that will match the given filter. Currently, the
14033	following filtering expressions are supported:
14034
14035	<ul>
14036	<li><i>Interval filters</i>. Used to specify valid intervals for
14037	integer device attributes (Vendor ID, Product ID and Revision).
14038	The format of the string is:
14039
14040	<tt>int:((m)\|([m]-[n]))(,(m)\|([m]-[n]))*</tt>
14041
14042	where <tt>m</tt> and <tt>n</tt> are integer numbers, either in octal
14043	(starting from <tt>0</tt>), hexadecimal (starting from <tt>0x</tt>)
14044	or decimal (otherwise) form, so that <tt>m < n</tt>. If <tt>m</tt>
14045	is omitted before a dash (<tt>-</tt>), the minimum possible integer
14046	is assumed; if <tt>n</tt> is omitted after a dash, the maximum
14047	possible integer is assumed.
14048	</li>
14049	<li><i>Boolean filters</i>. Used to specify acceptable values for
14050	boolean device attributes. The format of the string is:
14051
14052	<tt>true\|false\|yes\|no\|0\|1</tt>
14053
14054	</li>
14055	<li><i>Exact match</i>. Used to specify a single value for the given
14056	device attribute. Any string that doesn't start with <tt>int:</tt>
14057	represents the exact match. String device attributes are compared to
14058	this string including case of symbols. Integer attributes are first
14059	converted to a string (see individual filter attributes) and then
14060	compared ignoring case.
14061
14062	</li>
14063	<li><i>Any match</i>. Any value of the corresponding device attribute
14064	will match the given filter. An empty or @c null string is
14065	used to construct this type of filtering expressions.
14066
14067	</li>
14068	</ul>
14069
14070	<note>
14071	On the Windows host platform, interval filters are not currently
14072	available. Also all string filter attributes
14073	(<link to="#manufacturer"/>, <link to="#product"/>,
14074	<link to="#serialNumber"/>) are ignored, so they behave as
14075	<i>any match</i> no matter what string expression is specified.
14076	</note>
14077
14078	<see><link to="IUSBController::deviceFilters"/>,
14079	<link to="IHostUSBDeviceFilter"/></see>
14080	</desc>
14081
14082	<attribute name="name" type="wstring">
14083	<desc>
14084	Visible name for this filter.
14085	This name is used to visually distinguish one filter from another,
14086	so it can neither be @c null nor an empty string.
14087	</desc>
14088	</attribute>
14089
14090	<attribute name="active" type="boolean">
14091	<desc>Whether this filter active or has been temporarily disabled.</desc>
14092	</attribute>
14093
14094	<attribute name="vendorId" type="wstring">
14095	<desc>
14096	<link to="IUSBDevice::vendorId">Vendor ID</link> filter.
14097	The string representation for the <i>exact matching</i>
14098	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14099	(including leading zeroes).
14100	</desc>
14101	</attribute>
14102
14103	<attribute name="productId" type="wstring">
14104	<desc>
14105	<link to="IUSBDevice::productId">Product ID</link> filter.
14106	The string representation for the <i>exact matching</i>
14107	has the form <tt>XXXX</tt>, where <tt>X</tt> is the hex digit
14108	(including leading zeroes).
14109	</desc>
14110	</attribute>
14111
14112	<attribute name="revision" type="wstring">
14113	<desc>
14114	<link to="IUSBDevice::productId">Product revision number</link>
14115	filter. The string representation for the <i>exact matching</i>
14116	has the form <tt>IIFF</tt>, where <tt>I</tt> is the decimal digit
14117	of the integer part of the revision, and <tt>F</tt> is the
14118	decimal digit of its fractional part (including leading and
14119	trailing zeros).
14120	Note that for interval filters, it's best to use the hexadecimal
14121	form, because the revision is stored as a 16 bit packed BCD value;
14122	so the expression <tt>int:0x0100-0x0199</tt> will match any
14123	revision from <tt>1.0</tt> to <tt>1.99</tt>.
14124	</desc>
14125	</attribute>
14126
14127	<attribute name="manufacturer" type="wstring">
14128	<desc>
14129	<link to="IUSBDevice::manufacturer">Manufacturer</link> filter.
14130	</desc>
14131	</attribute>
14132
14133	<attribute name="product" type="wstring">
14134	<desc>
14135	<link to="IUSBDevice::product">Product</link> filter.
14136	</desc>
14137	</attribute>
14138
14139	<attribute name="serialNumber" type="wstring">
14140	<desc>
14141	<link to="IUSBDevice::serialNumber">Serial number</link> filter.
14142	</desc>
14143	</attribute>
14144
14145	<attribute name="port" type="wstring">
14146	<desc>
14147	<link to="IUSBDevice::port">Host USB port</link> filter.
14148	</desc>
14149	</attribute>
14150
14151	<attribute name="remote" type="wstring">
14152	<desc>
14153	<link to="IUSBDevice::remote">Remote state</link> filter.
14154	<note>
14155	This filter makes sense only for machine USB filters,
14156	i.e. it is ignored by IHostUSBDeviceFilter objects.
14157	</note>
14158	</desc>
14159	</attribute>
14160
14161	<attribute name="maskedInterfaces" type="unsigned long">
14162	<desc>
14163	This is an advanced option for hiding one or more USB interfaces
14164	from the guest. The value is a bit mask where the bits that are set
14165	means the corresponding USB interface should be hidden, masked off
14166	if you like.
14167	This feature only works on Linux hosts.
14168	</desc>
14169	</attribute>
14170
14171	</interface>
14172
14173
14174	<!--
14175	// IHostUSBDevice
14176	/////////////////////////////////////////////////////////////////////////
14177	-->
14178
14179	<enum
14180	name="USBDeviceState"
14181	uuid="b99a2e65-67fb-4882-82fd-f3e5e8193ab4"
14182	>
14183	<desc>
14184	USB device state. This enumeration represents all possible states
14185	of the USB device physically attached to the host computer regarding
14186	its state on the host computer and availability to guest computers
14187	(all currently running virtual machines).
14188
14189	Once a supported USB device is attached to the host, global USB
14190	filters (<link to="IHost::USBDeviceFilters"/>) are activated. They can
14191	either ignore the device, or put it to USBDeviceState_Held state, or do
14192	nothing. Unless the device is ignored by global filters, filters of all
14193	currently running guests (<link to="IUSBController::deviceFilters"/>) are
14194	activated that can put it to USBDeviceState_Captured state.
14195
14196	If the device was ignored by global filters, or didn't match
14197	any filters at all (including guest ones), it is handled by the host
14198	in a normal way. In this case, the device state is determined by
14199	the host and can be one of USBDeviceState_Unavailable, USBDeviceState_Busy
14200	or USBDeviceState_Available, depending on the current device usage.
14201
14202	Besides auto-capturing based on filters, the device can be manually
14203	captured by guests (<link to="IConsole::attachUSBDevice"/>) if its
14204	state is USBDeviceState_Busy, USBDeviceState_Available or
14205	USBDeviceState_Held.
14206
14207	<note>
14208	Due to differences in USB stack implementations in Linux and Win32,
14209	states USBDeviceState_Busy and USBDeviceState_Unavailable are applicable
14210	only to the Linux version of the product. This also means that (<link
14211	to="IConsole::attachUSBDevice"/>) can only succeed on Win32 if the
14212	device state is USBDeviceState_Held.
14213	</note>
14214
14215	<see><link to="IHostUSBDevice"/>, <link to="IHostUSBDeviceFilter"/></see>
14216	</desc>
14217
14218	<const name="NotSupported" value="0">
14219	<desc>
14220	Not supported by the VirtualBox server, not available to guests.
14221	</desc>
14222	</const>
14223	<const name="Unavailable" value="1">
14224	<desc>
14225	Being used by the host computer exclusively,
14226	not available to guests.
14227	</desc>
14228	</const>
14229	<const name="Busy" value="2">
14230	<desc>
14231	Being used by the host computer, potentially available to guests.
14232	</desc>
14233	</const>
14234	<const name="Available" value="3">
14235	<desc>
14236	Not used by the host computer, available to guests (the host computer
14237	can also start using the device at any time).
14238	</desc>
14239	</const>
14240	<const name="Held" value="4">
14241	<desc>
14242	Held by the VirtualBox server (ignored by the host computer),
14243	available to guests.
14244	</desc>
14245	</const>
14246	<const name="Captured" value="5">
14247	<desc>
14248	Captured by one of the guest computers, not available
14249	to anybody else.
14250	</desc>
14251	</const>
14252	</enum>
14253
14254	<interface
14255	name="IHostUSBDevice" extends="IUSBDevice"
14256	uuid="173b4b44-d268-4334-a00d-b6521c9a740a"
14257	wsmap="managed"
14258	>
14259	<desc>
14260	The IHostUSBDevice interface represents a physical USB device attached
14261	to the host computer.
14262
14263	Besides properties inherited from IUSBDevice, this interface adds the
14264	<link to="#state"/> property that holds the current state of the USB
14265	device.
14266
14267	<see><link to="IHost::USBDevices"/>,
14268	<link to="IHost::USBDeviceFilters"/></see>
14269	</desc>
14270
14271	<attribute name="state" type="USBDeviceState" readonly="yes">
14272	<desc>
14273	Current state of the device.
14274	</desc>
14275	</attribute>
14276
14277	<!-- @todo add class, subclass, bandwidth, configs, interfaces endpoints and such later. -->
14278
14279	</interface>
14280
14281
14282	<!--
14283	// IHostUSBDeviceFilter
14284	/////////////////////////////////////////////////////////////////////////
14285	-->
14286
14287	<enum
14288	name="USBDeviceFilterAction"
14289	uuid="cbc30a49-2f4e-43b5-9da6-121320475933"
14290	>
14291	<desc>
14292	Actions for host USB device filters.
14293	<see><link to="IHostUSBDeviceFilter"/>, <link to="USBDeviceState"/></see>
14294	</desc>
14295
14296	<const name="Null" value="0">
14297	<desc>Null value (never used by the API).</desc>
14298	</const>
14299	<const name="Ignore" value="1">
14300	<desc>Ignore the matched USB device.</desc>
14301	</const>
14302	<const name="Hold" value="2">
14303	<desc>Hold the matched USB device.</desc>
14304	</const>
14305	</enum>
14306
14307	<interface
14308	name="IHostUSBDeviceFilter" extends="IUSBDeviceFilter"
14309	uuid="4cc70246-d74a-400f-8222-3900489c0374"
14310	wsmap="managed"
14311	>
14312	<desc>
14313	The IHostUSBDeviceFilter interface represents a global filter for a
14314	physical USB device used by the host computer. Used indirectly in
14315	<link to="IHost::USBDeviceFilters"/>.
14316
14317	Using filters of this type, the host computer determines the initial
14318	state of the USB device after it is physically attached to the
14319	host's USB controller.
14320
14321	<note>
14322	The <link to="IUSBDeviceFilter::remote"/> attribute is ignored by this type of
14323	filters, because it makes sense only for
14324	<link to="IUSBController::deviceFilters">machine USB filters</link>.
14325	</note>
14326
14327	<see><link to="IHost::USBDeviceFilters"/></see>
14328	</desc>
14329
14330	<attribute name="action" type="USBDeviceFilterAction">
14331	<desc>
14332	Action performed by the host when an attached USB device
14333	matches this filter.
14334	</desc>
14335	</attribute>
14336
14337	</interface>
14338
14339	<!--
14340	// IAudioAdapter
14341	/////////////////////////////////////////////////////////////////////////
14342	-->
14343
14344	<enum
14345	name="AudioDriverType"
14346	uuid="4bcc3d73-c2fe-40db-b72f-0c2ca9d68496"
14347	>
14348	<desc>
14349	Host audio driver type.
14350	</desc>
14351
14352	<const name="Null" value="0">
14353	<desc>Null value, also means "dummy audio driver".</desc>
14354	</const>
14355	<const name="WinMM" value="1">
14356	<desc>Windows multimedia (Windows hosts only).</desc>
14357	</const>
14358	<const name="OSS" value="2">
14359	<desc>Open Sound System (Linux hosts only).</desc>
14360	</const>
14361	<const name="ALSA" value="3">
14362	<desc>Advanced Linux Sound Architecture (Linux hosts only).</desc>
14363	</const>
14364	<const name="DirectSound" value="4">
14365	<desc>DirectSound (Windows hosts only).</desc>
14366	</const>
14367	<const name="CoreAudio" value="5">
14368	<desc>CoreAudio (Mac hosts only).</desc>
14369	</const>
14370	<const name="MMPM" value="6">
14371	<desc>Reserved for historical reasons.</desc>
14372	</const>
14373	<const name="Pulse" value="7">
14374	<desc>PulseAudio (Linux hosts only).</desc>
14375	</const>
14376	<const name="SolAudio" value="8">
14377	<desc>Solaris audio (Solaris hosts only).</desc>
14378	</const>
14379	</enum>
14380
14381	<enum
14382	name="AudioControllerType"
14383	uuid="7afd395c-42c3-444e-8788-3ce80292f36c"
14384	>
14385	<desc>
14386	Virtual audio controller type.
14387	</desc>
14388
14389	<const name="AC97" value="0"/>
14390	<const name="SB16" value="1"/>
14391	<const name="HDA" value="2"/>
14392	</enum>
14393
14394	<interface
14395	name="IAudioAdapter" extends="$unknown"
14396	uuid="921873db-5f3f-4b69-91f9-7be9e535a2cb"
14397	wsmap="managed"
14398	>
14399	<desc>
14400	The IAudioAdapter interface represents the virtual audio adapter of
14401	the virtual machine. Used in <link to="IMachine::audioAdapter"/>.
14402	</desc>
14403	<attribute name="enabled" type="boolean">
14404	<desc>
14405	Flag whether the audio adapter is present in the
14406	guest system. If disabled, the virtual guest hardware will
14407	not contain any audio adapter. Can only be changed when
14408	the VM is not running.
14409	</desc>
14410	</attribute>
14411	<attribute name="audioController" type="AudioControllerType">
14412	<desc>
14413	The audio hardware we emulate.
14414	</desc>
14415	</attribute>
14416	<attribute name="audioDriver" type="AudioDriverType">
14417	<desc>
14418	Audio driver the adapter is connected to. This setting
14419	can only be changed when the VM is not running.
14420	</desc>
14421	</attribute>
14422	</interface>
14423
14424	<enum
14425	name="AuthType"
14426	uuid="7eef6ef6-98c2-4dc2-ab35-10d2b292028d"
14427	>
14428	<desc>
14429	VirtualBox authentication type.
14430	</desc>
14431
14432	<const name="Null" value="0">
14433	<desc>Null value, also means "no authentication".</desc>
14434	</const>
14435	<const name="External" value="1"/>
14436	<const name="Guest" value="2"/>
14437	</enum>
14438
14439	<!--
14440	// IVRDEServer
14441	/////////////////////////////////////////////////////////////////////////
14442	-->
14443
14444	<interface
14445	name="IVRDEServer" extends="$unknown"
14446	uuid="d38de40a-c2c1-4e95-b5a4-167b05f5694c"
14447	wsmap="managed"
14448	>
14449	<attribute name="enabled" type="boolean">
14450	<desc>VRDE server status.</desc>
14451	</attribute>
14452
14453	<attribute name="authType" type="AuthType">
14454	<desc>VRDE authentication method.</desc>
14455	</attribute>
14456
14457	<attribute name="authTimeout" type="unsigned long">
14458	<desc>Timeout for guest authentication. Milliseconds.</desc>
14459	</attribute>
14460
14461	<attribute name="allowMultiConnection" type="boolean">
14462	<desc>
14463	Flag whether multiple simultaneous connections to the VM are permitted.
14464	Note that this will be replaced by a more powerful mechanism in the future.
14465	</desc>
14466	</attribute>
14467
14468	<attribute name="reuseSingleConnection" type="boolean">
14469	<desc>
14470	Flag whether the existing connection must be dropped and a new connection
14471	must be established by the VRDE server, when a new client connects in single
14472	connection mode.
14473	</desc>
14474	</attribute>
14475
14476	<attribute name="VRDEExtPack" type="wstring">
14477	<desc>
14478	The name of Extension Pack providing VRDE for this VM. Overrides
14479	<link to="ISystemProperties::defaultVRDEExtPack"/>.
14480	</desc>
14481	</attribute>
14482
14483	<attribute name="authLibrary" type="wstring">
14484	<desc>
14485	Library used for authentication of RDP clients by this VM. Overrides
14486	<link to="ISystemProperties::VRDEAuthLibrary"/>.
14487	</desc>
14488	</attribute>
14489
14490	<attribute name="VRDEProperties" type="wstring" readonly="yes" safearray="yes">
14491	<desc>
14492	Array of names of properties, which are supported by this VRDE server.
14493	</desc>
14494	</attribute>
14495
14496	<method name="setVRDEProperty">
14497	<desc>
14498	Sets a VRDE specific property string.
14499
14500	If you pass @c null or empty string as a key @a value, the given @a key
14501	will be deleted.
14502
14503	</desc>
14504	<param name="key" type="wstring" dir="in">
14505	<desc>Name of the key to set.</desc>
14506	</param>
14507	<param name="value" type="wstring" dir="in">
14508	<desc>Value to assign to the key.</desc>
14509	</param>
14510	</method>
14511
14512	<method name="getVRDEProperty" const="yes">
14513	<desc>
14514	Returns a VRDE specific property string.
14515
14516	If the requested data @a key does not exist, this function will
14517	succeed and return an empty string in the @a value argument.
14518
14519	</desc>
14520	<param name="key" type="wstring" dir="in">
14521	<desc>Name of the key to get.</desc>
14522	</param>
14523	<param name="value" type="wstring" dir="return">
14524	<desc>Value of the requested key.</desc>
14525	</param>
14526	</method>
14527
14528	</interface>
14529
14530
14531	<!--
14532	// ISharedFolder
14533	/////////////////////////////////////////////////////////////////////////
14534	-->
14535
14536	<interface
14537	name="ISharedFolder" extends="$unknown"
14538	uuid="8388da11-b559-4574-a5b7-2bd7acd5cef8"
14539	wsmap="struct"
14540	>
14541	<desc>
14542	The ISharedFolder interface represents a folder in the host computer's
14543	file system accessible from the guest OS running inside a virtual
14544	machine using an associated logical name.
14545
14546	There are three types of shared folders:
14547	<ul>
14548	<li><i>Global</i> (<link to="IVirtualBox::sharedFolders"/>), shared
14549	folders available to all virtual machines.</li>
14550	<li><i>Permanent</i> (<link to="IMachine::sharedFolders"/>),
14551	VM-specific shared folders available to the given virtual machine at
14552	startup.</li>
14553	<li><i>Transient</i> (<link to="IConsole::sharedFolders"/>),
14554	VM-specific shared folders created in the session context (for
14555	example, when the virtual machine is running) and automatically
14556	discarded when the session is closed (the VM is powered off).</li>
14557	</ul>
14558
14559	Logical names of shared folders must be unique within the given scope
14560	(global, permanent or transient). However, they do not need to be unique
14561	across scopes. In this case, the definition of the shared folder in a
14562	more specific scope takes precedence over definitions in all other
14563	scopes. The order of precedence is (more specific to more general):
14564	<ol>
14565	<li>Transient definitions</li>
14566	<li>Permanent definitions</li>
14567	<li>Global definitions</li>
14568	</ol>
14569
14570	For example, if MyMachine has a shared folder named
14571	<tt>C_DRIVE</tt> (that points to <tt>C:\\</tt>), then creating a
14572	transient shared folder named <tt>C_DRIVE</tt> (that points
14573	to <tt>C:\\\\WINDOWS</tt>) will change the definition
14574	of <tt>C_DRIVE</tt> in the guest OS so
14575	that <tt>\\\\VBOXSVR\\C_DRIVE</tt> will give access
14576	to <tt>C:\\WINDOWS</tt> instead of <tt>C:\\</tt> on the host
14577	PC. Removing the transient shared folder <tt>C_DRIVE</tt> will restore
14578	the previous (permanent) definition of <tt>C_DRIVE</tt> that points
14579	to <tt>C:\\</tt> if it still exists.
14580
14581	Note that permanent and transient shared folders of different machines
14582	are in different name spaces, so they don't overlap and don't need to
14583	have unique logical names.
14584
14585	<note>
14586	Global shared folders are not implemented in the current version of the
14587	product.
14588	</note>
14589	</desc>
14590
14591	<attribute name="name" type="wstring" readonly="yes">
14592	<desc>Logical name of the shared folder.</desc>
14593	</attribute>
14594
14595	<attribute name="hostPath" type="wstring" readonly="yes">
14596	<desc>Full path to the shared folder in the host file system.</desc>
14597	</attribute>
14598
14599	<attribute name="accessible" type="boolean" readonly="yes">
14600	<desc>
14601	Whether the folder defined by the host path is currently
14602	accessible or not.
14603	For example, the folder can be inaccessible if it is placed
14604	on the network share that is not available by the time
14605	this property is read.
14606	</desc>
14607	</attribute>
14608
14609	<attribute name="writable" type="boolean" readonly="yes">
14610	<desc>
14611	Whether the folder defined by the host path is writable or
14612	not.
14613	</desc>
14614	</attribute>
14615
14616	<attribute name="autoMount" type="boolean" readonly="yes">
14617	<desc>
14618	Whether the folder gets automatically mounted by the guest or not.
14619	</desc>
14620	</attribute>
14621
14622	<attribute name="lastAccessError" type="wstring" readonly="yes">
14623	<desc>
14624	Text message that represents the result of the last accessibility
14625	check.
14626
14627	Accessibility checks are performed each time the <link to="#accessible"/>
14628	attribute is read. An empty string is returned if the last
14629	accessibility check was successful. A non-empty string indicates a
14630	failure and should normally describe a reason of the failure (for
14631	example, a file read error).
14632	</desc>
14633	</attribute>
14634
14635	</interface>
14636
14637	<!--
14638	// ISession
14639	/////////////////////////////////////////////////////////////////////////
14640	-->
14641
14642	<interface
14643	name="IInternalSessionControl" extends="$unknown"
14644	uuid="0bdda5da-67c8-47be-a610-b83a7fa3e8b6"
14645	internal="yes"
14646	wsmap="suppress"
14647	>
14648	<method name="getPID">
14649	<desc>PID of the process that has created this Session object.
14650	</desc>
14651	<param name="pid" type="unsigned long" dir="return"/>
14652	</method>
14653
14654	<method name="getRemoteConsole">
14655	<desc>
14656	Returns the console object suitable for remote control.
14657
14658	<result name="VBOX_E_INVALID_VM_STATE">
14659	Session state prevents operation.
14660	</result>
14661	<result name="VBOX_E_INVALID_OBJECT_STATE">
14662	Session type prevents operation.
14663	</result>
14664
14665	</desc>
14666	<param name="console" type="IConsole" dir="return"/>
14667	</method>
14668
14669	<method name="assignMachine">
14670	<desc>
14671	Assigns the machine object associated with this direct-type
14672	session or informs the session that it will be a remote one
14673	(if @a machine == @c null).
14674
14675	<result name="VBOX_E_INVALID_VM_STATE">
14676	Session state prevents operation.
14677	</result>
14678	<result name="VBOX_E_INVALID_OBJECT_STATE">
14679	Session type prevents operation.
14680	</result>
14681
14682	</desc>
14683	<param name="machine" type="IMachine" dir="in"/>
14684	</method>
14685
14686	<method name="assignRemoteMachine">
14687	<desc>
14688	Assigns the machine and the (remote) console object associated with
14689	this remote-type session.
14690
14691	<result name="VBOX_E_INVALID_VM_STATE">
14692	Session state prevents operation.
14693	</result>
14694
14695	</desc>
14696	<param name="machine" type="IMachine" dir="in"/>
14697	<param name="console" type="IConsole" dir="in"/>
14698	</method>
14699
14700	<method name="updateMachineState">
14701	<desc>
14702	Updates the machine state in the VM process.
14703	Must be called only in certain cases
14704	(see the method implementation).
14705
14706	<result name="VBOX_E_INVALID_VM_STATE">
14707	Session state prevents operation.
14708	</result>
14709	<result name="VBOX_E_INVALID_OBJECT_STATE">
14710	Session type prevents operation.
14711	</result>
14712
14713	</desc>
14714	<param name="aMachineState" type="MachineState" dir="in"/>
14715	</method>
14716
14717	<method name="uninitialize">
14718	<desc>
14719	Uninitializes (closes) this session. Used by VirtualBox to close
14720	the corresponding remote session when the direct session dies
14721	or gets closed.
14722
14723	<result name="VBOX_E_INVALID_VM_STATE">
14724	Session state prevents operation.
14725	</result>
14726
14727	</desc>
14728	</method>
14729
14730	<method name="onNetworkAdapterChange">
14731	<desc>
14732	Triggered when settings of a network adapter of the
14733	associated virtual machine have changed.
14734
14735	<result name="VBOX_E_INVALID_VM_STATE">
14736	Session state prevents operation.
14737	</result>
14738	<result name="VBOX_E_INVALID_OBJECT_STATE">
14739	Session type prevents operation.
14740	</result>
14741
14742	</desc>
14743	<param name="networkAdapter" type="INetworkAdapter" dir="in"/>
14744	<param name="changeAdapter" type="boolean" dir="in"/>
14745	</method>
14746
14747	<method name="onSerialPortChange">
14748	<desc>
14749	Triggered when settings of a serial port of the
14750	associated virtual machine have changed.
14751
14752	<result name="VBOX_E_INVALID_VM_STATE">
14753	Session state prevents operation.
14754	</result>
14755	<result name="VBOX_E_INVALID_OBJECT_STATE">
14756	Session type prevents operation.
14757	</result>
14758
14759	</desc>
14760	<param name="serialPort" type="ISerialPort" dir="in"/>
14761	</method>
14762
14763	<method name="onParallelPortChange">
14764	<desc>
14765	Triggered when settings of a parallel port of the
14766	associated virtual machine have changed.
14767
14768	<result name="VBOX_E_INVALID_VM_STATE">
14769	Session state prevents operation.
14770	</result>
14771	<result name="VBOX_E_INVALID_OBJECT_STATE">
14772	Session type prevents operation.
14773	</result>
14774
14775	</desc>
14776	<param name="parallelPort" type="IParallelPort" dir="in"/>
14777	</method>
14778
14779	<method name="onStorageControllerChange">
14780	<desc>
14781	Triggered when settings of a storage controller of the
14782	associated virtual machine have changed.
14783
14784	<result name="VBOX_E_INVALID_VM_STATE">
14785	Session state prevents operation.
14786	</result>
14787	<result name="VBOX_E_INVALID_OBJECT_STATE">
14788	Session type prevents operation.
14789	</result>
14790
14791	</desc>
14792	</method>
14793
14794	<method name="onMediumChange">
14795	<desc>
14796	Triggered when attached media of the
14797	associated virtual machine have changed.
14798
14799	<result name="VBOX_E_INVALID_VM_STATE">
14800	Session state prevents operation.
14801	</result>
14802	<result name="VBOX_E_INVALID_OBJECT_STATE">
14803	Session type prevents operation.
14804	</result>
14805
14806	</desc>
14807
14808	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14809	<desc>The medium attachment which changed.</desc>
14810	</param>
14811	<param name="force" type="boolean" dir="in">
14812	<desc>If the medium change was forced.</desc>
14813	</param>
14814	</method>
14815
14816	<method name="onStorageDeviceChange">
14817	<desc>
14818	Triggered when attached storage devices of the
14819	associated virtual machine have changed.
14820
14821	<result name="VBOX_E_INVALID_VM_STATE">
14822	Session state prevents operation.
14823	</result>
14824	<result name="VBOX_E_INVALID_OBJECT_STATE">
14825	Session type prevents operation.
14826	</result>
14827
14828	</desc>
14829
14830	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
14831	<desc>The medium attachment which changed.</desc>
14832	</param>
14833	<param name="remove" type="boolean" dir="in">
14834	<desc>TRUE if the device is removed, FALSE if it was added.</desc>
14835	</param>
14836	</method>
14837
14838	<method name="onCPUChange">
14839	<desc>
14840	Notification when a CPU changes.
14841	</desc>
14842	<param name="cpu" type="unsigned long" dir="in">
14843	<desc>The CPU which changed</desc>
14844	</param>
14845	<param name="add" type="boolean" dir="in">
14846	<desc>Flag whether the CPU was added or removed</desc>
14847	</param>
14848	</method>
14849
14850	<method name="onCPUExecutionCapChange">
14851	<desc>
14852	Notification when the CPU execution cap changes.
14853	</desc>
14854	<param name="executionCap" type="unsigned long" dir="in">
14855	<desc>The new CPU execution cap value. (1-100)</desc>
14856	</param>
14857	</method>
14858
14859	<method name="onVRDEServerChange">
14860	<desc>
14861	Triggered when settings of the VRDE server object of the
14862	associated virtual machine have changed.
14863
14864	<result name="VBOX_E_INVALID_VM_STATE">
14865	Session state prevents operation.
14866	</result>
14867	<result name="VBOX_E_INVALID_OBJECT_STATE">
14868	Session type prevents operation.
14869	</result>
14870
14871	</desc>
14872	<param name="restart" type="boolean" dir="in">
14873	<desc>Flag whether the server must be restarted</desc>
14874	</param>
14875	</method>
14876
14877	<method name="onUSBControllerChange">
14878	<desc>
14879	Triggered when settings of the USB controller object of the
14880	associated virtual machine have changed.
14881
14882	<result name="VBOX_E_INVALID_VM_STATE">
14883	Session state prevents operation.
14884	</result>
14885	<result name="VBOX_E_INVALID_OBJECT_STATE">
14886	Session type prevents operation.
14887	</result>
14888
14889	</desc>
14890	</method>
14891
14892	<method name="onSharedFolderChange">
14893	<desc>
14894	Triggered when a permanent (global or machine) shared folder has been
14895	created or removed.
14896	<note>
14897	We don't pass shared folder parameters in this notification because
14898	the order in which parallel notifications are delivered is not defined,
14899	therefore it could happen that these parameters were outdated by the
14900	time of processing this notification.
14901	</note>
14902
14903	<result name="VBOX_E_INVALID_VM_STATE">
14904	Session state prevents operation.
14905	</result>
14906	<result name="VBOX_E_INVALID_OBJECT_STATE">
14907	Session type prevents operation.
14908	</result>
14909
14910	</desc>
14911	<param name="global" type="boolean" dir="in"/>
14912	</method>
14913
14914	<method name="onUSBDeviceAttach">
14915	<desc>
14916	Triggered when a request to capture a USB device (as a result
14917	of matched USB filters or direct call to
14918	<link to="IConsole::attachUSBDevice"/>) has completed.
14919	A @c null @a error object means success, otherwise it
14920	describes a failure.
14921
14922	<result name="VBOX_E_INVALID_VM_STATE">
14923	Session state prevents operation.
14924	</result>
14925	<result name="VBOX_E_INVALID_OBJECT_STATE">
14926	Session type prevents operation.
14927	</result>
14928
14929	</desc>
14930	<param name="device" type="IUSBDevice" dir="in"/>
14931	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14932	<param name="maskedInterfaces" type="unsigned long" dir="in"/>
14933	</method>
14934
14935	<method name="onUSBDeviceDetach">
14936	<desc>
14937	Triggered when a request to release the USB device (as a result
14938	of machine termination or direct call to
14939	<link to="IConsole::detachUSBDevice"/>) has completed.
14940	A @c null @a error object means success, otherwise it
14941	describes a failure.
14942
14943	<result name="VBOX_E_INVALID_VM_STATE">
14944	Session state prevents operation.
14945	</result>
14946	<result name="VBOX_E_INVALID_OBJECT_STATE">
14947	Session type prevents operation.
14948	</result>
14949
14950	</desc>
14951	<param name="id" type="uuid" mod="string" dir="in"/>
14952	<param name="error" type="IVirtualBoxErrorInfo" dir="in"/>
14953	</method>
14954
14955	<method name="onShowWindow">
14956	<desc>
14957	Called by <link to="IMachine::canShowConsoleWindow"/> and by
14958	<link to="IMachine::showConsoleWindow"/> in order to notify
14959	console listeners
14960	<link to="ICanShowWindowEvent"/>
14961	and <link to="IShowWindowEvent"/>.
14962
14963	<result name="VBOX_E_INVALID_OBJECT_STATE">
14964	Session type prevents operation.
14965	</result>
14966
14967	</desc>
14968	<param name="check" type="boolean" dir="in"/>
14969	<param name="canShow" type="boolean" dir="out"/>
14970	<param name="winId" type="long long" dir="out"/>
14971	</method>
14972
14973	<method name="onBandwidthGroupChange">
14974	<desc>
14975	Notification when one of the bandwidth groups change.
14976	</desc>
14977	<param name="bandwidthGroup" type="IBandwidthGroup" dir="in">
14978	<desc>The bandwidth group which changed.</desc>
14979	</param>
14980	</method>
14981
14982	<method name="accessGuestProperty">
14983	<desc>
14984	Called by <link to="IMachine::getGuestProperty"/> and by
14985	<link to="IMachine::setGuestProperty"/> in order to read and
14986	modify guest properties.
14987
14988	<result name="VBOX_E_INVALID_VM_STATE">
14989	Machine session is not open.
14990	</result>
14991	<result name="VBOX_E_INVALID_OBJECT_STATE">
14992	Session type is not direct.
14993	</result>
14994
14995	</desc>
14996	<param name="name" type="wstring" dir="in"/>
14997	<param name="value" type="wstring" dir="in"/>
14998	<param name="flags" type="wstring" dir="in"/>
14999	<param name="isSetter" type="boolean" dir="in"/>
15000	<param name="retValue" type="wstring" dir="out"/>
15001	<param name="retTimestamp" type="long long" dir="out"/>
15002	<param name="retFlags" type="wstring" dir="out"/>
15003	</method>
15004
15005	<method name="enumerateGuestProperties" const="yes">
15006	<desc>
15007	Return a list of the guest properties matching a set of patterns along
15008	with their values, time stamps and flags.
15009
15010	<result name="VBOX_E_INVALID_VM_STATE">
15011	Machine session is not open.
15012	</result>
15013	<result name="VBOX_E_INVALID_OBJECT_STATE">
15014	Session type is not direct.
15015	</result>
15016
15017	</desc>
15018	<param name="patterns" type="wstring" dir="in">
15019	<desc>
15020	The patterns to match the properties against as a comma-separated
15021	string. If this is empty, all properties currently set will be
15022	returned.
15023	</desc>
15024	</param>
15025	<param name="key" type="wstring" dir="out" safearray="yes">
15026	<desc>
15027	The key names of the properties returned.
15028	</desc>
15029	</param>
15030	<param name="value" type="wstring" dir="out" safearray="yes">
15031	<desc>
15032	The values of the properties returned. The array entries match the
15033	corresponding entries in the @a key array.
15034	</desc>
15035	</param>
15036	<param name="timestamp" type="long long" dir="out" safearray="yes">
15037	<desc>
15038	The time stamps of the properties returned. The array entries match
15039	the corresponding entries in the @a key array.
15040	</desc>
15041	</param>
15042	<param name="flags" type="wstring" dir="out" safearray="yes">
15043	<desc>
15044	The flags of the properties returned. The array entries match the
15045	corresponding entries in the @a key array.
15046	</desc>
15047	</param>
15048	</method>
15049
15050	<method name="onlineMergeMedium">
15051	<desc>
15052	Triggers online merging of a hard disk. Used internally when deleting
15053	a snapshot while a VM referring to the same hard disk chain is running.
15054
15055	<result name="VBOX_E_INVALID_VM_STATE">
15056	Machine session is not open.
15057	</result>
15058	<result name="VBOX_E_INVALID_OBJECT_STATE">
15059	Session type is not direct.
15060	</result>
15061
15062	</desc>
15063	<param name="mediumAttachment" type="IMediumAttachment" dir="in">
15064	<desc>The medium attachment to identify the medium chain.</desc>
15065	</param>
15066	<param name="sourceIdx" type="unsigned long" dir="in">
15067	<desc>The index of the source image in the chain.
15068	Redundant, but drastically reduces IPC.</desc>
15069	</param>
15070	<param name="targetIdx" type="unsigned long" dir="in">
15071	<desc>The index of the target image in the chain.
15072	Redundant, but drastically reduces IPC.</desc>
15073	</param>
15074	<param name="source" type="IMedium" dir="in">
15075	<desc>Merge source medium.</desc>
15076	</param>
15077	<param name="target" type="IMedium" dir="in">
15078	<desc>Merge target medium.</desc>
15079	</param>
15080	<param name="mergeForward" type="boolean" dir="in">
15081	<desc>Merge direction.</desc>
15082	</param>
15083	<param name="parentForTarget" type="IMedium" dir="in">
15084	<desc>For forward merges: new parent for target medium.</desc>
15085	</param>
15086	<param name="childrenToReparent" type="IMedium" safearray="yes" dir="in">
15087	<desc>For backward merges: list of media which need their parent UUID
15088	updated.</desc>
15089	</param>
15090	<param name="progress" type="IProgress" dir="in">
15091	<desc>
15092	Progress object for this operation.
15093	</desc>
15094	</param>
15095	</method>
15096
15097	<method name="enableVMMStatistics">
15098	<desc>
15099	Enables or disables collection of VMM RAM statistics.
15100
15101	<result name="VBOX_E_INVALID_VM_STATE">
15102	Machine session is not open.
15103	</result>
15104	<result name="VBOX_E_INVALID_OBJECT_STATE">
15105	Session type is not direct.
15106	</result>
15107
15108	</desc>
15109	<param name="enable" type="boolean" dir="in">
15110	<desc>True enables statistics collection.</desc>
15111	</param>
15112	</method>
15113
15114	</interface>
15115
15116	<interface
15117	name="ISession" extends="$unknown"
15118	uuid="12F4DCDB-12B2-4EC1-B7CD-DDD9F6C5BF4D"
15119	wsmap="managed"
15120	>
15121	<desc>
15122	The ISession interface represents a client process and allows for locking
15123	virtual machines (represented by IMachine objects) to prevent conflicting
15124	changes to the machine.
15125
15126	Any caller wishing to manipulate a virtual machine needs to create a session
15127	object first, which lives in its own process space. Such session objects are
15128	then associated with <link to="IMachine" /> objects living in the VirtualBox
15129	server process to coordinate such changes.
15130
15131	There are two typical scenarios in which sessions are used:
15132
15133	<ul>
15134	<li>To alter machine settings or control a running virtual machine, one
15135	needs to lock a machine for a given session (client process) by calling
15136	<link to="IMachine::lockMachine"/>.
15137
15138	Whereas multiple sessions may control a running virtual machine, only
15139	one process can obtain a write lock on the machine to prevent conflicting
15140	changes. A write lock is also needed if a process wants to actually run a
15141	virtual machine in its own context, such as the VirtualBox GUI or
15142	VBoxHeadless front-ends. They must also lock a machine for their own
15143	sessions before they are allowed to power up the virtual machine.
15144
15145	As a result, no machine settings can be altered while another process is
15146	already using it, either because that process is modifying machine settings
15147	or because the machine is running.
15148	</li>
15149	<li>
15150	To start a VM using one of the existing VirtualBox front-ends (e.g. the
15151	VirtualBox GUI or VBoxHeadless), one would use
15152	<link to="IMachine::launchVMProcess"/>, which also takes a session object
15153	as its first parameter. This session then identifies the caller and lets the
15154	caller control the started machine (for example, pause machine execution or
15155	power it down) as well as be notified about machine execution state changes.
15156	</li>
15157	</ul>
15158
15159	How sessions objects are created in a client process depends on whether you use
15160	the Main API via COM or via the webservice:
15161
15162	<ul>
15163	<li>When using the COM API directly, an object of the Session class from the
15164	VirtualBox type library needs to be created. In regular COM C++ client code,
15165	this can be done by calling <tt>createLocalObject()</tt>, a standard COM API.
15166	This object will then act as a local session object in further calls to open
15167	a session.
15168	</li>
15169
15170	<li>In the webservice, the session manager (IWebsessionManager) instead creates
15171	a session object automatically whenever <link to="IWebsessionManager::logon" />
15172	is called. A managed object reference to that session object can be retrieved by
15173	calling <link to="IWebsessionManager::getSessionObject" />.
15174	</li>
15175	</ul>
15176	</desc>
15177
15178	<attribute name="state" type="SessionState" readonly="yes">
15179	<desc>Current state of this session.</desc>
15180	</attribute>
15181
15182	<attribute name="type" type="SessionType" readonly="yes">
15183	<desc>
15184	Type of this session. The value of this attribute is valid only
15185	if the session currently has a machine locked (i.e. its
15186	<link to="#state" /> is Locked), otherwise an error will be returned.
15187	</desc>
15188	</attribute>
15189
15190	<attribute name="machine" type="IMachine" readonly="yes">
15191	<desc>Machine object associated with this session.</desc>
15192	</attribute>
15193
15194	<attribute name="console" type="IConsole" readonly="yes">
15195	<desc>Console object associated with this session.</desc>
15196	</attribute>
15197
15198	<method name="unlockMachine">
15199	<desc>
15200	Unlocks a machine that was previously locked for the current session.
15201
15202	Calling this method is required every time a machine has been locked
15203	for a particular session using the <link to="IMachine::launchVMProcess" />
15204	or <link to="IMachine::lockMachine" /> calls. Otherwise the state of
15205	the machine will be set to <link to="MachineState_Aborted" /> on the
15206	server, and changes made to the machine settings will be lost.
15207
15208	Generally, it is recommended to unlock all machines explicitly
15209	before terminating the application (regardless of the reason for
15210	the termination).
15211
15212	<note>
15213	Do not expect the session state (<link to="ISession::state" />
15214	to return to "Unlocked" immediately after you invoke this method,
15215	particularly if you have started a new VM process. The session
15216	state will automatically return to "Unlocked" once the VM is no
15217	longer executing, which can of course take a very long time.
15218	</note>
15219
15220	<result name="E_UNEXPECTED">
15221	Session is not locked.
15222	</result>
15223
15224	</desc>
15225	</method>
15226
15227	</interface>
15228
15229	<!--
15230	// IStorageController
15231	/////////////////////////////////////////////////////////////////////////
15232	-->
15233
15234	<enum
15235	name="StorageBus"
15236	uuid="eee67ab3-668d-4ef5-91e0-7025fe4a0d7a"
15237	>
15238	<desc>
15239	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy);
15240	see <link to="IStorageController::bus" />.
15241	</desc>
15242	<const name="Null" value="0">
15243	<desc>@c null value. Never used by the API.</desc>
15244	</const>
15245	<const name="IDE" value="1"/>
15246	<const name="SATA" value="2"/>
15247	<const name="SCSI" value="3"/>
15248	<const name="Floppy" value="4"/>
15249	<const name="SAS" value="5"/>
15250	</enum>
15251
15252	<enum
15253	name="StorageControllerType"
15254	uuid="8a412b8a-f43e-4456-bd37-b474f0879a58"
15255	>
15256	<desc>
15257	The exact variant of storage controller hardware presented
15258	to the guest; see <link to="IStorageController::controllerType" />.
15259	</desc>
15260
15261	<const name="Null" value="0">
15262	<desc>@c null value. Never used by the API.</desc>
15263	</const>
15264	<const name="LsiLogic" value="1">
15265	<desc>A SCSI controller of the LsiLogic variant.</desc>
15266	</const>
15267	<const name="BusLogic" value="2">
15268	<desc>A SCSI controller of the BusLogic variant.</desc>
15269	</const>
15270	<const name="IntelAhci" value="3">
15271	<desc>An Intel AHCI SATA controller; this is the only variant for SATA.</desc>
15272	</const>
15273	<const name="PIIX3" value="4">
15274	<desc>An IDE controller of the PIIX3 variant.</desc>
15275	</const>
15276	<const name="PIIX4" value="5">
15277	<desc>An IDE controller of the PIIX4 variant.</desc>
15278	</const>
15279	<const name="ICH6" value="6">
15280	<desc>An IDE controller of the ICH6 variant.</desc>
15281	</const>
15282	<const name="I82078" value="7">
15283	<desc>A floppy disk controller; this is the only variant for floppy drives.</desc>
15284	</const>
15285	<const name="LsiLogicSas" value="8">
15286	<desc>A variant of the LsiLogic controller using SAS.</desc>
15287	</const>
15288	</enum>
15289
15290	<enum
15291	name="ChipsetType"
15292	uuid="8b4096a8-a7c3-4d3b-bbb1-05a0a51ec394"
15293	>
15294	<desc>
15295	Type of emulated chipset (mostly southbridge).
15296	</desc>
15297
15298	<const name="Null" value="0">
15299	<desc>@c null value. Never used by the API.</desc>
15300	</const>
15301	<const name="PIIX3" value="1">
15302	<desc>A PIIX3 (PCI IDE ISA Xcelerator) chipset.</desc>
15303	</const>
15304	<const name="ICH9" value="2">
15305	<desc>A ICH9 (I/O Controller Hub) chipset.</desc>
15306	</const>
15307	</enum>
15308
15309	<interface
15310	name="IStorageController" extends="$unknown"
15311	uuid="a1556333-09b6-46d9-bfb7-fc239b7fbe1e"
15312	wsmap="managed"
15313	>
15314	<desc>
15315	Represents a storage controller that is attached to a virtual machine
15316	(<link to="IMachine" />). Just as drives (hard disks, DVDs, FDs) are
15317	attached to storage controllers in a real computer, virtual drives
15318	(represented by <link to="IMediumAttachment" />) are attached to virtual
15319	storage controllers, represented by this interface.
15320
15321	As opposed to physical hardware, VirtualBox has a very generic concept
15322	of a storage controller, and for purposes of the Main API, all virtual
15323	storage is attached to virtual machines via instances of this interface.
15324	There are five types of such virtual storage controllers: IDE, SCSI, SATA,
15325	SAS and Floppy (see <link to="#bus" />). Depending on which of these four
15326	is used, certain sub-types may be available and can be selected in
15327	<link to="#controllerType" />.
15328
15329	Depending on these settings, the guest operating system might see
15330	significantly different virtual hardware.
15331	</desc>
15332
15333	<attribute name="name" type="wstring" readonly="yes">
15334	<desc>
15335	Name of the storage controller, as originally specified with
15336	<link to="IMachine::addStorageController" />. This then uniquely
15337	identifies this controller with other method calls such as
15338	<link to="IMachine::attachDevice" /> and <link to="IMachine::mountMedium" />.
15339	</desc>
15340	</attribute>
15341
15342	<attribute name="maxDevicesPerPortCount" type="unsigned long" readonly="yes">
15343	<desc>
15344	Maximum number of devices which can be attached to one port.
15345	</desc>
15346	</attribute>
15347
15348	<attribute name="minPortCount" type="unsigned long" readonly="yes">
15349	<desc>
15350	Minimum number of ports that <link to="IStorageController::portCount"/> can be set to.
15351	</desc>
15352	</attribute>
15353
15354	<attribute name="maxPortCount" type="unsigned long" readonly="yes">
15355	<desc>
15356	Maximum number of ports that <link to="IStorageController::portCount"/> can be set to.
15357	</desc>
15358	</attribute>
15359
15360	<attribute name="instance" type="unsigned long">
15361	<desc>
15362	The instance number of the device in the running VM.
15363	</desc>
15364	</attribute>
15365
15366	<attribute name="portCount" type="unsigned long">
15367	<desc>
15368	The number of currently usable ports on the controller.
15369	The minimum and maximum number of ports for one controller are
15370	stored in <link to="IStorageController::minPortCount"/>
15371	and <link to="IStorageController::maxPortCount"/>.
15372	</desc>
15373	</attribute>
15374
15375	<attribute name="bus" type="StorageBus" readonly="yes">
15376	<desc>
15377	The bus type of the storage controller (IDE, SATA, SCSI, SAS or Floppy).
15378	</desc>
15379	</attribute>
15380
15381	<attribute name="controllerType" type="StorageControllerType">
15382	<desc>
15383	The exact variant of storage controller hardware presented
15384	to the guest.
15385	Depending on this value, VirtualBox will provide a different
15386	virtual storage controller hardware to the guest.
15387	For SATA, SAS and floppy controllers, only one variant is
15388	available, but for IDE and SCSI, there are several.
15389
15390	For SCSI controllers, the default type is LsiLogic.
15391	</desc>
15392	</attribute>
15393
15394	<attribute name="useHostIOCache" type="boolean">
15395	<desc>
15396	If true, the storage controller emulation will use a dedicated I/O thread, enable the host I/O
15397	caches and use synchronous file APIs on the host. This was the only option in the API before
15398	VirtualBox 3.2 and is still the default for IDE controllers.
15399
15400	If false, the host I/O cache will be disabled for image files attached to this storage controller.
15401	Instead, the storage controller emulation will use asynchronous I/O APIs on the host. This makes
15402	it possible to turn off the host I/O caches because the emulation can handle unaligned access to
15403	the file. This should be used on OS X and Linux hosts if a high I/O load is expected or many
15404	virtual machines are running at the same time to prevent I/O cache related hangs.
15405	This option new with the API of VirtualBox 3.2 and is now the default for non-IDE storage controllers.
15406	</desc>
15407	</attribute>
15408
15409	<attribute name="bootable" type="boolean" readonly="yes">
15410	<desc>
15411	Returns whether it is possible to boot from disks attached to this controller.
15412	</desc>
15413	</attribute>
15414
15415	<method name="getIDEEmulationPort">
15416	<desc>
15417	Gets the corresponding port number which is emulated as an IDE device.
15418	Works only with SATA controllers.
15419
15420	<result name="E_INVALIDARG">
15421	The @a devicePosition is not in the range 0 to 3.
15422	</result>
15423	<result name="E_NOTIMPL">
15424	The storage controller type is not SATAIntelAhci.
15425	</result>
15426
15427	</desc>
15428	<param name="devicePosition" type="long" dir="in"/>
15429	<param name="portNumber" type="long" dir="return"/>
15430	</method>
15431
15432	<method name="setIDEEmulationPort">
15433	<desc>
15434	Sets the port number which is emulated as an IDE device.
15435	Works only with SATA controllers.
15436
15437	<result name="E_INVALIDARG">
15438	The @a devicePosition is not in the range 0 to 3 or the
15439	@a portNumber is not in the range 0 to 29.
15440	</result>
15441	<result name="E_NOTIMPL">
15442	The storage controller type is not SATAIntelAhci.
15443	</result>
15444
15445	</desc>
15446	<param name="devicePosition" type="long" dir="in"/>
15447	<param name="portNumber" type="long" dir="in"/>
15448	</method>
15449
15450	</interface>
15451
15452	<if target="wsdl">
15453
15454	<!--
15455	// IManagedObjectRef
15456	/////////////////////////////////////////////////////////////////////////
15457	-->
15458
15459	<interface
15460	name="IManagedObjectRef" extends="$unknown"
15461	uuid="9474d09d-2313-46de-b568-a42b8718e8ed"
15462	internal="yes"
15463	wsmap="managed"
15464	wscpp="hardcoded"
15465	>
15466	<desc>
15467	Managed object reference.
15468
15469	Only within the webservice, a managed object reference (which is really
15470	an opaque number) allows a webservice client to address an object
15471	that lives in the address space of the webservice server.
15472
15473	Behind each managed object reference, there is a COM object that lives
15474	in the webservice server's address space. The COM object is not freed
15475	until the managed object reference is released, either by an explicit
15476	call to <link to="IManagedObjectRef::release" /> or by logging off from
15477	the webservice (<link to="IWebsessionManager::logoff" />), which releases
15478	all objects created during the webservice session.
15479
15480	Whenever a method call of the VirtualBox API returns a COM object, the
15481	webservice representation of that method will instead return a
15482	managed object reference, which can then be used to invoke methods
15483	on that object.
15484	</desc>
15485
15486	<method name="getInterfaceName">
15487	<desc>
15488	Returns the name of the interface that this managed object represents,
15489	for example, "IMachine", as a string.
15490	</desc>
15491	<param name="return" type="wstring" dir="return"/>
15492	</method>
15493
15494	<method name="release">
15495	<desc>
15496	Releases this managed object reference and frees the resources that
15497	were allocated for it in the webservice server process. After calling
15498	this method, the identifier of the reference can no longer be used.
15499	</desc>
15500	</method>
15501
15502	</interface>
15503
15504	<!--
15505	// IWebsessionManager
15506	/////////////////////////////////////////////////////////////////////////
15507	-->
15508
15509	<interface
15510	name="IWebsessionManager" extends="$unknown"
15511	uuid="dea1b4c7-2de3-418a-850d-7868617f7733"
15512	internal="yes"
15513	wsmap="global"
15514	wscpp="hardcoded"
15515	>
15516	<desc>
15517	Websession manager. This provides essential services
15518	to webservice clients.
15519	</desc>
15520	<method name="logon">
15521	<desc>
15522	Logs a new client onto the webservice and returns a managed object reference to
15523	the IVirtualBox instance, which the client can then use as a basis to further
15524	queries, since all calls to the VirtualBox API are based on the IVirtualBox
15525	interface, in one way or the other.
15526	</desc>
15527	<param name="username" type="wstring" dir="in"/>
15528	<param name="password" type="wstring" dir="in"/>
15529	<param name="return" type="IVirtualBox" dir="return"/>
15530	</method>
15531
15532	<method name="getSessionObject">
15533	<desc>
15534	Returns a managed object reference to the internal ISession object that was created
15535	for this web service session when the client logged on.
15536
15537	<see><link to="ISession"/></see>
15538	</desc>
15539	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15540	<param name="return" type="ISession" dir="return"/>
15541	</method>
15542
15543	<method name="logoff">
15544	<desc>
15545	Logs off the client who has previously logged on with <link to="IWebsessionManager::logon" />
15546	and destroys all resources associated with the session (most importantly, all
15547	managed objects created in the server while the session was active).
15548	</desc>
15549	<param name="refIVirtualBox" type="IVirtualBox" dir="in"/>
15550	</method>
15551
15552	</interface>
15553
15554	</if>
15555
15556	<!--
15557	// IPerformanceCollector & friends
15558	/////////////////////////////////////////////////////////////////////////
15559	-->
15560
15561	<interface
15562	name="IPerformanceMetric" extends="$unknown"
15563	uuid="2a1a60ae-9345-4019-ad53-d34ba41cbfe9" wsmap="managed"
15564	>
15565	<desc>
15566	The IPerformanceMetric interface represents parameters of the given
15567	performance metric.
15568	</desc>
15569
15570	<attribute name="metricName" type="wstring" readonly="yes">
15571	<desc>
15572	Name of the metric.
15573	</desc>
15574	</attribute>
15575
15576	<attribute name="object" type="$unknown" readonly="yes">
15577	<desc>
15578	Object this metric belongs to.
15579	</desc>
15580	</attribute>
15581
15582	<attribute name="description" type="wstring" readonly="yes">
15583	<desc>
15584	Textual description of the metric.
15585	</desc>
15586	</attribute>
15587
15588	<attribute name="period" type="unsigned long" readonly="yes">
15589	<desc>
15590	Time interval between samples, measured in seconds.
15591	</desc>
15592	</attribute>
15593
15594	<attribute name="count" type="unsigned long" readonly="yes">
15595	<desc>
15596	Number of recent samples retained by the performance collector for this
15597	metric.
15598
15599	When the collected sample count exceeds this number, older samples
15600	are discarded.
15601	</desc>
15602	</attribute>
15603
15604	<attribute name="unit" type="wstring" readonly="yes">
15605	<desc>
15606	Unit of measurement.
15607	</desc>
15608	</attribute>
15609
15610	<attribute name="minimumValue" type="long" readonly="yes">
15611	<desc>
15612	Minimum possible value of this metric.
15613	</desc>
15614	</attribute>
15615
15616	<attribute name="maximumValue" type="long" readonly="yes">
15617	<desc>
15618	Maximum possible value of this metric.
15619	</desc>
15620	</attribute>
15621	</interface>
15622
15623	<interface
15624	name="IPerformanceCollector" extends="$unknown"
15625	uuid="e22e1acb-ac4a-43bb-a31c-17321659b0c6"
15626	wsmap="managed"
15627	>
15628	<desc>
15629	The IPerformanceCollector interface represents a service that collects
15630	and stores performance metrics data.
15631
15632	Performance metrics are associated with objects of interfaces like IHost
15633	and IMachine. Each object has a distinct set of performance metrics. The
15634	set can be obtained with <link to="IPerformanceCollector::getMetrics"/>.
15635
15636	Metric data is collected at the specified intervals and is retained
15637	internally. The interval and the number of retained samples can be set
15638	with <link to="IPerformanceCollector::setupMetrics" />. Both metric data
15639	and collection settings are not persistent, they are discarded as soon as
15640	VBoxSVC process terminates. Moreover, metric settings and data associated
15641	with a particular VM only exist while VM is running. They disappear as
15642	soon as VM shuts down. It is not possible to set up metrics for machines
15643	that are powered off. One needs to start VM first, then set up metric
15644	collection parameters.
15645
15646	Metrics are organized hierarchically, with each level separated by a
15647	slash (/) character. Generally, the scheme for metric names is like this:
15648
15649	<tt>Category/Metric[/SubMetric][:aggregation]</tt>
15650
15651	"Category/Metric" together form the base metric name. A base metric is
15652	the smallest unit for which a sampling interval and the number of
15653	retained samples can be set. Only base metrics can be enabled and
15654	disabled. All sub-metrics are collected when their base metric is
15655	collected. Collected values for any set of sub-metrics can be queried
15656	with <link to="IPerformanceCollector::queryMetricsData" />.
15657
15658	For example "CPU/Load/User:avg" metric name stands for the "CPU"
15659	category, "Load" metric, "User" submetric, "average" aggregate. An
15660	aggregate function is computed over all retained data. Valid aggregate
15661	functions are:
15662
15663	<ul>
15664	<li>avg -- average</li>
15665	<li>min -- minimum</li>
15666	<li>max -- maximum</li>
15667	</ul>
15668
15669	When setting up metric parameters, querying metric data, enabling or
15670	disabling metrics wildcards can be used in metric names to specify a
15671	subset of metrics. For example, to select all CPU-related metrics
15672	use <tt>CPU/</tt>, all averages can be queried using <tt>:avg</tt> and
15673	so on. To query metric values without aggregates <tt>*:</tt> can be used.
15674
15675	The valid names for base metrics are:
15676
15677	<ul>
15678	<li>CPU/Load</li>
15679	<li>CPU/MHz</li>
15680	<li>RAM/Usage</li>
15681	<li>RAM/VMM</li>
15682	</ul>
15683
15684	The general sequence for collecting and retrieving the metrics is:
15685	<ul>
15686	<li>
15687	Obtain an instance of IPerformanceCollector with
15688	<link to="IVirtualBox::performanceCollector" />
15689	</li>
15690	<li>
15691	Allocate and populate an array with references to objects the metrics
15692	will be collected for. Use references to IHost and IMachine objects.
15693	</li>
15694	<li>
15695	Allocate and populate an array with base metric names the data will
15696	be collected for.
15697	</li>
15698	<li>
15699	Call <link to="IPerformanceCollector::setupMetrics" />. From now on
15700	the metric data will be collected and stored.
15701	</li>
15702	<li>
15703	Wait for the data to get collected.
15704	</li>
15705	<li>
15706	Allocate and populate an array with references to objects the metric
15707	values will be queried for. You can re-use the object array used for
15708	setting base metrics.
15709	</li>
15710	<li>
15711	Allocate and populate an array with metric names the data will be
15712	collected for. Note that metric names differ from base metric names.
15713	</li>
15714	<li>
15715	Call <link to="IPerformanceCollector::queryMetricsData" />. The data
15716	that have been collected so far are returned. Note that the values
15717	are still retained internally and data collection continues.
15718	</li>
15719	</ul>
15720
15721	For an example of usage refer to the following files in VirtualBox SDK:
15722	<ul>
15723	<li>
15724	Java: <tt>bindings/webservice/java/jax-ws/samples/metrictest.java</tt>
15725	</li>
15726	<li>
15727	Python: <tt>bindings/xpcom/python/sample/shellcommon.py</tt>
15728	</li>
15729	</ul>
15730	</desc>
15731
15732	<attribute name="metricNames" type="wstring" readonly="yes" safearray="yes">
15733	<desc>
15734	Array of unique names of metrics.
15735
15736	This array represents all metrics supported by the performance
15737	collector. Individual objects do not necessarily support all of them.
15738	<link to="IPerformanceCollector::getMetrics"/> can be used to get the
15739	list of supported metrics for a particular object.
15740	</desc>
15741	</attribute>
15742
15743	<method name="getMetrics">
15744	<desc>
15745	Returns parameters of specified metrics for a set of objects.
15746	<note>
15747	@c Null metrics array means all metrics. @c Null object array means
15748	all existing objects.
15749	</note>
15750	</desc>
15751	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15752	<desc>
15753	Metric name filter. Currently, only a comma-separated list of metrics
15754	is supported.
15755	</desc>
15756	</param>
15757	<param name="objects" type="$unknown" dir="in" safearray="yes">
15758	<desc>
15759	Set of objects to return metric parameters for.
15760	</desc>
15761	</param>
15762	<param name="metrics" type="IPerformanceMetric" dir="return" safearray="yes">
15763	<desc>
15764	Array of returned metric parameters.
15765	</desc>
15766	</param>
15767	</method>
15768
15769	<method name="setupMetrics">
15770	<desc>
15771	Sets parameters of specified base metrics for a set of objects. Returns
15772	an array of <link to="IPerformanceMetric" /> describing the metrics
15773	have been affected.
15774	<note>
15775	@c Null or empty metric name array means all metrics. @c Null or
15776	empty object array means all existing objects. If metric name array
15777	contains a single element and object array contains many, the single
15778	metric name array element is applied to each object array element to
15779	form metric/object pairs.
15780	</note>
15781	</desc>
15782	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15783	<desc>
15784	Metric name filter. Comma-separated list of metrics with wildcard
15785	support.
15786	</desc>
15787	</param>
15788	<param name="objects" type="$unknown" dir="in" safearray="yes">
15789	<desc>
15790	Set of objects to setup metric parameters for.
15791	</desc>
15792	</param>
15793	<param name="period" type="unsigned long" dir="in">
15794	<desc>
15795	Time interval in seconds between two consecutive samples of
15796	performance data.
15797	</desc>
15798	</param>
15799	<param name="count" type="unsigned long" dir="in">
15800	<desc>
15801	Number of samples to retain in performance data history. Older
15802	samples get discarded.
15803	</desc>
15804	</param>
15805	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15806	<desc>
15807	Array of metrics that have been modified by the call to this method.
15808	</desc>
15809	</param>
15810	</method>
15811
15812	<method name="enableMetrics">
15813	<desc>
15814	Turns on collecting specified base metrics. Returns an array of
15815	<link to="IPerformanceMetric" /> describing the metrics have been
15816	affected.
15817	<note>
15818	@c Null or empty metric name array means all metrics. @c Null or
15819	empty object array means all existing objects. If metric name array
15820	contains a single element and object array contains many, the single
15821	metric name array element is applied to each object array element to
15822	form metric/object pairs.
15823	</note>
15824	</desc>
15825	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15826	<desc>
15827	Metric name filter. Comma-separated list of metrics with wildcard
15828	support.
15829	</desc>
15830	</param>
15831	<param name="objects" type="$unknown" dir="in" safearray="yes">
15832	<desc>
15833	Set of objects to enable metrics for.
15834	</desc>
15835	</param>
15836	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15837	<desc>
15838	Array of metrics that have been modified by the call to this method.
15839	</desc>
15840	</param>
15841	</method>
15842
15843	<method name="disableMetrics">
15844	<desc>
15845	Turns off collecting specified base metrics. Returns an array of
15846	<link to="IPerformanceMetric" /> describing the metrics have been
15847	affected.
15848	<note>
15849	@c Null or empty metric name array means all metrics. @c Null or
15850	empty object array means all existing objects. If metric name array
15851	contains a single element and object array contains many, the single
15852	metric name array element is applied to each object array element to
15853	form metric/object pairs.
15854	</note>
15855	</desc>
15856	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15857	<desc>
15858	Metric name filter. Comma-separated list of metrics with wildcard
15859	support.
15860	</desc>
15861	</param>
15862	<param name="objects" type="$unknown" dir="in" safearray="yes">
15863	<desc>
15864	Set of objects to disable metrics for.
15865	</desc>
15866	</param>
15867	<param name="affectedMetrics" type="IPerformanceMetric" dir="return" safearray="yes">
15868	<desc>
15869	Array of metrics that have been modified by the call to this method.
15870	</desc>
15871	</param>
15872	</method>
15873
15874	<method name="queryMetricsData">
15875	<desc>
15876	Queries collected metrics data for a set of objects.
15877
15878	The data itself and related metric information are returned in seven
15879	parallel and one flattened array of arrays. Elements of
15880	<tt>returnMetricNames, returnObjects, returnUnits, returnScales,
15881	returnSequenceNumbers, returnDataIndices and returnDataLengths</tt> with
15882	the same index describe one set of values corresponding to a single
15883	metric.
15884
15885	The <tt>returnData</tt> parameter is a flattened array of arrays. Each
15886	start and length of a sub-array is indicated by
15887	<tt>returnDataIndices</tt> and <tt>returnDataLengths</tt>. The first
15888	value for metric <tt>metricNames[i]</tt> is at
15889	<tt>returnData[returnIndices[i]]</tt>.
15890
15891	<note>
15892	@c Null or empty metric name array means all metrics. @c Null or
15893	empty object array means all existing objects. If metric name array
15894	contains a single element and object array contains many, the single
15895	metric name array element is applied to each object array element to
15896	form metric/object pairs.
15897	</note>
15898	<note>
15899	Data collection continues behind the scenes after call to @c
15900	queryMetricsData. The return data can be seen as the snapshot of the
15901	current state at the time of @c queryMetricsData call. The internally
15902	kept metric values are not cleared by the call. This makes possible
15903	querying different subsets of metrics or aggregates with subsequent
15904	calls. If periodic querying is needed it is highly suggested to query
15905	the values with @c interval*count period to avoid confusion. This way
15906	a completely new set of data values will be provided by each query.
15907	</note>
15908	</desc>
15909	<param name="metricNames" type="wstring" dir="in" safearray="yes">
15910	<desc>
15911	Metric name filter. Comma-separated list of metrics with wildcard
15912	support.
15913	</desc>
15914	</param>
15915	<param name="objects" type="$unknown" dir="in" safearray="yes">
15916	<desc>
15917	Set of objects to query metrics for.
15918	</desc>
15919	</param>
15920	<param name="returnMetricNames" type="wstring" dir="out" safearray="yes">
15921	<desc>
15922	Names of metrics returned in @c returnData.
15923	</desc>
15924	</param>
15925	<param name="returnObjects" type="$unknown" dir="out" safearray="yes">
15926	<desc>
15927	Objects associated with metrics returned in @c returnData.
15928	</desc>
15929	</param>
15930	<param name="returnUnits" type="wstring" dir="out" safearray="yes">
15931	<desc>
15932	Units of measurement for each returned metric.
15933	</desc>
15934	</param>
15935	<param name="returnScales" type="unsigned long" dir="out" safearray="yes">
15936	<desc>
15937	Divisor that should be applied to return values in order to get
15938	floating point values. For example:
15939	<tt>(double)returnData[returnDataIndices[0]+i] / returnScales[0]</tt>
15940	will retrieve the floating point value of i-th sample of the first
15941	metric.
15942	</desc>
15943	</param>
15944	<param name="returnSequenceNumbers" type="unsigned long" dir="out" safearray="yes">
15945	<desc>
15946	Sequence numbers of the first elements of value sequences of
15947	particular metrics returned in @c returnData. For aggregate metrics
15948	it is the sequence number of the sample the aggregate started
15949	calculation from.
15950	</desc>
15951	</param>
15952	<param name="returnDataIndices" type="unsigned long" dir="out" safearray="yes">
15953	<desc>
15954	Indices of the first elements of value sequences of particular
15955	metrics returned in @c returnData.
15956	</desc>
15957	</param>
15958	<param name="returnDataLengths" type="unsigned long" dir="out" safearray="yes">
15959	<desc>
15960	Lengths of value sequences of particular metrics.
15961	</desc>
15962	</param>
15963	<param name="returnData" type="long" dir="return" safearray="yes">
15964	<desc>
15965	Flattened array of all metric data containing sequences of values for
15966	each metric.
15967	</desc>
15968	</param>
15969	</method>
15970
15971	</interface>
15972
15973	<enum
15974	name="NATAliasMode"
15975	uuid="67772168-50d9-11df-9669-7fb714ee4fa1"
15976	>
15977	<desc></desc>
15978	<const name="AliasLog" value="0x1">
15979	<desc></desc>
15980	</const>
15981	<const name="AliasProxyOnly" value="0x02">
15982	<desc></desc>
15983	</const>
15984	<const name="AliasUseSamePorts" value="0x04">
15985	<desc></desc>
15986	</const>
15987	</enum>
15988
15989	<enum
15990	name="NATProtocol"
15991	uuid="e90164be-eb03-11de-94af-fff9b1c1b19f"
15992	>
15993	<desc>Protocol definitions used with NAT port-forwarding rules.</desc>
15994	<const name="UDP" value="0">
15995	<desc>Port-forwarding uses UDP protocol.</desc>
15996	</const>
15997	<const name="TCP" value="1">
15998	<desc>Port-forwarding uses TCP protocol.</desc>
15999	</const>
16000	</enum>
16001
16002	<interface
16003	name="INATEngine" extends="$unknown"
16004	uuid="4b286616-eb03-11de-b0fb-1701eca42246"
16005	wsmap="managed"
16006	>
16007	<desc>Interface for managing a NAT engine which is used with a virtual machine. This
16008	allows for changing NAT behavior such as port-forwarding rules. This interface is
16009	used in the <link to="INetworkAdapter::natDriver" /> attribute.</desc>
16010	<attribute name="network" type="wstring">
16011	<desc>The network attribute of the NAT engine (the same value is used with built-in
16012	DHCP server to fill corresponding fields of DHCP leases).</desc>
16013	</attribute>
16014	<attribute name="hostIP" type="wstring">
16015	<desc>IP of host interface to bind all opened sockets to.
16016	<note>Changing this does not change binding of port forwarding.</note>
16017	</desc>
16018	</attribute>
16019	<attribute name="tftpPrefix" type="wstring">
16020	<desc>TFTP prefix attribute which is used with the built-in DHCP server to fill
16021	the corresponding fields of DHCP leases.</desc>
16022	</attribute>
16023	<attribute name="tftpBootFile" type="wstring">
16024	<desc>TFTP boot file attribute which is used with the built-in DHCP server to fill
16025	the corresponding fields of DHCP leases.</desc>
16026	</attribute>
16027	<attribute name="tftpNextServer" type="wstring">
16028	<desc>TFTP server attribute which is used with the built-in DHCP server to fill
16029	the corresponding fields of DHCP leases.
16030	<note>The preferred form is IPv4 addresses.</note>
16031	</desc>
16032	</attribute>
16033	<attribute name="aliasMode" type="unsigned long">
16034	<desc></desc>
16035	</attribute>
16036	<attribute name="dnsPassDomain" type="boolean">
16037	<desc>Whether the DHCP server should pass the DNS domain used by the host.</desc>
16038	</attribute>
16039	<attribute name="dnsProxy" type="boolean">
16040	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16041	of the DNS proxy and process traffic using DNS servers registered on the host.</desc>
16042	</attribute>
16043	<attribute name="dnsUseHostResolver" type="boolean">
16044	<desc>Whether the DHCP server (and the DNS traffic by NAT) should pass the address
16045	of the DNS proxy and process traffic using the host resolver mechanism.</desc>
16046	</attribute>
16047	<attribute name="redirects" type="wstring" readonly="yes" safearray="yes">
16048	<desc>Array of NAT port-forwarding rules in string representation, in the following
16049	format: "name,protocol id,host ip,host port,guest ip,guest port".</desc>
16050	</attribute>
16051	<method name="setNetworkSettings">
16052	<desc>Sets network configuration of the NAT engine.</desc>
16053	<param name="mtu" type="unsigned long" dir="in">
16054	<desc>MTU (maximum transmission unit) of the NAT engine in bytes.</desc>
16055	</param>
16056	<param name="sockSnd" type="unsigned long" dir="in">
16057	<desc>Capacity of the socket send buffer in bytes when creating a new socket.</desc>
16058	</param>
16059	<param name="sockRcv" type="unsigned long" dir="in">
16060	<desc>Capacity of the socket receive buffer in bytes when creating a new socket.</desc>
16061	</param>
16062	<param name="TcpWndSnd" type="unsigned long" dir="in">
16063	<desc>Initial size of the NAT engine's sending TCP window in bytes when
16064	establishing a new TCP connection.</desc>
16065	</param>
16066	<param name="TcpWndRcv" type="unsigned long" dir="in">
16067	<desc>Initial size of the NAT engine's receiving TCP window in bytes when
16068	establishing a new TCP connection.</desc>
16069	</param>
16070	</method>
16071	<method name="getNetworkSettings">
16072	<desc>Returns network configuration of NAT engine. See <link to="#setNetworkSettings" />
16073	for parameter descriptions.</desc>
16074	<param name="mtu" type="unsigned long" dir="out" />
16075	<param name="sockSnd" type="unsigned long" dir="out" />
16076	<param name="sockRcv" type="unsigned long" dir="out" />
16077	<param name="TcpWndSnd" type="unsigned long" dir="out" />
16078	<param name="TcpWndRcv" type="unsigned long" dir="out" />
16079	</method>
16080	<method name="addRedirect">
16081	<desc>Adds a new NAT port-forwarding rule.</desc>
16082	<param name="name" type="wstring" dir="in">
16083	<desc>The name of the rule. An empty name is acceptable, in which case the NAT engine
16084	auto-generates one using the other parameters.</desc>
16085	</param>
16086	<param name="proto" type="NATProtocol" dir="in">
16087	<desc>Protocol handled with the rule.</desc>
16088	</param>
16089	<param name="hostIp" type="wstring" dir="in">
16090	<desc>IP of the host interface to which the rule should apply. An empty ip address is
16091	acceptable, in which case the NAT engine binds the handling socket to any interface.</desc>
16092	</param>
16093	<param name="hostPort" type="unsigned short" dir="in">
16094	<desc>The port number to listen on.</desc>
16095	</param>
16096	<param name="guestIp" type="wstring" dir="in">
16097	<desc>The IP address of the guest which the NAT engine will forward matching packets
16098	to. An empty IP address is acceptable, in which case the NAT engine will forward
16099	packets to the first DHCP lease (x.x.x.15).</desc>
16100	</param>
16101	<param name="guestPort" type="unsigned short" dir="in">
16102	<desc>The port number to forward.</desc>
16103	</param>
16104	</method>
16105	<method name="removeRedirect">
16106	<desc>Removes a port-forwarding rule that was previously registered.</desc>
16107	<param name="name" type="wstring" dir="in">
16108	<desc>The name of the rule to delete.</desc>
16109	</param>
16110	</method>
16111	</interface>
16112
16113	<!--
16114	// IExtPackManager
16115	/////////////////////////////////////////////////////////////////////////
16116	-->
16117
16118	<interface
16119	name="IExtPackPlugIn" extends="$unknown"
16120	uuid="58000040-e718-4746-bbce-4b86d96da461"
16121	wsmap="suppress"
16122	>
16123	<desc>
16124	Interface for keeping information about a plug-in that ships with an
16125	extension pack.
16126	</desc>
16127	<attribute name="name" type="wstring" readonly="yes">
16128	<desc>The plug-in name.</desc>
16129	</attribute>
16130	<attribute name="description" type="wstring" readonly="yes">
16131	<desc>The plug-in description.</desc>
16132	</attribute>
16133	<attribute name="frontend" type="wstring" readonly="yes">
16134	<desc>
16135	The name of the frontend or component name this plug-in plugs into.
16136	</desc>
16137	</attribute>
16138	<attribute name="modulePath" type="wstring" readonly="yes">
16139	<desc> The module path. </desc>
16140	</attribute>
16141	</interface>
16142
16143	<interface
16144	name="IExtPackBase" extends="$unknown"
16145	uuid="f79b75d8-2890-4f34-ffff-ffffa144e82c"
16146	wsmap="suppress"
16147	>
16148	<desc>
16149	Interface for querying information about an extension pack as well as
16150	accessing COM objects within it.
16151	</desc>
16152	<attribute name="name" type="wstring" readonly="yes">
16153	<desc>The extension pack name. This is unique.</desc>
16154	</attribute>
16155	<attribute name="description" type="wstring" readonly="yes">
16156	<desc>The extension pack description.</desc>
16157	</attribute>
16158	<attribute name="version" type="wstring" readonly="yes">
16159	<desc>
16160	The extension pack version string. This is restricted to the dotted
16161	version number and optionally a build indicator. No tree revision or
16162	tag will be included in the string as those things are available as
16163	separate properties. An optional publisher tag may be present like for
16164	<link to="IVirtualBox::version"/>.
16165
16166	Examples: "1.2.3", "1.2.3_BETA1" and "1.2.3_RC2".
16167	</desc>
16168	</attribute>
16169	<attribute name="revision" type="unsigned long" readonly="yes">
16170	<desc>The extension pack internal revision number.</desc>
16171	</attribute>
16172	<attribute name="edition" type="wstring" readonly="yes">
16173	<desc>
16174	Edition indicator. This is usually empty.
16175
16176	Can for instance be used to help distinguishing between two editions
16177	of the same extension pack where only the license, service contract or
16178	something differs.
16179	</desc>
16180	</attribute>
16181	<attribute name="VRDEModule" type="wstring" readonly="yes">
16182	<desc>The name of the VRDE module if the extension pack sports one.</desc>
16183	</attribute>
16184	<attribute name="plugIns" type="IExtPackPlugIn" safearray="yes" readonly="yes">
16185	<desc>Plug-ins provided by this extension pack.</desc>
16186	</attribute>
16187	<attribute name="usable" type="boolean" readonly="yes">
16188	<desc>
16189	Indicates whether the extension pack is usable or not.
16190
16191	There are a number of reasons why an extension pack might be unusable,
16192	typical examples would be broken installation/file or that it is
16193	incompatible with the current VirtualBox version.
16194	</desc>
16195	</attribute>
16196	<attribute name="whyUnusable" type="wstring" readonly="yes">
16197	<desc>
16198	String indicating why the extension pack is not usable. This is an
16199	empty string if usable and always a non-empty string if not usable.
16200	</desc>
16201	</attribute>
16202	<attribute name="showLicense" type="boolean" readonly="yes">
16203	<desc>Whether to show the license before installation</desc>
16204	</attribute>
16205	<attribute name="license" type="wstring" readonly="yes">
16206	<desc>
16207	The default HTML license text for the extension pack. Same as
16208	calling <link to="#queryLicense">queryLicense</link> with
16209	preferredLocale and preferredLanguage as empty strings and format set
16210	to html.
16211	</desc>
16212	</attribute>
16213
16214	<method name="queryLicense">
16215	<desc>
16216	Full feature version of the license attribute.
16217	</desc>
16218	<param name="preferredLocale" type="wstring" dir="in">
16219	<desc>
16220	The preferred license locale. Pass an empty string to get the default
16221	license.
16222	</desc>
16223	</param>
16224	<param name="preferredLanguage" type="wstring" dir="in">
16225	<desc>
16226	The preferred license language. Pass an empty string to get the
16227	default language for the locale.
16228	</desc>
16229	</param>
16230	<param name="format" type="wstring" dir="in">
16231	<desc>
16232	The license format: html, rtf or txt. If a license is present there
16233	will always be an HTML of it, the rich text format (RTF) and plain
16234	text (txt) versions are optional. If
16235	</desc>
16236	</param>
16237	<param name="licenseText" type="wstring" dir="return">
16238	<desc>The license text.</desc>
16239	</param>
16240	</method>
16241
16242	</interface>
16243
16244	<interface
16245	name="IExtPack" extends="IExtPackBase"
16246	uuid="431685da-3618-4ebc-b038-833ba829b4b2"
16247	wsmap="suppress"
16248	>
16249	<desc>
16250	Interface for querying information about an extension pack as well as
16251	accessing COM objects within it.
16252	</desc>
16253	<method name="queryObject">
16254	<desc>
16255	Queries the IUnknown interface to an object in the extension pack
16256	main module. This allows plug-ins and others to talk directly to an
16257	extension pack.
16258	</desc>
16259	<param name="objUuid" type="wstring" dir="in">
16260	<desc>The object ID. What exactly this is </desc>
16261	</param>
16262	<param name="returnInterface" type="$unknown" dir="return">
16263	<desc>The queried interface.</desc>
16264	</param>
16265	</method>
16266	</interface>
16267
16268	<interface
16269	name="IExtPackFile" extends="IExtPackBase"
16270	uuid="b6b49f55-efcc-4f08-b486-56e8d8afb10b"
16271	wsmap="suppress"
16272	>
16273	<desc>
16274	Extension pack file (aka tarball, .vbox-extpack) representation returned
16275	by <link to="IExtPackManager::openExtPackFile"/>. This provides the base
16276	extension pack information with the addition of the file name.
16277	</desc>
16278	<attribute name="filePath" type="wstring" readonly="yes">
16279	<desc>
16280	The path to the extension pack file.
16281	</desc>
16282	</attribute>
16283
16284	<method name="install">
16285	<desc>
16286	Install the extension pack.
16287	</desc>
16288	<param name="replace" type="boolean" dir="in">
16289	<desc>
16290	Set this to automatically uninstall any existing extension pack with
16291	the same name as the one being installed.
16292	</desc>
16293	</param>
16294	<param name="displayInfo" type="wstring" dir="in">
16295	<desc>
16296	Platform specific display information. Reserved for future hacks.
16297	</desc>
16298	</param>
16299	<param name="progess" type="IProgress" dir="return">
16300	<desc>
16301	Progress object for the operation.
16302	</desc>
16303	</param>
16304	</method>
16305	</interface>
16306
16307	<interface
16308	name="IExtPackManager" extends="$unknown"
16309	uuid="3295e6ce-b051-47b2-9514-2c588bfe7554"
16310	wsmap="suppress"
16311	>
16312	<desc>
16313	Interface for managing VirtualBox Extension Packs.
16314
16315	TODO: Describe extension packs, how they are managed and how to create
16316	one.
16317	</desc>
16318
16319	<attribute name="installedExtPacks" type="IExtPack" safearray="yes" readonly="yes">
16320	<desc>
16321	List of the installed extension packs.
16322	</desc>
16323	</attribute>
16324
16325	<method name="find">
16326	<desc>
16327	Returns the extension pack with the specified name if found.
16328
16329	<result name="VBOX_E_OBJECT_NOT_FOUND">
16330	No extension pack matching @a name was found.
16331	</result>
16332	</desc>
16333	<param name="name" type="wstring" dir="in">
16334	<desc>The name of the extension pack to locate.</desc>
16335	</param>
16336	<param name="returnData" type="IExtPack" dir="return">
16337	<desc>The extension pack if found.</desc>
16338	</param>
16339	</method>
16340
16341	<method name="openExtPackFile">
16342	<desc>
16343	Attempts to open an extension pack file in preparation for
16344	installation.
16345	</desc>
16346	<param name="path" type="wstring" dir="in">
16347	<desc>The path of the extension pack tarball. This can optionally be
16348	followed by a "::SHA-256=hex-digit" of the tarball. </desc>
16349	</param>
16350	<param name="file" type="IExtPackFile" dir="return">
16351	<desc>The interface of the extension pack file object.</desc>
16352	</param>
16353	</method>
16354
16355	<method name="uninstall">
16356	<desc>Uninstalls an extension pack, removing all related files.</desc>
16357	<param name="name" type="wstring" dir="in">
16358	<desc>The name of the extension pack to uninstall.</desc>
16359	</param>
16360	<param name="forcedRemoval" type="boolean" dir="in">
16361	<desc>
16362	Forced removal of the extension pack. This means that the uninstall
16363	hook will not be called.
16364	</desc>
16365	</param>
16366	<param name="displayInfo" type="wstring" dir="in">
16367	<desc>
16368	Platform specific display information. Reserved for future hacks.
16369	</desc>
16370	</param>
16371	<param name="progess" type="IProgress" dir="return">
16372	<desc>
16373	Progress object for the operation.
16374	</desc>
16375	</param>
16376	</method>
16377
16378	<method name="cleanup">
16379	<desc>Cleans up failed installs and uninstalls</desc>
16380	</method>
16381
16382	<method name="queryAllPlugInsForFrontend">
16383	<desc>
16384	Gets the path to all the plug-in modules for a given frontend.
16385
16386	This is a convenience method that is intended to simplify the plug-in
16387	loading process for a frontend.
16388	</desc>
16389	<param name="frontendName" type="wstring" dir="in">
16390	<desc>The name of the frontend or component.</desc>
16391	</param>
16392	<param name="plugInModules" type="wstring" dir="return" safearray="yes">
16393	<desc>Array containing the plug-in modules (full paths).</desc>
16394	</param>
16395	</method>
16396
16397	<method name="isExtPackUsable">
16398	<desc>Check if the given extension pack is loaded and usable.</desc>
16399	<param name="name" type="wstring" dir="in">
16400	<desc>The name of the extension pack to check for.</desc>
16401	</param>
16402	<param name="usable" type="boolean" dir="return">
16403	<desc>Is the given extension pack loaded and usable.</desc>
16404	</param>
16405	</method>
16406
16407	</interface>
16408
16409	<!--
16410	// BandwidthGroupType
16411	/////////////////////////////////////////////////////////////////////////
16412	-->
16413	<enum
16414	name="BandwidthGroupType"
16415	uuid="1d92b67d-dc69-4be9-ad4c-93a01e1e0c8e">
16416
16417	<desc>
16418	Type of a bandwidth control group.
16419	</desc>
16420
16421	<const name="Null" value="0">
16422	<desc>
16423	Null type, must be first.
16424	</desc>
16425	</const>
16426
16427	<const name="Disk" value="1">
16428	<desc>
16429	The bandwidth group controls disk I/O.
16430	</desc>
16431	</const>
16432
16433	<const name="Network" value="2">
16434	<desc>
16435	The bandwidth group controls network I/O.
16436	</desc>
16437	</const>
16438
16439	</enum>
16440
16441	<!--
16442	// IBandwidthGroup
16443	/////////////////////////////////////////////////////////////////////////
16444	-->
16445	<interface
16446	name="IBandwidthGroup" extends="$unknown"
16447	uuid="badea2d7-0261-4146-89f0-6a57cc34833d"
16448	wsmap="managed"
16449	>
16450	<desc>Represents one bandwidth group.</desc>
16451
16452	<attribute name="name" type="wstring" readonly="yes">
16453	<desc>Name of the group.</desc>
16454	</attribute>
16455
16456	<attribute name="type" type="BandwidthGroupType" readonly="yes">
16457	<desc>Type of the group.</desc>
16458	</attribute>
16459
16460	<attribute name="reference" type="unsigned long" readonly="yes">
16461	<desc>How many devices/medium attachements use this group.</desc>
16462	</attribute>
16463
16464	<attribute name="maxMbPerSec" type="unsigned long">
16465	<desc>The maximum number of MBytes which can be transfered by all
16466	entities attached to this group during one second.</desc>
16467	</attribute>
16468
16469	</interface>
16470
16471	<!--
16472	// IBandwidthControl
16473	/////////////////////////////////////////////////////////////////////////
16474	-->
16475	<interface
16476	name="IBandwidthControl" extends="$unknown"
16477	uuid="e2eb3930-d2f4-4f87-be17-0707e30f019f"
16478	wsmap="managed"
16479	>
16480	<desc>
16481	Controls the bandwidth groups of one machine used to cap I/O done by a VM.
16482	This includes network and disk I/O.
16483	</desc>
16484
16485	<attribute name="numGroups" type="unsigned long" readonly="yes">
16486	<desc>
16487	The current number of existing bandwidth groups managed.
16488	</desc>
16489	</attribute>
16490
16491	<method name="createBandwidthGroup">
16492	<desc>
16493	Creates a new bandwidth group.
16494	</desc>
16495
16496	<param name="name" type="wstring" dir="in">
16497	<desc>Name of the bandwidth group.</desc>
16498	</param>
16499	<param name="type" type="BandwidthGroupType" dir="in">
16500	<desc>The type of the bandwidth group (network or disk).</desc>
16501	</param>
16502	<param name="maxMbPerSec" type="unsigned long" dir="in">
16503	<desc>The maximum number of MBytes which can be transfered by all
16504	entities attached to this group during one second.</desc>
16505	</param>
16506	</method>
16507
16508	<method name="deleteBandwidthGroup">
16509	<desc>
16510	Deletes a new bandwidth group.
16511	</desc>
16512
16513	<param name="name" type="wstring" dir="in">
16514	<desc>Name of the bandwidth group to delete.</desc>
16515	</param>
16516	</method>
16517
16518	<method name="getBandwidthGroup" const="yes">
16519	<desc>
16520	Get a bandwidth group by name.
16521	</desc>
16522
16523	<param name="name" type="wstring" dir="in">
16524	<desc>Name of the bandwidth group to get.</desc>
16525	</param>
16526	<param name="bandwidthGroup" type="IBandwidthGroup" dir="return">
16527	<desc>Where to store the bandwidth group on success.</desc>
16528	</param>
16529	</method>
16530
16531	<method name="getAllBandwidthGroups" const="yes">
16532	<desc>
16533	Get all managed bandwidth groups.
16534	</desc>
16535
16536	<param name="bandwidthGroups" type="IBandwidthGroup" dir="return" safearray="yes">
16537	<desc>The array of managed bandwidth groups.</desc>
16538	</param>
16539	</method>
16540	</interface>
16541
16542	<!--
16543	// IVirtualBoxClient
16544	/////////////////////////////////////////////////////////////////////////
16545	-->
16546
16547	<interface
16548	name="IVirtualBoxClient" extends="$unknown"
16549	uuid="5fe0bd48-1181-40d1-991f-3b02f269a823"
16550	wsmap="suppress"
16551	>
16552	<desc>
16553	Convenience interface for client applications. Treat this as a
16554	singleton, i.e. never create more than one instance of this interface.
16555
16556	At the moment only available for clients of the local API (not usable
16557	via the webservice). Once the session logic is redesigned this might
16558	change.
16559	</desc>
16560
16561	<attribute name="virtualBox" type="IVirtualBox" readonly="yes">
16562	<desc>
16563	Reference to the server-side API root object.
16564	</desc>
16565	</attribute>
16566
16567	<attribute name="session" type="ISession" readonly="yes">
16568	<desc>
16569	Create a new session object and return the reference to it.
16570	</desc>
16571	</attribute>
16572
16573	<attribute name="eventSource" type="IEventSource" readonly="yes">
16574	<desc>
16575	Event source for VirtualBoxClient events.
16576	</desc>
16577	</attribute>
16578
16579	</interface>
16580
16581	<!--
16582	// Events
16583	/////////////////////////////////////////////////////////////////////////
16584	-->
16585	<enum
16586	name="VBoxEventType"
16587	uuid="cce48db6-8561-479d-8d46-1358bab45d4e"
16588	>
16589
16590	<desc>
16591	Type of an event.
16592	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16593	</desc>
16594
16595	<const name="Invalid" value="0">
16596	<desc>
16597	Invalid event, must be first.
16598	</desc>
16599	</const>
16600
16601	<const name="Any" value="1">
16602	<desc>
16603	Wildcard for all events.
16604	Events of this type are never delivered, and only used in
16605	<link to="IEventSource::registerListener"/> call to simplify registration.
16606	</desc>
16607	</const>
16608
16609	<const name="Vetoable" value="2">
16610	<desc>
16611	Wildcard for all vetoable events. Events of this type are never delivered, and only
16612	used in <link to="IEventSource::registerListener"/> call to simplify registration.
16613	</desc>
16614	</const>
16615
16616	<const name="MachineEvent" value="3">
16617	<desc>
16618	Wildcard for all machine events. Events of this type are never delivered, and only used in
16619	<link to="IEventSource::registerListener"/> call to simplify registration.
16620	</desc>
16621	</const>
16622
16623	<const name="SnapshotEvent" value="4">
16624	<desc>
16625	Wildcard for all snapshot events. Events of this type are never delivered, and only used in
16626	<link to="IEventSource::registerListener"/> call to simplify registration.
16627	</desc>
16628	</const>
16629
16630	<const name="InputEvent" value="5">
16631	<desc>
16632	Wildcard for all input device (keyboard, mouse) events.
16633	Events of this type are never delivered, and only used in
16634	<link to="IEventSource::registerListener"/> call to simplify registration.
16635	</desc>
16636	</const>
16637
16638	<const name="LastWildcard" value="31">
16639	<desc>
16640	Last wildcard.
16641	</desc>
16642	</const>
16643
16644	<const name="OnMachineStateChanged" value="32">
16645	<desc>
16646	See <link to="IMachineStateChangedEvent">IMachineStateChangedEvent</link>.
16647	</desc>
16648	</const>
16649	<const name="OnMachineDataChanged" value="33">
16650	<desc>
16651	See <link to="IMachineDataChangedEvent">IMachineDataChangedEvent</link>.
16652	</desc>
16653	</const>
16654	<const name="OnExtraDataChanged" value="34">
16655	<desc>
16656	See <link to="IExtraDataChangedEvent">IExtraDataChangedEvent</link>.
16657	</desc>
16658	</const>
16659	<const name="OnExtraDataCanChange" value="35">
16660	<desc>
16661	See <link to="IExtraDataCanChangeEvent">IExtraDataCanChangeEvent</link>.
16662	</desc>
16663	</const>
16664	<const name="OnMediumRegistered" value="36">
16665	<desc>
16666	See <link to="IMediumRegisteredEvent">IMediumRegisteredEvent</link>.
16667	</desc>
16668	</const>
16669	<const name="OnMachineRegistered" value="37">
16670	<desc>
16671	See <link to="IMachineRegisteredEvent">IMachineRegisteredEvent</link>.
16672	</desc>
16673	</const>
16674	<const name="OnSessionStateChanged" value="38">
16675	<desc>
16676	See <link to="ISessionStateChangedEvent">ISessionStateChangedEvent</link>.
16677	</desc>
16678	</const>
16679	<const name="OnSnapshotTaken" value="39">
16680	<desc>
16681	See <link to="ISnapshotTakenEvent">ISnapshotTakenEvent</link>.
16682	</desc>
16683	</const>
16684	<const name="OnSnapshotDeleted" value="40">
16685	<desc>
16686	See <link to="ISnapshotDeletedEvent">ISnapshotDeletedEvent</link>.
16687	</desc>
16688	</const>
16689	<const name="OnSnapshotChanged" value="41">
16690	<desc>
16691	See <link to="ISnapshotChangedEvent">ISnapshotChangedEvent</link>.
16692	</desc>
16693	</const>
16694	<const name="OnGuestPropertyChanged" value="42">
16695	<desc>
16696	See <link to="IGuestPropertyChangedEvent">IGuestPropertyChangedEvent</link>.
16697	</desc>
16698	</const>
16699	<!-- Console events -->
16700	<const name="OnMousePointerShapeChanged" value="43">
16701	<desc>
16702	See <link to="IMousePointerShapeChangedEvent">IMousePointerShapeChangedEvent</link>.
16703	</desc>
16704	</const>
16705	<const name="OnMouseCapabilityChanged" value="44">
16706	<desc>
16707	See <link to="IMouseCapabilityChangedEvent">IMouseCapabilityChangedEvent</link>.
16708	</desc>
16709	</const>
16710	<const name="OnKeyboardLedsChanged" value="45">
16711	<desc>
16712	See <link to="IKeyboardLedsChangedEvent">IKeyboardLedsChangedEvent</link>.
16713	</desc>
16714	</const>
16715	<const name="OnStateChanged" value="46">
16716	<desc>
16717	See <link to="IStateChangedEvent">IStateChangedEvent</link>.
16718	</desc>
16719	</const>
16720	<const name="OnAdditionsStateChanged" value="47">
16721	<desc>
16722	See <link to="IAdditionsStateChangedEvent">IAdditionsStateChangedEvent</link>.
16723	</desc>
16724	</const>
16725	<const name="OnNetworkAdapterChanged" value="48">
16726	<desc>
16727	See <link to="INetworkAdapterChangedEvent">INetworkAdapterChangedEvent</link>.
16728	</desc>
16729	</const>
16730	<const name="OnSerialPortChanged" value="49">
16731	<desc>
16732	See <link to="ISerialPortChangedEvent">ISerialPortChangedEvent</link>.
16733	</desc>
16734	</const>
16735	<const name="OnParallelPortChanged" value="50">
16736	<desc>
16737	See <link to="IParallelPortChangedEvent">IParallelPortChangedEvent</link>.
16738	</desc>
16739	</const>
16740	<const name="OnStorageControllerChanged" value="51">
16741	<desc>
16742	See <link to="IStorageControllerChangedEvent">IStorageControllerChangedEvent</link>.
16743	</desc>
16744	</const>
16745	<const name="OnMediumChanged" value="52">
16746	<desc>
16747	See <link to="IMediumChangedEvent">IMediumChangedEvent</link>.
16748	</desc>
16749	</const>
16750	<const name="OnVRDEServerChanged" value="53">
16751	<desc>
16752	See <link to="IVRDEServerChangedEvent">IVRDEServerChangedEvent</link>.
16753	</desc>
16754	</const>
16755	<const name="OnUSBControllerChanged" value="54">
16756	<desc>
16757	See <link to="IUSBControllerChangedEvent">IUSBControllerChangedEvent</link>.
16758	</desc>
16759	</const>
16760	<const name="OnUSBDeviceStateChanged" value="55">
16761	<desc>
16762	See <link to="IUSBDeviceStateChangedEvent">IUSBDeviceStateChangedEvent</link>.
16763	</desc>
16764	</const>
16765	<const name="OnSharedFolderChanged" value="56">
16766	<desc>
16767	See <link to="ISharedFolderChangedEvent">ISharedFolderChangedEvent</link>.
16768	</desc>
16769	</const>
16770	<const name="OnRuntimeError" value="57">
16771	<desc>
16772	See <link to="IRuntimeErrorEvent">IRuntimeErrorEvent</link>.
16773	</desc>
16774	</const>
16775	<const name="OnCanShowWindow" value="58">
16776	<desc>
16777	See <link to="ICanShowWindowEvent">ICanShowWindowEvent</link>.
16778	</desc>
16779	</const>
16780	<const name="OnShowWindow" value="59">
16781	<desc>
16782	See <link to="IShowWindowEvent">IShowWindowEvent</link>.
16783	</desc>
16784	</const>
16785	<const name="OnCPUChanged" value="60">
16786	<desc>
16787	See <link to="ICPUChangedEvent">ICPUChangedEvent</link>.
16788	</desc>
16789	</const>
16790	<const name="OnVRDEServerInfoChanged" value="61">
16791	<desc>
16792	See <link to="IVRDEServerInfoChangedEvent">IVRDEServerInfoChangedEvent</link>.
16793	</desc>
16794	</const>
16795	<const name="OnEventSourceChanged" value="62">
16796	<desc>
16797	See <link to="IEventSourceChangedEvent">IEventSourceChangedEvent</link>.
16798	</desc>
16799	</const>
16800	<const name="OnCPUExecutionCapChanged" value="63">
16801	<desc>
16802	See <link to="ICPUExecutionCapChangedEvent">ICPUExecutionCapChangedEvent</link>.
16803	</desc>
16804	</const>
16805	<const name="OnGuestKeyboard" value="64">
16806	<desc>
16807	See <link to="IGuestKeyboardEvent">IGuestKeyboardEvent</link>.
16808	</desc>
16809	</const>
16810	<const name="OnGuestMouse" value="65">
16811	<desc>
16812	See <link to="IGuestMouseEvent">IGuestMouseEvent</link>.
16813	</desc>
16814	</const>
16815	<const name="OnNATRedirect" value="66">
16816	<desc>
16817	See <link to="INATRedirectEvent">INATRedirectEvent</link>.
16818	</desc>
16819	</const>
16820	<const name="OnHostPciDevicePlug" value="67">
16821	<desc>
16822	See <link to="IHostPciDevicePlugEvent">IHostPciDevicePlugEvent</link>.
16823	</desc>
16824	</const>
16825	<const name="OnVBoxSVCAvailabilityChanged" value="68">
16826	<desc>
16827	See <link to="IVBoxSVCAvailabilityChangedEvent">IVBoxSVCAvailablityChangedEvent</link>.
16828	</desc>
16829	</const>
16830	<const name="OnBandwidthGroupChanged" value="69">
16831	<desc>
16832	See <link to="IBandwidthGroupChangedEvent">IBandwidthGroupChangedEvent</link>.
16833	</desc>
16834	</const>
16835	<const name="OnGuestMonitorChanged" value="70">
16836	<desc>
16837	See <link to="IGuestMonitorChangedEvent">IGuestMonitorChangedEvent</link>.
16838	</desc>
16839	</const>
16840	<const name="OnStorageDeviceChanged" value="71">
16841	<desc>
16842	See <link to="IStorageDeviceChangedEvent">IStorageDeviceChangedEvent</link>.
16843	</desc>
16844	</const>
16845
16846	<!-- Last event marker -->
16847	<const name="Last" value="72">
16848	<desc>
16849	Must be last event, used for iterations and structures relying on numerical event values.
16850	</desc>
16851	</const>
16852
16853	</enum>
16854
16855	<interface
16856	name="IEventSource" extends="$unknown"
16857	uuid="9b6e1aee-35f3-4f4d-b5bb-ed0ecefd8538"
16858	wsmap="managed"
16859	>
16860	<desc>
16861	Event source. Generally, any object which could generate events can be an event source,
16862	or aggregate one. To simplify using one-way protocols such as webservices running on top of HTTP(S),
16863	an event source can work with listeners in either active or passive mode. In active mode it is up to
16864	the IEventSource implementation to call <link to="IEventListener::handleEvent" />, in passive mode the
16865	event source keeps track of pending events for each listener and returns available events on demand.
16866
16867	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
16868	</desc>
16869
16870	<method name="createListener">
16871	<desc>
16872	Creates a new listener object, useful for passive mode.
16873	</desc>
16874	<param name="listener" type="IEventListener" dir="return"/>
16875	</method>
16876
16877	<method name="createAggregator">
16878	<desc>
16879	Creates an aggregator event source, collecting events from multiple sources.
16880	This way a single listener can listen for events coming from multiple sources,
16881	using a single blocking <link to="#getEvent"/> on the returned aggregator.
16882	</desc>
16883	<param name="subordinates" type="IEventSource" dir="in" safearray="yes">
16884	<desc>
16885	Subordinate event source this one aggregatres.
16886	</desc>
16887	</param>
16888	<param name="result" type="IEventSource" dir="return">
16889	<desc>
16890	Event source aggregating passed sources.
16891	</desc>
16892	</param>
16893	</method>
16894
16895	<method name="registerListener">
16896	<desc>
16897	Register an event listener.
16898
16899	<note>
16900	To avoid system overload, the VirtualBox server process checks if passive event
16901	listeners call <link to="IEventSource::getEvent"/> frequently enough. In the
16902	current implementation, if more than 500 pending events are detected for a passive
16903	event listener, it is forcefully unregistered by the system, and further
16904	<link to="#getEvent" /> calls will return @c VBOX_E_OBJECT_NOT_FOUND.
16905	</note>
16906	</desc>
16907	<param name="listener" type="IEventListener" dir="in">
16908	<desc>Listener to register.</desc>
16909	</param>
16910	<param name="interesting" type="VBoxEventType" dir="in" safearray="yes">
16911	<desc>
16912	Event types listener is interested in. One can use wildcards like -
16913	<link to="VBoxEventType_Any"/> to specify wildcards, matching more
16914	than one event.
16915	</desc>
16916	</param>
16917	<param name="active" type="boolean" dir="in">
16918	<desc>
16919	Which mode this listener is operating in.
16920	In active mode, <link to="IEventListener::handleEvent" /> is called directly.
16921	In passive mode, an internal event queue is created for this this IEventListener.
16922	For each event coming in, it is added to queues for all interested registered passive
16923	listeners. It is then up to the external code to call the listener's
16924	<link to="IEventListener::handleEvent" /> method. When done with an event, the
16925	external code must call <link to="#eventProcessed" />.
16926	</desc>
16927	</param>
16928	</method>
16929
16930	<method name="unregisterListener">
16931	<desc>
16932	Unregister an event listener. If listener is passive, and some waitable events are still
16933	in queue they are marked as processed automatically.
16934	</desc>
16935	<param name="listener" type="IEventListener" dir="in">
16936	<desc>Listener to unregister.</desc>
16937	</param>
16938	</method>
16939
16940	<method name="fireEvent">
16941	<desc>
16942	Fire an event for this source.
16943	</desc>
16944	<param name="event" type="IEvent" dir="in">
16945	<desc>Event to deliver.</desc>
16946	</param>
16947	<param name="timeout" type="long" dir="in">
16948	<desc>
16949	Maximum time to wait for event processing (if event is waitable), in ms;
16950	0 = no wait, -1 = indefinite wait.
16951	</desc>
16952	</param>
16953	<param name="result" type="boolean" dir="return">
16954	<desc>true if an event was delivered to all targets, or is non-waitable.</desc>
16955	</param>
16956	</method>
16957
16958	<method name="getEvent">
16959	<desc>
16960	Get events from this peer's event queue (for passive mode). Calling this method
16961	regularly is required for passive event listeners to avoid system overload;
16962	see <link to="IEventSource::registerListener" /> for details.
16963
16964	<result name="VBOX_E_OBJECT_NOT_FOUND">
16965	Listener is not registered, or autounregistered.
16966	</result>
16967	</desc>
16968	<param name="listener" type="IEventListener" dir="in">
16969	<desc>Which listener to get data for.</desc>
16970	</param>
16971	<param name="timeout" type="long" dir="in">
16972	<desc>
16973	Maximum time to wait for events, in ms;
16974	0 = no wait, -1 = indefinite wait.
16975	</desc>
16976	</param>
16977	<param name="event" type="IEvent" dir="return">
16978	<desc>Event retrieved, or null if none available.</desc>
16979	</param>
16980	</method>
16981
16982	<method name="eventProcessed">
16983	<desc>
16984	Must be called for waitable events after a particular listener finished its
16985	event processing. When all listeners of a particular event have called this
16986	method, the system will then call <link to="IEvent::setProcessed" />.
16987	</desc>
16988	<param name="listener" type="IEventListener" dir="in">
16989	<desc>Which listener processed event.</desc>
16990	</param>
16991	<param name="event" type="IEvent" dir="in">
16992	<desc>Which event.</desc>
16993	</param>
16994	</method>
16995
16996	</interface>
16997
16998	<interface
16999	name="IEventListener" extends="$unknown"
17000	uuid="67099191-32e7-4f6c-85ee-422304c71b90"
17001	wsmap="managed"
17002	>
17003	<desc>
17004	Event listener. An event listener can work in either active or passive mode, depending on the way
17005	it was registered.
17006	See <link to="IEvent" /> for an introduction to VirtualBox event handling.
17007	</desc>
17008
17009	<method name="handleEvent">
17010	<desc>
17011	Handle event callback for active listeners. It is not called for
17012	passive listeners. After calling <link to="#handleEvent"/> on all active listeners
17013	and having received acknowledgement from all passive listeners via
17014	<link to="IEventSource::eventProcessed"/>, the event is marked as
17015	processed and <link to="IEvent::waitProcessed"/> will return
17016	immediately.
17017	</desc>
17018	<param name="event" type="IEvent" dir="in">
17019	<desc>Event available.</desc>
17020	</param>
17021	</method>
17022
17023	</interface>
17024
17025	<interface
17026	name="IEvent" extends="$unknown"
17027	uuid="0ca2adba-8f30-401b-a8cd-fe31dbe839c0"
17028	wsmap="managed"
17029	>
17030	<desc>
17031	Abstract parent interface for VirtualBox events. Actual events will typically implement
17032	a more specific interface which derives from this (see below).
17033
17034	<b>Introduction to VirtualBox events</b>
17035
17036	Generally speaking, an event (represented by this interface) signals that something
17037	happened, while an event listener (see <link to="IEventListener" />) represents an
17038	entity that is interested in certain events. In order for this to work with
17039	unidirectional protocols (i.e. web services), the concepts of passive and active
17040	listener are used.
17041
17042	Event consumers can register themselves as listeners, providing an array of
17043	events they are interested in (see <link to="IEventSource::registerListener" />).
17044	When an event triggers, the listener is notified about the event. The exact
17045	mechanism of the notification depends on whether the listener was registered as
17046	an active or passive listener:
17047
17048	<ul>
17049	<li>An active listener is very similar to a callback: it is a function invoked
17050	by the API. As opposed to the callbacks that were used in the API before
17051	VirtualBox 4.0 however, events are now objects with an interface hierarchy.
17052	</li>
17053
17054	<li>Passive listeners are somewhat trickier to implement, but do not require
17055	a client function to be callable, which is not an option with scripting
17056	languages or web service clients. Internally the <link to="IEventSource" />
17057	implementation maintains an event queue for each passive listener, and
17058	newly arrived events are put in this queue. When the listener calls
17059	<link to="IEventSource::getEvent"/>, first element from its internal event
17060	queue is returned. When the client completes processing of an event,
17061	the <link to="IEventSource::eventProcessed" /> function must be called,
17062	acknowledging that the event was processed. It supports implementing
17063	waitable events. On passive listener unregistration, all events from its
17064	queue are auto-acknowledged.
17065	</li>
17066	</ul>
17067
17068	Waitable events are useful in situations where the event generator wants to track
17069	delivery or a party wants to wait until all listeners have completed the event. A
17070	typical example would be a vetoable event (see <link to="IVetoEvent" />) where a
17071	listeners might veto a certain action, and thus the event producer has to make
17072	sure that all listeners have processed the event and not vetoed before taking
17073	the action.
17074
17075	A given event may have both passive and active listeners at the same time.
17076
17077	<b>Using events</b>
17078
17079	Any VirtualBox object capable of producing externally visible events provides an
17080	@c eventSource read-only attribute, which is of the type <link to="IEventSource" />.
17081	This event source object is notified by VirtualBox once something has happened, so
17082	consumers may register event listeners with this event source. To register a listener,
17083	an object implementing the <link to="IEventListener" /> interface must be provided.
17084	For active listeners, such an object is typically created by the consumer, while for
17085	passive listeners <link to="IEventSource::createListener" /> should be used. Please
17086	note that a listener created with <link to="IEventSource::createListener"/> must not be used as an active listener.
17087
17088	Once created, the listener must be registered to listen for the desired events
17089	(see <link to="IEventSource::registerListener" />), providing an array of
17090	<link to="VBoxEventType" /> enums. Those elements can either be the individual
17091	event IDs or wildcards matching multiple event IDs.
17092
17093	After registration, the callback's <link to="IEventListener::handleEvent" /> method is
17094	called automatically when the event is triggered, while passive listeners have to call
17095	<link to="IEventSource::getEvent" /> and <link to="IEventSource::eventProcessed" /> in
17096	an event processing loop.
17097
17098	The IEvent interface is an abstract parent interface for all such VirtualBox events
17099	coming in. As a result, the standard use pattern inside <link to="IEventListener::handleEvent" />
17100	or the event processing loop is to check the <link to="#type" /> attribute of the event and
17101	then cast to the appropriate specific interface using @c QueryInterface().
17102	</desc>
17103
17104	<attribute name="type" readonly="yes" type="VBoxEventType">
17105	<desc>
17106	Event type.
17107	</desc>
17108	</attribute>
17109
17110	<attribute name="source" readonly="yes" type="IEventSource">
17111	<desc>
17112	Source of this event.
17113	</desc>
17114	</attribute>
17115
17116	<attribute name="waitable" readonly="yes" type="boolean">
17117	<desc>
17118	If we can wait for this event being processed. If false, <link to="#waitProcessed"/> returns immediately,
17119	and <link to="#setProcessed"/> doesn't make sense. Non-waitable events are generally better performing,
17120	as no additional overhead associated with waitability imposed.
17121	Waitable events are needed when one need to be able to wait for particular event processed,
17122	for example for vetoable changes, or if event refers to some resource which need to be kept immutable
17123	until all consumers confirmed events.
17124	</desc>
17125	</attribute>
17126
17127	<method name="setProcessed">
17128	<desc>
17129	Internal method called by the system when all listeners of a particular event have called
17130	<link to="IEventSource::eventProcessed" />. This should not be called by client code.
17131	</desc>
17132	</method>
17133
17134	<method name="waitProcessed">
17135	<desc>
17136	Wait until time outs, or this event is processed. Event must be waitable for this operation to have
17137	described semantics, for non-waitable returns true immediately.
17138	</desc>
17139	<param name="timeout" type="long" dir="in">
17140	<desc>
17141	Maximum time to wait for event processeing, in ms;
17142	0 = no wait, -1 = indefinite wait.
17143	</desc>
17144	</param>
17145	<param name="result" type="boolean" dir="return">
17146	<desc>If this event was processed before timeout.</desc>
17147	</param>
17148	</method>
17149	</interface>
17150
17151
17152	<interface
17153	name="IReusableEvent" extends="IEvent"
17154	uuid="69bfb134-80f6-4266-8e20-16371f68fa25"
17155	wsmap="managed"
17156	>
17157	<desc>Base abstract interface for all reusable events.</desc>
17158
17159	<attribute name="generation" readonly="yes" type="unsigned long">
17160	<desc>Current generation of event, incremented on reuse.</desc>
17161	</attribute>
17162
17163	<method name="reuse">
17164	<desc>
17165	Marks an event as reused, increments 'generation', fields shall no
17166	longer be considered valid.
17167	</desc>
17168	</method>
17169	</interface>
17170
17171	<interface
17172	name="IMachineEvent" extends="IEvent"
17173	uuid="92ed7b1a-0d96-40ed-ae46-a564d484325e"
17174	wsmap="managed" id="MachineEvent"
17175	>
17176	<desc>Base abstract interface for all machine events.</desc>
17177
17178	<attribute name="machineId" readonly="yes" type="uuid" mod="string">
17179	<desc>ID of the machine this event relates to.</desc>
17180	</attribute>
17181
17182	</interface>
17183
17184	<interface
17185	name="IMachineStateChangedEvent" extends="IMachineEvent"
17186	uuid="5748F794-48DF-438D-85EB-98FFD70D18C9"
17187	wsmap="managed" autogen="VBoxEvent" id="OnMachineStateChanged"
17188	>
17189	<desc>Machine state change event.</desc>
17190
17191	<attribute name="state" readonly="yes" type="MachineState">
17192	<desc>New execution state.</desc>
17193	</attribute>
17194	</interface>
17195
17196	<interface
17197	name="IMachineDataChangedEvent" extends="IMachineEvent"
17198	uuid="abe94809-2e88-4436-83d7-50f3e64d0503"
17199	wsmap="managed" autogen="VBoxEvent" id="OnMachineDataChanged"
17200	>
17201	<desc>
17202	Any of the settings of the given machine has changed.
17203	</desc>
17204
17205	<attribute name="temporary" readonly="yes" type="boolean">
17206	<desc>@c true if the settings change is temporary. All permanent
17207	settings changes will trigger an event, and only temporary settings
17208	changes for running VMs will trigger an event. Note: sending events
17209	for temporary changes is NOT IMPLEMENTED.</desc>
17210	</attribute>
17211	</interface>
17212
17213	<interface
17214	name="IMediumRegisteredEvent" extends="IEvent"
17215	uuid="53fac49a-b7f1-4a5a-a4ef-a11dd9c2a458"
17216	wsmap="managed" autogen="VBoxEvent" id="OnMediumRegistered"
17217	>
17218	<desc>
17219	The given medium was registered or unregistered
17220	within this VirtualBox installation.
17221	</desc>
17222
17223	<attribute name="mediumId" readonly="yes" type="uuid" mod="string">
17224	<desc>ID of the medium this event relates to.</desc>
17225	</attribute>
17226
17227	<attribute name="mediumType" readonly="yes" type="DeviceType">
17228	<desc>Type of the medium this event relates to.</desc>
17229	</attribute>
17230
17231	<attribute name="registered" type="boolean" readonly="yes">
17232	<desc>
17233	If @c true, the medium was registered, otherwise it was
17234	unregistered.
17235	</desc>
17236	</attribute>
17237	</interface>
17238
17239	<interface
17240	name="IMachineRegisteredEvent" extends="IMachineEvent"
17241	uuid="c354a762-3ff2-4f2e-8f09-07382ee25088"
17242	wsmap="managed" autogen="VBoxEvent" id="OnMachineRegistered"
17243	>
17244	<desc>
17245	The given machine was registered or unregistered
17246	within this VirtualBox installation.
17247	</desc>
17248
17249	<attribute name="registered" type="boolean" readonly="yes">
17250	<desc>
17251	If @c true, the machine was registered, otherwise it was
17252	unregistered.
17253	</desc>
17254	</attribute>
17255	</interface>
17256
17257	<interface
17258	name="ISessionStateChangedEvent" extends="IMachineEvent"
17259	uuid="714a3eef-799a-4489-86cd-fe8e45b2ff8e"
17260	wsmap="managed" autogen="VBoxEvent" id="OnSessionStateChanged"
17261	>
17262	<desc>
17263	The state of the session for the given machine was changed.
17264	<see><link to="IMachine::sessionState"/></see>
17265	</desc>
17266
17267	<attribute name="state" type="SessionState" readonly="yes">
17268	<desc>
17269	New session state.
17270	</desc>
17271	</attribute>
17272	</interface>
17273
17274	<interface
17275	name="IGuestPropertyChangedEvent" extends="IMachineEvent"
17276	uuid="3f63597a-26f1-4edb-8dd2-6bddd0912368"
17277	wsmap="managed" autogen="VBoxEvent" id="OnGuestPropertyChanged"
17278	>
17279	<desc>
17280	Notification when a guest property has changed.
17281	</desc>
17282
17283	<attribute name="name" readonly="yes" type="wstring">
17284	<desc>
17285	The name of the property that has changed.
17286	</desc>
17287	</attribute>
17288
17289	<attribute name="value" readonly="yes" type="wstring">
17290	<desc>
17291	The new property value.
17292	</desc>
17293	</attribute>
17294
17295	<attribute name="flags" readonly="yes" type="wstring">
17296	<desc>
17297	The new property flags.
17298	</desc>
17299	</attribute>
17300
17301	</interface>
17302
17303	<interface
17304	name="ISnapshotEvent" extends="IMachineEvent"
17305	uuid="21637b0e-34b8-42d3-acfb-7e96daf77c22"
17306	wsmap="managed" id="SnapshotEvent"
17307	>
17308	<desc>Base interface for all snapshot events.</desc>
17309
17310	<attribute name="snapshotId" readonly="yes" type="uuid" mod="string">
17311	<desc>ID of the snapshot this event relates to.</desc>
17312	</attribute>
17313
17314	</interface>
17315
17316	<interface
17317	name="ISnapshotTakenEvent" extends="ISnapshotEvent"
17318	uuid="d27c0b3d-6038-422c-b45e-6d4a0503d9f1"
17319	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotTaken"
17320	>
17321	<desc>
17322	A new snapshot of the machine has been taken.
17323	<see><link to="ISnapshot"/></see>
17324	</desc>
17325	</interface>
17326
17327	<interface
17328	name="ISnapshotDeletedEvent" extends="ISnapshotEvent"
17329	uuid="c48f3401-4a9e-43f4-b7a7-54bd285e22f4"
17330	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotDeleted"
17331	>
17332	<desc>
17333	Snapshot of the given machine has been deleted.
17334
17335	<note>
17336	This notification is delivered <b>after</b> the snapshot
17337	object has been uninitialized on the server (so that any
17338	attempt to call its methods will return an error).
17339	</note>
17340
17341	<see><link to="ISnapshot"/></see>
17342	</desc>
17343	</interface>
17344
17345	<interface
17346	name="ISnapshotChangedEvent" extends="ISnapshotEvent"
17347	uuid="07541941-8079-447a-a33e-47a69c7980db"
17348	wsmap="managed" autogen="VBoxEvent" id="OnSnapshotChanged"
17349	>
17350	<desc>
17351	Snapshot properties (name and/or description) have been changed.
17352	<see><link to="ISnapshot"/></see>
17353	</desc>
17354	</interface>
17355
17356	<interface
17357	name="IMousePointerShapeChangedEvent" extends="IEvent"
17358	uuid="a6dcf6e8-416b-4181-8c4a-45ec95177aef"
17359	wsmap="managed" autogen="VBoxEvent" id="OnMousePointerShapeChanged"
17360	>
17361	<desc>
17362	Notification when the guest mouse pointer shape has
17363	changed. The new shape data is given.
17364	</desc>
17365
17366	<attribute name="visible" type="boolean" readonly="yes">
17367	<desc>
17368	Flag whether the pointer is visible.
17369	</desc>
17370	</attribute>
17371	<attribute name="alpha" type="boolean" readonly="yes">
17372	<desc>
17373	Flag whether the pointer has an alpha channel.
17374	</desc>
17375	</attribute>
17376	<attribute name="xhot" type="unsigned long" readonly="yes">
17377	<desc>
17378	The pointer hot spot X coordinate.
17379	</desc>
17380	</attribute>
17381	<attribute name="yhot" type="unsigned long" readonly="yes">
17382	<desc>
17383	The pointer hot spot Y coordinate.
17384	</desc>
17385	</attribute>
17386	<attribute name="width" type="unsigned long" readonly="yes">
17387	<desc>
17388	Width of the pointer shape in pixels.
17389	</desc>
17390	</attribute>
17391	<attribute name="height" type="unsigned long" readonly="yes">
17392	<desc>
17393	Height of the pointer shape in pixels.
17394	</desc>
17395	</attribute>
17396	<attribute name="shape" type="octet" safearray="yes" readonly="yes">
17397	<desc>
17398	Shape buffer arrays.
17399
17400	The @a shape buffer contains a 1-bpp (bits per pixel) AND mask
17401	followed by a 32-bpp XOR (color) mask.
17402
17403	For pointers without alpha channel the XOR mask pixels are 32
17404	bit values: (lsb)BGR0(msb). For pointers with alpha channel
17405	the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
17406
17407	An AND mask is used for pointers with alpha channel, so if the
17408	callback does not support alpha, the pointer could be
17409	displayed as a normal color pointer.
17410
17411	The AND mask is a 1-bpp bitmap with byte aligned scanlines. The
17412	size of the AND mask therefore is <tt>cbAnd = (width + 7) / 8 *
17413	height</tt>. The padding bits at the end of each scanline are
17414	undefined.
17415
17416	The XOR mask follows the AND mask on the next 4-byte aligned
17417	offset: <tt>uint8_t *pXor = pAnd + (cbAnd + 3) & ~3</tt>.
17418	Bytes in the gap between the AND and the XOR mask are undefined.
17419	The XOR mask scanlines have no gap between them and the size of
17420	the XOR mask is: <tt>cXor = width * 4 * height</tt>.
17421
17422	<note>
17423	If @a shape is 0, only the pointer visibility is changed.
17424	</note>
17425	</desc>
17426	</attribute>
17427	</interface>
17428
17429	<interface
17430	name="IMouseCapabilityChangedEvent" extends="IEvent"
17431	uuid="d633ad48-820c-4207-b46c-6bd3596640d5"
17432	wsmap="managed" autogen="VBoxEvent" id="OnMouseCapabilityChanged"
17433	>
17434	<desc>
17435	Notification when the mouse capabilities reported by the
17436	guest have changed. The new capabilities are passed.
17437	</desc>
17438	<attribute name="supportsAbsolute" type="boolean" readonly="yes">
17439	<desc>
17440	Supports absolute coordinates.
17441	</desc>
17442	</attribute>
17443	<attribute name="supportsRelative" type="boolean" readonly="yes">
17444	<desc>
17445	Supports relative coordinates.
17446	</desc>
17447	</attribute>
17448	<attribute name="needsHostCursor" type="boolean" readonly="yes">
17449	<desc>
17450	If host cursor is needed.
17451	</desc>
17452	</attribute>
17453	</interface>
17454
17455	<interface
17456	name="IKeyboardLedsChangedEvent" extends="IEvent"
17457	uuid="6DDEF35E-4737-457B-99FC-BC52C851A44F"
17458	wsmap="managed" autogen="VBoxEvent" id="OnKeyboardLedsChanged"
17459	>
17460	<desc>
17461	Notification when the guest OS executes the KBD_CMD_SET_LEDS command
17462	to alter the state of the keyboard LEDs.
17463	</desc>
17464	<attribute name="numLock" type="boolean" readonly="yes">
17465	<desc>
17466	NumLock status.
17467	</desc>
17468	</attribute>
17469	<attribute name="capsLock" type="boolean" readonly="yes">
17470	<desc>
17471	CapsLock status.
17472	</desc>
17473	</attribute>
17474	<attribute name="scrollLock" type="boolean" readonly="yes">
17475	<desc>
17476	ScrollLock status.
17477	</desc>
17478	</attribute>
17479	</interface>
17480
17481	<interface
17482	name="IStateChangedEvent" extends="IEvent"
17483	uuid="4376693C-CF37-453B-9289-3B0F521CAF27"
17484	wsmap="managed" autogen="VBoxEvent" id="OnStateChanged"
17485	>
17486	<desc>
17487	Notification when the execution state of the machine has changed.
17488	The new state is given.
17489	</desc>
17490	<attribute name="state" type="MachineState" readonly="yes">
17491	<desc>
17492	New machine state.
17493	</desc>
17494	</attribute>
17495	</interface>
17496
17497	<interface
17498	name="IAdditionsStateChangedEvent" extends="IEvent"
17499	uuid="D70F7915-DA7C-44C8-A7AC-9F173490446A"
17500	wsmap="managed" autogen="VBoxEvent" id="OnAdditionsStateChanged"
17501	>
17502	<desc>
17503	Notification when a Guest Additions property changes.
17504	Interested callees should query IGuest attributes to
17505	find out what has changed.
17506	</desc>
17507	</interface>
17508
17509	<interface
17510	name="INetworkAdapterChangedEvent" extends="IEvent"
17511	uuid="08889892-1EC6-4883-801D-77F56CFD0103"
17512	wsmap="managed" autogen="VBoxEvent" id="OnNetworkAdapterChanged"
17513	>
17514	<desc>
17515	Notification when a property of one of the
17516	virtual <link to="IMachine::getNetworkAdapter">network adapters</link>
17517	changes. Interested callees should use INetworkAdapter methods and
17518	attributes to find out what has changed.
17519	</desc>
17520	<attribute name="networkAdapter" type="INetworkAdapter" readonly="yes">
17521	<desc>
17522	Network adapter that is subject to change.
17523	</desc>
17524	</attribute>
17525	</interface>
17526
17527	<interface
17528	name="ISerialPortChangedEvent" extends="IEvent"
17529	uuid="3BA329DC-659C-488B-835C-4ECA7AE71C6C"
17530	wsmap="managed" autogen="VBoxEvent" id="OnSerialPortChanged"
17531	>
17532	<desc>
17533	Notification when a property of one of the
17534	virtual <link to="IMachine::getSerialPort">serial ports</link> changes.
17535	Interested callees should use ISerialPort methods and attributes
17536	to find out what has changed.
17537	</desc>
17538	<attribute name="serialPort" type="ISerialPort" readonly="yes">
17539	<desc>
17540	Serial port that is subject to change.
17541	</desc>
17542	</attribute>
17543	</interface>
17544
17545	<interface
17546	name="IParallelPortChangedEvent" extends="IEvent"
17547	uuid="813C99FC-9849-4F47-813E-24A75DC85615"
17548	wsmap="managed" autogen="VBoxEvent" id="OnParallelPortChanged"
17549	>
17550	<desc>
17551	Notification when a property of one of the
17552	virtual <link to="IMachine::getParallelPort">parallel ports</link>
17553	changes. Interested callees should use ISerialPort methods and
17554	attributes to find out what has changed.
17555	</desc>
17556	<attribute name="parallelPort" type="IParallelPort" readonly="yes">
17557	<desc>
17558	Parallel port that is subject to change.
17559	</desc>
17560	</attribute>
17561	</interface>
17562
17563	<interface
17564	name="IStorageControllerChangedEvent" extends="IEvent"
17565	uuid="715212BF-DA59-426E-8230-3831FAA52C56"
17566	wsmap="managed" autogen="VBoxEvent" id="OnStorageControllerChanged"
17567	>
17568	<desc>
17569	Notification when a
17570	<link to="IMachine::mediumAttachments">medium attachment</link>
17571	changes.
17572	</desc>
17573	</interface>
17574
17575	<interface
17576	name="IMediumChangedEvent" extends="IEvent"
17577	uuid="0FE2DA40-5637-472A-9736-72019EABD7DE"
17578	wsmap="managed" autogen="VBoxEvent" id="OnMediumChanged"
17579	>
17580	<desc>
17581	Notification when a
17582	<link to="IMachine::mediumAttachments">medium attachment</link>
17583	changes.
17584	</desc>
17585	<attribute name="mediumAttachment" type="IMediumAttachment" readonly="yes">
17586	<desc>
17587	Medium attachment that is subject to change.
17588	</desc>
17589	</attribute>
17590	</interface>
17591
17592	<interface
17593	name="ICPUChangedEvent" extends="IEvent"
17594	uuid="D0F0BECC-EE17-4D17-A8CC-383B0EB55E9D"
17595	wsmap="managed" autogen="VBoxEvent" id="OnCPUChanged"
17596	>
17597	<desc>
17598	Notification when a CPU changes.
17599	</desc>
17600	<attribute name="cpu" type="unsigned long" readonly="yes">
17601	<desc>
17602	The CPU which changed.
17603	</desc>
17604	</attribute>
17605	<attribute name="add" type="boolean" readonly="yes">
17606	<desc>
17607	Flag whether the CPU was added or removed.
17608	</desc>
17609	</attribute>
17610	</interface>
17611
17612	<interface
17613	name="ICPUExecutionCapChangedEvent" extends="IEvent"
17614	uuid="dfa7e4f5-b4a4-44ce-85a8-127ac5eb59dc"
17615	wsmap="managed" autogen="VBoxEvent" id="OnCPUExecutionCapChanged"
17616	>
17617	<desc>
17618	Notification when the CPU execution cap changes.
17619	</desc>
17620	<attribute name="executionCap" type="unsigned long" readonly="yes">
17621	<desc>
17622	The new CPU execution cap value. (1-100)
17623	</desc>
17624	</attribute>
17625	</interface>
17626
17627	<interface
17628	name="IGuestKeyboardEvent" extends="IEvent"
17629	uuid="88394258-7006-40d4-b339-472ee3801844"
17630	wsmap="managed" autogen="VBoxEvent" id="OnGuestKeyboard"
17631	>
17632	<desc>
17633	Notification when guest keyboard event happens.
17634	</desc>
17635	<attribute name="scancodes" type="long" safearray="yes" readonly="yes">
17636	<desc>
17637	Array of scancodes.
17638	</desc>
17639	</attribute>
17640	</interface>
17641
17642	<interface
17643	name="IGuestMouseEvent" extends="IReusableEvent"
17644	uuid="1f85d35c-c524-40ff-8e98-307000df0992"
17645	wsmap="managed" autogen="VBoxEvent" id="OnGuestMouse"
17646	>
17647	<desc>
17648	Notification when guest mouse event happens.
17649	</desc>
17650
17651	<attribute name="absolute" type="boolean" readonly="yes">
17652	<desc>
17653	If this event is relative or absolute.
17654	</desc>
17655	</attribute>
17656
17657	<attribute name="x" type="long" readonly="yes">
17658	<desc>
17659	New X position, or X delta.
17660	</desc>
17661	</attribute>
17662
17663	<attribute name="y" type="long" readonly="yes">
17664	<desc>
17665	New Y position, or Y delta.
17666	</desc>
17667	</attribute>
17668
17669	<attribute name="z" type="long" readonly="yes">
17670	<desc>
17671	Z delta.
17672	</desc>
17673	</attribute>
17674
17675	<attribute name="w" type="long" readonly="yes">
17676	<desc>
17677	W delta.
17678	</desc>
17679	</attribute>
17680
17681	<attribute name="buttons" type="long" readonly="yes">
17682	<desc>
17683	Button state bitmask.
17684	</desc>
17685	</attribute>
17686
17687	</interface>
17688
17689
17690	<interface
17691	name="IVRDEServerChangedEvent" extends="IEvent"
17692	uuid="a06fd66a-3188-4c8c-8756-1395e8cb691c"
17693	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerChanged"
17694	>
17695	<desc>
17696	Notification when a property of the
17697	<link to="IMachine::VRDEServer">VRDE server</link> changes.
17698	Interested callees should use IVRDEServer methods and attributes to
17699	find out what has changed.
17700	</desc>
17701	</interface>
17702
17703	<interface
17704	name="IVRDEServerInfoChangedEvent" extends="IEvent"
17705	uuid="dd6a1080-e1b7-4339-a549-f0878115596e"
17706	wsmap="managed" autogen="VBoxEvent" id="OnVRDEServerInfoChanged"
17707	>
17708	<desc>
17709	Notification when the status of the VRDE server changes. Interested callees
17710	should use <link to="IConsole::VRDEServerInfo">IVRDEServerInfo</link>
17711	attributes to find out what is the current status.
17712	</desc>
17713	</interface>
17714
17715	<interface
17716	name="IUSBControllerChangedEvent" extends="IEvent"
17717	uuid="93BADC0C-61D9-4940-A084-E6BB29AF3D83"
17718	wsmap="managed" autogen="VBoxEvent" id="OnUSBControllerChanged"
17719	>
17720	<desc>
17721	Notification when a property of the virtual
17722	<link to="IMachine::USBController">USB controller</link> changes.
17723	Interested callees should use IUSBController methods and attributes to
17724	find out what has changed.
17725	</desc>
17726	</interface>
17727
17728	<interface
17729	name="IUSBDeviceStateChangedEvent" extends="IEvent"
17730	uuid="806da61b-6679-422a-b629-51b06b0c6d93"
17731	wsmap="managed" autogen="VBoxEvent" id="OnUSBDeviceStateChanged"
17732	>
17733	<desc>
17734	Notification when a USB device is attached to or detached from
17735	the virtual USB controller.
17736
17737	This notification is sent as a result of the indirect
17738	request to attach the device because it matches one of the
17739	machine USB filters, or as a result of the direct request
17740	issued by <link to="IConsole::attachUSBDevice"/> or
17741	<link to="IConsole::detachUSBDevice"/>.
17742
17743	This notification is sent in case of both a succeeded and a
17744	failed request completion. When the request succeeds, the
17745	@a error parameter is @c null, and the given device has been
17746	already added to (when @a attached is @c true) or removed from
17747	(when @a attached is @c false) the collection represented by
17748	<link to="IConsole::USBDevices"/>. On failure, the collection
17749	doesn't change and the @a error parameter represents the error
17750	message describing the failure.
17751	</desc>
17752	<attribute name="device" type="IUSBDevice" readonly="yes">
17753	<desc>
17754	Device that is subject to state change.
17755	</desc>
17756	</attribute>
17757	<attribute name="attached" type="boolean" readonly="yes">
17758	<desc>
17759	@c true if the device was attached and @c false otherwise.
17760	</desc>
17761	</attribute>
17762	<attribute name="error" type="IVirtualBoxErrorInfo" readonly="yes">
17763	<desc>
17764	@c null on success or an error message object on failure.
17765	</desc>
17766	</attribute>
17767	</interface>
17768
17769	<interface
17770	name="ISharedFolderChangedEvent" extends="IEvent"
17771	uuid="B66349B5-3534-4239-B2DE-8E1535D94C0B"
17772	wsmap="managed" autogen="VBoxEvent" id="OnSharedFolderChanged"
17773	>
17774	<desc>
17775	Notification when a shared folder is added or removed.
17776	The @a scope argument defines one of three scopes:
17777	<link to="IVirtualBox::sharedFolders">global shared folders</link>
17778	(<link to="Scope_Global">Global</link>),
17779	<link to="IMachine::sharedFolders">permanent shared folders</link> of
17780	the machine (<link to="Scope_Machine">Machine</link>) or <link
17781	to="IConsole::sharedFolders">transient shared folders</link> of the
17782	machine (<link to="Scope_Session">Session</link>). Interested callees
17783	should use query the corresponding collections to find out what has
17784	changed.
17785	</desc>
17786	<attribute name="scope" type="Scope" readonly="yes">
17787	<desc>
17788	Scope of the notification.
17789	</desc>
17790	</attribute>
17791	</interface>
17792
17793	<interface
17794	name="IRuntimeErrorEvent" extends="IEvent"
17795	uuid="883DD18B-0721-4CDE-867C-1A82ABAF914C"
17796	wsmap="managed" autogen="VBoxEvent" id="OnRuntimeError"
17797	>
17798	<desc>
17799	Notification when an error happens during the virtual
17800	machine execution.
17801
17802	There are three kinds of runtime errors:
17803	<ul>
17804	<li><i>fatal</i></li>
17805	<li><i>non-fatal with retry</i></li>
17806	<li><i>non-fatal warnings</i></li>
17807	</ul>
17808
17809	<b>Fatal</b> errors are indicated by the @a fatal parameter set
17810	to @c true. In case of fatal errors, the virtual machine
17811	execution is always paused before calling this notification, and
17812	the notification handler is supposed either to immediately save
17813	the virtual machine state using <link to="IConsole::saveState"/>
17814	or power it off using <link to="IConsole::powerDown"/>.
17815	Resuming the execution can lead to unpredictable results.
17816
17817	<b>Non-fatal</b> errors and warnings are indicated by the
17818	@a fatal parameter set to @c false. If the virtual machine
17819	is in the Paused state by the time the error notification is
17820	received, it means that the user can <i>try to resume</i> the machine
17821	execution after attempting to solve the problem that caused the
17822	error. In this case, the notification handler is supposed
17823	to show an appropriate message to the user (depending on the
17824	value of the @a id parameter) that offers several actions such
17825	as <i>Retry</i>, <i>Save</i> or <i>Power Off</i>. If the user
17826	wants to retry, the notification handler should continue
17827	the machine execution using the <link to="IConsole::resume"/>
17828	call. If the machine execution is not Paused during this
17829	notification, then it means this notification is a <i>warning</i>
17830	(for example, about a fatal condition that can happen very soon);
17831	no immediate action is required from the user, the machine
17832	continues its normal execution.
17833
17834	Note that in either case the notification handler
17835	<b>must not</b> perform any action directly on a thread
17836	where this notification is called. Everything it is allowed to
17837	do is to post a message to another thread that will then talk
17838	to the user and take the corresponding action.
17839
17840	Currently, the following error identifiers are known:
17841	<ul>
17842	<li><tt>"HostMemoryLow"</tt></li>
17843	<li><tt>"HostAudioNotResponding"</tt></li>
17844	<li><tt>"VDIStorageFull"</tt></li>
17845	<li><tt>"3DSupportIncompatibleAdditions"</tt></li>
17846	</ul>
17847	</desc>
17848	<attribute name="fatal" type="boolean" readonly="yes">
17849	<desc>
17850	Whether the error is fatal or not.
17851	</desc>
17852	</attribute>
17853	<attribute name="id" type="wstring" readonly="yes">
17854	<desc>
17855	Error identifier.
17856	</desc>
17857	</attribute>
17858	<attribute name="message" type="wstring" readonly="yes">
17859	<desc>
17860	Optional error message.
17861	</desc>
17862	</attribute>
17863	</interface>
17864
17865
17866	<interface
17867	name="IEventSourceChangedEvent" extends="IEvent"
17868	uuid="e7932cb8-f6d4-4ab6-9cbf-558eb8959a6a"
17869	waitable="yes"
17870	wsmap="managed" autogen="VBoxEvent" id="OnEventSourceChanged"
17871	>
17872	<desc>
17873	Notification when an event source state changes (listener added or removed).
17874	</desc>
17875
17876	<attribute name="listener" type="IEventListener" readonly="yes">
17877	<desc>
17878	Event listener which has changed.
17879	</desc>
17880	</attribute>
17881
17882	<attribute name="add" type="boolean" readonly="yes">
17883	<desc>
17884	Flag whether listener was added or removed.
17885	</desc>
17886	</attribute>
17887	</interface>
17888
17889	<interface
17890	name="IExtraDataChangedEvent" extends="IEvent"
17891	uuid="024F00CE-6E0B-492A-A8D0-968472A94DC7"
17892	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataChanged"
17893	>
17894	<desc>
17895	Notification when machine specific or global extra data
17896	has changed.
17897	</desc>
17898	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17899	<desc>
17900	ID of the machine this event relates to.
17901	Null for global extra data changes.
17902	</desc>
17903	</attribute>
17904	<attribute name="key" type="wstring" readonly="yes">
17905	<desc>
17906	Extra data key that has changed.
17907	</desc>
17908	</attribute>
17909	<attribute name="value" type="wstring" readonly="yes">
17910	<desc>
17911	Extra data value for the given key.
17912	</desc>
17913	</attribute>
17914	</interface>
17915
17916	<interface
17917	name="IVetoEvent" extends="IEvent"
17918	uuid="9a1a4130-69fe-472f-ac10-c6fa25d75007"
17919	wsmap="managed"
17920	>
17921	<desc>Base abstract interface for veto events.</desc>
17922
17923	<method name="addVeto">
17924	<desc>
17925	Adds a veto on this event.
17926	</desc>
17927	<param name="reason" type="wstring" dir="in">
17928	<desc>
17929	Reason for veto, could be null or empty string.
17930	</desc>
17931	</param>
17932	</method>
17933
17934	<method name="isVetoed">
17935	<desc>
17936	If this event was vetoed.
17937	</desc>
17938	<param name="result" type="boolean" dir="return">
17939	<desc>
17940	Reason for veto.
17941	</desc>
17942	</param>
17943	</method>
17944
17945	<method name="getVetos">
17946	<desc>
17947	Current veto reason list, if size is 0 - no veto.
17948	</desc>
17949	<param name="result" type="wstring" dir="return" safearray="yes">
17950	<desc>
17951	Array of reasons for veto provided by different event handlers.
17952	</desc>
17953	</param>
17954	</method>
17955
17956	</interface>
17957
17958	<interface
17959	name="IExtraDataCanChangeEvent" extends="IVetoEvent"
17960	uuid="245d88bd-800a-40f8-87a6-170d02249a55"
17961	wsmap="managed" autogen="VBoxEvent" id="OnExtraDataCanChange"
17962	waitable="true"
17963	>
17964	<desc>
17965	Notification when someone tries to change extra data for
17966	either the given machine or (if @c null) global extra data.
17967	This gives the chance to veto against changes.
17968	</desc>
17969	<attribute name="machineId" type="uuid" mod="string" readonly="yes">
17970	<desc>
17971	ID of the machine this event relates to.
17972	Null for global extra data changes.
17973	</desc>
17974	</attribute>
17975	<attribute name="key" type="wstring" readonly="yes">
17976	<desc>
17977	Extra data key that has changed.
17978	</desc>
17979	</attribute>
17980	<attribute name="value" type="wstring" readonly="yes">
17981	<desc>
17982	Extra data value for the given key.
17983	</desc>
17984	</attribute>
17985	</interface>
17986
17987	<interface
17988	name="ICanShowWindowEvent" extends="IVetoEvent"
17989	uuid="adf292b0-92c9-4a77-9d35-e058b39fe0b9"
17990	wsmap="managed" autogen="VBoxEvent" id="OnCanShowWindow"
17991	waitable="true"
17992	>
17993	<desc>
17994	Notification when a call to
17995	<link to="IMachine::canShowConsoleWindow"/> is made by a
17996	front-end to check if a subsequent call to
17997	<link to="IMachine::showConsoleWindow"/> can succeed.
17998
17999	The callee should give an answer appropriate to the current
18000	machine state using event veto. This answer must
18001	remain valid at least until the next
18002	<link to="IConsole::state">machine state</link> change.
18003	</desc>
18004	</interface>
18005
18006	<interface
18007	name="IShowWindowEvent" extends="IEvent"
18008	uuid="B0A0904D-2F05-4D28-855F-488F96BAD2B2"
18009	wsmap="managed" autogen="VBoxEvent" id="OnShowWindow"
18010	waitable="true"
18011	>
18012	<desc>
18013	Notification when a call to
18014	<link to="IMachine::showConsoleWindow"/>
18015	requests the console window to be activated and brought to
18016	foreground on the desktop of the host PC.
18017
18018	This notification should cause the VM console process to
18019	perform the requested action as described above. If it is
18020	impossible to do it at a time of this notification, this
18021	method should return a failure.
18022
18023	Note that many modern window managers on many platforms
18024	implement some sort of focus stealing prevention logic, so
18025	that it may be impossible to activate a window without the
18026	help of the currently active application (which is supposedly
18027	an initiator of this notification). In this case, this method
18028	must return a non-zero identifier that represents the
18029	top-level window of the VM console process. The caller, if it
18030	represents a currently active process, is responsible to use
18031	this identifier (in a platform-dependent manner) to perform
18032	actual window activation.
18033
18034	This method must set @a winId to zero if it has performed all
18035	actions necessary to complete the request and the console
18036	window is now active and in foreground, to indicate that no
18037	further action is required on the caller's side.
18038	</desc>
18039	<attribute name="winId" type="long long">
18040	<desc>
18041	Platform-dependent identifier of the top-level VM console
18042	window, or zero if this method has performed all actions
18043	necessary to implement the <i>show window</i> semantics for
18044	the given platform and/or this VirtualBox front-end.
18045	</desc>
18046	</attribute>
18047	</interface>
18048
18049	<interface
18050	name="INATRedirectEvent" extends="IMachineEvent"
18051	uuid="57DE97D7-3CBB-42A0-888F-610D5832D16B"
18052	wsmap="managed" autogen="VBoxEvent" id="OnNATRedirect"
18053	>
18054	<desc>
18055	Notification when NAT redirect rule added or removed.
18056	</desc>
18057	<attribute name="slot" type="unsigned long" readonly="yes">
18058	<desc>
18059	Adapter which NAT attached to.
18060	</desc>
18061	</attribute>
18062	<attribute name="remove" type="boolean" readonly="yes">
18063	<desc>
18064	Whether rule remove or add.
18065	</desc>
18066	</attribute>
18067	<attribute name="name" type="wstring" readonly="yes">
18068	<desc>
18069	Name of the rule.
18070	</desc>
18071	</attribute>
18072	<attribute name="proto" type="NATProtocol" readonly="yes">
18073	<desc>
18074	Protocol (TCP or UDP) of the redirect rule.
18075	</desc>
18076	</attribute>
18077	<attribute name="hostIp" type="wstring" readonly="yes">
18078	<desc>
18079	Host ip address to bind socket on.
18080	</desc>
18081	</attribute>
18082	<attribute name="hostPort" type="long" readonly="yes">
18083	<desc>
18084	Host port to bind socket on.
18085	</desc>
18086	</attribute>
18087	<attribute name="guestIp" type="wstring" readonly="yes">
18088	<desc>
18089	Guest ip address to redirect to.
18090	</desc>
18091	</attribute>
18092	<attribute name="guestPort" type="long" readonly="yes">
18093	<desc>
18094	Guest port to redirect to.
18095	</desc>
18096	</attribute>
18097	</interface>
18098
18099	<interface
18100	name="IHostPciDevicePlugEvent" extends="IMachineEvent"
18101	waitable="yes"
18102	uuid="9cebfc27-c579-4965-8eb7-d31794cd7dcf"
18103	wsmap="managed" autogen="VBoxEvent" id="OnHostPciDevicePlug"
18104	>
18105	<desc>
18106	Notification when host PCI device is plugged/unplugged. Plugging
18107	usually takes place on VM startup, unplug - when
18108	<link to="IMachine::detachHostPciDevice"/> is called.
18109
18110	<see><link to="IMachine::detachHostPciDevice"/></see>
18111
18112	</desc>
18113
18114	<attribute name="plugged" type="boolean" readonly="yes">
18115	<desc>
18116	If device successfully plugged or unplugged.
18117	</desc>
18118	</attribute>
18119
18120	<attribute name="success" type="boolean" readonly="yes">
18121	<desc>
18122	If operation was successful, if false - 'message' attribute
18123	may be of interest.
18124	</desc>
18125	</attribute>
18126
18127	<attribute name="attachment" type="IPciDeviceAttachment" readonly="yes">
18128	<desc>
18129	Attachment info for this device.
18130	</desc>
18131	</attribute>
18132
18133	<attribute name="message" type="wstring" readonly="yes">
18134	<desc>
18135	Optional error message.
18136	</desc>
18137	</attribute>
18138
18139	</interface>
18140
18141	<interface
18142	name="IVBoxSVCAvailabilityChangedEvent" extends="IEvent"
18143	uuid="97c78fcd-d4fc-485f-8613-5af88bfcfcdc"
18144	wsmap="managed" autogen="VBoxEvent" id="OnVBoxSVCAvailabilityChanged"
18145	>
18146	<desc>
18147	Notification when VBoxSVC becomes unavailable (due to a crash or similar
18148	unexpected circumstances) or available again.
18149	</desc>
18150
18151	<attribute name="available" type="boolean" readonly="yes">
18152	<desc>
18153	Whether VBoxSVC is available now.
18154	</desc>
18155	</attribute>
18156	</interface>
18157
18158	<interface
18159	name="IBandwidthGroupChangedEvent" extends="IEvent"
18160	uuid="334df94a-7556-4cbc-8c04-043096b02d82"
18161	wsmap="managed" autogen="VBoxEvent" id="OnBandwidthGroupChanged"
18162	>
18163	<desc>
18164	Notification when one of the bandwidth groups changed
18165	</desc>
18166	<attribute name="bandwidthGroup" type="IBandwidthGroup" readonly="yes">
18167	<desc>
18168	The changed bandwidth group.
18169	</desc>
18170	</attribute>
18171	</interface>
18172
18173	<enum
18174	name="GuestMonitorChangedEventType"
18175	uuid="ef172985-7e36-4297-95be-e46396968d66"
18176	>
18177
18178	<desc>
18179	How the guest monitor has been changed.
18180	</desc>
18181
18182	<const name="Enabled" value="0">
18183	<desc>
18184	The guest monitor has been enabled by the guest.
18185	</desc>
18186	</const>
18187
18188	<const name="Disabled" value="1">
18189	<desc>
18190	The guest monitor has been disabled by the guest.
18191	</desc>
18192	</const>
18193
18194	<const name="NewOrigin" value="2">
18195	<desc>
18196	The guest monitor origin has changed in the guest.
18197	</desc>
18198	</const>
18199	</enum>
18200
18201	<interface
18202	name="IGuestMonitorChangedEvent" extends="IEvent"
18203	uuid="0f7b8a22-c71f-4a36-8e5f-a77d01d76090"
18204	wsmap="managed" autogen="VBoxEvent" id="OnGuestMonitorChanged"
18205	>
18206	<desc>
18207	Notification when the guest enables one of its monitors.
18208	</desc>
18209
18210	<attribute name="changeType" type="GuestMonitorChangedEventType" readonly="yes">
18211	<desc>
18212	What was changed for this guest monitor.
18213	</desc>
18214	</attribute>
18215
18216	<attribute name="screenId" type="unsigned long" readonly="yes">
18217	<desc>
18218	The monitor which was changed.
18219	</desc>
18220	</attribute>
18221
18222	<attribute name="originX" type="unsigned long" readonly="yes">
18223	<desc>
18224	Physical X origin relative to the primary screen.
18225	Valid for Enabled and NewOrigin.
18226	</desc>
18227	</attribute>
18228
18229	<attribute name="originY" type="unsigned long" readonly="yes">
18230	<desc>
18231	Physical Y origin relative to the primary screen.
18232	Valid for Enabled and NewOrigin.
18233	</desc>
18234	</attribute>
18235
18236	<attribute name="width" type="unsigned long" readonly="yes">
18237	<desc>
18238	Width of the screen.
18239	Valid for Enabled.
18240	</desc>
18241	</attribute>
18242
18243	<attribute name="height" type="unsigned long" readonly="yes">
18244	<desc>
18245	Height of the screen.
18246	Valid for Enabled.
18247	</desc>
18248	</attribute>
18249
18250	</interface>
18251
18252	<interface
18253	name="IStorageDeviceChangedEvent" extends="IEvent"
18254	uuid="8a5c2dce-e341-49d4-afce-c95979f7d70c"
18255	wsmap="managed" autogen="VBoxEvent" id="OnStorageDeviceChanged"
18256	>
18257	<desc>
18258	Notification when a
18259	<link to="IMachine::mediumAttachments">storage device</link>
18260	is attached or removed.
18261	</desc>
18262	<attribute name="storageDevice" type="IMediumAttachment" readonly="yes">
18263	<desc>
18264	Storage device that is subject to change.
18265	</desc>
18266	</attribute>
18267	<attribute name="removed" type="boolean" readonly="yes">
18268	<desc>
18269	Flag whether the device was removed or added to the VM.
18270	</desc>
18271	</attribute>
18272	</interface>
18273
18274	<module name="VBoxSVC" context="LocalServer">
18275	<class name="VirtualBox" uuid="B1A7A4F2-47B9-4A1E-82B2-07CCD5323C3F"
18276	namespace="virtualbox.org">
18277	<interface name="IVirtualBox" default="yes"/>
18278	</class>
18279	</module>
18280
18281	<module name="VBoxC" context="InprocServer" threadingModel="Free">
18282	<class name="VirtualBoxClient" uuid="dd3fc71d-26c0-4fe1-bf6f-67f633265bba"
18283	namespace="virtualbox.org">
18284	<interface name="IVirtualBoxClient" default="yes"/>
18285	</class>
18286
18287	<class name="Session" uuid="3C02F46D-C9D2-4F11-A384-53F0CF917214"
18288	namespace="virtualbox.org">
18289	<interface name="ISession" default="yes"/>
18290	</class>
18291	</module>
18292
18293	</library>
18294
18295	</idl>
18296
18297	<!-- vim: set shiftwidth=2 tabstop=2 expandtab: -->

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

Download in other formats:

Original Format